Integrations with external systems
To increase the effectiveness of work in the system, to improve data quality, the system can be integrated with your existing systems.
Main integration flows:
1. Integration of catalogs
The most common examples of catalogs that may require integration:
- Equipment
- Shop floors
- Types of downtime
- Brands / product classes
- Etc.
If the integration is not configured, you must maintain these catalogs manually in the settings of the corresponding column:
If the catalogs are large or change frequently, this can be labor-intensive.
Configuring the integration allows automatically synchronizing the values within these catalogs with the values of this catalog in your master system. For example:
You have a Plant Maintenance system and it maintains an equipment catalog. You can arrange for the values of this catalog to be transmitted to the Production Logs system. Thus, each time a new piece of equipment appears (or an old one is decommissioned), this is automatically broadcast to Production Logs.
To configure this integration, after each update of the catalog on the side of the master system (the source system), it is necessary to transmit its contents to Production Logs.
Writing to the catalog happens through an API call:/api/v1/logsheet-custom-field-types/values
More detail about API access to the log can be read in the section Documentation for developers
2. Integration of log records – data export
Logs can be exported from Production Logs. This is very convenient if you subsequently need to build reporting, use the data for AI algorithms, or do statistical analysis.
There are two options for data export:
- Manual – when the user presses the export button
- Automatic via API.
In automatic mode, you can configure periodic data export processes as you need, for one or several logs at once.
For this, the API service is used:/api/v1/logsheet-records/logsheet/{headId}
More detail about API access to the log can be read in the section Documentation for developers
3. Integration of log records – data import from external sources
Importing data into the log can be convenient if you have external systems that register certain events. For example:
- Automatically read out exceedances of threshold values from sensors
- Automatic registration of equipment stoppage
In these cases, when you have sensors / a controller / an IIOT solution from which certain events can be retrieved, log records can be created automatically based on them.
For example: your controller determines whether a pump is working or not. And if the pump stops working, a record is automatically created in the equipment downtime log about the pump downtime, the time, and the duration of the stoppage. After which the responsible employee must manually supplement this record with information about the reason for this stoppage / downtime.
For automatic registration of a record in the log, the API service is used:/api/v1/logsheet-records
More detail about API access to the log can be read in the section Documentation for developers