Add Group Members Smart Service

Overview

The Add Group Members smart service allows you to add a user (or users) to a group as a step in your process.

Permissions needed

The Add Group Members smart service can only be executed by a System Administrator, or by administrators of the group in which new members are being added. If this task is assigned to any other user, a runtime exception is thrown and the process will be paused when that 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 all the inputs and outputs for the node. You can add additional input and outputs, if needed.

Node inputs

The default inputs for this node are:

Input	Type	Required	Multiple
Choose New Members	People	Yes	Yes
Choose Group	Group	Yes	No

Tip: When the Add Group Members node is run as an attended node, you will not be able to specify a value for any of the node inputs through the Data tab. Users can however, specify default values for form elements through the Forms tab.

a!addMembersToGroup()

The Add Group Members 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!addMembersToGroup( group, newMembers, onSuccess, onError )

Parameters

Keyword	Type	Description
`group`	Group	The group to which the new members will be added.
`newMembers`	List of User or Group	The users and groups that will be added as members.
`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
Process Reports	Incompatible	You cannot use this function to configure a process report.
Process Events	Incompatible	You cannot use this function to configure a process event node, such as a start event or timer event.

Feedback

Was this page helpful?