Learning CoB

# $extRef() - External reference fields

This keyword is used to link an instance to an external entity (an entity of any other system external to RecordM). The first parameter is the name of the external system we want to use and the second indicates the URI template to use when searching for entities in that system. In the example included below, we are using UserM (CoB's module for user account and permission management) as the external system to which we intend to link all instances of the given definition. As a second parameter we assign the relative path to the users listing according to the search query introduced as an input value at the instance level:

# Usage:

$extRef(System name,Search URI template)

Options:

  • System name: The name of the external system that is already configured in RecordM
  • Search URI template: The URI used to query the information in the external system

# Example:

$extRef(userm,/userm/user/search?q={{this}})

Here is a small video showing how to use a $extRef() keyword in a definition field at the instance level:


← $references() - Reference Fields →