Process Traceability Event

info

Please note that this content is under development and is not ready for implementation. This status message will be updated as content development progresses.

Description

The processTraceabilityEvent service is responsible for processing an Traceability Event (DTE), it only process one event type in one time. The service will check the event type and call the corresponding service to process the event such as processObjectEvent, processAggregationEvent, processTransformationEventOnly, processAssociationEvent, and processTransactionEvent.

Diagram

Example

{
  "name": "processTraceabilityEvent",
  "parameters": [
    {
      "vckit": {
        "vckitAPIUrl": "http://localhost:3332/v2",
        "issuer": "did:web:uncefact.github.io:project-vckit:test-and-development",
        "headers": {
          "Authorization": "Bearer test123"
        }
      },
      "traceabilityEvent": {
        "context": ["https://www.w3.org/2018/credentials/v1", "https://gs1.org/voc/"],
        "type": ["DigitalTraceabilityEvent"],
        "renderTemplate": [
          {
            "template": "<div><h2>Traceability Event</h2></div>",
            "@type": "WebRenderingTemplate2022"
          }
        ],
        "dlrIdentificationKeyType": "gtin",
        "dlrLinkTitle": "Traceability Event",
        "dlrVerificationPage": "https://verify.example.com"
      },
      "storage": {
        "url": "http://localhost:3334/v1/documents",
        "params": {
          "resultPath": "/uri",
          "bucket": "verifiable-credentials"
        },
        "options": {
          "method": "POST",
          "headers": {
            "Content-Type": "application/json"
          }
        }
      },
      "dlr": {
        "dlrAPIUrl": "https://dlr.example.com/api",
        "dlrAPIKey": "dlr-api-key-12345",
        "namespace": "gs1",
        "linkRegisterPath": "/api/resolver"
      },
      "identifierKeyPath": "/0/id",
      "eventTypePath": "/0/type/0"
    }
  ]
}

Definitions

Property	Required	Description	Type
vckit	Yes	Configuration for the VCKit service	VCKit
traceabilityEvent	Yes	Configuration for the EPCIS Traceability Event Event	Credential
storage	Yes	Configuration for storage service	Storage
dlr	Yes	Configuration for the Digital Link Resolver	IDR
identifierKeyPath	Yes	JSON path to the identifier in the credential subject or the object for function and arguments of JSON path to construct identifier	IdentifierKeyPath
eventTypePath	Yes	JSON path to the event type in the credential subject	String