Object Lock Services

Overview

Steps within the Object Locks Services category enable users to lock, unlock, and other locking related functionalities onto an Object. 

Locking an Object prevents any edits to the Object for a specified amount of time. Use cases for locking an Object may involve preventing users from making simultaneous edits or preventing access altogether during scheduled maintenance.

Unless a Flow is built to display a warning and/or prevent access, users will be able to access a locked Object when it's selected in the Portal.

Locking an Object

The following example demonstrates locking and unlocking Objects with the Lock Object, Is Locked, and ReleaseLock steps. Below is an example that will prevent access to a Folder. The Project can be imported into a Decisions environment.

1. In a Designer Folder, create a Flow. The Flow Designer will open.
2. From Toolbox > FAVORITE STEPS, attach a Fetch Entities step to the Start step.
3. In the Properties tab for the Fetch Entities step, define the ENTITY FETCH DEFINITION by selecting Folder for TypeName.
4. Under Fetch Criteria select ADD and define the Field Name to 'fullPath' and Query Match Type to Contains, then, click OK.
5. Constant map 'DocRequests' to INPUTS > fullPath. This ensures that the Object locked by the Lock Service step is the DocRequests Folder. Then connect the No Results path to the End step.
6. From Toolbox > ITERATION, add a ForEach step to the Results path. 
7. Navigate to the Properties for the ForEach step, then map EntityResults to INPUTS > Collection.
8. On the Next path, add an IsLocked step from INTEGRATION > INTERNAL SERVICES > OBJECTLOCKSERVICE.
9. From the Properties of the IsLocked step, map Item.EntityFolderID to INPUTS > object Id.
   
   
10. Attach a Show Form step to the True path. Design the Form to contain a Button control labeled Done and a Label control stating the Object was already locked.
11. Connect the Done path to the ForEach Step. 
12. On the False path, attach a LockObject step from INTEGRATION > INTERNAL SERVICES > OBJECTLOCKSERVICE from the Toolbox. 
13. Navigate to the LockObject step's Properties and map Item.EntityFolderID, to object Id. Then, set lock For Time to a Constant value of 1 Minute[s].

    
    

14. On the Done path of the LockObject step, add another Show Form step from the FAVORITE STEPS category of the Toolbox panel.
15. Create a Form with the Label control stating that the Object is now locked, along with a Done Button. Then, save and close the Form.
16. Connect the Done path of the Object is locked Form to the ForEach Step.
17. Save the Flow.

Debug

1. From the FlowDesigner, select the Debug link from the top Action bar.
2. Click START DEBUGGING.
   
   The Flow will fetch the DocRequests Folder, send it through the ForEach step, and check if it's locked. This result returns False thus sending it to the Lock Object step to be locked before landing at the End step.
   
3. Click CREATE NEW SESSION.

Unlocking an Object

1. Create a new Flow. Ensure the Fetch Entities step's Input is set to the locked Object.
2. On the Next path, add a ReleaseLock step found in INTEGRATION > INTERNALSERVICES > OBJECTLOCKSERVICES.
3. In the Properties for the step, map the object Id Input to Item.EntityFolder.ID.

Debug

1. From the FlowDesigner, select the Debug link from the top Action bar.
2. Click START DEBUGGING.

Upon completing the Flow, the locked Object is now released.