Wiki source code of Barcode-Plugin
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | [[**Plugin download**>>url:https://customer.formcycle.eu/index.php/apps/files/?dir=/FORMCYCLE%20-%20Plugins%20Customer/fc-plugin-bundle-barcode&fileid=6474||target="_blank"]] (requires login) | ||
| 2 | |||
| 3 | The Barcode plugin allows users to create barcodes (from form data). This plugin is subject to additional charge. | ||
| 4 | |||
| 5 | A plugin installation guide can be found [[here>>doc:Formcycle.UserInterface.Client.Plugins.WebHome]]. | ||
| 6 | |||
| 7 | == Plugin parameters == | ||
| 8 | |||
| 9 | {{id name="fig_plugin_barcode"/}} | ||
| 10 | {{figure image="plugin_barcode_en.png"}}Configuration UI of the Barcode plugin. The content of the barcode can be generated from form input using [[placeholders>>doc:Formcycle.UserInterface.Variables.WebHome]]. The output variable may be used for subsequent workflow actions such as [[Word (Fill)>>doc:Formcycle.Designer.Workflow.Actions.FillWordDocument.WebHome]] or [[PDF (Fill)>>doc:Formcycle.Designer.Workflow.Actions.FillPdfDocument.WebHome]]{{/figure}} | ||
| 11 | {{id name="fig_barcode_doc_en"/}} | ||
| 12 | {{figure image="barcode_doc_en.png"}}Including a QR code in a document using [[Word (Fill)>>doc:Formcycle.Designer.Workflow.Actions.FillWordDocument.WebHome]]. On the left is a Word document containing a control element with the value of the barcode variable. For more information about how to fill Word documents look [[here>>doc:Formcycle.Designer.Workflow.Actions.FillWordDocument.PreparationWord.WebHome]]. After the workflow processing has been executed with a barcode plugin action and a Word (Fill) action the document on the right is generated.{{/figure}} | ||
| 13 | |||
| 14 | * **Format** (Mandatory) | ||
| 15 | Selction of the desired barcode format. The following formats are available: //UPC-A//, //UPC-E//, //EAN-8//, //EAN-13//, //CODE 39//, //CODE 93//, //CODE 128//, //ITF//, //CODABAR//, //DATAMATRIX//, //PDF417//, //QR// and //AZTEC//. | ||
| 16 | |||
| 17 | * **Content** (Mandatory) | ||
| 18 | The content that should be encoded. It can be generated with [[placeholders>>doc:Formcycle.UserInterface.Variables.WebHome]] as seen in the [[figure>>||anchor="fig_plugin_barcode"]]. The content has to: | ||
| 19 | ** be non-empty | ||
| 20 | ** conform to the selected format | ||
| 21 | ** be the right size. It can not be too big (the max size depends on the format) | ||
| 22 | * If this is not the case an error will occur during plugin execution. | ||
| 23 | |||
| 24 | * **Name of output file** (Mandatory) | ||
| 25 | Name of the image file to be generated. The **file extension** has to be given. The following file extensions are possible: {{code language="none"}}.png{{/code}}, {{code language="none"}}.jpg{{/code}}, {{code language="none"}}.jpeg{{/code}}, {{code language="none"}}.bmp{{/code}}, {{code language="none"}}.gif{{/code}} | ||
| 26 | |||
| 27 | * **Name of output variable** (optional) | ||
| 28 | The variable allows access to the image data ({{code language="none"}}Base64{{/code}} data) of the barcode. The variable name can not contain whitespaces. Other actions can access the image data via this variable, e.g. [[Word (Fill)>>doc:Formcycle.Designer.Workflow.Actions.FillWordDocument.WebHome]] or [[PDF (Fill)>>doc:Formcycle.Designer.Workflow.Actions.FillPdfDocument.WebHome]] for including the barcode in documents. The syntax for including the image data is as follows: | ||
| 29 | ** Word (Fill): {{code language="none"}}<Name of output variable>.b64img(){{/code}} | ||
| 30 | ** PDF (Fill): {{code language="none"}}<Name of output variable>-b64img{{/code}} | ||
| 31 | |||
| 32 | * **Width** (Mandatory) | ||
| 33 | Width of the barcode | ||
| 34 | |||
| 35 | * **Height** (Mandatory) | ||
| 36 | Height of the barcode |