Substituting Fields in Output Formats

In output formats, you can insert field tags used to complete information in generated report files.

Important: This functionality is only available for .docx, .pdf, and .rtf output format extensions. For more information, see Supported Functionality.

Before you begin:
  • Create a report from an output format and a template.
  • Insert a Set Field instruction at the top of the template.
    Note: If the instruction is declared elsewhere, the substitution does not work.
See Also
About Report Output Formats
Output Formats
  1. Open the output format file in a dedicated editor.

    Note: The output format file can be the file attached to the output format and downloaded from the Output Formats page or another file. Depending on the file type, this file must follow certain rules. For more information, see Output Formats.

  2. In the output format file, enter the $Name tag before the %endheader keyword or after the %begintrailer keyword. Name corresponds to the set field name defined in the template or to a predefined field, see Predefined Substitution Fields. Undefined set field names are not substituted.
  3. Save and attach the output format file to the output format. For more information, see Attaching a File to an Output Format.

You can now generate a report file with field tags substituted by the evaluation of the set field codes.