Field Loop Expansion Tokens

Field Loop Token

Description

<FIELD#>

Inserts the 1-based index of the current field in the record, without considering array elements or group fields as individual fields.

<FIELD#_ZERO>

Inserts the 0-based index of the current field in the record, without considering array elements or group fields as individual fields.

<FIELD#LOGICAL>

Inserts the 1-based index of the current field in the record. Array elements and group fields are considered as individual fields. For example a structure with three fields, one of which is an array of 8 elements, is treated as having 10 fields.

<FIELD#LOGICAL_ZERO>

Inserts the 0-based index of the current field in the record. Array elements and group fields are considered as individual fields. For example a structure with three fields, one of which is an array of 8 elements, is treated as having 10 fields.

<FIELD_ALTNAME>

Inserts the alternate name of the field. Array fields are represented in Synergy format, for example ALTNAME[1]. If no alternate name is available then the real name is used.

Alternates: <field_altname> <Field_Altname> <Field_altname> <FieldAltname> <fieldAltname>

<FIELD_ARRIVEM>

Inserts the name of the fields arrive method if present, or by nothing if not.

Alternates: <field_arrivem> <Field_Arrivem> <Field_arrivem> <FieldArrivem> <fieldArrivem>

<FIELD_BASENAME>

Inserts the base name of the field. Array field dimensions are not included in the base name.

Alternates: <field_basename> <Field_Basename> <Field_basename> <FieldBasename> <fieldBasename>

<FIELD_BREAK_MODE>

Inserts a value indicating whether the field is a break field, and if so what type of break field.

Possible Values: "None", "Change", "Always", "Return" (quotes not inserted)

<FIELD_CHANGEM>

Inserts the name of the fields change method if present, or by nothing if not.

Alternates: <field_changem> <Field_Changem> <Field_changem> <FieldChangem> <fieldChangem>

<FIELD_CLASS>

Inserts the name of the fields class, if present. Only date, time and user-defined fields can have a class assigned.

Possible Values: YYMMDD, YYYYMMDD, YYJJJ, YYYYJJJ, YYPP, YYYYPP, HHMMSS, HHMM, UserAlpha, UserBinary, UserDate, UserNumeric

<FIELD_COL>

Inserts the screen column for placement of the field on the screen in a cell-based environment. If the field has a column position specified then this is used, otherwise the default of column 15 is used.

<FIELD_CSCONVERT>

Inserts a string indicating the appropriate C# string to numeric conversion method to use to attempt to parse a string into a numeric value. For non-numeric fields the token is replaced by nothing.

Possible values: bool.TryParse, byte.TryParse, decimal.TryParse, double.TryParse, int.TryParse, float.TryParse, long.TryParse, sbyte.TryParse, short.TryParse, uint.TryParse, ulong.TryParse, ushort.TryParse

<FIELD_CSDEFAULT>

Inserts a C# default value based on the fields data type.

Possible values: "", 0, false, new DateTime(), null

<FIELD_CSTYPE>

Inserts a string indicating the C# equivalent data type of the field.

Possible values: bool, byte, double, float, int, long, decimal, DateTime, Nullable<DateTime>, sbyte, short, string, uint, ulong, ushort

<FIELD_CUSTOM_DBL_TYPE>

Inserts a custom DBL data type of a field, if present. Otherwise inserts the same value as <FIELD_SPEC>.

Developers can specify a custom value via a special token in the fields user text or long description, like this:

CUSTOM_DBL_TYPE=d5.2;

The name of the token MUST be specified in upper case and the value MUST be terminated by a semi-colon, as shown above.

<FIELD_CUSTOM_SQL_TYPE>

Inserts a custom SQL data type of a field, if present. Otherwise inserts the same value as <FIELD_SQLTYPE>.

Developers can specify a custom value via a special token in the fields user text or long description, like this:

CUSTOM_SQL_TYPE=DECMIAL(5,2);

The name of the token MUST be specified in upper case and the value MUST be terminated by a semi-colon, as shown above.

<FIELD_CUSTOM_CONVERT_FUNCTION>

Inserts the name of a custom data conversion function associated with a field., if present. Otherwise inserts nothing. The custom convert function should accept a single parameter which is of the actual data type of the real field, and have a return value which is the custom data type as defined by <FIELD_CUSTOM_DBL_TYPE>.

Developers can specify a custom value via a special token in the fields user text or long description, like this:

CUSTOM_CONVERT_FUNCTION=DivideBy100;

The name of the token MUST be specified in upper case and the value MUST be terminated by a semi-colon, as shown above.

You can test if a field has a custom convert function specified with <IF CUSTOM_CONVERT_FUNCTION>.

For example, if a field is a D5 and you wish to process it as a D5.2 then you might set the following values in the long description:

CUSTOM_DBL_TYPE=D5.2;

CUSTOM_SQL_TYPE=DECIMAL(5,2);

CUSTOM_CONVERT_FUNCTION=DivideBy100;

CUSTOM_STRING_FUNCTION=DivideBy100ToString;

And the custom convert function might look like this:

function DivideBy100, d.

required in decimalValue, n

proc

freturn decimalValue / 100.0

endfunction

<FIELD_CUSTOM_STRING_FUNCTION>

Inserts the name of a custom data conversion function associated with a field., if present. Otherwise inserts nothing. The custom convert function should accept a single parameter which is of the actual data type of the real field, and have a return value which is the custom data type as defined by <FIELD_CUSTOM_DBL_TYPE> but formatted appropriately into a string value.

Developers can specify a custom value via a special token in the fields user text or long description, like this:

CUSTOM_STRING_FUNCTION=DivideBy100AsString;

The name of the token MUST be specified in upper case and the value MUST be terminated by a semi-colon, as shown above.

You can test if a field has a custom convert function specified with <IF CUSTOM_STRING_FUNCTION>.

For example, if a field is a D5 and you wish to process it as a D5.2 then you might set the following values in the long description:

CUSTOM_DBL_TYPE=D5.2;

CUSTOM_SQL_TYPE=DECIMAL(5,2);

CUSTOM_CONVERT_FUNCTION=DivideBy100;

CUSTOM_STRING_FUNCTION=DivideBy100ToString;

And the string convert function might look like this:

function DivideBy100ToString, string

required in decimalValue, n

proc

freturn %string(decimalValue/100.0)

endfunction

<FIELD_DBL_NET_CONVERTER>

Inserts the name of a static method in the class DblNetConverter that can be used to convert the fields DBL data type to an appropriate Synergy .NET data type. An example of the DblNetConverter class is provided in "%PUBLIC%\Documents\CodeGenTemplates\DblNetConverter.dbl".

This token is only intended to be used when generating code that will be compiled with .NET, and does not currently support the following field types:

•Binary fields and alpha fields with a binary subclass.

•Decimal fields with a YYYYPP or YYPP subclass.

•Enum fields.

•Struct fields.

•User defined fields with a numeric or date subclass.

If any of the above field types are encountered the value inserted will be DblNetConverter.NotImplemented which will cause a NotImplementedException to be thrown at runtime.

Possible values that can be generated are:

DblNetConverter.AlphaToString
DblNetConverter.BooleanToBoolean
DblNetConverter.DateToNullableDateTime
DblNetConverter.HHMMSSToTimeSpan
DblNetConverter.HHMMToTimeSpan
DblNetConverter.I1ToSByte
DblNetConverter.I2ToShort
DblNetConverter.I4ToInt
DblNetConverter.I8ToLong
DblNetConverter.ImpliedToDecimal
DblNetConverter.LargeDecimalToLong

DblNetConverter.NotImplemented
DblNetConverter.NumberToBoolean
DblNetConverter.NumberToByte
DblNetConverter.NumberToDouble
DblNetConverter.NumberToInt
DblNetConverter.NumberToLong
DblNetConverter.NumberToSByte
DblNetConverter.NumberToShort
DblNetConverter.NumberToSingle
DblNetConverter.NumberToUInt
DblNetConverter.NumberToULong
DblNetConverter.NumberToUShort
DblNetConverter.SmallDecimalToInt
DblNetConverter.YYJJJToDateTime
DblNetConverter.YYMMDDToDateTime
DblNetConverter.YYYYJJJToDateTime
DblNetConverter.YYYYMMDDToDateTime

<FIELD_DEFAULT>

Inserts the fields default value, if present.

<FIELD_DESC>

Inserts the description of the field.

<FIELD_DESC_DOUBLE>

Inserts the description of the field. If any double quote characters are present in the description they are replaced with a single quote.

<FIELD_DESC_SINGLE>

Inserts the description of the field. If any single quote characters are present in the description they are replaced with a double quote.

<FIELD_DIMENSION1_INDEX>

When CodeGen encounters array fields it expands them into multiple fields each of which is of the same type and size. When processing a field which was formally part of an array, this token can be used to insert the original dimension one index of the field. For non-array fields inserts a single zero (0).

<FIELD_DIMENSION2_INDEX>

When CodeGen encounters array fields it expands them into multiple fields each of which is of the same type and size. When processing a field which was formally part of an array with at least two dimensions, this token can be used to insert the original dimension two index of the field. For non-array fields or for array fields with only one dimension inserts a single zero (0).

<FIELD_DIMENSION3_INDEX>

When CodeGen encounters array fields it expands them into multiple fields each of which is of the same type and size. When processing a field which was formally part of an array with at least three dimensions, this token can be used to insert the original dimension three index of the field. For non-array fields or for array fields with less than three dimensions inserts a single zero (0).

<FIELD_DIMENSION4_INDEX>

When CodeGen encounters array fields it expands them into multiple fields each of which is of the same type and size. When processing a field which was formally part of an array with four dimensions, this token can be used to insert the original dimension four index of the field. For non-array fields or for array fields with less than four dimensions inserts a single zero (0).

<FIELD_DISPLAY_LENGTH>

If the current field has a non-zero display length specified then that length is inserted, otherwise nothing is inserted.

<FIELD_DRILLM>

Inserts the name of the fields drill method if present, or by nothing if not.

Alternates: <field_drillm> <Field_Drillm> <Field_drillm> <FieldDrillm> <fieldDrillm>

<FIELD_DRILL_PIXEL_COL>

Inserts the pixel column for placement of a fields drill button on a form.

Example Output: 275

<FIELD_ELEMENT>

For array fields inserts the one-based element number of the field currently being processed by the field loop. For multi-dimension arrays the token inserts a comma-separated list of current index numbers. For non-array fields the token does not cause anything to be written to the output stream.

Example Output:

For a non-array field:                              <no output>
For a single-dimensional array:           1
For a two-dimensional array:                    1,2
For a three-dimensional array:          1,2,3
For a four-dimensional array:           1,2,3,4

<FIELD_ELEMENT0>

For array fields inserts the one-based element number of the field currently being processed by the field loop. For multi-dimension arrays the token inserts a comma-separated list of current index numbers. For non-array fields the token inserts 0.

Example Output

For a non-array field:                              0
For a single-dimensional array:           1
For a two-dimensional array:                    1,2
For a three-dimensional array:          1,2,3
For a four-dimensional array:           1,2,3,4

<FIELD_ENUMBASEVAL>

For enumerated fields, inserts the enumerated fields base value. The base value is the value assigned to the first member of the enumeration. For non-enumerated fields nothing is inserted.

Note: This token refers to UI Toolkit enumerated fields, which are numeric fields with an enumeration specified via the "Enumerated?" field on the fields Validation tab. This token does NOT refer to fields whose Type is set to Enum on the Field Definition page.

Example Output: 1

<FIELD_ENUMLENGTH>

For enumerated fields, inserts the maximum length of the fields’ enumerated values. For non-enumerated fields nothing is inserted.

Example Output: 12

<FIELD_ENUMSTEPVAL>

For enumerated fields, inserts an enumerated fields step value. The step value is the number that is added to or subtracted from the base value for each of the second and subsequent enumeration members. For non-enumerated fields nothing is inserted.

Note: This token refers to UI Toolkit enumerated fields, which are numeric fields with an enumeration specified via the "Enumerated?" field on the fields Validation tab. This token does NOT refer to fields whose Type is set to Enum on the Field Definition page.

Example Output: 1

<FIELD_ENUMWIDTH>

Inserts the pixel width for the maximum length of the fields’ enumerated values.

Calculated as the maximum length of the fields enumerated values multiplied by 12 pixels per character. This default character width can be overridden using the -cw command line option.

Example Output: 144

<FIELD_FORMATNAME>

Inserts the name of the fields Repository format, or nothing if no format is specified.

Integer Fields

The regular expression for integer fields will constrain the number of characters entered, and restrict those characters to being numeric characters, but it will NOT restrict the user to only entering valid numeric values. For example, an i1 field can store up to 127, the regular expression will constrain the entry to 3 numeric characters but it will still be possible to enter an out of range value (e.g. 256).

Required Fields

Currently CodeGen only takes a fields "required" status into account for alpha fields. If an alpha field is required then the regular expression produced will require at least one character be present.

<FIELD_REPORT_JUSTIFICATION>

Inserts the report justification of the current field.

Possible Values: Left, Right, Center

SQL Data Type Mappings

Synergy Data Type	SQL Server Type	MySQL Type	PostgreSQL Type
Alpha	VARCHAR(n)	VARCHAR(n)	VARCHAR(n)
Alpha (Binary)	CHAR(n)	VARBINARY(n)	CHAR(n)
Auto sequence	BIGINT	BIGINT	BIGINT
Auto time	BIGINT	BIGINT	BIGINT
Binary	CHAR(n)	VARBINARY(n)	CHAR(n)
Boolean	BIT	BOOLEAN	BOOLEAN
Date (YYYYMMDD)	DATE	DATE	DATE
Date (YYMMDD)	DATE	DATE	DATE
Date (YYYYJJJ)	DECIMAL(7)	DECIMAL(7)	NUMERIC(7)
Date (YYJJJ)	DECIMAL(5)	DECIMAL(5)	NUMERIC(5)
Date (YYYYPP)	DECIMAL(6)	DECIMAL(6)	NUMERIC(6)
Date (YYPP)	DECIMAL(4)	DECIMAL(4)	NUMERIC(4)
Decimal	DECIMAL(n)	DECIMAL(n)	NUMERIC(n)
Enum	INT	INT	INT
Implied Decimal	DECIMAL(n,p)	DECIMAL(n,p)	NUMERIC(n,p)
Integer (i1)	SMALLINT	TINYINT	SMALLINT
Integer (i2)	SMALLINT	SMALLINT	SMALLINT
Integer (i4)	INT	INT	INT
Integer (i8)	BIGINT	BIGINT	BIGINT
Structure field	VARCHAR(n)	VARCHAR(n)	VARCHAR(n)
Time (HHMMSS)	TIME(0)	TIME(0)	TIME(0)
Time (HHMM)	TIME(0)	TIME(0)	TIME(0)
User Defined Alpha	CHAR(n)	CHAR(n)	CHAR(n)
User Defined Numeric	CHAR(n)	CHAR(n)	CHAR(n)
User Defined Time-stamp (see below)	DATETIME2	TIMESTAMP	TIMESTAMP
User Defined Date (all others)	CHAR(n)	CHAR(n)	CHAR(n)

User-Defined Time-stamp Fields

User-defined time-stamp fields can be implemented in the same way as supported by xfODBC:

•Define the field as a user-defined date type, length 20

•Set the fields "user string" to ^CLASS^=YYYYMMDDHHMISSUUUUUU

•Use the <IF USERTIMESTAMP> and <IF NOTUSERTIMESTAMP> expressions to detect the fields in field loops.

•Use the SQL CONVERT function to convert a YYYYMMDDHHMISSUUUUUU string into a DATETIME2 value as required by SQL Server. Note that DATETIME2 fields are only supported from SQL Server 2008. An example of using CONVERT is shown below:

a20field = %datetime

a26field = %string(^d(a20field),"XXXX-XX-XX XX:XX:XX.XXXXXX")

Then when building your SQL statement you would do something like this

sql = sql + "CONVERT(DATETIME2," + a26field + ",21)"

<FIELD_TEMPLATE>

Inserts the name of the Repository template from which the field inherited its attributes or by a null string if no template is referenced.

<FIELD_TKSCRIPT>

Inserts a UI Toolkit .field script file command for the field.

<FIELD_TSDEFAULT>

Inserts a TypeScript default value based on the fields data type.

Possible Values: "", 0, 0.0, new Date(), false, null

<FIELD_TSTYPE>

Inserts a string indicating the VB.NET data type of the field.

Possible Values: string, number, Date, boolean

<FIELD_TYPE>

Inserts a character indicating the synergy data type of field.

Possible Values: A, D, I

Alternates: <field_type> <Field_Type> <Field_type> <FieldType> <fieldType>

<FIELD_TYPE_NAME>

Inserts a string indicating the Synergy data type of field.

Possible Values: ALPHA, AUTO SEQUENCE, AUTO TIME, BINARY, DATE, DECIMAL, IMPLIED, INTEGER, JULIAN, TIME, USER ALPHA, USER DATE, USER NUMERIC

<FIELD_USER_TYPE>

For user-defined fields, inserts the fields user defined field type string, if present, otherwise inserts nothing.

<FIELD_UTEXT>

Inserts the fields’ user-defined text string.

<FIELD_VBDEFAULT>

Inserts a VB.NET default value based on the fields data type.

Possible Values: "", 0, False, New DateTime(), Nothing

<FIELD_VBTYPE>

Inserts a string indicating the VB.NET data type of the field.

Possible Values: Boolean, Byte, DateTime, Decimal, Integer, Long, Nullable(Of DateTime), Short, String, System.Double, System.SByte, System.Single, System.UInt16, System.UInt32, System.UInt64

<FIELD_VIEW_LENGTH>

If the current field has a non-zero view length specified then that length is inserted, otherwise nothing is inserted.

<MAPPED_FIELD>

Inserts the name of the mapped field in the mapped structure. To use this token you must use @MAP=structure; in the structures user text field or long description and @MAP=field; in each fields user text field or long description.

Alternates: <mapped_field> <Mapped_Field> <Mapped_field> <MappedField> <mappedField>

<MAPPED_PATH>

Inserts the name of the mapped path in the mapped structure. To use this token you must use @MAP=structure; in the structures user text field or long description and @MAP=field; in each fields user text field or long description.

Alternates: <mapped_path>

<MAPPED_PATH_CONV>

Inserts the name of the mapped path in the mapped structure . To use this token you must use @MAP=structure; in the structures user text field or long description and @MAP=field; in each fields user text field. If there is also an @MAPF=function; in the user text or long description then that conversion function will also be applied.

Alternates: <mapped_path_conv>

<MAPPING_FUNCTION>

Inserts the name of the fields mapping function, if defined.