Modify Folder Security Smart Service

Overview

The Modify Folder Security smart service allows you to select a user to be added to a specified folder as a reader, author, and/or administrator. Only a System Administrator or a Knowledge Center Administrator can add users in these roles.

Properties

• Category: Document Management

• Icon:

• Assignment Options: Attended or unattended

• Compatible with autoscale: Yes *

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
Folder	Folder	Yes	No
Readers	People	No	Yes
Authors	People	No	Yes
Administrators	People	No	Yes

The users and groups selected as readers, authors, and administrators will be added to that role for the folder. The folder's existing readers, authors, and administrators, will not be removed when this smart service executes.

Usage considerations

Run at low throughput in autoscaled processes

This smart service is not intended for high-throughput usage and should only be used at low frequency in processes with autoscale enabled. The underlying services this node relies on may not scale to the same degree as autoscale-enabled processes, which may impact performance at high concurrency.

For autoscaled processes, consider one or more of these approaches:

• Position this node in less used paths within your process flow. This could be an exception path or an uncommon case for the process.
• Monitor node execution times during performance testing to see if the node performs differently at scale.

When used in an autoscaled process, the node should behave as it would in a standard process of comparable scale. For typical workloads, no special design considerations are needed.

a!modifyFolderSecurity()

The Modify Folder Security 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!modifyFolderSecurity( folder, readers, authors, administrators, onSuccess, onError )

Parameters

Keyword	Type	Description
folder	Folder	The folder you want to set security for.
readers	List of User or Group	The new users and groups to have reader access to the folder.
authors	List of User or Group	The new users and groups to have author access to the folder.
administrators	List of User or Group	The new users and groups to have administrator access to the folder.
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 Interfaces	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	Partially compatible	If autoscale is enabled, can be used to configure a supported process event node (such as a start event or timer event).
Event Consumer Filter Conditions	Incompatible	Cannot be used in filter conditions.
Event Consumer Event Handlers	Incompatible	Cannot be used in event handler expressions.

Feedback