Edit Document Properties Smart Service

Overview

The Edit Document Properties node allows you to update the name and description of a selected document. To complete this task you must have either Editor or Administrator rights for the folder where the document is located.

This node can only be executed with the appropriate user rights. Attempting to complete this task without sufficient rights generates an error message for the Process Administrator and pauses the process.

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. The default inputs are:

Input Type Required Multiple
Document Document Yes No
Name Text No No
Description Text No 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 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 entered by your assigned user(s) into a form.

a!editDocumentProperties()

The Edit Document Properties 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!editDocumentProperties(document, name, description, onSuccess, onError)

Parameters

Keyword Type Description

document

Document

The document to modify.

name

Text

The new name of the document.

description

Text

The new description of the document.

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().

Open in Github Built: Mon, Nov 15, 2021 (03:03:53 PM)

On This Page

FEEDBACK