fDocs Actions Methods

Email Document

Changes made in 3.6

The EmailDocument action method allows for the following parameters:

  • From: the ‘from’ address. May be left blank to use the fSeries default from address
  • To: the ‘to’ address (may be included multiple times, each resulting in a separate email sent). Must have at least one non-blank value; if not the action will not be taken. If the fSeries EmailTestAddress is set, the email will be sent to that address. Each setting may have multiple email addresses, separate by commas or semi-colons.
  • CC: the copy address may  include multiple email addresses, separate by commas or semi-colons.
  • Bcc: the blind copy address may  include multiple email addresses, separate by commas or semi-colons.
  • ReplyTo: the reply to address may  include multiple email addresses, separate by commas or semi-colons.
  • Subject: the subject line of the email.
  • Template: references a text file in the fSeries Data folder “EmailTemplates” that contains a template for the layiout of the email (see below for more details)
  • Message: message text
  • SendAsText: set to “true” or “yes” to send as text instead of the default HTML

The emails body text is taken either from the template specified or, if none is specified, from the Message parameter. If a template is used, the Message value may be used to substitute for #Message# in the template’s text.

Any other parameters may be defined, which are then used to substitute placeholders in the body text (e.g. UserName parameter replaces #UserName# in the body text.

There are no settings for this method.

Save Document

The SaveDocument action method allows for the following setting:

  • Path: the path to the folder where the document will be saved. A subfolder within this may be specified as a parameter.

The method has the following parameter:

  • Location: the subfolder within the specified path where the document will be saved.

At least one of the Path or Location must be non-blank for the action to be taken.

Wisdom

All values may be configured as either parameters (set by the template designer) or settings (set by the administrator). The available values are:

  • DocType
  • ParentReference
  • TemplatePath
  • Title
  • UniqueId
  • Folder

In addition if any other values are specified these are each taken to be a metadata key and the value given used as the corresponding metadata value.

image_pdfimage_print