Process Transaction 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 processTransactionEvent service is responsible for processing a Transaction Event (DTE), issuing a Verifiable Credential (VC), uploading it to the Storage service, registering the link to the stored DTE with the Identity Resolver service, and managing DPPs in local storage associated with the event. It handles the entire lifecycle of creating and managing a transaction event, from data input to storage, resolution, and local data management.

Diagram

Example

{
  "name": "processTransactionEvent",
  "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": [
          {
            "type": "html",
            "template": "<div><h2>Transaction Event</h2><p>ID: {{transactionId}}</p></div>"
          }
        ],
        "dlrIdentificationKeyType": "gtin",
        "dlrLinkTitle": "Transaction 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/transactionId",
      "localStorageParams": {
        "storageKey": "transactionEvents",
        "keyPath": "/transactionId"
      }
    }
  ]
}

Definitions

Property	Required	Description	Type
vckit	Yes	Configuration for the VCKit service	VCKit
traceabilityEvent	Yes	Configuration for the EPCIS Transaction 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
localStorageParams	Yes	Configuration for local storage management	LocalStorage