Page Comparison

The following data types can be specified:

• "packed decimal" or "packed" (both variations have the same meaning)
• "decimal" or "zoned" or "zoned decimal" or "numeric" (all variations have the same meaning)
• "integer"
• "unsigned integer"
• "char"
• "boolean"
• "date"
• "time"
• "timestamp"
• "pointer"
• "data structure" or "ds" (both variations have the same meaning)

Some config properties only apply to certain types.

Specifies the field length. It is required for most data types; exceptions are:

• date
• time
• timestamp
• pointer
• data structure

Specifies the number of decimal positions. It required for packed and zoned fields.

Specifies the default sort order for arrays declared with the dim property. The orderBy property is used by array-related API, such as pjs.lookup().

Possible values are:

• "ASCEND"
• "DESCEND"

Identifies a data structure as qualified, meaning that all references to its subfields must be qualified with the data structure name first; for example: MyDS.mysubfield = "myvalue". This makes the data structure similar to a JavaScript object.

If qualified is not specified, the subfields can be referenced directly; for example: mysubfield = "myvalue".

Identifies a special subfield and can only be specified on a data structure subfield configuration with the elements property.

Possible values are:

For a Status Data Structure (statusDS):

• "*status" - Status Code (commonly used to identify errors)
• "*proc" - Module Name
• "*parms" - Number of parameters passed
• "*routine" - Name of the routine in which an exception or an error occurred

For an Information Data Structure (infDS):

• "*file" - The first 8 characters of a file name
• "*record" - The first 8 characters of a record format name being processed
• "*opcode" - Operation
• "*status" - Status Code
•  "*routine" - The first 8 characters of the name of a routine in which a file operation was done

Use this property to create null-capable fields.

• Use true to just make the field null-capable. This option allows you to assign a null value to the field.
• Use a string to specify a reference a Boolean field to use as the null-indicator and to make the field null-capable.

Specifies the name of a file that contains the fields used as the subfield description for the data structure being defined. The property can specified as a String that contains the file name or as an object with the following properties:

• file - name of the file
• format - name of the format within the file

The file name can be qualified with a library; for example: "PRODLIB/MYFILE".

Specified on a data structure to make its definition like a previously defined database table. The property can be specified as a String, which names the previously defined record format, or as an object with the following properties:

• record - internal record format name from a previously defined table, specified as a String.
• fields - optional String value of "*key". If "*key" is specified, only key fields will be defined.

When likeRec is specified, the data structure becomes qualified automatically.

Specifies a data area object to be associated with the declared field. The name of the data area may include a library. For example:

• "MYDTAARA" (data area will be searched for using the pathlist / IBM i library list because the library name was not specified)
• "PRODLIB/MYDTAATA" (the library name is explicitly specified here)

The format for a date type field. The available date formats are:

• "*job"
• "*mdy"
• "*dmy"
• "*ymd"
• "*jul"
• "*iso"
• "*usa"
• "*eur"
• "*jis"

This property is ignored if the field is not a date field.

The separator for a date type field. The available separators are:

• '-' (hyphen)
• '.' (dot)
• ',' (comma)
• '&' (ampersand)
• ' ' (space)
• '/' (forward slash)

This property is ignored if the field is not a date field, and also ignored for date fields with format "*iso", "*usa", "*eur", and "*jis".

The format for a time type field. The available time formats are:

• "*hms"
• "*iso"
• "*usa"
• "*eur"
• "*jis"

This property is ignored if the field is not a time field.

The separator for a time type field. The available time separators are:

• ':' (colon)
• '.' (dot)
• ',' (comma)
• '&' (ampersand)
• ' ' (space)

This property is ignored if the field is not a time field and also ignored for time fields with format other than "*hms".