Description:
This step archives another Form Instance by the Instance ID.
Inputs
- Name - Step name
- InstanceID - Form Instance ID to archive
Returns
- True – step executed successfully
- False – step failed to execute
Usage:
Example:
Let’s build and execute the “clsArchiveFormInstanceDef” example.
- Create a new process definition called “clsArchiveFormInstanceDef” and open the definition in designer mode.
- Drag a "clsArchiveFormInstance" step to the canvas.
- Connect the dots between the “Start” and "clsArchiveFormInstance" step.
- Click the "clsArchiveFormInstance" step to configure its “Required” properties. Provide a name for the step. Provide the GUID value of an existing form instance. Click the Save button. Note: Click the "AI Predict" button for the Copilot to add new process steps that match your process description.
- 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 below. Configure the “Logging” using the following properties.
- Save the process definition, create a new instance, and then execute it. As configured, the process step should archive the existing Form instance.
- Navigate to Administration> Archive> Process Instance> Search by the GUID information.
Definition Sample:
You may download the sample definition(s) from the link here and later import them (drag-and-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.