Relation Loop Expansion Tokens

 

Relation loop expansion tokens are used to insert information about the current relation being processed within the context of a relation loop into the output stream. Relation loop tokens can only be used inside a relation loop.

 

Key Loop Token

Description

<RELATION_NUMBER>

 

Inserts the one-based index of the current relation.

<RELATION_NAME>

 

Inserts the name of the current relation.

<RELATION_FROMKEY>

 

Inserts the name of the key in the current structure from which the relation originates.

 

Alternates:

 

<relation_fromkey> <Relation_Fromkey> <Relation_fromkey> <RelationFromkey> <relationFromkey>

 

<RELATION_TOSTRUCTURE>

 

Inserts the name of the structure targeted by this relation.

 

Alternates:

<relation_tostructure> <Relation_Tostructure> <Relation_tostructure> <RelationTostructure> <relationTostructure>

<RELATION_TOSTRUCTURE_DISPLAY_FIELD>

Inserts the name of the display field within the relations TO structure, if a display field is specified. If not specified nothing is inserted.

 

You can test whether the TO structure has a display field using <IF TO_DISPLAY_FIELD>.

 

Alternates:

<relation_tostructure_display_field> <Relation_Tostructure_Display_Field> <Relation_tostructure_display_field> <RelationTostructureDisplayField> <relationTostructureDisplayField>

 

<RELATION_TOSTRUCTURE_NOPLURAL>

 

Inserts the name of the structure targeted by this relation. If the name of the structure ends with an "S" character it will be removed.
 

Alternates:

<relation_tostructure_noplural> <Relation_Tostructure_Noplural> <Relation_tostructure_noplural> <RelationTostructureNoplural> <relationTostructureNoplural>

<RELATION_TOSTRUCTURE_PLURAL>

 

Inserts the name of the structure targeted by this relation. If the name of the structure does not end with an "S" character one will be added.
 

Alternates:

<relation_tostructure_plural> <Relation_Tostructure_Plural> <Relation_tostructure_plural> <RelationTostructurePlural> <relationTostructurePlural>

<RELATION_TOKEY>

 

Inserts the name of the key in the structure targeted by this relation.

 

Alternates:  <relation_tokey> <Relation_Tokey> <Relation_tokey> <RelationTokey> <relationTokey>

<FROM_KEY_CHANGES>

 

Inserts text indicating whether the FROM key allows changes to existing key entries.

 

Possible values:  CHANGES, NOCHANGES

<FROM_KEY_DENSITY>

 

Inserts the key packing density for the FROM key.

 

Possible values:  50 to 100

<FROM_KEY_DESCRIPTION>

 

Inserts the description of the FROM key. Be aware that key descriptions are optional in Repository, so this token may expand to nothing.

 

<FROM_KEY_DUPLICATES>

 

Inserts text indicating whether the FROM key allows duplicate values.

 

Possible values:  DUPLICATES, UNIQUE                    

<FROM_KEY_DUPLICATES_AT>

 

Inserts text indicating where duplicate values are inserted for the FROM key.

 

Possible values:  FRONT, END

<FROM_KEY_LENGTH>

 

Inserts the length of the from key. The length of the key is the sum of the length of all key segments.

<FROM_KEY_NULLTYPE>

 

Inserts the FROM keys null key type.  The token should only be used within a <IF NULLKEY> expression.

 

Possible values:  NONE, REPLICATE, NOREPLICATE, SHORT

Alternates:  <key_nulltype>

<FROM_KEY_NULLVALUE>

 

Inserts the from keys null key value.  The token should only be used within an <IF NULLKEY> expression.

<FROM_KEY_NUMBER>

 

Inserts the number of the FROM key, primary key is key 0, first alternate key is key 1, and so on.

 

Possible values:  0 to 1023

 

<FROM_KEY_ORDER>

 

Inserts the ordering sequence of the FROM key, ascending or descending.

 

Possible values:  ASC, DESC

<FROM_KEY_SEGMENTS>

 

Inserts the number of FROM key segments defined.

 

Possible values:  1 to 8

<FROM_KEY_UNIQUE>

 

If the from key does not allow duplicates then inserts the text UNIQUE, otherwise nothing is inserted.

<TO_KEY_CHANGES>

 

Inserts text indicating whether the TO key allows changes to existing key entries.

 

Possible values:  CHANGES, NOCHANGES

<TO_KEY_DENSITY>

 

Inserts the key packing density for the TO key.

 

Possible values:  50 to 100

<TO_KEY_DESCRIPTION>

 

Inserts the description of the to key. Be aware that key descriptions are optional in Repository, so this token may expand to nothing!

<TO_KEY_DUPLICATES>

 

Inserts text indicating whether the TO key allows duplicate values.

 

Possible values:  DUPLICATES, UNIQUE

<TO_KEY_DUPLICATES_AT>

 

Inserts text indicating where duplicate values are inserted for the TO key.

 

Possible values:  FRONT, END

<TO_KEY_LENGTH>

 

Inserts the length of the to key. The length of the key is the sum of the length of all key segments.

<TO_KEY_NULLTYPE>

 

Inserts the TO keys null key type.  The token should only be used within a <IF NULLKEY> expression.

 

Possible values:  NONE, REPLICATE, NOREPLICATE, SHORT

Alternates:  <key_nulltype>

<TO_KEY_NULLVALUE>

 

Inserts the to keys null key value.  The token should only be used within an <IF NULLKEY> expression.

<TO_KEY_NUMBER>

 

Inserts the number of the TO key, primary key is key 0, first alternate key is key 1, and so on.

 

Possible values:  0 to 1023

<TO_KEY_ORDER>

 

Inserts the ordering sequence of the TO key, ascending or descending.

 

Possible values:  ASC, DESC

<TO_KEY_SEGMENTS>

 

Inserts the number of TO key segments defined.

 

Possible values:  1 to 8

<TO_KEY_UNIQUE>

 

If the to key does not allow duplicates then inserts the text UNIQUE, otherwise nothing is inserted.

 

 

Copyright © 2021  Synergex International, Inc.