> SYSPRO Communications Service

SYSPRO Communications Service

This service allows for client/server communications (i.e. between the SYSPRO Application server and SYSPRO clients). This service replaced CCITCP2 in SYSPRO 7.

Applications using this service

  • SYSPRO client/server

  • Terminal services

  • SYSPRO Office Integration

Getting Started

Installation

  1. Run the SYSPRO_Communications_Service.exe executable.

    You can obtain the file from the Ports and Downloads section of the InfoZone. Otherwise, contact your local reseller for more information.

    After any port updates, we recommend you restart the service to release any e.net business objects which may be held by the service.

    Reinstalling a service is typically only required if an updated and/or improved version of the service is released.

  2. During the installation you will be required to configure settings for the service.

    Recommended best practice is to use a specific network account that has been created for SYSPRO instead of the local system account.

    Installation field Description
    SYSPRO Communications Service  
    Service Name This forms part of the naming convention for the service that is displayed in the Windows Services Management Console.
    Service Description This forms part of the naming convention for the service that is displayed in the Windows Services Management Console.
    Communication Ports
    Port numbers Description
    Below 1023 Reserved for system ports.
    From 1024 to 49151 Recommended user ports.

    Once a port number is assigned, avoid reusing that number for another service as this will cause a conflict.

    From 49152 to 65535 Dynamic ports.
    Service SOAP port This is the port that the service will use to host the SOAP endpoint. If set, SOAP communication must be performed using an address that includes the port number (e.g. http://localhost:{PortNumber}/SYSPROWCFService/Soap).
    Add port to firewall This adds the SOAP port automatically to the firewall.

Configuring SYSPRO Office Integration to use the SYSPRO Communications Service

  1. Run the SYSPRO Credentials function from the SYSPRO OFFICE INTEGRATION tab within the relevant Office application (e.g. Word, Excel, Outlook)

  2. At the Type of Connection and Client Server Setup fields select the Client Server option.

  3. At the IP Address field, enter WCF:SERVER:1978 (where SERVER indicates the name of the SYSPRO Application Server or IP address, and 1978 reflects the default SYSPRO Communications Service port that is in use.

  4. At the Service field, enter WCF:0 (where 0 indicates the SYSPRO instance).

Troubleshooting

Debugging and diagnostics

You can troubleshoot errors or failures when using this service by editing the associated config file in elevated mode (i.e. with administrator privileges).

The SYSPROCOMMSService.exe.config file is located in the folder to which you installed the service and defaults to: C:\Program Files (x86)\SYSPRO\SYSPRO Communications Service\1978\ (where 1978 indicates your entry at the Service SOAP port installation field).

[Note]

You should only edit this file for debugging purposes.

Don't use this as a method to update values for the service. The reason for this is that a wizard installation updates the system registry, which is what is read when using the service. A fresh installation will overwrite these values, which may cause problems when you next run the service.

Key Description
baseaddress The template base address used by the service. For REST and SOAP communication, the schema must be left as http:// even if a different binding is used as the service will configure this automatically.
DetailedLog When set to true the service will output a detailed log file to the temp folder of the machine on which the service is installed.
serviceserversoapbinding The communication binding for the service to use for SOAP communication
serviceclientsoapbinding  
serviceserversoapport This is the port that the service will use to host the SOAP endpoint. If set, SOAP communication must be performed using an address that includes the port number (e.g. http://localhost:{PortNumber}/SYSPROWCFService/Soap).
serviceclientsoapport  
servicesettingssoapport This is the port used by the service to communicate settings with clients
serviceserveraddress  
expirytimeout  
ClientSettingsProvider.ServiceUri  
reliableSessionValue Indicates if reliable session is turned on. When changing this, you must also update the reliableSession variable on the ServerBinding and ClientBinding below
use64bitsyspro  

Service logging

The SYSPRO Communications Service outputs an event log to the SYSPROCOMMS file (Control Panel->Administrative Tools->Event Viewer->Applications and Service Logs) which you can review for diagnosing any problems encountered.

Problem: Service grows quickly and fails

  1. Locate and open the SYSPROCOMMSService.exe.config file.

  2. Against the netTcpBinding node (ServerBinding, ClientBinding and SettingsBinding) ensure that the MaxBufferPoolSize is set to 0. This creates a new pool buffer, which has been shown to yield positive results.