Disabling History for a Workflow

You can use the Keep Instance and History dropdown list to specify if instance and history records are saved for workflows. Workflow history records take the form of execution and error log records. In the Keep Instance and History dropdown list, you can select to save workflow instances and history records Always, Never, or Only When Testing. You can access the Keep Instance and History dropdown list in the following places:

By default, the Only When Testing option is selected when you create new workflows. Be aware that history records created prior to 2018.1 are saved for existing workflows. You can delete records for these workflows using the Instances and History Records popup window. For details, see Deleting Workflow Instances and History Records.

When you select the Never or Only When Testing options, you can view workflow instance and history records on the record's Active Workflows Subtab and Workflow History Subtab subtabs while the workflow runs. After the workflow finishes or is canceled, the history records related to the workflow instance’s execution are deleted from the database. When you select the Always option, history records related to the workflow instance’s execution are saved in the database. Be aware that history records are never deleted for workflows that transition to a state with the Do Not Exit Workflow box enabled. For details, see Exit States.

One of the benefits of not saving history records for workflows that process many records can be improved system performance. Workflows that process many records produce a large amount of history records that can slow system performance. Additionally, a large amount of database space can be freed when you delete workflow history records.

To disable history for a workflow:

  1. Go to Customization > Workflow > Workflows.

  2. On the Workflows page, click Edit next to a workflow for which you want to disable history.

  3. In the context panel, on the Summary tab, click the Edit icon.

  4. On the Workflow Definition window, in the Keep Instance and History dropdown list, click Never.

  5. Click Save.

You can also disable history for workflows that are locked. See Editing a Locked Workflow.

Related Topics

General Notices