SYSPRO Run Time Products

The third party product performs the following steps when accessing the e.net Solutions API:

1. Login to e.net Solutions

   The third-party product logs in using the appropriate credentials, including an operator code, password, company code, and other optional parameters.

   Once validated, a unique UserId is returned, which manages the connection's state and must be used in all subsequent e.net API calls.

2. Invoke Business Objects

   The product can then invoke the required Business Objects using the acquired UserId.

3. Repeat as Needed

   If multiple Business Objects need to be accessed, the product can continue to invoke them using the same UserId.

   If only a single Business Object is required, you can proceed to the next step.

4. Logout

   Finally, the product logs out of the UserId, releasing any resources held by the e.net Solutions state management system.

Before an application can access the e.net Solutions API, two essential tasks must be completed at the end-user's site:

• License Acquisition

  The site must purchase e.net licenses for specific Functional Areas, which group related Business Objects.

  For example:

  The Customer Query Functional Area includes various customer query-related Business Objects.

• Operator Code Assignment

  Once the licenses are obtained, an administrator must assign these licenses to specific SYSPRO operator codes.

  For example:

  If 20 seats are purchased for the Customer Query Functional Area, up to 20 operator codes can access the related Business Objects.

To summarize, the end-user site must first purchase e.net licenses and then assign them to operator codes, enabling third-party applications to log in and access the e.net API.

Over the past two decades, many third-party developers have successfully used this approach to create applications that seamlessly integrate with SYSPRO.

Several ISVs have developed solutions that seamlessly integrate with SYSPRO using the e.net API. Some of these applications are designated as 'e.net Run Time Products' or simply 'Run Time Products' through commercial agreements between SYSPRO and ISVs. These agreements define the product name, product code, and the e.net Functional Areas used by the product. This information is stored on the SYSPRO license server.

When a SYSPRO license is generated, one or more Run Time Products can be associated with it. When this license is imported at the end-user's site, any associated Run Time Products are automatically imported as well.

How to view the Run Time Products?

The Company Setup program (accessible when browsing on companies from the login dialog and selecting the Change option) allows users to view these Run Time Products.

From the company login dialog, users can select the Licensed Run Time Products option to see the details:

To use a licensed application, the application must call e.net using a special Login XML string that includes the Run Time Product's name and product code.

This authentication process ensures that the Run Time Product is matched with the license at the end-user's site, allowing the application to call Business Objects without being pre-assigned to a SYSPRO operator code.

In contrast to regular e.net Solutions applications, a Run Time Product doesn't require the end-user site to import a license with e.net Functional Area seats and pre-assign licenses to operator codes.

Instead, the Run Time Product license is imported directly at the end-user’s site, simplifying the integration between the Run Time Product and a SYSPRO site. The third party product can then immediately call into e.net Solutions and log on to a valid operator code, without any further license apportionment.

When logging into e.net Solutions, the application can pass an XML input string as part of the login credentials, specifying the agreed-upon 'product code'.

<Logon>
  <Product>MyEdiProduct</Product>
</Logon>

Run Time Products are applicable where an ISV has a commercial arrangement with SYSPRO. Once agreed, a Run Time Product is added to the list of available Run Time Products that can be included in the SYSPRO license.

If a customer elects to include the Run Time Product, then the license is issued with the Run Time Product included.

Once imported at the site, the Run Time Product can then pass the product code at the time of logging into e.net Solutions. The login process validates the product code against the SYSPRO license and grants access to the applicable functional areas (i.e. Standard or Managed).

The Run Time Product connection to e.net is managed by SYSPRO and doesn't require or make use of any other e.net licenses (i.e. It doesn't use the e.net System Manager or e.net Functional Areas). As such, there is no requirement to apportion any e.net Functional Areas licenses across various operators.

If there are no other e.net requirements, then (as mentioned in the previous item) no other e.net licenses are required. Neither the e.net System Manager or e.net Functional Areas.

If you require additional e.net access (over and above the ISV's Run Time Licensed product) then the e.net System Manager must be licensed, together with the appropriate e.net Functional Areas for the other e.net usage.

For clarity: You don't need to take account of the Run Time Product requirements when licensing the e.net System Manager and e.net Functional Areas for the other e.net requirements.

The following uses Microsoft Excel as an example of a third party application connecting to the SYSPRO data:

1. Launch the third-party application - in this case Microsoft Excel.

2. Select the Data tab and expand the Get Data menu, followed by From Other Sources.

   Select the From OData Feed option.

   In other third party applications, you would typically select the Choose OData Feed option from Available data sources (or similar wording).

3. Select Basic on the OData feed window and enter your endpoint (i.e. URL) for the applicable entity (i.e. company id or system) that you want to query.

   URL example:

   https://localhost/SYSPRO8Odata/SYSPROOData/edu1

4. Select OK.

   The OData feed window is displayed.

5. From the Basic tab, enter the user name and password applicable for your configured SYSPRO OData operator.

6. Select the Connect function.

   The endpoint is queried and the Navigator window returns all available tables for the SQL database being queried.

7. Select the tables that you want to pull into Microsoft Excel (i.e. your SQL based third party application).

ISV's can access SYSPRO OData (without the customer having to license it for their SYSPRO site) by passing their runtime product code when calling the SYSPRO OData Service.

To pass a runtime product code with a call to the SYSPRO OData Service, the words #RunTimeProductCode# and the actual product code must be included as part of the username of the basic authentication information for all API requests.

The structure of the username field should be as follows:

[username]#RunTimeProductCode#[runtime product code]

If no runtime product code is provided and the site isn't licensed for the Data Connector - OData module, then the SYSPRO OData functionality will not be available for use.