Articles in this section

See more
Print

Text File | Move AD Object rule

  • Updated
Follow

Rule description

This rule takes Active Directory objects defined in a CSV text file and moves them to an OU defined directly or mapped dynamically in a CSV file.

Note: CSV-file should be in UTF-8 format in case of using letters with an accent: á, ä, é, í, ö, ü and etc.

 

When to use this rule

Use this rule when you need to move Active Directory objects defined in a CSV text file to an OU defined directly or mapped dynamically in a CSV file.

This rule requires a source text file in the comma-separated variable format (CSV). You can use the template CSV file provided with the rule, or create a file in Microsoft Excel and export it as CSV.

 

Rule Settings

Query Section

Setting name Description

Select Data Source

Specifies the text file to be imported.

You can create a new file or use an existing one. The CSV file should contain the anchor column for each AD object that will be processed.
Separator used in file

 

Use this setting to select the separator used in the file.
Limit scope to this Domain or OU

This setting defines the search query scope

To improve query performance, limit the scope to specific OU.

Important: To test rule configuration, limit the rule scope to an OU that contains test accounts or objects. 
Data source anchor attribute

Select the column in the data source that will be used to find a matching user account in Active Directory and determine if the user account already exists.

The value of this column in the data source is compared to the Active Directory Anchor Attribute value in Active Directory.
Active Directory Anchor attribute

Select the attribute in the Active Directory to compare the Data Source Anchor attribute when searching for a matching user account.

More Options

 

Filter CSV Data

This setting specifies the filter that can remove data rows from the imported text file that satisfies the specific condition. 

Properties to display 

Select properties to display for each object found by the query.

Filter

To hide unwanted data based on criteria, not supported by the Active Directory query, set the filtering conditions here.

Example: filter by the found object Distinguished Name.

Tip: For optimal performance, use the Query criteria above to filter objects whenever possible. 

Initialization script

 

Script

Usually, rules use query criteria to limit the query search scope. It improves the performance of the executed rule.

Due to PowerShell limitations, it is not possible to use calculated expressions in query criteria. That is the point where the initialization script can help. You can initialize a global variable in this setting and then use it in query criteria.

Important: To use a variable, declared in the initialization script, in the query scope, it must be global: $global:<variable name>.

Example: Update AD users, created in the last ten days.

  1. Add this initialization script:
{$global:DatePeriod = (Get-Date).AddDays(-10)}
  1. Use $DatePeriod variable in query criteria builder:

 

Action Section

Setting name Description

Move to this OU

Select an OU directly to move all objects or a column containing an OU path in the data file to dynamically map the target OU based on an attribute.

 

Output Section

This section defines the output format of this rule.

To get more information about this section, please see the Output section article.

 

Enforce/Schedule section

This section defines the schedule for how often to run the rule.

To get more information about this section, please see the Enforce/Schedule section article. 

 

Change History

Version Notes
9.3.0  The rule has been added to the product.

 

Related articles

Comments

0 comments

Please sign in to leave a comment.