Difference between revisions of "Custom Field Type: Special – Barcode"

From SmartWiki
Jump to: navigation, search
 
(18 intermediate revisions by 5 users not shown)
Line 2: Line 2:
 
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.
  
This field type converts another field's value (numeric or alphanumeric depends on the coding system selected) into a barcode image.  
+
This field type converts another field's value (numeric or alphanumeric depends on the coding system selected) into a barcode image.
 +
 
 +
==Field Illustrated==
 +
[[Image:Cf_sb_ex1.png]]<br />
 +
''In this image, the Barcode custom field is displaying the value in the '''Special Number''' field as a barcode (above)''
 +
 
 +
 
 +
[[Image:Cf_sb_ex2.png]]<br />
 +
''In General Settings, the Values field is populated with the Custom Field ID for the Special Auto Number for this example (above)''
 +
 
  
==Field Display==
 
[[Image:BarcCode2.PNG]]
 
''In this image the Barcode custom field is displaying the value in the '''Ticket Number''' field as a barcode.''
 
  
 
==Field Options==
 
==Field Options==
 +
All common options:<br />
 +
[[Custom Fields - General Information #General_Settings|General Settings]]<br />
 +
[[Custom Fields - General Information #Role Field Permissions and Status Field Permissions|Permissions & Availability]]<br />
 +
[[Custom Fields - General Information #Classic Options|Classic Options]]<br />
 +
For further information, please refer to [[Custom Fields – General Information]].<br /><br />
 +
Options listed below are specific to this particular field type.
  
===Values===
+
* '''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''' section below.
 +
 
 +
==Values==
 
The '''Values''' field is used to specify:
 
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 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.
 
* The Code Type (also known as Symbology), which is the encoding format of the barcode.
Line 17: Line 32:
 
* The width of the barcode.
 
* The width of the barcode.
  
<u>Usage:</u>
+
===Usage===
 
  '''customfieldid,codetype,showtext,width'''
 
  '''customfieldid,codetype,showtext,width'''
  
<u>Options:</u>
+
===Values Options===
* '''customfieldid''' = the Custom Field ID of the field that stores the actual value.
+
* '''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)
 
* '''codetype'''= can be any of the Code Types listed below. If none is provided the default is CODABAR (which only accepts integer values)
  
Line 30: Line 45:
 
  ONECODE, POSTNET, PLANET, RM4SCC,
 
  ONECODE, POSTNET, PLANET, RM4SCC,
 
  UPCA, UPCA_2, UPCA_5, UPCE, UPCE_2, UPCE_5
 
  UPCA, UPCA_2, UPCA_5, UPCE, UPCE_2, UPCE_5
::'''Note:''' 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.
 
  
 
* '''showtext''' = whether or not to show the text underneath the barcode. Can be ''yes'' or ''no''. The default is ''yes''.
 
* '''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.
 
* '''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==
 +
{| class="wikitable"
 +
|-
 +
||'''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''
 +
|}
  
  
Examples for the '''Values''' field:
 
:*12345        ''-will be interpreted as 12345,CODABAR,yes,1''
 
:*12345,,,2    ''-will be interpreted as 12345,CODABAR,yes,2''
 
:*12345,ISBN    ''-will be interpreted as 12345,ISBN,Yes,1''
 
:*12345,ISBN,,2 ''-will be interpreted as 12345,ISBN,yes,2''
 
  
===Height===
+
==Notes==
 
The '''Height''' of the barcode image can adjusted by the height settings of the [[Custom Field]].
 
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).
 
(The '''Width''' is controlled by the '''Values''' section as described above).
 +
<br /><br />
  
===[[Visibility Condition]]===
+
{{CustomFieldPageFooter}}
The [[Visibility Condition]] field can be used to enter a logical statement which determines whether or not the field is displayed.
 
 
 
===[[Role Field Permissions|Role - Field Permissions]]===
 
 
 
These [[Role Field Permissions|fields]] allow you to control by [[Role]] who is allowed to view and/or modify the field.
 
 
 
===[[Status Field Permissions|Status - Field Permissions]]===
 
* ''Only present within the [[Universal Tracking Application]]''
 
These [[Status Field Permissions|fields]] allow you to control by the [[Status]] of the record whether or not the field can be viewed and/or modified.
 
 
 
 
 
[[Category:Custom Fields]]
 

Latest revision as of 15:41, 4 December 2018

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

Cf sb ex1.png
In this image, the Barcode custom field is displaying the value in the Special Number field as a barcode (above)


Cf sb ex2.png
In General Settings, the Values field is populated with the Custom Field ID for the Special Auto Number for this example (above)


Field Options

All common options:
General Settings
Permissions & Availability
Classic Options
For further information, please refer to Custom Fields – General Information.

Options listed below are specific to this particular field type.

  • 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 section below.

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


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).