Property description

The externalLink property creates an action button leading to the external link in the object panel. The action button will be added to the following places:

  • Object page: Displayed as a component in the right-side area of an object page. Shown in the screenshot.
  • Object header: Displayed as a button in the object header. Shown in the screenshot.
  • Object preview: Displayed as a button when hovering on an object link in e.g., a table.
  • Object detail: Displayed in the advanced search, diagrams, etc. For more information, see object detail.

Example

Example JSON

Minimal JSON

{
  "linkAttributeKey": "",
  "title": ""
}

Example JSON

{
  "title": "Report link",
  "linkAttributeKey": "cust_example_external_link"
}

Nested properties

PropertyDescriptionValuesMandatory
linkAttributeKeyKey of the attribute type whose value will be used as the external link.stringYes
titleTranslation key of the title. Define the key in translations to specify how the text is displayed in the UI. Unlike the name property, if you use a specific string of text for the title, this text will appear with the package key. For example, Comment Section will be displayed as package_key_comment section.stringYes