Skip to main content

Conversions Basics

Conversions are user-defined data transformers supporting data format and data structure changes. They are useful when the source data does not match the destination data.

An example conversion is defining and modifying the destination data structure of extracted weather data. The data can be modified by applying functions. Functions include multiplying, dividing, adding a prefix, etc.

Configuring Conversions​

Note

Before you can configure a Conversion, you must have a Protocol defined.

To configure a Protocol, please see the Protocol guide page.

Create a Conversion​

To create a conversion, enter the ‘Data conversions’ page by clicking on the Data option in the menu screen.

Initial Conversion Definition​

  1. Click Create conversion + Step 1 for create

  2. Enter a name and description for your conversion

  3. Select a protocol for your conversion

  4. Click Create Step 4 for create

  5. Click on the arrow to enter the conversion design space Step 5 for create

Conversion Design Space​

  1. Upload a JSON or XML file of the source data structure. Step 1 for create DS

  2. Drag and drop the required fields into the middle panel (Specifications panel)

  3. Click on the three dots of the dropped field in the middle panel Step 3 for create DS

  4. Click on Select fields Step 4 for create DS

  5. Select the relevant protocol property(s)

  6. Click Apply Step 6 for create DS

  7. Click on the three dots again of the dropped field in the middle panel

  8. Click on Apply functions Step 8 for create DS

  9. Click on Available fields and select the relevant protocol property to modify

  10. Configure relevant functions for your data

  11. Click Apply and then Finish Step 11 for create DS

  12. Click on Select assertions if required and select the relevant protocol property Step 12 for create DS

  13. Configure relevant assertions for your data

  14. Click Apply and then Finish Step 14 for create DS

  15. Repeat steps 2-14 as necessary

  16. Click Generate output icon in the output panel Step 16 for create DS

  17. Verify output matches your destination data structure

  18. Click on the three dots on the top right corner

  19. Click Save Step 19 for create DS

  20. Add a save description if necessary

  21. Click Add Step 21 for create DS

Deploy a Conversion​

To deploy a conversion, enter the ‘Data conversions’ page by clicking on the Data option in the menu screen.

Note

To use a conversion in a workflow, the conversion must first be deployed.

  1. Click on the arrow of your conversion to enter the conversion design space Step 1 for deply DS

  2. In the Output Panel, click on the arrow to deploy the conversion. Step 2 for deply DS

  3. Click Yes Step 3 for deply DS

Modify a Conversion​

To modify a conversion, enter the ‘Data conversions’ page by clicking on the Data option in the menu screen.

  1. Click on the arrow of your conversion to enter the conversion design space Step 1 for modify DS

  2. Modify the conversion as necessary

  3. Click on the three dots on the top right corner

  4. Click Save Step 4 for modify DS

  5. Add a save description if necessary

  6. Click Add Step 6 for modify DS

Remove a Conversion​

To remove a conversion, enter the ‘Data conversions’ page by clicking on the Data option in the menu screen.

Warning

If you delete a conversion that is being used in a workflow, the workflow will fail.

  1. Click on the trash icon next to the conversion to be removed Step 1 for remove DS

  2. Click Yes to delete Step 2 for remove DS