Using the User Message Definition Type

The User Message Definition Type is a special type used in a Chain Definition to represent a manual task to be performed by an operator. User Message Process Definitions do not have an editable script source, however, you can set the following user message-specific properties:

Other Process Definition properties behave like traditional Process Definitions.

Variables

Variables are used in the text field that will be sent to users requesting interaction.

The following table lists the built-in variables:

Variables can also be used in the Go To Step field, a list can be found in the Scripting Contexts and Implicit Objects topic.

Parameters

Parameters allow you to specify additional information in the user message Text field. You can retrieve data from tables, other Process Definitions within the Chain, for example, for use in the Text field.

Parameters are specified as ${parameters.<parameter_name>}.

Example

Please make sure the ${parameters.reportName} is consistent with the results of the ${parameters.check}. See the attachments.

Response

The Response tab allows you to specify one or more possible reactions to the user message. For example, you use the user message in step 2 to go to the previous step if the data from Step 1 do not add up. In this case, you create two responses as follows:

Note: The Go To Step functionality only works when the status is Completed, there is already a GoToStep Status Handler for Completed Goto NextStep on the step, and there is only one process in the step of the user message. This last prerequisite ensures that only one process defines the step to go to.

Attachments

User messages support a number of different attachment types:

• URL - a URL to a website or file, for example http://www.redwood.com
• Document - A Redwood Server document, for example doc:/Redwood/myImage.png
• <process_spec>:<file_spec>[<options>]

Tip: Attachments have a mandatory description field which will be used to identify the files in the user message reply dialog. Using clear descriptions for attachments further streamlines the processing of the user message by the addressees.

Specifying <process_spec>

• Job <process_ID> - where <process_ID> is the ID of the process.
• <step_name>, Job <n> - where <step_name> is the name of the step (not the description) and <n> is the order of the call in the step.
• parent - the immediate parent of the current user message process; note that in chains, the parent is usually the step. The keyword is used when you submit a user message from within a RedwoodScript Process Definition, for example.

Specifying <file_spec>

• <short_file_name> - the technical file name, such as stdout.log.
• ?type=<type> - where <type> is either log or output; will attach all files matching the type
  • log - log files contain the output of standard error, for example all error messages
  • output - output files contain the output of standard out, for example the report

Specifying <options>

• ?range=<start>,<end> - specify a range of line numbers, negative numbers are counted backwards (from the end of the file)
• ?search - search for the occurrence of a string in the file, by default, the line with the first occurrence is copied.
  • ?options - customize the behavior of search
  • WildCard - Used with a search string of "*" to specify a wild card search
  • Reverse - Returns the last line in the file matching the search string
  • IgnoreCase - Performs a case insensitive search
  • EntireLine - An entire line in the attachment must match the specified string
  • RangeResult - Returns all lines that match the search string

Example

• Job 123:stdout.log
• Step 2, Job 2:stderr.log
• parent:GL_Accounts.xlsx
• GL Quarter Close EMEA, Job 4:stderr.log?range=-15,-1
• Step 1, Job 3:stderr.log?search="caused by"?options=RangeResult,IgnoreCase

Addressees of the user message will be able to view, delete, and add new attachments to the user message when they reply.

Participants

Specify users/roles that can react upon the user message. Participants are automatically granted the required privileges to reply to the user message. The users/roles will need Edit processes privileges to manage attachments.

Reacting on User Messages

Once a user message has been created, you can navigate to Business > User Messages to react on the user message. The following actions are available:

Note: Each user message process will have the associated user message listed in the Related Objects field.

On User Message Operation Action

User message Process Definitions have a special type of script action named On User Message Operation; it is available alongside On Change, Pre-Running, and Post-Running Actions on the Actions tab of the Process Definition editor. It is used to react to any interaction a user has with the user message such as replying, adding attachments or forwarding.

See Also

• User Message Forms
• User Message Form Editor
• Creating Process Definitions

usermessage user message