removeInstances Step

Use this step to remove all process instances older than a certain time duration

Last published at: October 26th, 2024

Description:

This step is permanently removes all process instances, older than a certain time duration.  

 

Inputs

  • olderThan—Older than
  • expireType—Expire type 
 

 

Returns

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

 

Usage:

 

 

Example:

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

  • Create a new definition called “removeInstancesDef” 
  • Select the definition and click the “design” button
  • Drag the “removeInstances” step from the toolbox to the canvas
  • Connect the dots between the Start and “removeInstances” step
  • Click the “removeInstances” step to configure its “Settings” properties. Provide a step name. Provide the time duration value and select the Expire type from the drop-down list. Click the Save button to confirm.  

 

  • 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 new process instance, and execute. Render the process instance.  This step removes all the process instances as per the configuration. Navigate to the Process—Instances page to verify that the table contents are sorted by date. 

 

Definition Sample:

You may download the sample definition(s) from the link here and later import it (drag-drop) to your FlowWright Process Definition (XML file) or Form Definition (HTML file) page.

NOTE: Please verify and complete the process steps for any missing configurations, such as file path references and database connections after import. Then, save the definition to confirm the changes.

Click here to download the sample file.