Print this page

Best Practices for Relationship Parameter in Augment Nodes in Wave Analytics

Knowledge Article Number 000247160
Description The relationship parameter is applied as a prefix to field names in the "right_select" of an Augment node. This allows the incorporated fields to be easily identified in the structure of the dataset. See the below example:

Source Datasets:
Left_Dataset
Name
Id
Amount
RightLookupId
 
Right_Dataset
Name
Id
Description

Augment Code:
"Augment_LeftWithRight": {
   "action": "augment",
   "parameters": {
      "left": "Left_Dataset",
      "left_key": [ "RightLookupId" ],
      "relationship": "FromRight",
      "right": "Right_Dataset",
      "right_key": [ "Id" ],
      "right_select": [ "Name","Id","Description" ]
   }
},

Result:
Augment_LeftWithRight
Name
Id
Amount
RightLookupId
FromRight.Name
FromRight.Id
FromRight.Description

 
Resolution

Best Practices for Relationships

  • Make the relationship meaningful. Having a concise and accurate descriptor will ease later consumption of the data.
  • Ensure the relationship adheres to API naming conventions. As the relationship value becomes part of the field's API name, it needs to meet the criteria defined in the Field Names section of the Metadata Format Reference:
    • Can contain only alphanumeric and underscore characters
    • Must begin with a letter
    • Can’t end with an underscore
    • Can’t contain 2 consecutive underscore characters
    • Must be unique across all fields of the object

 




promote demote