Versions Compared

Version Old Version 29 New Version 30
Changes made by

Alex Roytman

Alex Roytman

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The pjs.define() API is used within Profound.js modules to declare fields, arrays, and data structures with a strong data type. All IBM i data types are available.

...

Property nameProperty typeDescription
typeString

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"

Some config properties only apply to certain types.

lengthNumber

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

  • date
  • time
  • timestamp
  • pointer
  • data structure
decimalsNumber

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

varyingBooleanSpecifies that a character field is of varying length; otherwise, the field will be a fixed length field padded with spaces.
initValueString/Number/Boolean/ArraySpecified the field's initial value.
dimNumberThis property turns the definition into an array. When declared this way, arrays start with an index of 1, similar to RPG.
orderByString

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"
elementsObjectSpecifies an object of subfields for a data structure. Each property within the object is the subfield name, while the property value is another config object.
qualifiedBoolean

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 qualifies qualified is not specified, the subfields can be referenced directly; for example: mysubfield = "myvalue".

specialString

Available to data-structure subfields. Acceptable Identifies a special subfield and can only be specified on a data structure subfield configuration with the elements property.

Possible values are:PSDS

For a Status Data Structure (statusDS):

  • "*status" - Status Code (commonly used to identify errors)
  • "*proc" - Module Name
  • "*parmparms" - Number of parameters passed
  • "*routine"
INFDS
  • - 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
nullableBoolean / String

Use this property to create null-capable fields.

  • Pass in Use true to just make the field null-capable. This option also allows you to assign a null value to the field.
  • Pass in Use a string , which references to specify a reference a Boolean field to use as the null-indicator and makes to make the field null-capable.
likeRecObject

Specified on a data structure Available when using a data structure type. This object requires two elements.

  • intrecname - String, name of record format from previously defined table.
  • 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.

likeDSStringUsed on a data structure to specify the name of another data structure from which the configuration is derived.
dataAreaString

Available to all data types, except from the pointer type. String pointing to data-area object. Example values:

  • MYDTAARA
    • PRODLIB/DTAATA

    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)
    statusDSBooleanIdentifies a Status Data Structure. A Status Data Structure is automatically populated with information about the current Profound.js module and job. It is an easy way to retrieve information, such as the current IBM i job name, the current user id, and more.

    ...

    Code Block
    languagejavascript
    pjs.define("arr", { type: 'char', length: 10, dim: 3, initValue: '0123456789' });

     

    Data structures

    When you declare a field of data-structure type,  this means you need to provide an 'elements' object. Each key in this object will be the name of the subfield and the value of this key will be another config element. If a data-structure is qualified, the data-structure will act similar to a JavaScript object.

    Example 5: Data structure with two subfields (non-qualified)

    ...