Defining text with variables

Variables allow you to use metadata information for a job, and use this information (for example the customer or its reference number) in e-mail notifications.

To define text with variables

  1. Select a flow element that supports attaching e-mail information, such as the Folder element.
  2. In the Properties pane, click Attach email addresses or Attach email body text (depending on what you want to configure).
  3. Select > Define multi-line/single-line text with variables.
  4. If a dialog pops up, type the required text or e-mail addresses, and click Define variables to insert a variable. If you selected Define single-line text with variables, no dialog pops up. Proceed with the next step.
  5. Select the sample job from which you want to see sample values for variables. You need at least one valid sample job. Refer to Creating a sample job.
  6. Search for the variable you want to insert:
    1. Select a group (from the first column).
    2. Select a variable belonging to that group (from the second column). In the third column you will find information about the selected variable and (at the bottom) the value of that variable as found in the sample job. Depending on the selected variable, you may have additional options (displayed at the right), e.g. in case of dates, to define the format of that date.
    3. Click Insert variable. The Text with variables field (below the columns) shows the selected variable.
      Note: You can put more variables in this 'text with variables' field as well as any extra text. When the jobs will be processed in this flow, the variables will be replaced with their actual values. For example, a line like "The [Job.NameProper] has size [Job.Size] bytes" will be replaced with something like "The testfile has size 5412 bytes" and this new line will be used as the value of the property (for example, attached as e-mail body if the corresponding property is involved).
    4. Click OK.
  7. If you selected Define multi-line text with variables in step 3, to insert more variables, repeat steps 4 to 6. If you selected Define single-line text with variables, all variables must be inserted at once.
  8. To close the dialog as required, click OK.