About the Traceability Driver
A Comprehensive Guide to the Traceability Driver The Traceability Driver is a ready-to-use solution that streamlines integration between traceability systems with standardized data. Initially built f…
A Comprehensive Guide to the Traceability Driver
The Traceability Driver is a ready-to-use solution that streamlines integration between traceability systems with standardized data. Initially built for the seafood industry using the GDST standard, it is now expanding to support other commodities. The Traceability Driver enables systems to exchange traceability data in a consistent, standardized way, creating more connected and interoperable supply chains.
How the Traceability Driver Works
The Traceability Driver connects to an organization’s existing database and maps traceability data into standardized events and master data. The mapped data is stored in a separate Data Cache, where it can be accessed and shared through standardized API queries. Acting as a simple translation layer, the Traceability Driver allows organizations to make their traceability data interoperable without needing to change how the data is stored in their internal systems.
The Traceability Driver can be deployed on-premises or within an organization’s own cloud environment, allowing the organization to maintain control over its data. The system only reads data from existing databases and does not write back to it, ensuring the original system remains secure. Data is transferred into a separate Data Cache, where it is stored and accessed by the prebuilt API. The system is configured with secure authentication methods such as OAuth or API keys, allowing organizations to control who can access and exchange their traceability information, preserving both data integrity and confidentiality.
Data Synchronization
The Traceability Driver facilitates synchronization between your existing software system and the standardized data structure. The system synchronizes up to 10,000 items per batch, ensuring that your traceability data stays up to date. The synchronization process involves:
- Automatically executing on startup.
- Loading mappings from a local Mappings folder.
- Transforming traceability data into standardized formats and storing it in the Data Cache.
- After processing, the system waits one minute before the next sync cycle.
A key feature of the synchronization is that the Traceability Driver uses memory variables to track where it last left off in the data sync, ensuring that the process resumes from the correct point, rather than reprocessing the same records.
Data Cache
The Data Cache is where all traceability data is stored, making it the source for any data queries made through the API. The Data Cache is persistent and may contain traceability data pulled from external traceability solutions in addition to data mapped from your organization’s internal systems. The Data Cache should not be dropped, as doing so may result in the loss of data received from external systems.
By default, this cache is built using MongoDB, but it can be reconfigured to use other databases depending on your organization's needs.
Dashboard and Monitoring
The Traceability Driver comes with an integrated dashboard that provides visibility into the system’s current state, including synchronization progress, event statistics, and errors. It allows users to:
- View synchronization progress and statistics.
- Monitor the number of events, master data entries, and syncs.
- See recent errors that have occurred during synchronization.
The dashboard also includes basic authentication, where the default password can be configured through the appsettings.json file or via environment variables.
Installation and Configuration
The Traceability Driver can be deployed in two primary ways:
- Docker Installation:
- The Traceability Driver comes as a Docker image that can be configured and deployed with ease.
- You can use Docker Compose to set up the environment and specify how to connect to the necessary databases and configure the mappings.
- Release Installation:
- Alternatively, the Traceability Driver can be installed as a standalone module on either Windows or Linux servers. After installation, you can configure the system by editing the appsettings.json file, placing the necessary mappings in the Mappings folder, and starting the system to begin syncing the data.
Security and Authentication
The Traceability Driver supports three authentication modes:
- OAuth (JWT) Authentication: Self-signed tokens for API access.
- API Key Authentication: Secure the API using keys configured in the system.
- No Authentication: For cases where authentication isn’t required.
Each method provides flexibility for securing access to the system, depending on the organization’s security policies.
Mapping and Event Transformation
The Traceability Driver uses mapping files to transform data from your system into a Common Event Model that conforms to the data standards. These mappings define how to query and transform data into the necessary events, master data, and traceability information.
- Selectors are used to identify the data from your database.
- Event Mappings define how each piece of data should be transformed into the standardized fields, such as EventId, EventTime, and ProductId.
- Memory Variables store data between synchronization cycles to track where the last sync left off and ensure continuity.
Customizable to Fit Your Needs
The Traceability Driver offers customization to meet the unique needs of your system:
- Multiple Database Support: The system is designed to integrate with different databases, and custom configurations allow it to scale across various environments.
- Dictionaries for Data Transformation: Using dictionary-based mappings, the Traceability Driver can transform values from your database to their data standard equivalents (e.g., transforming specific equipment types or catch areas into standardized URNs).
- Identifier Generation: The system automatically generates traceability identifiers (e.g., EPC, GTIN, PGLN) using customizable domain settings, ensuring each piece of data is uniquely identifiable.
GDST Capability Test Integration
The Traceability Driver also integrates with the GDST’s Capability Test, allowing users to verify that their implementation complies with the GDST Standard. This functionality can be triggered directly from the dashboard after configuring the necessary details, such as API keys and PGLN identifiers.
The Traceability Driver provides an easy, scalable, and secure solution for automating the process of becoming GDST Capable. Users simply provide an EPC linked to data mapped by the Traceability Driver, enabling the Capability test to query the driver for GDST traceability data. The system is flexible, easy to deploy, and customizable to meet your organization’s specific needs.
You will need to request access to the GDST Capability Test by reaching out to info@theGDST.org
Traceability Driver in Practice
The Traceability Driver has been implemented by technology solution providers with different system architectures to support GDST capability. Koltiva used the Driver to map data from its existing MySQL system to GDST requirements, reducing its estimated development time by 60% and passing the GDST Capability Test in about one month.
Aqua Exchange demonstrated how the Driver can also work with non-standard database architectures. Using a mapping layer between its Neo4j database and a SQL database, Aqua Exchange implemented the Driver without changing its existing system architecture or requiring direct implementation support, and passed the GDST Capability Test in approximately 1–2 weeks.
These case studies demonstrate how the Traceability Driver can reduce the technical effort required to align existing systems with GDST while accommodating different technology environments.
How did we do?