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

From SmartWiki
Jump to: navigation, search
Line 14: Line 14:
 
* 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.
* Whether or not the source text should be displayed along with the barcode
+
* Whether or not the source text should be displayed below with the barcode.
 
* The width of the barcode.
 
* The width of the barcode.
  
Line 21: Line 21:
  
 
<u>Options:</u>
 
<u>Options:</u>
* '''customfieldid''' = the Custom Field ID of the field that stores the actual value
+
* '''customfieldid''' = the Custom Field ID of the field that stores the actual value.
* '''codetype'''= can be any one of list 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)
  
 
  CODABAR, CODE11, CODE39, CODE39EX, CODE93, CODE128, CODE128A, CODE128B, CODE128C
 
  CODABAR, CODE11, CODE39, CODE39EX, CODE93, CODE128, CODE128A, CODE128B, CODE128C
Line 31: Line 31:
 
  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.  
 
::'''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.''
+
::''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.
 
::If the Custom Field you are using as the source does not meet the requirements no barcode will be displayed.
  
Line 37: Line 37:
 
* '''width''' = The width of bars. The default value is 1.
 
* '''width''' = The width of bars. The default value is 1.
  
Example of entries
+
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''
  
12345,ISBN,yes,1
 
  
12345,ISBN,yes
+
The Width and Height of the whole image can adjusted by width and height settings of the [[Custom Field]]
 
 
12345,ISBN
 
 
 
12345
 
 
 
12345,,yes,1
 
 
 
12345,ISBN,,1
 
 
 
12345,ISBN,yes
 
 
 
Width and Height of the whole image can adjusted by width and height settings of customfield
 
  
  

Revision as of 12:20, 25 May 2009

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 Display

BarcCode2.PNG In this image the Barcode custom field is displaying the value in the Ticket Number field as a barcode.

Field Options

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

Options:

  • customfieldid = the Custom Field ID of the field that stores the actual 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
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.
  • width = The width of bars. The default value is 1.

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


The Width and Height of the whole image can adjusted by width and height settings of the Custom Field


Visibility Condition

The Visibility Condition field can be used to enter a logical statement which determines whether or not the field is displayed.

Role - Field Permissions

These fields allow you to control by Role who is allowed to view and/or modify the field.

Status - Field Permissions

These fields allow you to control by the Status of the record whether or not the field can be viewed and/or modified.