EXD-API Plugins Overview#

The conversion of legacy data into standard data formats often requires data conversion. This can lead to an increased volume of data due to data copies and to an disruption of existing tool chains that use this data.

To avoid these conflicts, ASAM ODS has introduced the External Data API with version 6.2. The External Data API enable access to legacy data through microservices that expose the metadata and mass data they contain we call such a service an EXD-API Plugin.

EXD-API Plugin

As a member of the ASAM ODS working group, Peak Solution was significantly involved in the definition of External Data API and the Peak ASAM ODS Server supports the External Data API from the very beginning.

Existing EXD-API Plugins#

You can find a list of publicly available EXD-API Plugins in the Peak Solution GitHub repository.

Developing EXD-API Plugins#

Developing an EXD-API Plugin best starts with an existing EXD-API Plugin and adapting it to your needs or if this doesn’t work for you getting the gRPC definition file (.proto file) from the ASAM GitHub repository and start from scratch.

Modify an existing EXD-API Plugin#

In most cases measurement data files are of CSV format, but vary in formatting like header, delimiter and other. However, the basic structure is common, so you can modify an existing plugin and adapt it to your needs - which in some cases only requires changing a single line of code:

Start from scratch#

Use the existing gRPC tools to generate the initial server code from the .proto file. gRPC tools are available for many common programming languages, so you can choose for instance a programming languages which already provides a library for the file or data format you want to access. Or you choose the one you’re most familiar with.

Testing your EXD-API Plugin#

You can also easily test your EXD-API Plugins:

Working principle of EXD-API Plugins#

Now that you’ve familiarized yourself programming EXD-API Plugins you may want to learn more about the interaction and calling sequences between the Plugin and the ASAM ODS server:

License#

Copyright © 2025 Peak Solution GmbH

The training material in this repository is licensed under a Creative Commons BY-NC-SA 4.0 license. See LICENSE file for more information.

Notebook: 📓 Back to course overview