Rule description
This rule queries the specified SQL data source and сreates Active Directory users with remote linked mailbox accounts according to the Action section settings.
For more details please see Provisioning Linked Mailboxes article.
When to use this rule
Use this rule to when you need to perform bulk provisioning of Active Directory user accounts with remote linked mailboxes.
Rule Settings
Query Section
Setting name | Description |
---|---|
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. |
Properties to display |
Select properties to display for each object found by the query. |
Filter data
|
Set the filtering conditions to only return objects or data that need to be processed by the rule. Example: filter by Name column.
|
Skip user if anchor attribute already exists |
The anchor attribute must be unique in the Data Source. Using the defined Anchor attribute, the rule checks to see if the anchor is already present in Active Directory. If the anchor is present, then this user was previously created, and the row in the Data Source is skipped. |
Data source anchor attribute |
Defines the column in the Data Source that will be used to determine if the user account already exists. This value is compared to the Active Directory Anchor Attribute. Because user names are likely to have duplicates, some other attribute with a unique value should be used to determine if records read from the Data Source have already been processed. |
Active directory anchor attribute |
Defines the attribute in the Active Directory to which the Data Source anchor attribute is to be compared. When a new user is created this value also specifies the Active Directory attribute into which the Data Source anchor is written for comparison the next time the rule is executed. |
Action section
Setting name |
Description |
---|---|
Create master account in |
Specify OU for master accounts creation. |
Create mailbox account in |
Specify OU for mailbox accounts creation. |
Mailbox Account Naming Properties |
|
Logon name (SamAccountName)
|
By default, the SamAccountName is automatically generated from the Data Source assuming the Data Source contains the correct named fields. If field names are not the same as shown for the selected format, contact Cayosoft for an override format. The SamAccountName must have a unique value in the target domain. |
UPNSuffix (@domain.com)
|
It is the domain name component of the new user’s UserPrincipalName (UPN). The default UPN suffix is defined in the Default domain setting in AD Users web query. If you are using Office 365, this value should be set to a domain that has been registered in Office 365/Azure AD. |
UserPrincipalName
|
By default, the UserPrincipalName (UPN) is automatically generated from the Data Source assuming the Data Source contains the correctly named fields. If field names are not the same as shown for the selected UPN format, contact Cayosoft for an override format. The UPN must be a unique value. |
FirstName (GivenName) |
If the Data Source contains a field named FirstName, do nothing. Otherwise, use the Selector button to choose a field from the Data Source.
|
Initials |
|
Last/SurName (sn) |
|
Name (cn)
|
If the Data Source contains fields named FirstName and LastName, choose the desired format or do nothing. |
Display Name
|
|
Description
|
If the Data Source contains a field name Description, do nothing. Otherwise, manually enter a static text value or use the Selector button to choose a field from the Data Source. |
Mailbox Account Alternate Name Generation |
|
Name conflict resolution |
This option determines how the system should react when the name of a user being created already exists. |
Logon Name (SamAccountName) (Alternative) UserPrincipalName (Alternative) Name (cn) (Alternative) Email Address (Alternative) DisplayName (Alternative) |
The behavior of this attribute is the same as in the Contact Info section.
|
Counter format |
This setting specifies the number of fixed symbols the counter should have. |
Add counter when |
Specifies if a counter should always be added to the username, or only when name conflicts occur. |
Mailbox Account Organization Properties |
|
Office Job Title (Title) Department Company Employee Number EmployeeID Division |
If the Data Source contains one of these field names, do nothing. Otherwise, manually enter a static text value or use the Selector button to choose a field from the Data Source. |
Manager identifier |
Use the Selector button to choose a field from the Data Source that is a unique identifier for the user’s manager. Typically this will be the Managers EmployeeNumber or EmployeeID. |
AD attribute for manager lookup |
Select an Active Directory attribute that is used to search for the value of the Manager Identifier specified in the field above. |
Mailbox Account Contact Properties |
|
Country |
Specify the user country. By default, the value is taken from Active Directory extension. |
Email address |
Specify the format for email address. Note: If alternative SMTP addresses are needed, the rule AD Users | Set Proxy Addresses can be run after this rule.
|
Office phone (telephoneNumber) Mobile phone (mobile) Street address City (l) State Postal code |
If the Data Source contains a field with one of these names, do nothing. Otherwise manually enter a static text value or use the Selector button to choose a field from the Data Source.
|
Mailbox Account Other Properties |
|
Other Properties |
If you want every provisioned user to have extension attribute 1 populated with some string value then use this: |
Master Account Naming Properties |
|
Master account UPNSuffix (@domain.com)
|
By default, the first value is taken from the Trusted Domains table in Active Directory extension. |
Master account Logon name (SamAccountName) |
Specify master account naming properties. By default, they are taken from mailbox account.
|
Master account UserPrincipalName
|
|
Master account FirstName (GivenName) |
|
Master account Initials |
|
Master account Last/SurName (sn) |
|
Master account Name (cn)
|
|
Master account Display Name
|
|
Master Account Logon Settings |
|
Default Password |
This setting defines the password for the new account. This value can be static text, a field from the Data Source chosen using the Selection button, or set to Generate Random Password Note: Static passwords or passwords from Data Source must meet the Active Directory Password Complexity Policy of the target container, or the account will be created in a disabled state. Randomly Generated Passwords will be generated to match both the Active Directory Password Complexity Policy and additional complexity requirements defined in the Cayosoft Administrator Password Complexity Policy.
|
Must change password at next logon Account enabled User cannot change password Password never expires |
These settings enable/disable the standard Active Directory user object settings. |
Account Expiration Date |
This setting defines the Account Expiration attribute in Active Directory. In addition to populating this field from the Data Source, a text string can also be manually entered into the field in the format MM/DD/YYYY or YYYY-MM-DD. |
Master Account Other Properties |
|
Other Properties |
If you want every provisioned user to have extension attribute 1 populated with some string value then use this: |
Remote Mailbox Settings |
|
Remote Routing Address |
Specify the format for remote routing address. |
Enable automatic email address updates by address policy |
By default, Exchange contains an email address policy for every mail-enabled object. For more information, please see this article https://docs.microsoft.com/en-us/exchange/email-address-policies-exchange-2013-help. If the Exchange address policy is applied, it generates email addresses automatically. By default, this policy is not enabled, Cayosoft Administrator generates the email address by itself. |
Enable in-place archive |
Select Yes to create an in-place archive mailbox. |
Notify Manager |
|
Notify Manager |
Specify whether you want to notify the manager when the user is created. You can also select send email for each created user or send one email for all created users. |
Additional to |
Additional email can be sent to Default Notify & Alert Email Address - usually, this is the administrator's email address. |
CC, BCC |
Email address where the copy will be sent. |
From |
Users can receive emails from default SMTP from address. |
Subject |
Email subject. Tip: It is possible to customize email subject by using different tokens, see Customizing an automation rule or web action output email – Cayosoft Help Center.
|
Message |
Message text. Tip: It is possible to customize email message by using different tokens, see Customizing an automation rule or web action output email – Cayosoft Help Center.
|
Limit the number of emails sent per minute |
An integer value that represents the number of emails sent per minute by this rule. To change the default value, navigate to Home > Configuration > Settings > Email Settings (SMTP). The default limit for Office 365 SMTP gate is 30 emails per minute. |
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 |
---|---|
8.0.0 | Execution history name setting is deleted. |
7.3.0 | Data Source filter is added. |
7.2.0 | Limit the number of emails sent per minute setting is added. |
6.3.1 | The rule is introduced in the product. |
Comments
0 comments
Please sign in to leave a comment.