Adaxes Web Interface HelpShow AllHide All

Custom Command Overview

Active Directory management often involves complex repetitive tasks. To speed up and facilitate such tasks, Softerra Adaxes provides Custom Commands. With their help, you can combine all operations related to a specific task in one command and perform this command in a single mouse click in the Adaxes Administration Console and Web Interface.

For example, when an employee leaves for vacation, you need to perform several operations such as: disable his or her account, forward employee's mail to a manager, update description to include information about the reason and date of account disabling. To facilitate the execution of all these operations, you can create a Custom Command with required actions. Once created, the Custom Command will be displayed in the user interface, and you will be able to perform vacation-related operations quickly and easily as any regular operation.

Custom Commands can be used to streamline the execution of various operations, such as updating objects, changing group membership, performing operations on home directories, moving or deleting objects, etc. The operations available for a Custom Command depend on the object type selected for this Custom Command. For example, if you create a Custom Command for users, you can add such actions as enable/disable account, create Exchange mailbox, create or share the home directory, etc., whereas in Custom Commands for groups such actions are not available.

You may want Custom Commands or their specific actions to be executed only on the objects in a specific location, on enabled accounts, on the members of a specific group, etc. For this purpose, you can set necessary conditions in Custom Commands. After that, Custom Command actions will be executed, only if the specified conditions are met.

Custom Command Execution

One Custom Command can have several sets of actions and conditions. These sets and actions in them are executed sequentially in the order of their arrangement. To change the order of action execution, you need to change their sequence.

Each action in a Custom Command has an option to be executed synchronously or asynchronously. Synchronous execution means that actions are performed strictly in the order of their arrangement, one after another. Asynchronous execution means actions can be executed concurrently, irrespective of their order, and you will be able to work with Adaxes without waiting for Custom Command actions to be performed.

Another option that can be set for each action is approvals. If you select to send an action for approval, this action will be executed, only after an approval of a responsible person is granted.

Actions executed by Custom Commands are displayed in the Execution Log. The Execution Log displays the status of action execution for each objects as well as errors, warnings and information messages. The result of asynchronous operations is not displayed in the Execution Log. However, you can see it in the Service Event Log.

Access Control

To perform Custom Commands, users must have the Execute All Custom Commands or Execute <Custom Command> permissions. These permissions are granted with the help of Security Roles.

Built-In Custom Command

Adaxes provides the built-in Custom Command intended for deprovisining user accounts. You can perform the Deprovision Custom Command on the users you need. When performed, this Custom Command will disable the user account, set the password to a random value, set the account expiration date to current date, delete user home directory and its share, forward user mail to its manager, etc.

If necessary, you can modify built-in Custom Commands the way you need, add or remove their actions or conditions, or even delete them.

Example of Using Custom Commands: Assigning Users to a Specific Project

To assign a user to a specific project, you need to perform a number of operations. You need to add a user to groups to grant this user necessary permissions, send a greeting message with project description to a new project member, execute scripts. To execute these actions in one operation, you can create the Custom Command with the following actions:

Add the User to the 'Alpha Project' group
Send e-mail notification (Welcome to Alpha Project)
Run PowerShell script 'Assign to Project' for the User

With such Custom Command, a project manager (or other responsible persons) will be able to perform all these operations by clicking this Custom Command in the user interface. The only permission necessary for that is the permission to perform this Custom Command.

See Also