clsArchiveProcessInstance Step

Use this step to archive other process instance.

Last published at: June 7th, 2024


This step archives another process instance by the Instance ID. 



  • Name - Step name
  • InstanceID - Process Instance ID to archive



  • True – step executed successfully
  • False – step failed to execute






Let’s build and execute the “clsArchiveProcessInstanceDef” example.

  • Create a new definition called “clsArchiveProcessInstanceDef”
  • Select the definition and click the “design” button
  • Drag a "clsArchiveProcessInstance" step to the canvas
  • Connect the dots between the start and "clsArchiveProcessInstance" step
  • Click on the "clsArchiveProcessInstance" step to configure its “Settings” properties. Provide a name to the step. Provide the other process instance GUID information. 


  • 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 in the images below. Configure the “Logging” using the following properties.


  • Save the process definition, create a process instance, and execute. As configured, the process step should archive the other process instance. Navigate to Administration—Archive—Process Instance—Search by the GUID information. The list of archived instances is seen in the table below.