Links and External Models

The links and externalDataModels sections allow the current model to reference attributes or metrics from other models. Use these sections to create federated or composite models that span multiple datasets.

External Data Models

Defines references to other models and the attributes and metrics within them.

Field	Type	Description	Example
`id`	String	The unique ID of the external model reference.	`"32FDC6D9..."`
`baseDataModel`	Object	The identity of the external model.	`{ name: "Day (Passthru Live)" }`
`objects`	Array	The specific attributes or metrics referenced.	`[ { name: "Month" } ]`

Example

See the following external data models file example:

Copy

externalDataModels:
- id: "32FDC6D9437543EFB6901A0CF92B5263"
  baseDataModel:
    information:
      objectId: "A2C871BF7FB24D609E9213296EE1B8C7"
      name: "Daily Calendar Analysis"
  objects:
  - information:
      objectId: "DF339BEFF66C43B29B13B7148A8AEED3"
      name: "Month"
    hidden: false

Links

Links can be created between objects in the current model and objects in external data models. They can also be created between multiple external data model objects.

Field	Type	Description	Example
`targets`	Array	The collection of objects to link together. For the object in the current model, leave the `externalDataModelId` field empty.	`[ { objectId: "...", name: "Month (2)" } ]`
`sourceObjectId`	String	The ID of the source object.	`"DF339BEF..."`
`alias`	String	The alias for the link connection.	`"Month"`
`linkedAttribute`	Object	The definition of the linked attribute, including its forms and displays.	`{ information: {...} }`

Example

See the following links file example:

Copy

links:
- targets:
    - objectId: "DF339BEFF66C43B29B13B7148A8AEED3"
      name: "Month (2)"
      subType: "attribute"
    - objectId: "02823C2379EB4F4C88EF9159EB8E33DE"
      name: "Month"
      subType: "attribute"
      externalDataModelId: "32FDC6D9437543EFB6901A0CF92B5263"
    sourceObjectId: "DF339BEFF66C43B29B13B7148A8AEED3"
    alias: "Month"
    linkedAttribute:
      information:
        primaryLocale: "en-US"
        objectId: "C2AD21536AA3438CA566E457DA4DDD94"
        subType: "attribute"
        name: "Month"
        description: "Unique identifier for the month in format YYYYMM"
      forms:
      - id: "45C11FA478E745FEA08D781CEA190FE5"
        name: "Month ID"
        description: "Unique identifier for the month in format YYYYMM"
        category: "ID"
        type: "system"
        displayFormat: "number"
        dataType:
          type: "integer"
          precision: 4
          scale: 0
        alias: "month_id"
        semanticRole: "month"
      keyForm:
        id: "45C11FA478E745FEA08D781CEA190FE5"
        name: "Month ID"
      displays:
        reportDisplays:
        - id: "45C11FA478E745FEA08D781CEA190FE5"
          name: "Month ID"
        browseDisplays:
        - id: "45C11FA478E745FEA08D781CEA190FE5"
          name: "Month ID"
      nonAggregatable: false
      acl:
        "294DEDC011D2F1D56000D98E67019608":
          granted: 255
          denied: 0
          inheritable: false
        "37DECDD94EAA4A2AF3C7A6B17080DADF":
          granted: 255
          denied: 0
          inheritable: false
        C82C6B1011D2894CC0009D9F29718E4F:
          granted: 255
          denied: 0
          inheritable: false
      translations:
        name:
          targetName: "Object Name"
          translationValues:
            1033:
              translation: "Month"
        description:
          targetName: "Object Description"
          translationValues:
            1033:
              translation: "Unique identifier for the month in format YYYYMM"
        forms:
          "45C11FA478E745FEA08D781CEA190FE5":
            name:
              targetName: "Attribute Form Name"
              translationValues:
                1033:
                  translation: "Month ID"
            description:
              targetName: "Attribute Form Description"
              translationValues:
                1033:
                  translation: "Unique identifier for the month in format YYYYMM"