Edit Group Smart Service

Summary

The Edit Group smart service allows you to select a group and update any of its available fields, including its name, description, and parent group.

Permissions Needed

The Edit Group smart service can only be executed by a system administrator or by an administrator of the group. Attempting to run this node without sufficient rights causes an error message to be sent to the process administrator and pauses the process. This also occurs if you attempt to rename a group using an existing name or specify an object that does not exist.

Attempting to execute this task as a Basic User causes a run-time exception that pauses the process and sends an alert to the Process Administrator.

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

Node Inputs

Name Type Required Multiple Default Value Comments
Group Group Yes No
Name Text Yes No

The following characters are not allowed in group names.

/ \ < > " , . * '

Description Text No No
Delegated Creation? Integer No 0 (No) The default values are Yes or No. The integer 1 equals yes. 0 equals no.
Parent Group Group No No The user account that activates this activity must have Administrator rights for the parent group in order to add this new group as a child.
Membership Policy Number Yes No Closed Default value options: Closed, Exclusive, Automatic
Visibility Number Yes No Public Default value options: Public, Personal, Restricted
Privacy Policy Number Yes No Low Default value options: Low, High

If the activity is run without being assigned to a user (or a group) you must specify values for each of the node inputs listed.

Selecting a Personal visibility input value sets other associated node input values automatically. Be aware that the node input lists on the Data tab and the dropdown lists displayed task form are not automatically filtered when this happens to show only valid options for the visibility. Any invalid selections (made by you at design time, or by your users at runtime) are ignored when the group is created.

If the Visibility input is set to Personal, the following settings are configured automatically.

  • The Group Type input is set to Custom
  • No value can be specified for the Parent Group node input.
  • The membership policy node input is set to Closed.
  • The privacy policy node input is set to High.

a!editGroup()

The Edit Group 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!editGroup(group, name, description, groupType, delegatedCreation, parent, membershipPolicy, securityType, groupPrivacy, onSuccess, onError)

Inputs

  • group (Group): The group to modify.
  • name (Text): The name of the group.
  • description (Text): The description of the group.
  • groupType (Text): The type of the group.
  • delegatedCreation (Boolean): Should administrators of this group be permitted to create additional groups as children? Default: false.
  • parent (Group): The group's parent. You must be an administrator of this group.
  • membershipPolicy (Text): The membership policy of the new group. Valid values: CLOSED (default), EXCLUSIVE, AUTOMATIC.
  • securityType (Text): The security type of the new group. Valid values: PUBLIC (default), PERSONAL, RESTRICTED.
  • groupPrivacy (Text): The privacy policy of the new group. Valid values: LOW (default), HIGH.
  • 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().

Returns

Example

See Create Group Smart Service

FEEDBACK