Skip to main content

Document State How To's

How to's for the Document State guide.

How to Change the Status of a Document in a Workflow?​

Steps to Change Document Status​

1. Add the Document Status Object​

  • Open the Flow Designer.
  • Drag and drop the Document Status object from the toolbox to your workflow canvas.

2. Configure the Position​

  • Go to the Properties panel.
  • Select a Position from the dropdown list to specify who performs the document status change.
  • If left empty, the status update will not display any initiator information.

3. Add Documents to the Status List​

  • In the Status List section, choose one or more documents to update.
  • For each document, select the new status from the available options.
  • You can add multiple rows to manage multiple documents simultaneously.

4. Validate the Configuration​

  • If any required configuration is missing or incorrect, a red exclamation icon will appear on the object.
  • Hover over the icon to view detailed error or warning messages.

5. Test the Workflow​

  • Save and execute the workflow.
  • Ensure that document statuses are updated correctly at the designated step.

How to Use Events with the Document Status Object?​

Steps to Handle Events​

1. Open the Events Tab​

  • Select the Document Status object in the flow.
  • Go to the Events tab in the Properties Panel.

2. Attach Custom Code​

  • Double-click on the desired event.
  • The system will automatically generate a method block in the .cs file of the workflow.

3. Implement Custom Logic​

  • Inside the generated method, add your business logic to customize document status updates.

Example: void OnBeforeStatusChange(object sender, EventArgs e)

{ Example: log document info before status change Logger.Info("Document status is about to change.") }