Orien has the capability to pull SAP data from a SAP instance through APIs. Currently, Orien can receive JSON payloads of:
- SAP Functional Locations
- SAP Equipment
- SAP Material
- SAP Work Centers
- SAP Measuring Points
- SAP Measuring Documents
- SAP Planned Maintenance Completion
Below will be a guide on how to view and utilise your SAP data within Orien. Orien's SAP integration requires a valid, non-expired Orien Self-Service API key to be passed in the body JSON payload. For further details, view the API docs for Orien, click here Self Service API Documentation.
For more information about Orien API routes and functionalities, view the Swagger docs for Orien here: Swagger Documentation.
This process will utilise Orien's External Hierarchy and functionality. For help using the External Hierarchy, use this article: SAP External Hierarchy
If you have any questions about the process or want to inquire how to initialise this SAP data into Orien, contact Orien support at: support@orien.zendesk.com
SAP Endpoint Configuration
SAP Endpoints can be configured for each database and are configured by Orien IT and will need to be done prior to this step. For any enquiries or help, please contact Orien support at: support@orien.zendesk.com. To view the SAP Endpoint Config, select Integration Config, then select the SAP Config module at the Database Level.
When selected, you'll be able to configure Endpoints for that specific Client Data/Database. The properties and values for each of these endpoint configurations are listed below. When an SAP Endpoint is selected, various properties can be assigned to configure the endpoint (e.g., Page Limiter, Criteria. AA Description, URL Type, Integration Endpoint), and a plant type (e.g., Material Plant, Planning Plant, Maintenance Plant) are required for each endpoint Configuration.
SAP API Routes
For the Routes below, you'll need to prepend the base URL of your Orien instance and append the Company Code assigned to your instance. Expand the Routes to view a sample payload. An example will be: Lorem.orien.app/api/ss/v1/integration-change/sap-functional-location/. These routes will receive JSON payloads of the following data:
Order of Initialisations
Initialisations should be run in a general process as some of the technical objects have prerequisites (e.g., an Equipment is allocated to a FLOC). We recommend Initialisations to run sequentially in the following order:
- SAP Functional Locations
- SAP Equipment
- SAP Material
- SAP Work Centers
- SAP Measuring Points
- SAP Planned Maintenance Completion
SAP Reference Objects
SAP Reference Objects are used to specify the data that is received from SAP. This is useful when SAP data is used across multiple databases. Each of these objects uses the Code field as a parameter with an optional description field. The table below is an example of what values are expected.
| ERROR MESSAGE | DESCRIPTION | RESOLUTION |
|---|---|---|
| Catalogue Profile | {Catalogue Profile Name} | |
| Construction Type | 000000000020009999 | |
| Functional Location Category | Technical system - standard | W |
| Object Type | DIST | |
| Planner Group | A99 | |
| Plant | Plant Name | {Plant Code} |
Included in the SAP Ref Objects are SAP Work Centers. Work Centers are able to be created, edited, and deleted in this tab.
| WORK CENTRE FIELD | SAMPLE VALUE | |
|---|---|---|
| Description (STEXT) | Mechanic | |
| Plant (WERKS) | A999 | |
| Category (VERWE) | AAA | |
| USAGE (PLANV) | 001 | |
| Control Key (STEUS) | PMAA | |
| Indicator Control Key is Referenced (STEUS_REF) | ||
| Capacity Category (KAPART) | ||
| Capacity Planner Group (PLANR) | PM | |
| Base Unit of Measurement | H | |
| Capacity utilisation (NGRAD) | 100 | |
| Cost Center (KOSTL) | 0400690139 | |
| Cost Per Unit/Rate | ||
| Currency Key | ||
| System Status | ||
| Code(ARBPL) | AA1AA111 | |
| Notes | ||
Data Sync Records
Throughout the initialisation process, the progress of key actions will be recorded and available in the Data Sync module. The module will show the history of processes completed on the selected database. Below is an example of the Data Sync screen that has had several previous processes.
When the View Messages is selected, the process has been separated into all of its session messages. This helps to identify what stage the data sync is currently at or if any errors have occurred. Below is an example of messages that are received from a completed SAP Measurement Point process:
Delta Schedulers
To receive Deltas (updates) from SAP to existing data within the External Hierarchy, a scheduler will need to be set up and configured at each database for each Integration type (FLOC, Equipment, Materials etc.). For our user guide for setting up schedulers, please review our article here: Orien Scheduler
When creating a scheduler to pull in Deltas to Orien, these are the fields required:
| PROPERTY | TYPE | SOURCE |
|---|---|---|
| Description | String | Manual Input |
| Type | Collection | Static Orien Field - Must use 'Apply Integration Changes' |
| Schedule Interval (days) | Integer | Manual Input |
| Hour of the Day (0 to 23) | Integer | Manual Input |
| Disabled | Boolean | Manual Input |
| Next Due date | Date | Manual Input |
| Integration Type | Collection | Static Orien Field |
| Integration Server | Collection | Static Orien Field |
| Plant | Collection | User-defined Ref Object in SAP Config |
| API Key | String | Manual Input |
Alongside the Delta Schedulers, an integration Timeout Checker scheduler should be applied to each Integrated Database and run at least once a week.
Note
Deltas should be run daily. Delta data is only stored within the system for 7 days.
Once all of the Schedulers are set up, it will look like this: