- 18 Oct 2022
- Print
- PDF
ABots - Azure AD User Management - Licensing
- Updated on 18 Oct 2022
- Print
- PDF
Once configured, the Azure User Management Licensing ABot can automatically run licensing processes in your Azure active directory in response to workflow tickets opened in SysAid. This saves time and for both the IT admin and the employee who needs the update in the Azure active directory.
Before you setup this ABot, ensure that your ABots platform is up and running. See the SysAid ABot Guide for details.
Skills included
The Azure User Management ABot includes the following skills:
- Add licenses to a user - Adds licenses to users in the Azure active directory
- Remove licenses from a user - Removes licenses from users in the Azure active directory
New CI Type
To use the Azure User Management ABot you need to add a new CI type called 'Azure Active Directory Objects' to your CMDB. You can use this CI type for your Azure licenses. This enables you to select licenses from the Requested Azure Licenses field which is included in the Add licenses and Remove Licenses template.
When you create a license in your CMDB using this template, please ensure that the Serial Number field contains the relevant key according to Microsoft definitions.
Import Skills
- On the main My Apps page, in the Azure Active Directory User Management Licensing ABot's icon, click .
- Click the slider.
- Click Import ABot Skills.
The skills are imported in the background.
Setup the Templates
Each skill that you import includes a built-in template, ready to launch the automated process when a ticket is submitted. To set up the template you need to ensure that it has the credentials to access the machine that you want to run the automated process from. That machine must have access to all of the relevant agents. You also will want to ensure that the template is available in the Automation panel so that the skill can be run from within another ticket.
To add credentials
- In Settings > Service Desk Templates, locate the new template. It will have the same name as the imported skill.
- Open the template.
- In the Request Details tab, ensure that the Visible in automation panel check box is selected.
- In the Launch ABot workflow tab, click .
- In the Execution Credentials - Windows row, select the Credentials you want in the Set Values column.
- Click OK.
Using the ABot
Once the ABot skills have been imported, and the templates have been set up, admins and end-users can easily use the ABot's skills to initialize and automatically run the common tasks.
To add an ABot process from any ticket
- In the ticket form, click Automations.
- From the Select an Automation Process drop-down list, select the ABot skill you want to run.
- Click Launch.
- In the window that opens, enter the information in the required fields.
- Click Apply.
To run an ABot using a template
- Open a new request form.
- From the template drop-down, select the template for the ABot skill you want to run.
- Enter the information in the required fields.
- Click Apply.
You can access a record for each process run by ABots in Settings > Automate Joe > Process Monitor.
Parameter Mapping
Each skill has it's own parameter mapping that needs to be set up in the workflow template that you want to run the skill. To set up the template, see the Setup the Templates section above.
For any of the parameters, follow the following steps:
- Select if you want the parameter to be populated from an SR field, an action item field, credential set, Automate Joe agent, group field, or a manual Velocity command.
- In the Set Value column, select a field, or type input with the variable name of the field you want to populate.
- Select Get Text if you want to output the field value's caption instead of the its key.
- Click OK.
To better understand the parameters for each skill, see the reference tables below that detail the mandatory parameters that must be populated for each skill.
Add a License to a User
Parameter | Description |
---|---|
Required Parameters | |
Execution Agent - Windows | The Windows agent that the ABot uses to run the process. |
Execution Credentials - Windows | The credentials set to access the service on which you the ABot will execute the automated process. |
Execution Agent - REST | The REST agent that the ABot uses to run the process. |
Authentication Username | The field that contains the Azure authentication username name for the user you want to add the license to. |
Authentication Password | The field that contains the Azure authentication password name for the user you want to add the license to. |
Request user | The field that contains the user who is requesting the license added by this process. |
Requested license | The field that contains the CI for the Azure license added by this process. |
Output parameters | |
Process exit code | Code that displays the result of the process run by the ABot. 0 - The process was successfully executed Select the field you where you want this information displayed. |
Process last message | Message that states if the process was successful or not. Select the field you where you want this information displayed. |
Remove a License from a User
Parameter | Description |
---|---|
Required Parameters | |
Execution Agent - Windows | The Windows agent that the ABot uses to run the process. |
Execution Credentials - Windows | The credentials set to access the service on which you the ABot will execute the automated process. |
Execution Agent - REST | The REST agent that the ABot uses to run the process. |
Authentication Username | The field that contains the Azure authentication username name for the user you want to remove the license from. |
Authentication Password | The field that contains the Azure authentication password name for the user you want to remove the license from. |
Request user | The field that contains the user who is requesting the license removal executed by this process. |
Requested license | The field that contains the CI for the Azure license removed by this process. |
Output parameters | |
Process exit code | Code that displays the result of the process run by the ABot. 0 - The process was successfully executed Select the field you where you want this information displayed. |
Process last message | Message that states if the process was successful or not. Select the field you where you want this information displayed. |
Other ABots
For information about other available ABots, see any of the following help pages: