Structure Expansion Tokens

 

Structure expansion tokens are expansion tokens that are used to insert information about the current Repository structure into the output stream. They can be used anywhere in a template file.

Structure Token

Description

<DATA_FIELDS_LIST>

Inserts a comma-separated list of a structures data fields (i.e. non primary key) fields.

<DISPLAY_FIELD>

Inserts the name of the structures display field, if defined.

<FILE_ADDRESSING>

Inserts the addressing size of the structures first assigned data file.

<FILE_COMPRESSION>

Inserts a string indicating whether the structures first assigned file has data compression enabled.

<FILE_DENSITY>

Inserts the default key density of the structures first assigned file.

<FILE_DESC>

Inserts the description of the first data file assigned to the structure.

<FILE_ISAMC_SPEC>

 

Inserts an ISAMC file specification string based on the file attributes defined in the first file assigned to the structure.

<FILE_NAME>

Inserts the name of the first data file assigned to the structure.

<FILE_NAME_NOEXT>

Inserts the name of the first data file assigned to the structure, with the file extension removed.

<FILE_PAGESIZE>

Inserts the page size of the structures first assigned file.

<FILE_PORTABLE_INT_SPECS>

 

Inserts the portable integer positions string of the first data file assigned to the current structure.

<FILE_RECTYPE>

Inserts a string indicating the record type of the first data file assigned to the structure.

<FILE_RPS_NAME>

 

Inserts the repository name of the first file definition that is assigned to the structure being processed.

<FILE_STATIC_RFA>

Inserts a string indicating whether the structures first assigned file has static RFA’s enabled.

<FILE_TYPE>

Inserts a string indicating the type of the first data file assigned to the structure.

<FILE_UTEXT>

Inserts the user text string of the first data file assigned to the structure.

<MAPPED_FILE>

Inserts the file specification of the first file assigned to the mapped structure.

<MAPPED_STRUCTURE>

Inserts the name of the mapped structure.

<PRIMARY_KEY_FIELD>

Inserts the name of the first segment of the structures primary key. This token only works with structures with single segment primary keys.

<STRUCTURE_#n>

Switches context to a different structure. Only valid when processing multiple structures with the -ms option.

<STRUCTURE_CHILDREN>

Inserts the number of the structures first level child members (fields and groups).

<STRUCTURE_DESC>

Inserts the structure description.

<STRUCTURE_FIELDS>

Inserts the total number of fields in the structure. If the structure includes any array fields then the individual array field elements are counted towards the number of fields in the structure.

<STRUCTURE_KEYS>

Inserts the total number of keys defined in the structure.

<STRUCTURE_LDESC>

Inserts the structures long description.

<STRUCTURE_NAME>

Inserts the name of the Repository structure that is currently being processed, or the structures alias name if specified.

<STRUCTURE_NOALIAS>

Inserts the name of the Repository structure that is currently being processed. This token is always replaced by the actual name of the repository structure, even if an alias name has been specified.

<STRUCTURE_NOPLURAL>

 

Inserts the name of the structure that is currently being processed. If the name ends with an "S" character then it will be removed.

<STRUCTURE_PLURAL>

 

Inserts the name of the structure that is currently being processed. If the name does not end with an "S" character then one will be added.

<STRUCTURE_SIZE>

Inserts the structure size in bytes.

<STRUCTURE_UTEXT>

Inserts the structure user text string.

 

 


Copyright © 2018  Synergex International, Inc.