Creating a Cargo Variable Mapping

For a Cargo connection to work it needs at least one Variable Mapping. Each mapping pairs a model variable with a property key on the host site, allowing KnowledgeKube to retrieve data from the site and process it as though it were native to the model.

If you are adding mappings during the initial creation of your cargo connection, you can proceed directly to step 7.

Implementation:

  1. Switch to the Your Models tab.
  2. Right-click the intended model.
  3. Select Model Cargo.
  4. Select the intended cargo connection.
  5. If the connection is not already checked out to you, click Check Out Cargo.
  6. Click the Properties button.
  7. Click Add.
  8. Enter a valid Property Key. Enter the unique name of the Property Key associated with the target value on your site. This instructs the Cargo connection where to find the external data needed for this mapping.
  9. (Optional) Write a suitable Description. Use this field to clearly state the purpose of the mapping. Here, it may be useful to mention what kind of information is being fetched, where it originates from, and how it will be used after being passed through Cargo into your KnowledgeKube model.
  10. (Optional) Provide a Default Value. Any time KnowledgeKube is unable to retrieve a value from the property key, it will use this value instead.
  11. In the Assigned Variable field enter the keyword of the KnowledgeKube variable that will store the value fetched from the target location.
  12. Click OK.
  13. Repeat steps 7-13 until you have all the mappings you need.
  14. Click OK.

This interface is also used when editing an existing mapping. When you do this, the fields will be pre-populated with the mapping's current properties.