> SYSPRO e.net WCF Service

SYSPRO e.net WCF Service

This service (based on Windows Communication Foundation) exposes the ENCORE.DLL library to internal and external applications that need to interact with SYSPRO (e.g. SYSPRO Espresso, Predictive Search, third party developer applications, etc). Data is retrieved from the SYSPRO database using the open e.net architecture, without compromising data integrity.

This service was developed to replace SYSPRO Web Services. Although still supported, the SYSPRO e.net WCF Service has since been replaced by the SYSPRO e.net Communications Service which includes load balancing functionality. A limitation of the SYSPRO e.net WCF Service is that it is not fault-tolerant (e.g. if a channel fails, the whole service fails). You can set up multiple processes, but this requires installing multiple instances of the service (i.e. each third party application could have a separate service running on its own port number - a time-consuming scenario for administrators to manage).

Applications using this service

  • SYSPRO Server-side Reporting

  • SYSPRO Web-based Product Configurator

  • SYSPRO Executive Dashboard Gadget

  • SYSPRO Workflow

  • SYSPRO Espresso

  • SYSPRO Point of Sale

  • SYSPRO e.net Diagnostics

  • SYSPRO Harmony

  • Any external or third party e.net application accessing SYSPRO data

Getting Started

Installation

  1. Run the SYSPRO_WCF_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.

    Installation field Description
    SYSPRO WCF enet 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.
    SYSPRO Instance This indicates the default instance of SYSPRO with which the service will communicate. SYSPRO instances are reflected in your Windows Registry to identify the Base folder of your SYSPRO install where the necessary .dll and .exe files are located.
    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 SOAP port to firewall This adds the SOAP port automatically to the firewall.
    Service REST port This is the port that the service will use to host the REST endpoint. You must add the REST port to the firewall manually.

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 SYSPROWCFHostService.exe.config file is located in the folder to which you installed the service and defaults to: C:\Program Files (x86)\SYSPRO\SYSPRO WCF Service\20000 (where 20000 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
Language The default language to use with SYSPRO communication. This can be overridden if manually specified during the logon.
LogDetail The default logging detail used by SYSPRO. This can be overridden if manually specified during the logon.
Instance This indicates the default instance of SYSPRO with which the service will communicate. SYSPRO instances are reflected in your Windows Registry to identify the Base folder of your SYSPRO install where the necessary .dll and .exe files are located.
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.
servicesoapbinding The communication binding for the service to use for SOAP communication
servicerestport This is the port that the service will use to host the REST endpoint. You must add the REST port to the firewall manually.
servicesoapport 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).
ReceiveTimeout The maximum length of time a call to the service can take.
SendTimeout The maximum length of time a call to the service can take.

Service logging

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