Skip to main content Skip to complementary content

Inferred Documentation

In this scenario you will work with inferred semantic relationships for the Name and Business Definition.

Steps

From the object page

  1. Navigate to the object page for the object you wish to document. Then click the Overview tab.
  2. Click on the pencil (Edit) icon in the Documentation section.
  3. In the Inferred Documentation section of the dialog, click on the ADD button next to a line item to create a direct term documentation link to that term.
  4. Or click on the Edit icon in the Mapped Documentation section and pick as in that section.
  5. Click OK.
Information note

The Name (next to the physical name) and Business Definition in the Mapped Documentation section now inherit from the term selected.

From the Semantic Flow tab

  1. Navigate to the object page for the object you wish to document. Then click the Semantic Flow tab.
  2. Click Edit Documentation.
  3. From here it is the same steps as on the Overview tab.
Information note

The items in the list are of different Types which reflect the documentation type. The types are defined here.

Example

From the object page

Navigate to the object page for the field PTCID in the PAYTRANS.csv file.

Click the pencil icon to edit the Documentation.

Information note

You may edit the Local Documentation directly here, create a Mapped Documentation relationship from an existing term or other object or a new one you create from this information, see the Inferred Documentation links including search matching terms if available.

From the Semantic Flow tab

Navigate to the object page for the column Customer PO Amount in the Tableau report at Tableau > Metadata Management > Finance1 > Customer_PO_Invoice_Item_FACT__Finance_Dimensional_DW_ > Customer PO Invoice Item.

Go to the Semantic Flow tab.

Information note

All the definitions which could be found are through inference. In this case, the data flow (pass-through, i.e. without transformation) lineage and semantic lineage trace is performed on the list of possible inferred definitions is presented.

The list of types are defined here.

Click on the Diagram tab on the left.

Information note

The graphical pass-through data flow and semantic lineage trace is presented.

Click on the Expand icon and select To column level.

Information note

All the column level data flow lines are gray, indicating pass-through lineage. If there were a transformation defined for that step in the lineage then it would be assumed that the meaning is different and a definition may not be inferred beyond that point in the data flow lineage.

Return to the List view (click the List tab on the left).

Information note

The definitions inferred from terms are listed first and then the definitions inferred from other objects are list after.

Now, to pick one of these term definitions and directly create an Is Defined By relationships between the actual term with the definition and this imported object, simply click Edit Documentation and you have the same presentation as with the Overview tab and can ADD with the preferred definition (the first one in the list in this case).

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!