File Header Tokens

 

File header tokens are a special class of token that provides high level processing information to the code generator. None of the file header tokens cause any output to be written directly to the output stream of the current template. All file header tokens consist of a pair of matching opening and closing tags that surround some significant value. Any file header tokens that you use in a template file must appear together at the very top of the template file.

The file header tokens are:

File Header Token

Description

<CODEGEN_FILENAME>

Allows you to define the name of the output file within a template file.

<CODEGEN_FOLDER>

 

Allows you to specify a sub-folder (below the main output folder) in which the output file should be created.

<OPTIONAL_USERTOKEN>

Allows you to specify that a template requires a specific user defined token, but allows you to provides a default value for that user token if a value has not been provided by any other mechanism.

<PROCESS_TEMPLATE>

Allows you to specify that an additional template is to be processed immediately after the current template.

<PROVIDE_FILE>

Allows you to specify that an additional file is also provided to the output directory as part of the processing of the current template.

<REQUIRES_CODEGEN_VERSION>

 

Allows you to specify that a minimum version of CodeGen is required in order to successfully process the template.

<REQUIRES_CUSTOM_BUTTON_EXPRESSION>

Allows you to specify that a particular custom button loop expression is required in order to be able to successfully generate code from the template.

<REQUIRES_CUSTOM_BUTTON_TOKEN>

Allows you to specify that a particular custom button loop token is required in order to be able to successfully generate code from the template.

<REQUIRES_CUSTOM_ENUM_EXPRESSION>

Allows you to specify that a particular custom enumeration expression is required in order to be able to successfully generate code from the template.

<REQUIRES_CUSTOM_ENUM_TOKEN>

Allows you to specify that a particular custom enumeration loop token is required in order to be able to successfully generate code from the template.

<REQUIRES_CUSTOM_ENUM_MEMBER_EXPRESSION>

Allows you to specify that a particular custom enumeration member loop expression is required in order to be able to successfully generate code from the template.

<REQUIRES_CUSTOM_ENUM_MEMBER_TOKEN>

Allows you to specify that a particular custom enumeration member loop token is required in order to be able to successfully generate code from the template.

<REQUIRES_CUSTOM_FIELD_EXPRESSION>

Allows you to specify that a particular custom field loop expression is required in order to be able to successfully generate code from the template.

<REQUIRES_CUSTOM_FIELD_TOKEN>

Allows you to specify that a particular custom field loop token is required in order to be able to successfully generate code from the template.

<REQUIRES_CUSTOM_FILE_EXPRESSION>

Allows you to specify that a particular custom file loop expression is required in order to be able to successfully generate code from the template.

<REQUIRES_CUSTOM_FILE_TOKEN>

Allows you to specify that a particular custom file loop token is required in order to be able to successfully generate code from the template.

<REQUIRES_CUSTOM_KEY_EXPRESSION>

Allows you to specify that a particular custom key loop expression is required in order to be able to successfully generate code from the template.

<REQUIRES_CUSTOM_KEY_TOKEN>

Allows you to specify that a particular custom key loop token is required in order to be able to successfully generate code from the template.

<REQUIRES_CUSTOM_LOOPUTIL_EXPRESSION>

Allows you to specify that a particular custom loop utility expression is required in order to be able to successfully generate code from the template.

<REQUIRES_CUSTOM_LOOPUTIL_TOKEN>

Allows you to specify that a particular custom loop utility token is required in order to be able to successfully generate code from the template.

<REQUIRES_CUSTOM_NOTINLOOP_EXPRESSION>

Allows you to specify that a particular custom "not in loop" expression is required in order to be able to successfully generate code from the template.

<REQUIRES_CUSTOM_NOTINLOOP_TOKEN>

Allows you to specify that a particular custom "not in loop" token is required in order to be able to successfully generate code from the template.

<REQUIRES_CUSTOM_RELATION_EXPRESSION>

Allows you to specify that a particular custom relation loop expression is required in order to be able to successfully generate code from the template.

<REQUIRES_CUSTOM_RELATION_TOKEN>

Allows you to specify that a particular custom relation loop token is required in order to be able to successfully generate code from the template.

<REQUIRES_CUSTOM_SEGMENT_EXPRESSION>

Allows you to specify that a particular custom key segment loop expression is required in order to be able to successfully generate code from the template.

<REQUIRES_CUSTOM_SEGMENT_TOKEN>

Allows you to specify that a particular custom key segment loop token is required in order to be able to successfully generate code from the template.

<REQUIRES_CUSTOM_SELECTION_EXPRESSION>

Allows you to specify that a particular custom field selection loop expression is required in order to be able to successfully generate code from the template.

<REQUIRES_CUSTOM_SELECTION_TOKEN>

Allows you to specify that a particular custom field selection loop token is required in order to be able to successfully generate code from the template.

<REQUIRES_CUSTOM_STRUCTLOOP_EXPRESSION>

Allows you to specify that a particular custom structure loop expression is required in order to be able to successfully generate code from the template.

<REQUIRES_CUSTOM_STRUCTLOOP_TOKEN>

Allows you to specify that a particular custom structure token is required in order to be able to successfully generate code from the template.

<REQUIRES_CUSTOM_TAG_EXPRESSION>

Allows you to specify that a particular custom tag loop expression is required in order to be able to successfully generate code from the template.

<REQUIRES_CUSTOM_TAG_TOKEN>

Allows you to specify that a particular custom tag loop token is required in order to be able to successfully generate code from the template.

<REQUIRES_CUSTOM_EXPRESSION>

Allows you to specify that a particular custom generic or structure expression is required in order to be able to successfully generate code from the template.

<REQUIRES_CUSTOM_TOKEN>

Allows you to specify that a particular custom generic or structure token is required in order to be able to successfully generate code from the template.

<REQUIRES_OPTION>

Allows you to specify that a particular command line option is required in order to be able to successfully generate code from the template.

<REQUIRES_USERTOKEN>

Allows you to specify that a particular user-defined token is required in order to be able to successfully generate code from the template.

 

 


Copyright © 2018  Synergex International, Inc.