MailMerge Action Parameters

The MailMerge action supports the following input arguments:

uid

Defines from which record the data for the merge fields in the document template is taken and to which record the resulting document(s) is/are linked.

Available values:

  • Record: The uid of the current record
  • Linked: The uid of the record linked to the current record

This parameter is mandatory.

linkId

Defines the link that is used to access the document generated and uploaded by MailMerge to the database. This ensures that rights restriction on the database does not prevent the user from accessing the document generated using MailMerge.

saveMode

Defines whether and how the resulting document(s) are uploaded to the Aurea CRM database.

Available values:

  • None: Same as if left blank. The user is prompted to choose an upload action.
  • Link: The resulting file(s) are created as a D1 record and linked to the record defined in parameter uid via D3 .
  • DoNotSave: The resulting file(s) are not uploaded at all, just displayed to the user.

Default: Link

formatName

Defines the word processor format to be used for creating the letter(s). If left empty, a selection dialog is displayed allowing the user to select any available word processor format.

You can specify the name of any defined word processor format.

formatFilter

If formatName is empty, use this parameter to filter the word processor formats displayed in the format selection dialog.

You can specify any filter string and use wildcards (example - up*).

Specifying a filter string enables you to display only word processor formats that are suitable for the current info area, provided you use an adequate naming scheme for the format names.

background

If set, the whole letter creation process is done in the background and the user just receives a message of the result.

Possible values: <empty> | true | false

This setting overrules the Create in Background option in the word processor format, see Defining Word Processor Formats.

Default: empty.