Open Reporting API

The Open Reporting API reduces duplication by letting developers and external applications call on SYSPRO to run and distribute reports and documents directly in the external application.

Leveraging the SYSPRO Reporting Service Server infrastructure, developers can query the SYSPRO database and produce the required documents which are added to the print queue from where they can be viewed, executed and managed. Developers can choose whether to access the document via the report queue or the API for further automation (a destination code indicates the origin of the queue item).

PDF version

Exploring

ClosedRelated Information

PDF and Video Resources

Feature Guides

Video Highlights

Starting

ClosedPrerequisites

Before using the Open Reporting API, ensure that Server-side Printing is working correctly in SYSPRO.

The following is required:

ClosedServer
  • Reporting Host Service

  • Crystal Reports Server Embedded (CR 2013) SP8

  • SAP BusinessObjects BI platform .Net SDK Redistributable 64-bit 4.2. SP3

ClosedClient

  • Browser pop-ups must be enabled.

    This is only applicable for previewing PDFs in a web-browser application.
ClosedSYSPRO configuration requirements

  • Server side reporting (configured within the SYSPRO System Setup program).

  • e.Net Service Details (configured within the SYSPRO System Setup program).

ClosedRestrictions and Limits

  • When emailing a document, only one email address can be entered in the To and CC lines.

  • Known limitations:

    The following are known limitations, which will be addressed during the lifetime of SYSPRO 8:

    • Batch printing is currently not supported.

    • Documents that are printed using this architecture are currently not added to the document archive.

      The generated documents are stored in the SRS document queue used for server side printing and will be visible from the SRS Document Queue program. However, they are not added to the document archive.

      There will be no PDF file in the SRS Document Printing archive folder, nor will the document be visible in the Document Archive Viewer.

    • This functionality is limited to the following document types:

      • Invoice

      • Delivery note

      • Order acknowledgment

      • AR statements

      • Quotes
      • Factory documentation
      • Purchase order

      • Dispatch notes

      Support for other documents and reports will be made available in the future.
ClosedSetup Options
ClosedSystem Setup

The System Setup program lets you configure your SYSPRO environment. These settings can affect processing within this program.

Program List > Administration > General Setup

ClosedE.Net Service Details
  • Server name
  • SOAP port
  • REST port
ClosedReporting
  • Reporting configuration
  • Server-side configuration

Solving

ClosedFAQs
ClosedWhere can I download the SYSPROSRSClientLibrary.dll?

The SYSPROSRSClientLibrary.dll assembly file is located in your SYSPRO \Base folder.

It is placed into this folder during the installation of SYSPRO 8.

ClosedWhere can I find the SYSPROSRSDocumentAPI.dll assembly?

This file is no longer in use and has been replaced by the SYSPROSRSClientLibrary.dll assembly file.

The SYSPROSRSClientLibrary.dll assembly (located in your \Base directory) is used by all applications that want to use the functionality of the SRS API.

ClosedWhere can I see the host service end-point in SYSPRO?
  1. Load the System Setup program (SYSPRO Ribbon bar > Setup > General Setup).
  2. Navigate to the Reporting tab.
  3. The host service end-point is displayed at the Reporting service field of the Server-side configuration section.

Using

ClosedTasks
ClosedInstalling/starting the SRS Host Service

The SYSPRO 8 Reporting Host Service install file is named: SYSPRO.8.REPORTING.HOST.SERVICE.EXE.

It is deployed with the SYSPRO Installer and can be installed automatically when SYSPRO 8 is installed.

We recommend stopping the SYSPRO 8 Reporting Host Service before any updates are done and restarting it thereafter.

You only need to reinstall the service if an updated and/or improved version of the service is released.
ClosedConfiguring server-side reporting

  1. From the System Setup program, select the Reporting tab.

  2. Configure the required settings:

    Field Action

    Reporting configuration

    Select Server-side reporting using SQL.

    SQL Server name

  3. Enter the name of the SQL Server instance that contains the _SRS database.
    		4.

    Reporting authentication

     

    Select the type of authentication you will use.

    If you select Windows authentication, ensure that the user name supplied can create a database and has read/write permissions.

  4. Save your changes.

    Ensure that you can successfully print the document type using SYSPRO before trying to print it using the API.

ClosedHow to use the API

All API calls are done via the SRS library.

  1. Create a new project and add the DLL as a reference.

  2. Use the five available methods to query and generate documents.

ClosedHow to add a reference to the client library assembly

  1. Open the solution.

  2. Select the Solution Explorer (View > Solution Explorer).

  3. Right-click on References in the Solution Explorer pane of the project and select Add Reference.

  4. Select Browse and navigate to the \Base folder.

  5. Select SYSPROSRSClientLibrary.dll and select Add.

  6. Ensure the assembly is checked in the list of assemblies and select OK.

Referencing

ClosedAPI Methods

The exposed API methods can be used in a number of ways:

  • Authentication.

  • Controlling login and logout.

  • Controlling the formats of the documents.

This lets customers with login credentials access their data to generate documentation from third-party applications. External or third-party applications like SYSPRO Espresso can request the information from the API and, once received, apply it to generate the required documents.

The SYSPROSRSClientLibrary.dll assembly (located in the \Base folder) allows an application like SYSPRO Espresso to call the SYSPRO 8 Reporting Host Service in order to create the documents.

The following API methods are exposed:

Method Description

AuthSysproUser

This controls and authorizes the logging on of users. This method returns a session ID.

AuthenticateSysproGUID

This controls and authorizes access of users that are already logged in. This method returns a session ID.

LogOffUserSession

This logs off sessions of stand-alone applications.

DetermineDocument Options

This provides a list of formats for the selected document type. This method returns XML with details of available documents and formats.

It only returns SRS formats and looks at the control file (i.e. sales order control file), to determine which formats are defined for SRS according to the governing business rules.

For the Sales Order Document Printing functionality, this method returns the following that can be used to determine which document types can be printed:

  • Sales order number

  • Sales order status

  • Sales order flags

  • Dispatch note number

ProduceDocument

This generates the document to print on the host server.

When previewing the document, it is returned in a HEX encoded format of a PDF document

A third-party developer will have to convert the content back to ASCII format, before saving it to disk.

The input XML is passed to the business object, which in turn communicates with the Document Print program. The SYSPRO 8 Reporting Host Service uses the XML returned from the Document Print program, to generate the document using the selected format.

The following codes are used for the sales order documents types:

  • I - invoice
  • D - delivery note
  • O - order acknowledgment
  • N - dispatch notes
ClosedSample XML
Get document details
ClosedxmlParam

None

ClosedxmlIn 
<Query>
<Option>
<Function>GETDOCDET</Function>
</Option>
<Filter>
<OrderNumber FilterType='S' FilterValue='791' />
</Filter>
</Query>
ClosedxmlOut 
<DocumentControl Language="05" Language2="EN" CssStyle="" DecFormat="1"
DateFormat="01" 
Role="01" Version="8.0.001" OperatorPrimaryRole="   ">
<DocumentInformation>
<SalesOrder>000791</SalesOrder>
<OrderStatus>9</OrderStatus>
<Translated_OrderStatus>Complete</Translated_OrderStatus>
<ActiveFlag>N</ActiveFlag>
<Translated_ActiveFlag>No</Translated_ActiveFlag>
<CancelledFlag />
<Translated_CancelledFlag>No</Translated_CancelledFlag>
<SODocumentType>O</SODocumentType>
<Translated_SODocumentType>Order</Translated_SODocumentType>
<CanPrintAcknowledgement>false</CanPrintAcknowledgement>
<CanRePrintAcknowledgement>false</CanRePrintAcknowledgement>
<CanPrintDeliveryNote>false</CanPrintDeliveryNote>
<CanRePrintDeliveryNote>false</CanRePrintDeliveryNote>
<CanGenerateInvoice>false</CanGenerateInvoice>
<Documents>
<Invoice>
<InvoiceNumber>100506</InvoiceNumber>
<InvoiceSource>O</InvoiceSource>
<Translated_InvoiceSource>Order</Translated_InvoiceSource>
<DateLastInvPrt>2015-04-08</DateLastInvPrt>
</Invoice>
</Documents>
<Formats>
<Format>
<DocumentType>Order Acknowledgement</DocumentType>
<FormatCode>0</FormatCode>
<FormatName>Order Acknowledgemen</FormatName>
</Format>
<Format>
<DocumentType>Delivery Note</DocumentType>
<FormatCode>0</FormatCode>
<FormatName>Delivery Note</FormatName>
</Format>
<Format>
<DocumentType>Invoice</DocumentType>
<FormatCode>0</FormatCode>
<FormatName>Invoice</FormatName>
</Format>
</Formats>
</DocumentInformation>
</DocumentControl>
Produce document
ClosedxmlParam 
<DocumentControl>
<DocumentType>SalesOrder</DocumentType>
<Print>False</Print>
<Email>False</Email>
<Preview>True</Preview>
<XmlOnly>False</XmlOnly>
<PrinterDetails>
<PrinterName />
<PrintCopies>1</PrintCopies>
<PrintCollate>True</PrintCollate>
</PrinterDetails>
<CanPrintAcknowledgement>false</CanPrintAcknowledgement>
<EmailDetails>
<EmailFromAddress />
<EmailToAddress />
<EmailCCAddress />
<EmailToAddress />
<EmailBodyText />
</EmailDetails>
</DocumentControl>
ClosedxmlIn 
<Query>
<Option>
<Function>ONLINE</Function>
<DocumentType>I</DocumentType>
<Format>0</Format>
<Reprint>Y</Reprint>
</Option>
<Filter>
<OrderNumber FilterType='S' FilterValue='000791' />
<InvoiceNumber FilterType='S' FilterValue='100506' />
</Filter>
</Query>
Closedxmlout 
<Query>
<Document>
<Status />
<DocumentGuid/>
<ErrorMessage/>
<StatusPreview/>
<DocumentHex>HEX Encoded PDF file</ DocumentHex >
<Document>
</Query>
ClosedSample Code

The following sample code is provided to assist you to use the API.

The sample code is provided in C# and is specifically for sales order document types. It needs to be adjusted if used for other document types.

Create the SYSPROSRSClient object

// Replace "localhost:20140" with the endpoint of your
// SRS reporting host service
// See Reporting service field on Reporting tab in System Setup
SYSPROSRSClientLibrary.SYSPROSRSClient _sysproSRSClient = 
new SYSPROSRSClientLibrary.SYSPROSRSClient("localhost:20140");
Authenticate to the service using operator and company code

string sessionId = _sysproSRSClient.AuthenticateSYSPROUser
({OperatorCode}, {OperatorPassword}, {CompanyCode}, {CompanyPassword});
Authenticate to the service using Logon GUID
You would only use this function if you already have a session ID that you want to use.

string sessionId = _sysproSRSClient.AuthenticateSYSPROGuid({GUID});

Determine the available document options for sales order document types

StringBuilder xmlIn = new StringBuilder();
xmlIn.Append("<Query>");
xmlIn.Append("<Option>");
xmlIn.Append("<Function>GETDOCDET</Function>");
xmlIn.Append("<IncludeFormatDetails>Y</IncludeFormatDetails>");
xmlIn.Append("</Option>");
xmlIn.Append("<Filter>");
xmlIn.AppendFormat("<OrderNumber FilterType='S' FilterValue='{0}' />", 791); 
// Where 791 is the Sales Order number
xmlIn.Append("</Filter>");
xmlIn.Append("</Query>");
string documentOptions = _sysproSRSClient.DetermineDocumentOptions(
_sessionId, "SalesOrder", xmlIn.ToString());
// See documentation for sample XML out
Produce the document for sales order invoice

StringBuilder xmlParam = new StringBuilder();
xmlParam.Append("<DocumentControl>");
xmlParam.Append("<DocumentType>SalesOrder</DocumentType>");
xmlParam.Append("<Print>False</Print>");
xmlParam.Append("<Preview>True</Preview>");
xmlParam.Append("<XmlOnly>False</XmlOnly>");
xmlParam.Append("<PrinterDetails>");
xmlParam.Append("<PrinterName />");
xmlParam.Append("<PrintCopies>1</PrintCopies>");
xmlParam.Append("<PrintCollate>True</PrintCollate>");
xmlParam.Append("</PrinterDetails>");
xmlParam.Append("<EmailDetails>");
xmlParam.Append("<EmailFromAddress />");
xmlParam.Append("<EmailToAddress />");
xmlParam.Append("<EmailCcAddress />");
xmlParam.Append("<EmailSubject />");
xmlParam.Append("<EmailBodyText />");
xmlParam.Append("</EmailDetails>");
xmlParam.Append("</DocumentControl>");
StringBuilder xmlIn = new StringBuilder();
xmlIn.Append("<Query>");
xmlIn.Append("<Option>");
// This is always 'ONLINE'
xmlIn.Append("<Function>ONLINE</Function>");
// See Document Type Codes
xmlIn.Append("<DocumentType>I</DocumentType>");
// Format code selected to print with - see output from DetermineDocumentOptions
xmlIn.Append("<Format>0</Format>");
xmlIn.Append("<Reprint>Y</Reprint>"); 
Print/Reprint flag - see output from DetermineDocumentOptions
xmlIn.Append("</Option>");
xmlIn.Append("<Filter>");
xmlIn.AppendFormat("<OrderNumber FilterType='S' FilterValue='{0}' />",791);
//Where 791 is the Sales Order number
xmlIn.AppendFormat("<InvoiceNumber FilterType='S' FilterValue='{0}' />",100506);
// Where 100506 is the Invoice number
xmlIn.Append("</Filter>");
xmlIn.Append("</Query>");
string xmlOut = _sysproSRSClient.ProduceDocument(
sessionId, xmlParam.ToString(), xmlIn.ToString());
// See documentation for sample XML out
Retrieve the document content from the HEX encoded string from the output XML

// Document Content is HEX encoded as it may contain invalid XML characters, i.e. NULL characters
string hexString = {Get content from XML};
hexString = hexString.Replace(" ", "");
byte[] arrASCII = new byte[hexString.Length / 2];
for (int i = 0; i < hexString.Length; i += 2)
{
arrASCII[i / 2] = (byte)Convert.ToByte(hexString.Substring(i, 2), 16);
Logoff from the SYSPRO session

// If you authenticated using a OperatorCode and 
// CompanyCode then you might want to logoff.
_sysproSRSClient.LogoffUserSession(sessionId);