Set Group Attributes Smart Service

The Set Group Attributes smart service allows you to modify attribute values for the selected group.

Appian allows you to create types of groups that include additional data (attributes), which must be supplied when creating each new group of that type. This smart service allows you to update any such data associated with a group.

CAUTION: The Set Group Attributes smart service can only be executed with a System Administrator or Group Administrator's user rights. If this task is run by any other user, a run-time exception alert is sent to the Process Administrator and the process is paused (when the user attempts to submit the task generated by this node).

Properties

  • Category: Identity 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 the Node Inputs and Node Outputs for the Service Node. You must add additional Node Inputs for each group attribute. The Node Inputs you create must match the name and the data type of the group attribute that you want to update.

For example, if you have a Group Type called Work Groups that includes the attributes TeamLeader (User) and Location (Text/String); you can use this node to update those attributes for a specific group that was created from the Group Type, such as Six Sigma Analysts. In this example, you would create two additional Node Inputs called Team Leader and Location. Team Leader would require a User data type. Location would require a Text data type.

Note: The Set Group Attributes smart service cannot be used to update attribute names that include spaces. In the example above, the attribute name TeamLeader is used instead of Team Leader because the format of the former is acceptable for this smart service.

Input Data Type Required Multiple
Choose Group Group Yes No
Attribute Name Attribute Data Type Yes or 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. When using the Expression Editor, you can reference and modify Process Variables, rules, constants, and other data. The expressions then populate your Node Input values.

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

a!setGroupAttributes()

The Set Group Attributes 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!setGroupAttributes(group, attributes, onSuccess, onError)

Inputs

  • group (Group): The group whose attributes will be set.
  • attributes (Dictionary): The attributes to set on the group.
  • 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().
FEEDBACK