DELMIA Apriso (Dassault Systèmes)

​

Overview

• DelmiaAprisoApi (DelmiaAprisoRestApi.lot) is a client connector on https://YOUR_APRISO_SERVER with 16 events.
• DelmiaAprisoWebhookReceiver (mes_delmia-apriso_webhook.lot, optional) is a server connector on port 9008 that receives calls from Apriso.

​

Server host

​

Authentication

1. Register Coreflux as a client application in ClientApplications.xml (in the server’s CentralConfiguration folder) with a ClientId, and an ApiKey and/or a ClientSecret, the Scopes it may request (standard_operations, message_processing, …) and the ClientCredentials grant. Restart the Apriso services.
2. Pick a flow. Every Web API event takes "authorization" and "client_id" in its MQTT payload and sends them as Authorization and X-Client-Application.
   • API key: "authorization": "ApiKey <ApiKey>", "client_id": "<ClientId>". Check it with HelloApiKey.
   • Access token: publish GetToken (client credentials) with client_id, client_secret and scope, then send "authorization": "Bearer <access_token>". Check it with HelloToken. GetUserToken (password grant, login_type standard or ldap) and RefreshToken are there too.
3. Publish the Standard Operations you want to call in Process Builder > Web Services Manager, with security level API Key or Access Token.

​

Payload conventions

• Standard Operations. DescribeOperation returns the operation’s Inputs, Outputs and a sample ExecutionParameters body. The run events send "body" unchanged: {"Inputs": {...}, "ExecutionMode": 1, "JobPool": "", "Retries": 1, "SleepTime": 1000, "SynchronuousQueue": "", "Timeout": 5000}. Only Inputs is required. ExecutionMode is 0 (in the IIS process), 1 (synchronous through Job Executor, the default) or 2 (queued asynchronously). The response carries Outputs.
• Revisions. Calls use the operation’s default revision. The ...Revision events take a revision such as REV.001.001.
• Presets. DeclareProduction, ReportMachineStatus, PostQualityInspectionResult and GetOrder use the same contract on their own topics, so each plant use case gets a clean topic. Their operation codes and Inputs are examples: send the codes and Inputs of the operations you published.
• Business Integrator. ProcessMessageAsync sends "body" as an XML string with Content-Type: application/xml for the message_name of your external system, and needs a token with the message_processing scope.
• Formats. Apriso answers JSON by default. Token requests are form-encoded, so keep the values in client_secret, password and scope free of & and =.

​

Tokens and auth checks

​

Standard Operations

​

Plant presets

​

Business Integrator and discovery

​

Receiving calls from Apriso (optional)

​

Examples

{
  "client_id": "<client id>",
  "client_secret": "<client secret>",
  "scope": "standard_operations,message_processing",
  "state": "coreflux"
}

{
  "authorization": "ApiKey <api key>  (or: Bearer <access_token>)",
  "client_id": "<client id>",
  "operation_code": "GetEmployee",
  "body": {
    "Inputs": {
      "Id": 1
    },
    "ExecutionMode": 1,
    "Retries": 1,
    "SleepTime": 1000,
    "Timeout": 5000
  }
}

{
  "authorization": "ApiKey <api key>  (or: Bearer <access_token>)",
  "client_id": "<client id>",
  "operation_code": "ProductionDeclaration",
  "body": {
    "Inputs": {
      "WipOrderNo": "WO-1001",
      "OperationSequenceNo": "10",
      "Quantity": 12,
      "UomCode": "EA"
    },
    "ExecutionMode": 1,
    "Retries": 1,
    "SleepTime": 1000,
    "Timeout": 5000
  }
}

{
  "authorization": "Bearer <access_token with message_processing>",
  "client_id": "<client id>",
  "message_name": "MyExternalSystem1",
  "body": "<FlexNet_WorkCenters Version=\"1.0\"><WorkCenter><Code>WP02</Code><Facility>C1P</Facility></WorkCenter></FlexNet_WorkCenters>"
}

DEFINE ACTION AprisoLogin
ON EVERY 12 HOURS DO
    SET "cid" WITH GET SECRET "APRISO_CLIENT_ID"
    SET "csec" WITH GET SECRET "APRISO_CLIENT_SECRET"
    PUBLISH TOPIC "mes/delmia-apriso/token/create" WITH { "client_id": {cid}, "client_secret": {csec}, "scope": "standard_operations,message_processing", "state": "coreflux" }

DEFINE ACTION AprisoKeepToken
ON TOPIC "mes/delmia-apriso/token/create/response" DO
    SET "token" WITH GET JSON "access_token" IN PAYLOAD AS STRING
    KEEP TOPIC "internal/delmia-apriso/authorization" WITH "Bearer " + {token}

​

Writes

​

Not packaged

​

Status