Relation Loop Expansion Tokens

unlisted

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.

<RELATION_TOSTRUCTURE>

 

Inserts the name of the structure targeted by this relation.

<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.

<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.

<RELATION_TOKEY>

 

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

<FROM_KEY_CHANGES>

 

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

<FROM_KEY_DENSITY>

 

Inserts the key packing density for the from key.

<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.

<FROM_KEY_DUPLICATES_AT>

 

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

<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.

<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.

<FROM_KEY_ORDER>

 

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

<FROM_KEY_SEGMENTS>

 

Inserts the number of from key segments defined.

<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.

<TO_KEY_DENSITY>

 

Inserts the key packing density for the to key.

<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.

<TO_KEY_DUPLICATES_AT>

 

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

<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.

<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.

<TO_KEY_ORDER>

 

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

<TO_KEY_SEGMENTS>

 

Inserts the number of to key segments defined.

<TO_KEY_UNIQUE>

 

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

 

 


Copyright © 2018  Synergex International, Inc.