Skip to main content

Protocols Basics

Protocols are a user-defined data structure that can be used when creating conversions. Protocols define the destination data structure of your use case.

Configuring Protocols​

Create a Protocol​

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

  1. Click Create protocol + Step 1 for create

  2. Enter a name and description for your protocol

  3. Click Create Step 3 for create

  4. Click on the arrow to enter the protocol design space Step 4 for create

  5. Create a protocol property by defining a Property key

  6. Select an Expected datatype if necessary Step 6 for create

  7. Click +Add child property to add child properties as necessary

  8. Define a Child key

  9. Select an Expected datatype for your child property if necessary Step 9 for create

  10. Click Create Step 10 for create

  11. Repeat steps 6-8 for all required child properties

  12. Repeat steps 4-9 until all protocol properties are defined

  13. Save Protocol by clicking the three dots on top right corner

  14. Click Save Step 14 for create

  15. Add a save description if necessary

  16. Click Add Step 16 for create

Modify a Protocol​

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

  1. Click on the arrow to enter the protocol design space Step 1 for modify

  2. Modify the protocol as necessary

  3. Save Protocol by clicking the three dots on top right corner

  4. Click Save Step 4 for modify

  5. Add a save description if necessary

  6. Click Add Step 6 for modify

Remove a Protocol​

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

Warning

You cannot remove a protocol if it is being used by a conversion. You must delete the conversion first then the protocol.

  1. Click on the trash icon next to the protocol to be removed Step 1 for delete

  2. Click Yes to delete Step 2 for delete