Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

titleTable of Contents

...

Table of Contents

Overview

The purpose of the LogiX Business Integrator Component is to enable data exchange between LogiX Applications and ISA-95 Level 4: Business logistics and reporting systems, such as ERP, APS, or CMMS.

...

  • Processing orders

  • Handling materials

  • Scheduling production events

  • Processing raw and aggregated KIPs and other data by LogiX applications

Assumptions

  • Almost every LogiX deployment needs to communicate with ERP systems or other business apps.

  • Those applications are often COTS or legacy software that are hard to change.

  • Even for the same app (or a set of apps), there are often various integration scenarios for a single Client.

Goals

  • Decoupling:

    • LogiX internal data model, of which semantics is known across LogiX components, from external data models.

    • LogiX cloud services from implementation of custom integration components, supporting various interfaces, different orchestrations, ETL batch exchanges, and data formats.

  • Common core message bus and data structure

  • Security:

    • Authorizations

    • DDoS - Request Flood prevention

    • Events/errors logging

  • Out-of-the-box observability:

    • Monitoring

    • Logging for auditing and debugging

    • Tracing in case there is a need for deeper problem analysis.

...

The description is available here: https://stage.api.logix.cloud/index.html <link>

Authentication

In accordance with OpenID Connect specifications, the following parameters are sent to each Client individually:

...

Code Block
{
    "access_token": "eyJh...",
    "expires_in": 3600,
    "token_type": "Bearer",
    "scope": "api.logix.cloud logix.api"
}

General Assumptions

  1. In API calls, you should use IDs for factories (PlantCode) and production lines (LineCode). You can find those IDs in the ConfigHub app in the Factories tab.

  2. If you want to add new activities or modify the existing ones, you should use the HTTP PUT method:

  • if the activity that you are adding exists, it will be updated.

  • if the activity that you are adding does not exist, it will be added as a new activity.

Updating via an external system is not allowed only if a specific activity is blocked as Managed by LogiX (it is done by setting a special internal flag in LogiX). Such blocking occurs automatically when an activity is added or modified through an app that belongs to the LogiX Suite (PackOS or KeepUp).

  1. Changing the statuses of activities that are in the

LogiX scheduler can be initiated from outside by invoking right methods on the resources related to specific activities.

...