Description:

This step updates a document that is checked out in DMS. 

Usage:

Example:

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

• Create a new process definition named “DMSUpdateDocumentDef” and open it in designer mode. 
• Drag a “updateVariables, DMSCheckOutDocument, DMSUpdateDocument, DMSCheckInDocument” step to the canvas.
• Connect the dots between the “Start” and the other steps, as shown above. 
• Define a variable or global to hold the Document ID and the new file path. 
• On the DMS page, navigate to and select the document shown in this example. Click the ellipsis button for context features. Select the “Get URL” menu. 

• A pop-up window displays the document link. Copy the “docID” value to the clipboard. 

• Click the ellipsis button to access context features. Select the “View History” menu. The page displays the history information as shown in the example below.  

• 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 "DMSCheckOutDocument" step to configure its "Required" properties. Provide a name for the step. Provide the variable or global reference that contains the “Document ID” value. Provide the variable or global reference that will hold the “Revision 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. 

• Click the "DMSUpdateDocument" step to configure its "Required" properties. Provide a name for the step. Provide the variable or global reference that contains the “Document ID” value. Provide the file path to the new document on the application server. 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.

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

• Click the "DMSCheckInDocument" step to configure its "Optional" properties. Provide the comments. Click the Save button. 

• Save the process definition, create a new instance, and then execute it. Render the process instance to note that the status is completed. The “DMSUpdateDocument” process step successfully replaced the document. 

• On the DMS page, navigate and select the document used in this example. Click the ellipsis button for context features. Select the “View History” menu. 

• The page displays the history information as shown in the example below.  As noticed, the document was checked out for changes and updated in this workflow example. 

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.