User AD Sync Job
Overview
The AD User Sync job reads user information from Active Directory and updates the corresponding properties in Atria. It processes existing provisioned Atria users, using their stored SAM account names to find the AD accounts. It does not discover and import new AD users.
At a high level, the job:
- Loads the platform, private and shared AD environments and their customers.
- Loads each customer's provisioned users and effective user display-property mappings.
- Queries AD in batches for the account properties and mapped attributes.
- Saves returned values into Atria and records processing messages in the job run.
This is separate from the AD Sync Service, which synchronises users and passwords between customer and hosted AD environments. This job reads information from AD into Atria; it does not copy passwords.
Properties synchronised
Account, password and mailbox status
The job explicitly saves these seven properties:
| AD property | Atria property | Meaning |
|---|---|---|
LockedOut | Locked | Whether the account is locked. |
PasswordExpired | Expired | Whether the password has expired. |
PasswordNeverExpires | NeverExpires | Whether password expiry is disabled. |
Enabled | Disabled | The inverse of AD's enabled state. |
msDS-UserPasswordExpiryTimeComputed | ExpirationDate | Password expiry date, rather than account expiry. |
msExchMailboxGuid | MailboxGUID | Exchange mailbox identifier, where available. |
LastLogon | LastLogon | Latest logon returned by responding domain controllers. |
PasswordLastSet is also requested, but this job does not persist it. Last logon depends on which domain controllers can be contacted and successfully queried.
Default AD display-property mappings
The job also reads user display properties with a populated ADAttribute mapping. The following are the mappings supplied in the default database definitions. Customer-specific overrides and custom properties can change the effective list.
| Atria display label | Atria property | AD attribute |
|---|---|---|
| First Names | givenName | givenName |
| Last Name | sn | sn |
| Display Name | displayName | displayName |
| UPN | userPrincipalName | userPrincipalName |
| Username | sAMAccountName | sAMAccountName |
| Title | title | title |
| Department | Department | Department |
| Location | physicalDeliveryOfficeName | physicalDeliveryOfficeName |
| Manager | manager | manager |
| Test User | employeeType | employeeType |
| Phone Number | telephoneNumber | telephoneNumber |
| Home Phone | homePhone | homePhone |
| Mobile | mobile | mobile |
| IP Phone | ipPhone | ipPhone |
| Pager | pager | pager |
| Fax | facsimileTelephoneNumber | facsimileTelephoneNumber |
| Street | streetAddress | streetAddress |
| P.O. Box | postOfficeBox | postOfficeBox |
| City | l | l |
| State/Province | st | st |
| Zip/Postal Code | postalCode | postalCode |
| Country | co | co |
| Description | description | description |
| Notes | info | info |
| Web Page | wWWHomePage | wWWHomePage |
The mapped value is saved under the Atria property name. These mappings are independent of the job's batching configuration. Review the customer's effective User display properties in Display Properties when investigating which additional attributes are included. A property without an AD attribute mapping is not requested through this mechanism.
Although sAMAccountName is mapped by default, the job searches AD using the SAM account name already stored in Atria. If oldname is renamed to newname directly in AD, the job still searches for oldname. It cannot discover and apply that rename through this lookup. Check account matching before relying on the job to reflect identity changes.
Installation
The customer's AD connection must be configured and reachable through Atria's Active Directory API. The job requires existing provisioned Atria users with matching AD SAM account names.
On the Provisioning Server, use an administrative PowerShell session:
Get-AtriaComponent -Name AdUserSync
Import-AtriaExtension -Extension AdUserSync
The import command installs or updates the extension. See extension import parameters for version and restart options.
Open Configuration > Provisioning & Debug Tools > Jobs and look for AD User Sync. The Atria installer creates this job during platform installation or upgrade; inspect the existing job before creating another.
If a job is absent and you need to create one, choose + Add, set a descriptive label, and select the AD User Sync task. Start with configuration {} to use the defaults. Choose scheduled or on-demand execution as described in Jobs System.
Configuration
Scheduling and execution
Use the job's execution controls to configure when it runs, the CRON expression and log level. Check the actual schedule on your installation; an example nightly schedule is 0 1 * * * (01:00 UTC). The installer may have converted a local installation-time schedule to UTC.
The default configuration is:
{}
For explicit batching settings, use:
{
"ShardConfiguration": {
"Strategy": "smallestsize",
"MaximumShards": 4,
"ShardKey": 0,
"UserBatchSize": 20
}
}
Job parameters
All parameters below are nested under ShardConfiguration. A shard is a parallel group of work.
| Parameter | Default | Behaviour |
|---|---|---|
Strategy | smallestsize | Balances work using customer user counts. Use roundrobin for round-robin distribution; other values fall back to smallestsize. |
MaximumShards | 4 | Maximum parallel work groups. Values of zero or less fall back to 4. |
ShardKey | 0 | 0 groups by customer ID; 1 groups by environment ID. |
UserBatchSize | 20 | Users included in each AD request. Values of zero or less fall back to 20. |
These settings control workload distribution and request size. They do not select attributes, customers or individual users. Additional attributes come from the effective display-property mappings described above.
Verify a run
Save the job and run it manually from the job's actions menu. Open its run details and check the customer, batch and user messages. Compare a known user's AD value with its corresponding Atria property.
If a user is missing, check that they are provisioned in Atria and their stored SAM account name matches AD. If an additional property is missing, check its effective AD attribute mapping and whether the attribute exists in that AD schema. Review user-level errors as well as the overall result: processing can continue after an individual user or batch fails.