Configure settings for Synch Service
Important
This content is archived and is not being updated. For the latest documentation, see Microsoft Dynamics 365 product documentation. For the latest release plans, see Dynamics 365 and Microsoft Power Platform release plans.
Applies To: Microsoft Dynamics AX 2012 R2, Microsoft Dynamics AX 2012 Feature Pack
This topic describes how to use the Synch Service Settings wizard to manage Commerce Data Exchange: Synch Service. You must have administrative credentials to open the Synch Service Settings wizard.
Note
Synch Service is required for Retail only in Microsoft Dynamics AX 2012 R2 and Microsoft Dynamics AX 2012 Feature Pack. In Microsoft Dynamics AX 2012 R3, this component is used only to support previous versions of Retail POS while you upgrade (N-1).
Click Start > All Programs > Microsoft Dynamics AX > Commerce Data Exchange > Synch Service > Service Settings to open the wizard.
To register an instance of Synch Service, type the name of the instance in the Server name field, and then click Add. By default, the local computer name is displayed. This step associates the instance of Synch Service with the local message database.
To manage an existing instance, select the instance in the All Servers list. You can also start or stop an instance on this page.
Tip
To prevent confusion, use a unique name for each instance of Synch Service in the organization.
Click Next.
On the Service properties page, enter the following information, or accept the default settings.
Option
Description
Packet Owner
If you select 2nd Stage Synch Service in the Server mode field, specify the server where packages originate.
Server mode
In most cases, you should select Synch Service. However, if the selected instance of Synch Service is a forwarder, select 2nd Stage Synch Service.
Server port
Enter the listening port for Synch Service. This setting is not available for a forwarder instance, because in that case, the service only forwards packages. If you plan to run more than one instance of the service on the same computer, you must change the port values so that they do not conflict with other services.
Use the Off button to turn the server listening port on or off. We do not recommend that you turn the port off.
Telnet port
Enter the port that is used by the Synch Service Telnet interface. This feature lets you use Telnet to monitor the status of Synch Service. If you also run a Telnet server on the computer, assign the Synch Service interface to another port to conflicts.
Click Next.
On the Synch Service specific properties page, enter the following information, or accept the default settings.
Option
Description
Working Directory
The path of the folder where Synch Service keeps temporary files and package files, if it is configured to keep package files. To change this path, click Browse.
Days Messages Exist
Enter the number of days to keep incoming or outgoing messages that have been processed. If you type a value of 0 in this field, messages are not deleted.
Timer Interval
Enter the interval at which Synch Service checks for packages that must be reprocessed.
Limit Job Process (cnt)
Enter the maximum number of job records that Synch Service processes per connection. You should set this field to a lower value when the average package size is high, and to a higher value when the average package size is low. To disable the feature, enter a value of 0. We do not recommend that you disable this feature.
This feature ensures that Synch Service continues to process job records, even if it has a heavy load that might typically cause it to stop responding. Additionally, when this feature is on, if the first job record in the batch has an error, the remaining packages are skipped for the run.
Click Next.
On the Synch Service Properties page, enter the following information, or accept the default settings.
Option
Description
Hold Connections
Enter the number of connections to the source database that Synch Service should reserve.
Idle Conn. Time
Enter the number of idle minutes before the reserved connections time out and are released.
Thread Timeout
Enter the number of seconds before threads that are used in connections to remote locations time out.
Max. Forw. Threads
Enter the maximum number of threads that can be used concurrently to send packages.
Max Hop counter
Enter the maximum number of transfers, per package, between instances of Synch Service. This setting prevents infinite loops that can be caused by a Synch Service instance that is incorrectly configured.
Socket Timeout
Enter the number of seconds that Synch Service waits for the network to finish a particular send or receive operation. To prevent Synch Service from shutting down just because it is waiting for the network, set this field to a value that is lower than the value in the Thread Timeout field.
Retry Interval
Enter the interval at which Synch Service makes another attempt to perform an operation on a package that failed.
Maximum retries
Enter the number of attempts before Synch Service stops trying to perform an operation on a package.
Forw. Attempts
Enter the maximum number of attempts that Synch Service makes to forward a packet. This setting works only on a forwarder instance.
Use Processor
Enter the processor that the service should run on. If you want the operating system to allocate processors, select All Processors.
Disable IPsec
Select this option to bypass the IPsec requirements of Synch Service. For more information, see Configure or bypass IPsec for Synch Service.
.gif "Note")
Note
If the Disable IPsec option is selected for a distribution location in Retail Scheduler, the Disable IPsec option in Synch Service Settings should be selected for all instances of Synch Service that communicate with that location.Prefer IPV6
Select this check box to use the IPv6 communication protocol, if it is enabled.
Click Next.
On the Server debugging properties page, enter the following information, or accept the default settings.
Option
Description
Keep Package Files
Select this option if you want to save the packages of exchanged information so that you can view them by using Synch Service Pack Viewer. When this option is selected, Synch Service does not delete the temporary package files from the working directory.
Do not enable this feature for a long time, because it can cause you to run out of disk space and prevent Synch Service from operating correctly. For more information about Pack Viewer, see Synch Service Pack Viewer.
Exception Dump
Select this option to create a memory dump file if Synch Service suddenly stops working.
Log/Dump Dir
Enter the folder where log files are saved. Confirm that the folder that you specify actually exists.
Log Mode
Select this option to log Synch Service operations in the manner that is specified by the Log Level settings.
When Write to Windows event log is selected, Synch Service writes the logging data to the Windows event log.
Max Lines/Logfile
Enter the maximum number of lines in each log file. Synch Service creates three log files. When the maximum number of lines has been reached in one log file, Synch Service rotates to the next log file. At startup, Synch Service makes a copy of the old log files by appending .old to their names. Therefore, if the service has been set to automatically restart when a failure occurs, the failure appears in the old log files.
Log Level
Select the amount of error logging that occurs. Usually, Error logging and Main logging are sufficient, but more detail might be helpful in some cases. The following levels are available:
Error – All errors that are reported from Synch Service are logged.
Main – The main operations in Synch Service are logged.
Actions – Detailed information about operations in Synch Service is logged.
Detail – Very detailed information about operations in Synch Service is logged.
Functions – Highly detailed and technical information about operations in Synch Service is logged. This option is intended for use by developers only.
.gif "Important")
Important
The logging that is specified by the Log Level settings can occur only if the Log Mode option is selected.Click Finish. To configure another instance of Synch Service, select the instance in the All Servers list, and then repeat the steps in this procedure.
When the configuration is completed, close the wizard.
On a Microsoft Dynamics AX client computer, modify the Application Object Server (AOS) profile so that it uses this instance of Synch Service. For more information, see Set up an AOS profile.