Alerts
What is an Alert?
Alerts may be added to keep administrators informed of the success completion and/or failure of any workflow. Alerts are delivered as status emails to the designated recipients. For each workflow choose the previously created alerts or add a new alert. Easily add multiple recipients, by separating the addresses with a semicolon.
Where do I manage Alerts?
To manage workflow alerts, simply open the left navigation menu and click Alerts, located under Settings, see figure 1.
Figure 1: Directory Sync Setup and Settings Menu
How do you setup a new Alert?
Follow these steps to create a new workflow alert.
- Navigate to Alerts.
- Click New.
- Enter a Name, click Next.
- Enter recipients. To add multiple recipients, separate addresses with a semicolon ( ; ).
- Click Next.
- Choose Language preference, click Next.
- Choose which events trigger alerts.
- Choose Workflow Failure at a minimum.
- Do not choose Local Agent Offline for a Cloud only workflows and environments.
- Click Next.
- Click Finish.
How do you add an Alert to a workflow?
Follow these steps to add an alert to an existing workflow.
- Navigate to Workflows.
- Locate and select Write workflow created earlier.
- Click the Settings button.
- Click Alerts.
- Click Add.
- Select the Alert created in the previous steps.
- Click OK.
- Navigate to Workflows.
- Repeat these steps for each workflow.
What workflow events can generate an alert?
You can select to have an email notification sent when the workflow finishes for the following events:
- Workflow Completion - A notification will be sent each time your workflow completes successfully.
- Workflow Failure - A notification will be sent each time your workflow completes successfully.
- Local Agent Offline - A notification will be sent each time local agents go offline.
How do I edit an Alert?
Alerts can be edited on the Alerts page by selecting an Alert in the table and clicking "Settings."
How do I enable or disable an Alert?
Active alerts can be disabled on the Alerts page by selecting the alert in the table and clicking "Disable." Disabled alerts can be activated on the Alerts page by selecting the alert in the table and clicking "Enable."
Additional Information
Workflows
Workflow Test Mode
Evaluate Changed Objects Only
Scripts
What is a script?
A script entry is used to securely store a PowerShell script file and can be run as part of workflow at any point in the process using the Script Task.
Where do I manage saved Scripts?
To manage saved scripts, simply open the left navigation menu and click Scripts, located under Settings, see figure 1.
Figure 1: Directory Sync Setup and Settings Menu
How do you select a PowerShell script to run?
On the Run PowerShell Scripts screen, choose an existing script to run. Stop workflow on error will stop the workflow if an error is encountered, so placement of this step within the workflow sequence must be considered.
How do you add a new PowerShell script?
On the Scripts page, click the New button to add a new script to the collection. Name your script, and choose a local environment for it to apply to. Directory Sync does not validate your scripts, so be sure that you test them first in a non-production environment. Note that all scripts are run under the service account and an account with the required AD Rights must be configured to logon to the service.
Data Sets
What is a Data Set?
Data Sets can be used in conjunction with the “LookupValue” function to find source values and replace with target values.
What are Data Sets used for?
Data Sets are ideal for managing long lists of replacement strings commonly associated with Directory migration and consolidation projects.
For example, if a Data Set is named "Domains" and you want to replace "contoso.com" with "hr.contoso.com", set the Key Value to "contoso.com" and Return Value to "hr.contoso.com". Then in the appropriate attribute advanced mapping (e.g. UserPrincipalName) you could reference a formula like, LookupValue('Domains', s.UserPrincipalName, null)
This formula will find contoso.com from the UserPrincipalName attribute with hr.contoso.com.
Some other common uses cases might be:
- Update common attributes values like Department from the old format to the new format (e.g. HR to Human Resources)
- Reorganize OUs but applying data sets to determine the target OU
- Map complex environments with multiple source domains to different target domains
- Breakdown complex text strings into smaller pieces for use within another function
Where do I manage saved Data Sets?
To manage saved data sets, simply open the left navigation menu and click Data Sets, located under Settings, see figure 1.
Figure 1: Directory Sync Setup and Settings Menu
How do I create a new Data Set?
To create a Data Set:
- Select "Data Sets" under Settings in the left navigation menu.
- Click “New”.
- On the General tab, enter a name and description for the Data Set and click "Save".
- Click the "Values" tab.
- Click "New" to enter key values and return values or click "Import" to choose a file of key values and return values. If importing a data set, click "Download Example" to download an example CSV.
How do I import a Data Set?
On the Data Sets details screen, click the Import button to select a CSV with Key Value and Return Value columns.
Note: The imported CSV will replace any existing data in the data set.
Can you export a Data Set?
Select the data set(s) and click the Export button to generate a CSV file of existing data sets. You can then use the Import action to upload modifications to the list if desired.
How do I archive a Data Set?
Select the data set(s) and click the Archive button to archive the data set(s).
How-To
The following Quick Start Guides have been created to assist with common directory sync scenarios.
