Lock Document Smart Service

Overview

The Lock Document node allows you to select and check out a document so that no one else can upload a new version until it has been unlocked.

Only a System Administrator, a member of the Document Administrators group, a Knowledge Center Administrator, or the person who created the lock can break it.

The Lock Document node is located under Appian Smart Service > Document Management in the Process Modeler Palette.

Properties

• Category: Document Management

• Icon:

• Assignment Options: Attended/Unattended

Configuration options

This section contains tab configuration details specific to this smart service. For more information about common configurations see the Process Node Properties page.

Data tab

This tab displays all the Node Inputs and Node Outputs for the Service Node. You can add additional inputs and outputs, if needed.

Node inputs

The default inputs are:

Input	Data Type	Required	Multiple
Document	Document	Yes	No

If the node is run without being assigned to a user (or a group) you must specify values for each of the Node Inputs listed in the table above. You can either manually enter data into the text-field, or a value can be generated using the using the Expression Editor. When using the Expression Editor, you can reference and modify Process Variables, rules, constants, and other data. The expressions then specify your Node Input values.

If the node is assigned, the Node Input values are typed by your assigned user(s) into a form.

a!lockDocument()

The Lock Document smart service is available as an expression function that can be executed inside a saveInto on a Interface Component or as part of a Web API.

Syntax

a!lockDocument( document, onSuccess, onError )

Parameters

Keyword	Type	Description
document	Document	The document to lock.
onSuccess	Any Type	A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a!save() or a!httpResponse().
onError	Any Type	A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a!save() or a!httpResponse().

Feature compatibility

The table below lists this smart service function's compatibility with various features in Appian.

Feature	Compatibility	Note
Portals	Partially compatible	Can be used with Appian Portals if it is connected using an integration and web API.
Offline Mobile	Incompatible
Sync-Time Custom Record Fields	Incompatible
Real-Time Custom Record Fields	Incompatible	Custom record fields that evaluate in real time must be configured using one or more Custom Field functions.
Process Reports	Incompatible	Cannot be used to configure a process report.
Process Events	Incompatible	Cannot be used to configure a process event node, such as a start event or timer event.

Feedback