Using variables

You can use these variables during distribution.

You can use them in expressions that are linked to the document type:

  • dom.document.language
  • dom.document.company
  • dom.document.reportcode
  • dom.batch.user
  • dom.batch.session
  • dom.batch.context: The context specified by a Document Provider.
  • dom.destination.name: The name specified at the Receiver Independent Destination.
  • dom.destination.type: The constant names of the ttrpi.dest domain.
  • dom.destination.custom
  • dom.destination.address: The address of the destination. If the destination has type email, this variable is set only if there is only one to-address.
  • You can also use the ## expression. The text between the ## is converted to a document type variable and must be mapped to a report variable in the report rule.

To get all email addresses for the destination, you can use this function in expressions that are linked to the Document Type: function long dom.destination.get.email.addresses(ref string address.types(,), ref string addresses(,) mb)

The output argument address.types is filled with the type of the email recipient, for example: “to”, “cc”, or “bcc”. The output argument addresses is filled with the recipient address. Both output arguments must be declared as based, the output argument addresses must be declared as multibyte as well. The function returns the number of email addresses present.

You can use these variables in expressions that are linked to the Report Rule:

  • dom.batch.session
  • dom.batch.session.pid
  • dom.report.language

You can use these variables in expressions that are linked to the Document Provider Rule:

  • dom.batch.context: The context specified by a Document Provider.
  • dom.batch.language: The language specified by a Document Provider.

You can use these functions in expressions that are linked to the Report Rule:

  • get.keyword1()
  • get.keyword2()
  • get.keyword3()
  • get.keyword4()
  • get.<report rule variable>()

These variables are used as special parameter setting during printing:

  • splitfield; When the content or value of the expression in 'splitfield' changes, printing will continue in a new separated document.
  • font.scaling; the value of this variable is used for the font scaling. Possible values are:
    • 'blank': No font scaling
    • > '2' font scaling factor.
    • < '2' default font scaling factor '9' is used.
  • show.total.number.of.pages; indicate whether the total number of pages must be printed.

    For example: 'Page: 1' will be replaced with '1 - x' where 'x' is the total number of pages.

    The expression can contain:

    • 'true' print total number of pages.
    • 'yes' print total number of pages.
    • > '0' print total number of pages.
    • Any other value. Do not print total number of pages.