Skip to main content

Report

The Report activity is a read-only task that allows users to view and acknowledge information without providing input.

Purpose​

Use the Report activity when you need to:

  • Present information to users for review
  • Require acknowledgment of data or results

Configuration​

Report Activity Editor

Name​

  • Activity Name: Unique identifier for this report in the workflow
  • Used to reference the activity in workflow design and execution logs

User Instructions​

  • Instructions Field: Large text area for detailed instructions
  • Provide clear, step-by-step guidance for the assigned user
  • Supports multi-line text for comprehensive task descriptions

Files & Links​

Add supporting materials to help users complete the report review:

  • New File: Attach files from the application for reference
  • New Url: Add links to external resources, documents, or systems
  • Files and links appear in the report view for easy access

Due Date Type​

Configure when the report review should be completed:

  • None: No deadline specified
  • Fixed Date: Set a specific due date
  • Relative: Set deadline relative to workflow start or previous activity

Owner​

  • User or Security Group: Assign the report review to a specific user or group
  • The owner is responsible for reviewing the report
  • Only one owner can be assigned per report
  • Click the icon to browse and select from available users and groups

Contributors​

  • Add Multiple Contributors: Users who can assist with the report review
  • Contributors can view and work on the task alongside the owner
  • Click + New Contributor to add users or groups
  • Useful for collaborative review tasks

Supervisors​

  • Add Multiple Supervisors: Users who oversee the report review
  • Supervisors can monitor progress and completion
  • Click + New Supervisor to add users or groups

Advance Rule​

Determines when this activity is triggered based on predecessor activities:

  • When All: Activity starts only after all predecessor activities complete (default)
  • When Any: Activity starts when any predecessor activity completes
  • When First: Activity starts the first time any predecessor completes, then ignores others

Outcomes​

The activity has a single outcome path:

  • User acknowledges/completes the review
  • Workflow continues to the next step

Usage Notes​

  • Built on the Action activity with a read-only intent
  • No data input is expected from the user
  • Currently implemented identically to Action, but semantically indicates read-only use
  • Useful for creating audit trails of information review
  • Use clear, actionable instructions to ensure proper review
  • Attach relevant files and links to provide context

Best Practices​

  • Clear Instructions: Write detailed, step-by-step instructions in the User Instructions field
  • Appropriate Assignment: Assign to users who need to be aware of the information
  • Include Context: Add files and links that provide the information to be reviewed
  • Set Deadlines: Use Due Date Type when timely acknowledgment is important
  • Use Contributors: Add contributors for reports that benefit from collaborative review
  • Add Supervisors: Include supervisors when oversight or acknowledgment tracking is needed
  • Make Information Accessible: Ensure all necessary information is easily accessible through files and links

JSON Reference​

{
  "discriminator": "ReportingWorkflowActivity",
  "activityId": "<uuid>",
  "name": "Report",
  "positionX": 0,
  "positionY": 0,
  "advanceRule": 2,
  "ownerGroupOrUser": { "username": "user@example.com" },
  "contributorGroupsOrUsers": [],
  "supervisorGroupsOrUsers": [],
  "dueDate": null,
  "dueDateCalculationMode": 0,
  "htmlDescription": "<p>Please review the following report.</p>",
  "items": []
}
PropertyTypeDescription
ownerGroupOrUserobject | nullCorresponds to the Owner field. An object { "username": string } identifying the user or group responsible for reviewing the report.
contributorGroupsOrUsersarrayCorresponds to the Contributors list. Array of { "username": string } objects.
supervisorGroupsOrUsersarrayCorresponds to the Supervisors list. Array of { "username": string } objects.
dueDatestring | nullDue date duration (ISO 8601). null means no due date.
dueDateCalculationModeinteger0 = None, 1 = AbsoluteDate, 2 = FromWorkflowStartCalendarDays, 3 = FromWorkflowStartBusinessDays, 4 = FromWorkflowEndCalendarDays, 5 = FromWorkflowEndBusinessDays, 6 = FromActivityStartCalendarDays, 7 = FromActivityStartBusinessDays.
htmlDescriptionstringCorresponds to the User Instructions field. HTML instructions shown to the user. Supports {variable} interpolation.
itemsarrayForm items displayed in the report panel. Pass [] for a plain report with no form.