clsLogHistoryItem Step
Description:
This step adds custom messages to the history types of items, such as User, Process Definition, 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 process definition called “addMessageToHistoryDef” and open the definition in designer mode.
- Drag multiple “AddMessageToHistory” steps to the canvas.
- Connect the dots between the “Start” and “AddMessageToHistory” steps, as shown above.
- Click the first “AddMessageToUser” step to configure its “Required” properties. Provide a name for 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. Note: Click the "AI Predict" button for the Copilot to add new process steps that match your process description. Repeat this step and configure the item type with a different list value.
- 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 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 the history types of items, such as User, Process Definition, Process Instance, Forms Definition, or Forms Instance.
- Navigate to User Management - Search on the User - Click on View History to view the comments.
- The historical information is rendered on the new page as shown below.
Definition Sample:
You may download the sample definition(s) from the link here and later import them (drag-and-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.