Administration

The Administration Activity allows you to create an manipulate Users and User Groups.

This Activity can have an arbitrary amount of Outcomes, but all Outcomes must have the same name. The script of each Outcome is evaluated once the Activity has completed. Each Outcome with a script evaluating to true is followed. If more than one Outcome script evaluates to true, the Instance is paralleled. If no Outcome script evaluates to true, the Instance is ended by entering the closed-state.

Activity config

General

• Name - Name of the Activity.
• Version - Version of this Activity used in the Process. If a new version of this Activity is available and you want to use it, you have to manually update the version here. When a new Activity is added to the Process, automatically the latest version is placed.
• Timeout in second - Once this time is elapsed, the Activity is closed and the Instance changes into the faulted-state. The default Timeout is two minutes. The timeout can be shortened and extended by entering a custom duration. If the Activity is left after a timeout, the first Outcome is followed. If multiple Outcomes have the same name as the first Outcome, all of them are followed. However, a continuation after a timeout does not effect the Outcome Scripts, meaning only Outcomes with Outcome Scripts evaluating to true are followed.
• Hide in process graph - Controls if the Activity is hidden (Yes) or shown (No) in the Process Graph on the Execution Screen.
• Continue on error - If this is set to Yes, the execution of the Instance continues even if the Activity failed. If set to No, the Instance fails when the Activity fails by entering the faulted-state. In the case of a continuation after an error, the first Outcome is followed. If multiple Outcomes have the same name as the first Outcome, all of them are followed. However, a continuation after an error does not effect the Outcome Scripts, meaning only Outcomes with Outcome Scripts evaluating to true are followed.

Administration

Administration Activity specific configurations

GENERAL

General interaction configuration, shared with most other Activities

• Disable activity - Disables (Yes) or enables (No) the Activity. When disabled, the Activity is not executed and passed like a Connection by following the first Outcome. If multiple Outcomes have the same name as the first Outcome, all of them are followed. Disabling the Activity does not effect the Outcome Scripts, i.e., still only Outcomes with Outcome Scripts evaluating to true are followed.
• Retry on error - If set to Yes, an automatic retry is executed up to ten times. If set to No, no retries are done. Retries are issued when the Activity failed so that the Instance would enter the faulted-state if the retry is disabled.
• Additional text for task list - Description of this Activity shown to the Users in their task list. You can enter this text directly or use Process Context Expressions to compile it.

SETTINGS

Configure the manipulations of Users and User Groups, respectively. The various manipulations can be combined in an arbitrary way.

• Add user groups - Creates new User Groups. The configuration for a new group is added by clicking on Add:
  • User group names - Name of the new User Group specified directly or determined by a Process Context Expression.
  • Each configuration can be removed by clicking on .
• Assign users to groups - Add one or multiple users to one or more groups. Be aware the Instance will fail, if the User and the Group do not exists, respectively.
  • List of users - Users that should be added to the User Groups specified in List of user groups. The configuration for a User is added by clicking on Add:
    • Each row specifies one User either by their User ID or their User name. Both can be specified directly or determined by a Process Context Expression.
    • Each configuration can be removed by clicking on .
  • List of user groups - User Groups the Users specified in List of users will be added to. The configuration for a User Group is added by clicking on Add:
    • Each row specifies one User Group either by its User Group ID or its User Group name. Both can be specified directly or determined by a Process Context Expression.
    • Each configuration can be removed by clicking on .
  • Assign users to user groups - Adds Users to User Groups. The A new configuration can be added by clicking on Add:
    • Key - User that will be added to the User Group specified in Value. The User can be identified by the User ID or User name and both can be specified directly or determined by a Process Context Expression.
    • Value - User Group the User specified in Key will be added to. The User Group can be identified by the User Group ID or User Group name and both can be specified directly or determined by a Process Context Expression.
    • Each configuration can be removed by clicking on .
  • Remove users from user groups - Removes Users from User Groups. If the specified Users are not part of the specified User Groups, nothing is changed and the Instance will continue. A new configuration can be added by clicking on Add:
    • Key - User that will be removed from the User Group specified in Value. The User can be identified by the User ID or User name and both can be specified directly or determined by a Process Context Expression.
    • Value - User Group the User specified in Key will be removed from. The User Group can be identified by the User Group ID or User Group name and both can be specified directly or determined by a Process Context Expression.
    • Each configuration can be removed by clicking on .
• Assign users to subscriptions - Adds a User to a Subscription. Be aware the Instance will fail, if the User and the Subscription do not exists, respectively.
  • List of users - Users that should be added to the Subscriptions specified in List of subscriptions. The configuration for a User is added by clicking on Add:
    • Each row specifies one User either by their User ID or their User name. Both can be specified directly or determined by a Process Context Expression.
    • Each configuration can be removed by clicking on .
  • List of subscriptions - Subscriptions the Users specified in List of users will be added to. The configuration for a Subscription is added by clicking on Add:
    • Each row specifies one Subscription by its Subscription ID that is either specified directly or determined by a Process Context Expression. The Subscription ID of the current Subscription is determined by the Process Context Expression ##[CurrentSubscription.Id].
    • Each configuration can be removed by clicking on .
• Disable users - Disables the specified Users so that the User cannot access the Account anymore. A User to be disabled can be added by clicking on Add:
  • Users - User that will be disabled can be identified by the User ID or User name and both can be specified directly or determined by a Process Context Expression. Be aware the Instance will fail, if the User does not exists.
  • Each disable configuration can be removed by clicking on .
• Enable users - Enables the specified Users so that the User can access the Account again. A User to be disabled can be added by clicking on Add:
  • Users - Users that will be enabled can be identified by the User ID or User name and both can be specified directly or determined by a Process Context Expression. Be aware the Instance will fail, if the User does not exists.
  • Each enable configuration can be removed by clicking on .
• Delete users - Deletes the specified Users. Be aware that the data of the User is not deleted, but only the User itself. This means, that a new User with the same email address will regain access to the data of the deleted User. A User to be deleted can be added by clicking on Add:
  • Users - A User that will be deleted can be identified by its User ID or User name and both can be specified directly or determined by a Process Context Expression. Be aware the Instance will fail, if the User does not exists.
  • Each delete configuration can be removed by clicking on .
• Add or update users - Creates new Users or updates existing ones. The Users are identified by their email address within one Account. I.e., if an email address is already assigned to a User in the Account, this Users is updated. If the email address does not belong to a User in the Account, a new User is created. If the email address belongs to a User that was deleted, a new User is created that also gains access to all the data of the deleted User with the same email address.
  Multiple Users can be added or updated at the same time. Therefore, multiple Emails, Lastnames, Firstnames and Titles can be entered. Be aware, when you create or update multiple Users at the same time, that the numbers of entries in Emails, Lastnames, Firstnames and Titles must be the same. If this is not the case, the Instance will fail.
  • Email / Username - Email address of the User also used at Username. The email address is used to uniquely identify the User and as the login name of the user. Clicking on Add creates a new email configuration:
    • The email address uniquely identifying the User that is also used as the Username. It can be entered directly or determined by a Process Context Expression.
    • Each configuration can be removed by clicking on .
  • Lastnames - Last name of the User. Clicking on Add creates a new last name configuration:
    • The last name entered directly or determined by a Process Context Expression.
    • Each configuration can be removed by clicking on .
  • Firstnames - First name of the User. Clicking on Add creates a new first name configuration:
    • The first name entered directly or determined by a Process Context Expression.
    • Each configuration can be removed by clicking on .
  • Titles - Title of the User. Clicking on Add creates a new title configuration:
    • The title entered directly or determined by a Process Context Expression.
    • Each configuration can be removed by clicking on .
  • Time zone - Home time zone for the new or updated Users