Plug Database icon

Plug Database

Run Plug Database commands over REST or Socket.

Tools → Generate Barcode

AI-generated

Summary

Generate a barcode or QR code image encoding specified text with customizable options, outputting as binary data within the workflow.

Inputs

  • Tool Category — Select the group of tools to show; default is 'Documents' but for barcode generation, it typically involves 'Code / Identification'.
  • Text (required) — Text string to encode into the barcode or QR code.
  • Barcode Type (required) — Choose the barcode standard to generate, such as QR Code, Code 128, EAN-13, etc.
  • Output Format (required) — Choose the image format for the generated barcode (PNG or SVG).
  • File Name — Specify the name of the generated image file; defaults to 'barcode'.
  • Output Binary Property — Specify the binary property name where the generated image binary data will be stored; defaults to 'data'.
  • Render Options — Customize rendering details including scale, barcode height, max text size, max output size, whether to include human-readable text, text alignment, QR error correction level, foreground and background colors.
  • Advanced Options JSON — Provide additional bwip-js rendering options as JSON, with values as strings, numbers, or booleans, to fine-tune barcode generation.
  • Include Base64 JSON — If enabled, includes a base64-encoded version of the generated image in the JSON output alongside the binary data.
  • Base64 Output Property — When base64 JSON inclusion is enabled, this is the JSON property name for the base64 image string.
  • Include Plug Tools Metadata — Include generation metadata in output JSON for detailed info about the barcode generation process.
  • Metadata Property — The JSON property name to store generation metadata, default is '__plugTools'.

Output shape

a single JSON object per input item with embedded barcode image binary data and optional base64 string and metadata.

The generated barcode image is output as binary data stored under the specified output binary property, defaulting to 'data'. Optionally, base64 string representation and detailed metadata about the generation can be included in the JSON output properties. The operation processes each input item independently and returns corresponding output items with generated barcode images. Limits on text size and output image size are enforced as configured in render options.

Links

Discussion