Difference between revisions of "Custom Field Type: Special – Barcode"
From SmartWiki
| Line 1: | Line 1: | ||
| − | |||
| − | |||
==General Description== | ==General Description== | ||
The '''Special - Barcode''' [[Custom Field]] displays a barcode, which is an optical machine-readable representation of data. | The '''Special - Barcode''' [[Custom Field]] displays a barcode, which is an optical machine-readable representation of data. | ||
Revision as of 14:01, 5 July 2018
Contents
General Description
The Special - Barcode Custom Field displays a barcode, which is an optical machine-readable representation of data.
This field type converts another field's value (numeric or alphanumeric depends on the coding system selected) into a barcode image.
Field Illustrated
In this image, the Barcode custom field is displaying the value in the Special Number field as a barcode (above)
In General Settings, the Values field is populated with the Custom Field ID for the Special Auto Number for this example (above)
Field Options
| Option | Description | Format |
|---|---|---|
| Custom Field ID | The unique ID number associated with the custom field. | Not Applicable |
| Field Type | The list of available Field Types. | @fieldtype@ |
| Field Name | The name of the field, used internally to reference the user's input; | @fieldname@ |
| Caption | The leading question or prologue before the field. | @caption@ |
| Display Order | The order (relative to other fields) in which this field is displayed. | @displayorder@ |
| Description | Definition and general description of the custom field. Will not be displayed. | @description@ |
- Values: Used to specify the Custom ID, Code Type, Source Text, and Width of the barcode you wish to generate. Additional details located in the Values located below.
- Label Display: Determines the location of the field caption. Options include: Left of Field, Above Field, No Caption, Hide Caption. Note: this option was previously called Label Display. (See examples here.)
- Tool Tip: When the user hovers their mouse pointer over the caption of a field, the text in this section will appear.
- On New Record: Controls how the field should be displayed until record has been saved once.
- Always Display: Field will be exposed both before and after the record is saved.
- Hide on New Record: Field will be hidden until record is saved.
- Only Show on New Record: Field will be exposed until record is saved, and then it will be hidden. This option is useful for fields that provide instructions for filling out forms before saving.
- SmartField View - Include or exclude this field from SmartField Views (@SmartFields@) or only display this field for SmartField Views. See SmartField View for further details.
Options
General Options
- Enable Multiple Select: Enables users to select multiple values from the listed values.
- Disable Field From Global Search: Selecting this option means that the contents of this field will not be displayed in Global Search results.
Formatting
- Height: Enables the user to set the height of the field in pixels.
- Width: Enables the user to set the width of the field in pixels.
Values
The Values field is used to specify:
- The Custom Field ID of the field that contains the integer or text string you wish to have converted to a barcode.
- The Code Type (also known as Symbology), which is the encoding format of the barcode.
- Whether or not the source text should be displayed below with the barcode.
- The width of the barcode.
Usage
customfieldid,codetype,showtext,width
Values Options
- customfieldid = the Custom Field ID of the field that stores the source value.
- codetype= can be any of the Code Types listed below. If none is provided the default is CODABAR (which only accepts integer values)
CODABAR, CODE11, CODE39, CODE39EX, CODE93, CODE128, CODE128A, CODE128B, CODE128C EAN8, EAN8_2, EAN8_5, EAN13, EAN13_2, EAN13_5 IDENTCODE, INTERLEAVED25, ISBN, ISBN_5, ISSN, ISSN_2, ITF14, LEITCODE, MSI, MSI10, MSI11,MSI1010, MSI1110 ONECODE, POSTNET, PLANET, RM4SCC, UPCA, UPCA_2, UPCA_5, UPCE, UPCE_2, UPCE_5
- showtext = whether or not to show the text underneath the barcode. Can be yes or no. The default is yes.
- width = The width of bars. The default value is 1.
Notes on Code Types Many of the Code Types listed above have strictly defined rules about the number of digits, location of alphanumeric characters etc.
- For example: EAN13 requires 13 integers; RM4SCC is for UK Postal Codes, and cannot have any spaces.
- If the Custom Field you are using as the source does not meet the requirements no barcode will be displayed.
Value field Examples
| Value | Interpreted As |
| 12345 | 12345,CODABAR,yes,1 |
| 12345,,,2 | 12345,CODABAR,yes,2 |
| 12345,ISBN | 12345,ISBN,yes,1 |
| 12345,ISBN,,2 | 12345,ISBN,yes,2 |
Permissions & Availability Tab
- Visibility Condition: See the Visibility Condition Wiki page.
- Field Permission Matrix: See the Field Permission Matrix Wiki page.
- Role - Field Permissions: These settings allow you to control by Role who is allowed to view and/or modify the field.
- Status - Field Permissions: These settings allow you to control by the Status of the record whether or not the field can be viewed and/or modified. (Only present within the Universal Tracking Application)
- Type - Field Permissions: These settings allow you to control by the template of the record whether or not the field can be viewed and/or modified. (Only present within the Universal Tracking Application)
Notes
The Height of the barcode image can adjusted by the height settings of the Custom Field.
(The Width is controlled by the Values section as described above).
