Skip to main content

Articles in this section

See more
Print

Import SQL Data | Rename AD Users rule

  • Updated

Import SQL Data | Rename AD Users rule

Overview

This rule queries the specified SQL data source and renames user accounts within the scope according to the Action section settings.

Rule settings

Query section

Setting name Description

Limit scope to this domain or OU*

This setting defines the search query scope. To improve query performance, limit the scope to a specific OU.

IMPORTANT: To test the rule configuration, limit the rule scope to an OU that contains test accounts or objects and use the Preview feature.
SQL instance

Specify the name of the SQL instance as defined in the Utils extension for the SQL Server configuration. Using the Default SQL instance setting will retrieve the current setting from the SQL connection settings of the Utils extension.

NOTE: For more information, review the Connecting to Microsoft SQL Server data source article.
SQL database name

Specify a database name from the selected SQL instance.
SQL table Specify a SQL Table or View from the selected database. Click the [...] button to display a list of tables to choose from.
SQL credentials

Click the [...] button to enter the SQL credentials.

NOTE: Cayosoft Administrator does not support Windows Authentication when connecting to a SQL Server database. The database connection must use SQL Server Authentication, where the credentials (username and password) are created and managed within SQL Server. Mixed Mode refers to the SQL Server configuration that allows both SQL Server Authentication and Windows Authentication, but only the SQL Server Authentication method is supported by Cayosoft Administrator.
Data source filter

You can use the point-and-click filter builder for the specified data source.

NOTE: If the Where clause is also specified, it will be applied and DataSource Filter will be ignored.
Maximum number of objects* Specify the maximum number of objects to modify in the selected scope.
More options
Return these SQL columns

Specify columns returned by the data source.
Where clause

Define a WHERE statement in the SQL query sent to the data source to limit the rows returned by SQL Server.
Filter* Filter the returned query to show matching data only. The setting features filters not supported by the Query criteria setting.
Properties to display*

Define the object properties to display in the output file.
Empty field in data source*

Define the rule behavior in case of an empty field in the data source:

  • Select Clear property value to delete the target property value.

  • Select Ignore to keep the original property value.
Data source anchor attribute*

Select a column in the data source that contains the attribute value for identifying and mapping a user.
Active Directory anchor attribute* Select an AD attribute to compare the data source anchor attribute to when searching for a matching user account.
Initialization script
Script

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

Due to the 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

    Copy
    {$global:DatePeriod = (Get-Date).AddDays(-10)}

  2. Use the $DatePeriod variable in the query criteria builder:

Action section

Setting name Description
Attribute generation rules

Cayosoft Administrator can automatically generate object attributes. Select a generation rule from the list or create your own generation rule to satisfy the requirements and policies of your organization.

Refer to the following video guide to learn more about the expression builder: Expression Builder for Generating UserNames.
Validate display name uniqueness

Enable the uniqueness check of the displayName user attribute.
Alternative name generation rules
Alternative attribute generation rules Cayosoft Administrator can automatically resolve name conflicts and ensure the name attributes are unique. Select an alternative generation rule from the list or create your own generation rule to satisfy the requirements and policies of your organization in case of an attribute generation conflict.

Refer to the following video guide to learn more about the expression builder: Expression Builder for Generating UserNames.
Counter format

Define the counter format to suffix conflicting users with a numeric value and generate unique names across the organizations.

TIP: To use two-digit numbers, specify 00. To start from a specific number (e.g., 5), specify 5.
More options
Name conflict resolution

Define the conflict resolution logic to automatically resolve name conflicts and ensure the name attributes are unique:

  • Suffix the name with a numeric counter value and continue

  • Log error in the Execution History and continue

  • Use alternative generation rules, suffix the name with a numeric counter value and continue

  • Use alternative generation rules, log error in the Execution History and continue

Update targetAddress prefix for user with remote mailbox

Define the update behavior for the targetAddress attribute for users with remote mailboxes.

Remove previous targetAddress value

Set the option to Yes to remove the previous targetAddress value from the proxyAddresses attribute.
Set mail attribute to new Primary SMTP

Define the update behavior for the mail attribute.
Previous email address

Define the action for the previous email address:

  • Remove

  • Keep as a secondary proxy address
Virtual and other attributes
Virtual and other attributes Using the Attribute mapping dialog, map a data source attribute to the target attribute.
Attribute mapping script

Set up attribute mapping using scripts. Refer to the following example:

  • To populate a virtual attribute populated with a string value, use the following line:

    {@{'csvaAttribute1'='YourString'}}

    The csvaAttribute1 value is a name of a virtual attribute in Configuration > Virtual Attributes in the Cayosoft Administrator Console.

Output section

This section defines the output format of this rule.

To get more information about this section, please see the Rule 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 Rule Enforce/Schedule section article.

© Copyright 2013-2026 Cayosoft Inc. All rights reserved.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request
Return to top

Related articles

Comments

0 comments

Article is closed for comments.