Activity Comment
AutomatR.DefaultActivities.Commented
The "Activity Comment" in AutomatR is a non-functional activity primarily used for documentation and commenting within workflows. It does not perform any executable actions but serves as a way for developers to include comments or notes directly within the workflow diagram. This can be helpful for explaining complex logic, providing context, or leaving notes for collaborators who review the workflow.
Properties
| Name | Description |
|---|---|
| Misc | |
| Body | This property allows you to input the content of the comment or note. You can enter text, explanations, or any information that aids in understanding the workflow. It supports plain text and may include line breaks for better formatting. String variables containing the comment or note text. This allows you to dynamically generate or update comments based on variables or expressions. |
| Display Name | The display name of the activity. A display name is automatically generated when you indicate a target. |
How to use:
- Drag and drop the "Activity Comment" onto the workflow where you want to include a comment.
- In the "Body" property, enter the text of the comment, providing relevant information or explanations.
- Optionally, in the "Display Name" property, enter a name that will be displayed as the label for the comment in the workflow diagram.
Example: Consider the following example where an "Activity Comment" is used to explain a specific section of a workflow:
Activity Comment:
Body: "Retrieve customer information from the database and check eligibility."
Display Name: "Customer Information Retrieval"
In this example, the comment provides context for the activities related to retrieving customer information. The "Display Name" is set to "Customer Information Retrieval" to label the comment in the workflow diagram.
By using "Activity Comment" strategically, developers can enhance the readability and understanding of workflows, making it easier for team members to collaborate, troubleshoot, and maintain the automation projects.