Skip to main content

Market Adapter

Market adapters function as the first step of two steps for getting data into the Energyworx Platform. This is accomplished by reading the data of the file it is subjected to and creating an output that can be interpreted by the Platform in Python to achieve the ultimate goal of bringing data into the system.

The Market Adapter configuration allows the user to upload a Python code that will be executed in runtime to perform all the normalizing data processes. However, the platform also provides some generic Market Adapters that can be used to read more common file types, such as:

file typetechnical name
CSVcsv
Excelexcel
JSON/JSONPjson_market_adapter
XMLxml

The configuration name of the Market Adapter should be unique, but you can use the above base Market Adapters in as many configurations as you may see fit.

Market Adapter configuration​

Market Adapter management can be found at [Smart Integration -> Market Adapters]. Go through the following steps in order to create, edit or copy a Market Adapter. For creating a new Market Adapter, the menu will look as follows.

  1. Click the [Create] button.
  2. Fill in the Name, Technical name, and Version fields (The Description field is optional).
  3. Note: The Technical name needs to match the Market Adapters file name in the code. The Version needs to match the Market Adapters class name in the code, which is either V1 or V2 in a lot of cases.
  4. Click the [Choose a Transformation Configuration] hyperlink to assign a Transformation Configuration. A new window will open.
  5. Use the Search field to narrow down your search if necessary and click [Select].
  6. Note: Only the properties that are available in the Market Adapters code can be added.
  7. Click the [+ Add] button in the Properties section.
  8. Fill in the Keys and Values fields.
  9. Click [Save] when you’re done.

In addition to all the fields you previously filled in, the Market Adapter is also given a unique ID.

When you need to edit an already existing Market Adapter, go to the Market Adapter overview. This will look as follows.

  1. Click the [Details] button. You are now redirected to the Market Adapter page.
  2. Click the [Edit] button.
  3. Make your desired changes and click [Save] when you’re done.

In some cases it can be useful to copy an already existing Market Adapter and make the necessary changes from there on.

  1. Go to the overview and click the [Details] button of the Market Adapter you want to copy.
  2. Simply click [Copy]. You are now redirected to the Market Adapter page. All the available fields are already filled in.
  3. Make your desired changes and click [Save] when you’re done.

Implementation​

In addition to the provided basic Market Adapters customers can also implement their own Market Adapter in python code. You can see how to write code for Market Adapter in How to write a Market Adapter

Automated MA Assignment​

The platform can automatically assign a Market Adapter (MA) to incoming files as soon as they land in cloud storage. This feature enables fully automated, hands-free data ingestion based on the file's payload type.

Configuration

Automated MA assignment is configured per namespace using the namespace propertymarket_adapters. This can be set by going to Admininstrator > Namespaces > Details (of a specific namespace)

The namespace property can only be set by platform admins (until 25.04 version, only available to energyworx accounts, must be requested via service desk) The property define which market adapter to use for a given payload, the format is as follows:

{
"Payload1": 6419342926311424,
"Payload2": 9876543210123456,
"Payload3": MA_id,
}

🔒 Platform Restrictions Setting the namespace properties can only be done by Platform Administrators.

Availability Note: Prior to version 25.04, this feature was exclusively available to Energyworx accounts and required a request via the service desk. This restriction has been lifted starting from 25.04