Description:
This step adds custom messages to items' history types, such as User, Process Definition or Process Instance, Forms Definition, or Forms Instance.
Inputs
- itemType – select Item Type (like User, Process Definition or Instance, Forms Definition or Instance)
- message – History message as text
- itemID – Definition ID of the above Item Type (advanced)
Returns
- True – step executed successfully
- False - step failed to execute
Usage:
Example:
Let’s build and execute the “addMessageToHistoryDef” example:
- Create a new definition called “addMessageToHistoryDef”
- Select the definition and click the “design” button
- Drag the “AddMessageToHistory” step to the canvas
- Connect the dots between the Start and “AddMessageToHistory” steps
- Click on the “AddMessageToUser” step to configure its “Required” properties. Provide a name to the step. Select the item type (User, Process Instance, Process Definition, Form Instance, Form Definition) from the drop-down list. Provide the history message. Provide the item GUID value. Click the Save button.
- The “Logging” setting configuration is necessary for documentation and also measures the workflow progress and the percent complete. This is achieved by configuring the step state and percent fields individually, as shown in the images below. Configure the “Logging” using the following properties.
- Save the "addMessageToHistoryDef" process definition, create a new instance, and execute. This step should add custom messages to items' history types, such as User, Process Definition or Process Instance, Forms Definition or Forms Instance.
- Navigate to User Management - Search on the User - Click on View History to view the comments
- The history information is rendered on the new page as below.
Definition Sample:
You may download the ZIP file and extract the sample definition(s) from the link here. Then, you can later import it (drag-drop) to your FlowWright Process Definition (XML file) or Form Definition (HTML file) page.
NOTE: Please verify and complete the process steps for any missing configurations, such as file path references and database connections after import. Then, save the definition to confirm the changes.
Click here to download the sample file.