- 27 Sep 2023
- 4 Minutes to read
Active Directory - User Management - On\Offboarding from CSV
- Updated on 27 Sep 2023
- 4 Minutes to read
Once configured, the Active Directory User Management - On\Offboarding from CSV can automatically run user offboarding processes in your 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 active directory.
The Active Directory User Management - On\Offboarding from CSV includes the following skills:
- Create a User From CSV - Disables a user in the active directory
- Disable a user From CSV - Removes a user from the active directory
- Before you setup this ABot, ensure that your ABots platform is up and running. See the SysAid ABot Guide for details.
- For any Active Directory ABot, ensure that you have the Active Directory module for PowerShell installed.
- Create a dedicated user in Activ Directory to run your ABots.
- Add the user to the "Users" container only in Active Directory.
- Provision the user with "Domain Admin" permissions that allows the user to run actions as processes.
- On the main My Apps page, in the Active Directory User Management - On\Offboarding from CSV 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 select values in all of the mandatory parameter mapping fields. Each skill has a different set of fields that are detailed below, but all require the relevant credentials. The credentials you select must have access to the machine that you want to run the automated process from and the machine must have access to all of the relevant agents. See the ABot guide for information on how to prepare credentials so they can be selected in the parameter mapping for a skill.
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 set up a template
- 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 . There may be a delay in loading the Parameter Mapping fields.
- Select the fields you want for parameter mapping. See the Parameter mapping section for explanations of each field and which fields are mandatory for each skill.
- 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.
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
- 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.
Naming convention parameters
Naming convention parameters allow you to select how various email addresses, user names, and names are generated. If non of the available conventions meet the needs for a user you want to create, you can customize the convention for that user.
See the table below for the full list of available conventions for each parameter and further details on how to enter a custom convention.
To enter a naming convention
- Select Manual in the Data Source column.
- Enter the number corresponding to the naming convention you want to use. See the table below for reference.
- (Optional) To create a custom template:
- Duplicate the template for this instance.
- Open the Parameter Mapping for the new duplicate template you just created.
- Enter 99 in the naming convention field.
- Enter the exact name as you want it to be created in the field for that parameter. See the table below for reference.
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.
For information about other available ABots, see any of the following help pages:
- Active Directory - User Management - On\Offboarding
- Active Directory - User Management - Groups and OU
- Azure Active Directory - User Management - On\Offboarding
- Azure Active Directory - User Management - Licensing
- Microsoft Exchange - User Management - Distribution Groups
- Exchange Online -Mailbox Management- New Mailbox