OverviewCopy link to clipboard
The Delete Group smart service allows you to select a group and remove it from the system.
Note: The Portal Administrators and Document Administrators custom groups are built into Appian and cannot be deleted, even by system administrators.
Permissions neededCopy link to clipboard
The Delete Group activity 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.
PropertiesCopy link to clipboard
-
Category: Identity Management
-
Icon:
-
Assignment Options: This smart service can be either attended or unattended (default)
Configuration optionsCopy link to clipboard
This section contains tab configuration details specific to this smart service. For more information about common configurations see the Process Node Properties page.
Data tabCopy link to clipboard
Node inputsCopy link to clipboard
Name | Type | Required | Multiple | Default Value | Comments |
---|---|---|---|---|---|
Group | Group | Yes | No | The group to delete. |
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.
a!deleteGroup()Copy link to clipboard
The Delete 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.
SyntaxCopy link to clipboard
a!deleteGroup( group, onSuccess, onError )
ParametersCopy link to clipboard
Keyword | Type | Description |
---|---|---|
|
Group |
The group to delete. |
|
Any Type |
A list of saves or an HTTP response to execute after the smart service executes successfully. Created with |
|
Any Type |
A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with |
ReturnsCopy link to clipboard
ExampleCopy link to clipboard
See Create Group Smart Service
Feature compatibilityCopy link to clipboard
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 | 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 | Incompatible | Cannot be used to configure a process event node, such as a start event or timer event. |