Description:

This step archives a document in the DMS folder. 

Usage:

Example:

Let’s build and execute the “DMSArchiveDocumentDef” example:

• Create a new process definition named “DMSArchiveDocumentDef” and open it in designer mode. 
• Drag an “updateVariables and DMSArchiveDocument” step to the canvas.
• Connect the dots between the “Start” and the other steps, as shown above. 
• Define a variable or a global to hold the DMS Document ID. 
• On the DMS page, navigate to the folder and select the document shown in this example. Use the column selector to include the “ID” column to show. Copy-paste the “Document ID” value to the clipboard. 

• Click the "updateVariables" step to configure its "Required" properties. Provide a name for the step. Click the Save button. Note: Click the "AI Predict" button to have Copilot add new process steps that match your process description. 

• Click the "updateVariables" step to configure its "Optional" properties. Provide a variable reference to hold the “Document ID” value. Copy-paste the value from the clipboard. Click the Save button. 

• Click the "DMSArchiveDocument" step to configure its "Required" properties. Provide a name for the step. Provide the variable or global reference that holds the “Document ID” value. Click the Save button. Note: Click the "AI Predict" button to have Copilot add new process steps that match your process description. 

• The “Logging” setting configuration is necessary for documentation and also measures workflow progress and completion percentage. 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 instance, and then execute it. Render the process instance to note that the status is completed, and the DMS document has been archived successfully.  

• On the DMS page, select the folder, then click View > Archive.  

• The list of archived folders is displayed in the table below. You can use the Search textbox to filter the results. Select the item from the table and click the Actions menu to navigate to “Restore, Destroy, and Empty” features. 

• Restore an Archive. Select the document in the table, then click Actions > Restore. 

• A confirmation pop-up window appears. Click the OK button. 

• The archived document is “undone” and removed from the DMS Archive folder. A confirmation message is displayed in the top-right corner.  

• Destroy an Archive. Select the document in the table, then click Actions > Destroy. 

• A pop-up is displayed for confirmation. Click the OK button. The archived document is “removed permanently,” and a confirmation message is displayed in the top-right corner.  

• Empty an Archive. Select Actions > Empty menu option to remove all archived documents.

• Type “REMOVE” in the text box and click the “Empty Archive” button to start. All archived documents and their contents are removed, and a confirmation message appears in the top-right corner. 

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 any missing configuration steps after import, such as file path references and database connections. Then, save the definition to confirm the changes. 

Click here to download the sample file.