SYSPRO 8 Active Directory Sync Service

The SYSPRO.AD.Sync.Service.exe.config file is located in the same folder in which the service is installed.

If you need to make changes to the file, we suggest the following alternative options:

• Uninstall the service
• Create a custom.config file

To create a custom.config file, make a copy of the SYSPRO.AD.Sync.Service.exe.config file and rename it to custom.config.

The custom.config file can then contain the entry you want to modify and the startup node. Any entries not contained in the custom.config file are retrieved from the original SYSPRO.AD.Sync.Service.exe.config file.

You can view monitoring and troubleshooting messages about this service using the Event Viewer function in Windows:

(Control Panel > System and Security Administrative Tools > Event Viewer > Applications and Service Logs)

However, this depends on the logging level defined in the Service.config file.

You can start, stop, restart and configure this service using the Services function in Windows:

(Control Panel > System and Security Administrative Tools > Services)

The SYSPRO 8 Active Directory Sync Service must be run as a named user that has READ permission to access Microsoft Active Directory (AD).

The PollInterval is set to default every 12 hours, but can be changed if required.

The minimum setting is 0.30 minutes.

None.

The synchronization between SYSPRO and Microsoft Active Directory (AD) is a one-way service.

SYSPRO operators defined as AD Managed are managed by Microsoft Active Directory (AD) and updated accordingly in SYSPRO automatically when the SYSPRO 8 Active Directory Sync Service runs.

The following operator attributes are managed by Microsoft Active Directory (AD) and cannot be maintained in SYSPRO for Active Directory operators:

• Operator name
• Operator email address
• Network user name
• Operator status (i.e. Active, Disabled or Removed)

You can rename the SYSPRO.ERP security group in Microsoft Active Directory (AD) by adding a suffix to the group name.

When you install the SYSPRO 8 Active Directory Sync Service (using the SYSPRO Installer app) ensure that you enter this suffix at the Security Group Suffix parameter field.

If required, you can update the suffix after installing the SYSPRO 8 Active Directory Sync Service:

1. Create a custom.config file:

   To create a custom.config file, make a copy of the SYSPRO.AD.Sync.Service.exe.config file and rename it to custom.config.

   The custom.config file can then contain the entry you want to modify and the startup node. Any entries not contained in the custom.config file are retrieved from the original SYSPRO.AD.Sync.Service.exe.config file.

   You should ideally stop the service while you do this, otherwise the configurations will be picked up at the next poll interval.

2. Update the ADSecurityGroup key's value with the new security group name.

If you have configured receiving emails in the System Setup program (Review email required, Failure email required, Success email required) the following variables are passed to the email templates when the Microsoft Active Directory (AD) synchronization takes place:

• $SsoUserCount$

  Count of users added for review.

• $SsoOpChanged$

  Count of operators with changes (e.g. email, name).

• $SsoOpActivated$

  Count of operators whose status has changed to active from disabled or removed.

• $SsoOpDisabled$

  Count of operators whose status has changed to disabled.

• $SsoOpRemoved$

  Count of operators whose status has changed to removed.

• $FailedMsg$

  If the synchronization fails, then this contains the message as written to the log file.