> SYSPRO WCF Service Introduction

SYSPRO WCF Service Introduction

The SYSPRO WCF Service allows you to retrieve data from the SYSPRO database using e.net architecture without compromising data integrity. It is an open architecture that supports the REST protocol which enables third party developers to interact with SYSPRO using the Encore.dll library.

The following applications currently use this service:

  • SYSPRO Executive Dashboard Gadget
  • SYSPRO On-the Go iPhone application
  • Any external or third party e.net application accessing SYSPRO data

Utilities class

Logon

This method must be performed first to obtain a UserId (Guid) before calling any operations in the SYSPRO WCF Services. This UserId can be used for subsequent calls to other methods. The Logon operation must be called with the relevant user credentials. The Encore instance must be specified in the format: EncoreInstance_X (e.g. for BaseDir2, use EncoreInstance_2).

Sample usage:

http://{servername}/SYSPROWCFService/Rest/Logon?Operator={Operator}

Append the following details:

  • &OperatorPassword={OperatorPassword}
  • &CompanyId={CompanyId}
  • &CompanyPassword={CompanyPassword}
  • &LanguageCode={LanguageCode}
  • &LogLevel={LogLevel}
  • &EncoreInstance={EncoreInstance_0}
  • &XmlIn={XmlIn}

Logoff

This method can be called once you have performed the relevant method call and require the system to logoff.

Sample usage:

http://{servername}/SYSPROWCFService/Rest/Logoff?UserId={UserId}

Get Logon Profile

This method returns XML containing information about the user who is currently logged on.

Sample usage:

http://{servername}/SYSPROWCFService/Rest/GetLogonProfile?UserId={UserId}

Query class

Browse

Sample usage:

http://{servername}/SYSPROWCFService/Rest/Query/Browse?UserId={UserId}

Append the following details:

  • &XmlIn={XmlIn}

Fetch

Sample usage:

http://{servername}/SYSPROWCFService/Rest/Query/Fetch?UserId={UserId}

Append the following details:

  • &XmlIn={XmlIn}

Query

Sample usage:

http://{servername}/SYSPROWCFService/Rest/Query/Fetch?UserId={UserId}

Append the following details:

  • &BusinessObject={BusinessObject}
  • &XmlIn={XmlIn}

Setup class

Add

Sample usage:

http://{servername}/SYSPROWCFService/Rest/Setup/Add?UserId={UserId}

Append the following details:

  • &BusinessObject={BusinessObject}
  • &XmlParameters={XmlParameters}
  • &XmlIn={XmlIn}

Update

Sample usage:

http://{servername}/SYSPROWCFService/Rest/Setup/Update?UserId={UserId}

Append the following details:

  • &BusinessObject={BusinessObject}
  • &XmlParameters={XmlParameters}
  • &XmlIn={XmlIn}

Delete

Sample usage:

http://{servername}/SYSPROWCFService/Rest/Setup/Delete?UserId={UserId}

Append the following details:

  • &BusinessObject={BusinessObject}
  • &XmlParameters={XmlParameters}
  • &XmlIn={XmlIn}

Transaction class

Build

Sample usage:

http://{servername}/SYSPROWCFService/Rest/Transaction/Build?UserId={UserId}

Append the following details:

  • &BusinessObject={BusinessObject}
  • &XmlIn={XmlIn}

Post

Sample usage:

http://{servername}/SYSPROWCFService/Rest/Transaction/Post?UserId={UserId}

Append the following details:

  • &BusinessObject={BusinessObject}
  • &XmlParameters={XmlParameters}
  • &XmlIn={XmlIn}

Hint and tips

Connectivity loss

  • You can use the KeepAlive options (System-wide Personalization) to assist in minimizing loss of connectivity on the network to the SYSPRO server ( i.e. Packet priority management, bandwidth throttling).

Downloading the SYSPRO WCF Service

  1. Open the SYSPRO Support Zone.

  2. Select Web Interface from the Downloads section.

  3. Select the SYSPRO WCF Services link.

  4. Select SYSPROWCFServiceSetup.zip.

  5. Save the file to a folder on your local system.

  6. Extract the contents of the file.

Installing SYSPRO WCF Services

  1. Run the SYSPRO WCF Services install file.

    You can obtain the file from the SYSPRO Installation DVD, or from the Downloads section on the Support Zone.

  2. Follow the instructions presented by the installation wizard.

    • You will need to indicate the host settings at the Service Base Address field.

    • You will need to indicate the folder to which you want to install the SYSPRO WCF Service.

Checking the status of the SYSPRO WCF Service

You would typically use this procedure as part of a troubleshooting exercise where you suspect that the service has failed to start.

  1. Load the Event Viewer management tool (Control Panel > System and Security > Administrative Tools > Event Viewer).

  2. Locate the SYSPROWCF entry (Event Viewer > Applications and Services Logs > SYSPROWCF).

  3. Review the log details for the service.

Starting the SYSPRO WCF Service manually

You would typically use this procedure when an application that requires this service to be running (e.g. SYSPRO Desktop Gadgets) indicates that it is unable to connect to the service.

  1. Load the Windows Component Services management tool (Control Panel > System and Security > Administrative Tools > Component Services).

  2. Locate the SYSPRO WCF Service from the Services pane.

  3. Start the service.