Articles in this section

See more
Print

(Legacy) Import SQL Data | Suspend AD Users rule

  • Updated
Follow
Important: Starting from Cayosoft Administrator version 10.3, the Suspend Tool was migrated to Administrator Service with significantly improved functionality. All default suspend configuration settings are now in the Administrator Console in the new 'Suspend Configurations' node.

Use the new Import SQL Data | Suspend AD Users rule.

Rule description

This rule queries the specified Microsoft SQL data source and suspends matching Active Directory user accounts according to the settings specified in the provided Cayosoft Suspend Policy file. 

Note: Starting from version 7.3.0, this rule also supports mapping between Active Directory user account and Cloud user account by anchor attributes. For details, please see How to map Active Directory users to Office 365 cloud users article.

 

When to use this rule

Use this rule when you need to suspend Active Directory user accounts based on the data in the external data source, for example, the HR system. Please see the Creating and saving custom suspend policy article for details on providing the Cayosoft Suspend Policy file. 

Remember to configure the related Office 365 user account suspend settings in the Suspend | Office 365 User rule.

 

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 specific OU.

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

SQL Instance

 

Specify the name of the SQL Instance as defined in the Utils Extension 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, please see Connecting to Microsoft SQL Server data source article.

SQL Database Name

Specify database name from selected SQL Instance.

SQL Table

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

SQL Credentials

Specify the database from the data source SQL Instance. Click the [...] button to enter SQL Credentials.

Note: Windows Authentication cannot be used to access a Microsoft SQL Server database. The account must be a Mixed Mode or SQL Account.

Data Source Filter

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

Note: If Where Clause is also specified, it will be applied and DataSource Filter will be ignored.
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.

Returned Properties

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

Filter

 

Set the filtering conditions to only return objects or data that need to be processed by the rule.

Example: filter by Name column.

 
Sort by Specify column to sort the result objects list.

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 suspend a matching account.

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.

 

Action Section

Setting name Description
Default suspend settings

It is possible to use default user suspend settings file or custom suspend settings file.

To select custom suspend settings file, click [...] button.

Default User Suspend Settings File is the file specified in HOME > CONFIGURATION > Active Directory configuration, Cayosoft Suspend Policies section. 
Suspend related Office 365 user

Set to Yes to suspend a matching Office 365 user account.

Configure the Office 365 user account suspend settings in the Suspend | Office 365 User rule.
Suspend related Skype On-Premises User Set to Yes to suspend Skype Server service for the on-premises user.

 

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
7.3.0
  1. Data Source filter is added.
  2. The rule supports mapping between Active Directory user account and Cloud user account by anchor attributes.

 

Related articles

Comments

0 comments

Please sign in to leave a comment.