Actions - Substitution

Genereration occurs through the setup and iterations of environements, while substituting Template-pieces.

Actions	Description
PROC_SKEL {PAR1} {PAR2} {PAR3}	This is the core action, that executes the actual production. The action substitues a Template-Piece. , and are sub-strings, that are concatenated. In this way the name of the Template-Piece can be varied.

The substitution of a Template-Piece is done in the following way:

The Template_Piece, that is names in the PROC_SKEL statement is searched in the Template-file.
Subsequently all lines in the Template-Piece are scanned for substitition-variables.
For all substitution-variables the current value is substituted.
If alle substitition-variables have been processed, the line is written to the OUT-file, that is assumed to be open at htat moment.
When all the lines of a Template-Piece have been processed, the Template-Piece is considered to be processed.

There can be several groups of Substitution variables, that can be used in Action Scripts as well as in Template-files.

Actions	Description
&system& variables	Variables, that are used in Action Scripts as well as in Template files. They are given their default value at the start of hte Action-script.
&Template& variables	Variables, that are mainly used in Template-files although they can be used in Action Scripts, for instance for the control of condition-dependent PROC_SKEL actions. Most of these variables get their value by reading in the datadictionary. SeeAction Scripts – Datadictionary actions.
&paramete&r variables	Variables, that are used in Action Scripts as well as in Temaplte files. They are defined by the contents of parameter-files. They are used in a set global and local variables.
&context& variables	Variables, that are used in Action Scripts as well as in Temaplte files. They are defined in the contexts as defined in the setup and iteration using FOR … NEXT iterations.

System variables.

System variables are variables, that recieve a waarde at the start of an Action Script.

With system variables general parameter actions are applicable. See Action Scripts - Parameter Actions.

Actions	Default Value	Description
SYSTEM1	1	Often used as counting or flag variable
SYSTEM2	1	Often used as counting or flag variable
SYSTEM3	1	Often used as counting or flag variable
SYSTEM4	1	Often used as counting or flag variable
SYSTEM5	1	Often used as counting or flag variable
INDENT	INDENT	Used in INDENT / UNINDENT actions. See Action Scripts Format Actions
UN_INDENT	UN_INDENT	Used in INDENT / UNINDENT actions. See Action Scripts Format Actions
MESS	MESS	To be used as a Mnemonic String or Constant in Action Scripts
BEFORE	BEFORE	To be used as a Mnemonic String or Constant in Action Scripts
AFTER	AFTER	To be used as a Mnemonic String or Constant in Action Scripts
KOMMA	,	To be used as a Mnemonic String or Constant in Action Scripts
HAAKJE_OPENEN	(	To be used as a Mnemonic String or Constant in Action Scripts
HAAKJE_SLUITEN	)	To be used as a Mnemonic String or Constant in Action Scripts
TYPE_C	C	To be used as a Mnemonic String or Constant in Action Scripts
TYPE_D	D	To be used as a Mnemonic String or Constant in Action Scripts
TYPE_N	N	To be used as a Mnemonic String or Constant in Action Scripts
TYPE_F	F	To be used as a Mnemonic String or Constant in Action Scripts
GWORD	0	Used in text processing Action Scripts. Contains the last word fetched after a WORD_GET action, if BWORD equals TRUE.
GCHAR	0	Used in text processing Action Scripts. Contains the last character fetched after a CHAR_GET action, if BCHAR equals TRUE.
BLINE	0	Used in text processing Action Scripts. Is TRUE as a result of a LINE_GET actie, when a line was actually fetched.
BWORD	0	Used in text processing Action Scripts. Is TRUE as a result of a WORD_GET actie, when a line was actually fetched
BCHAR	0	Used in text processing Action Scripts. Is TRUE as a result of a CHAR_GET actie, when a line was actually fetched
TRUE	TRUE	To be used as a Mnemonic String or Constant in Action Scripts
FALSE	FALSE	To be used as a Mnemonic String or Constant in Action Scripts
SEARCH	&*	Used in text processing Action Scripts as default search string in a LINE_SRCH action. The default value can be changed, before a LINE_SRCH is executed.
LOCATION	0	Used in text processing Action Scripts as the result of a LINE_SRCH action. Contains the column, where the search string was found.
BTREE	FALSE	NA (deprecated)
TSTACK	0	NA (deprecated)
OSTACK	0	NA (deprecated)
SUBR	MAIN	NA (deprecated)
SUBR_SKL_PART	0	NA (deprecated)

Template variables.

Template variables are mostly variables, getting a value when iterations of the following form in an Action Script are executed: BEGIN_RELATIONS … END_RELATIONS. and ATR_BEGIN … ATR_END. For owner and member variables other iterations are used (See Action scripts – Datadictionary actions).

Template-variables starting with an E_prefix refer to Entities in the datadictionary.
Template-variables starting with an A_prefix refer to Attributes in the datadictionary.

Actions	Description
E_name	The active table_name is substituted. It is assumed, that the substitution (via a PROC_SKEL statement) is executed in an iteration of a BEGIN_RELATIONS … END_RELATIONS loop. See Action Scripts – Datadictionary actions.
E_number	The rank number og the active table is substituted. It is assumed, that the substitution (via a PROC_SKEL statement) is executed in an iteration of a BEGIN_RELATIONS … END_RELATIONS loop. See Action Scripts – Datadictionary actions.
E_descr	The description of the active table is substituted. It is assumed, that the substitution (via a PROC_SKEL statement) is executed in an iteration of a BEGIN_RELATIONS … END_RELATIONS loop. See Action Scripts – Datadictionary actions.
E_short	The shortname of the active table is substituted. It is assumed, that the substitution (via a PROC_SKEL statement) is executed in an iteration of a BEGIN_RELATIONS … END_RELATIONS loop. See Action Scripts – Datadictionary actions.
E_own	The active owner table-name of a nested owner loop is substituted. It is assumed, that the substitution (via a PROC_SKEL statement) is executed in an iteration of a OWN_BEGIN … OWN_END loop. See Action Scripts – Datadictionary actions.
E_mem	The active member table-name of a nested member loop is substituted. It is assumed, that the substitution (via a PROC_SKEL statement) is executed in an iteration of a MEM_BEGIN … MEM-END loop. See Action Scripts – Datadictionary actions.
A_name	The name of the active attribute of the active table is substituted. It is assumed, that the substitution (via a PROC_SKEL statement) is executed in an iteration of a ATR_BEGIN …ATR_END loop, nested within a BEGIN_RELATIONS … END_RELATIONS loop. See Action Scripts – Datadictionary actions.
A_number	The rank number of the active attribute of the active table is substituted. It is assumed, that the substitution (via a PROC_SKEL statement) is executed in an iteration of a ATR_BEGIN …ATR_END loop, nested within a BEGIN_RELATIONS … END_RELATIONS loop. See Action Scripts – Datadictionary actions.
A_typ	The type of the active attribute of the active table is substituted. It is assumed, that the substitution (via a PROC_SKEL statement) is executed in an iteration of a ATR_BEGIN …ATR_END loop, nested within a BEGIN_RELATIONS … END_RELATIONS loop. See Action Scripts – Datadictionary actions..
A_len	The length of the active attribute of the active table is substituted. It is assumed, that the substitution (via a PROC_SKEL statement) is executed in an iteration of a ATR_BEGIN …ATR_END loop, nested within a BEGIN_RELATIONS … END_RELATIONS loop. See Action Scripts – Datadictionary actions..
A_un	The unicity-indication (‘U’=unique, i.e., key-attribute, ‘-‘=not unique i.e., normal attribute) of the active attribute of the active table is substituted. It is assumed, that the substitution (via a PROC_SKEL statement) is executed in an iteration of a ATR_BEGIN …ATR_END loop, nested within a BEGIN_RELATIONS … END_RELATIONS loop. See Action Scripts – Datadictionary actions.
A_own	The attribut-name of the active owner table-name of the owner loop is substituted. It is assumed, that the substitution (via a PROC_SKEL statement) is executed in an iteration of a ATR_OWN_BEGIN …ATR_OWN_END loop, nested within a OWN_BEGIN … OWN_END loop. See Action Scripts – Datadictionary actions.
Sys_date	System date, to be used as a documentation-field in a header to be generated to denote when the generation has been executed.
Sys_time	System time, , to be used as a documentation-field in a header to be generated to denote when the generation has been executed.
Skl_name	Name of the active Template-file, tio be as a documentation-field in a header to denote which template-file has been used for the generation.
Db_name	Database name. Is filled via a FILNAM_DBN action in preparation of a GET_DATADIC action. See Action Scripts – Datadictionary actions.
Db_version	Database version. Is filled via a FILNAM_DBN action in preparation of a GET_DATADIC action. See Action Scripts – Datadictionary actions.
Rdb_root	Database root. Is filled via a FILNAM_DBN action in preparation of a GET_DATADIC action. See Action Scripts – Datadictionary actions.

In general the database_name and the database_version can be used as documentation-fields in a header to be generated to denote, which version of the datamodel has been used for generation.

Parameter variables.

Parameter variables are defined through parameter files. See Parameters – Composition and Parameters – Actions. They can be used in substitution actions like other variables. See Action Scripts – Parameter actions.

Context variables.

Context variables are defined through context files. See Contexts – Composition and Contexts – Actions. They can be used in substitution actions like other variables. See Action – Context actions.

Picture fetch

If you like the header, it can be found here.

Images

If you are using firefox, put your cursor over the logo. But for some reason IE does not like image rollover effects. Its not that big of a deal.

Modgen : Actions - Substitution

Info

Custom designs

About the initiator

User Guide Modgen