External Systems

Added in: release-2022-07

External Systems define a relation to a source system. External Systems usually have stored the original document which will be one way synced to Livingdocs via Import.

An example:

externalSystems: [
  {
    handle: 'cms',
    isPrimary: true, // default: false
    url: {
      origin: 'https://cms.de',
      pathPattern: '/{{id}}/{{metadata.cmsId}}'
    }
  }
]

An External System defines an URL with origin and a pathPattern. The pathPattern can have placeholders which will be replaced with real values during runtime to build the final URL to the source system.

• {{id}} -> replaced by Livingdocs documentId
• {{metadata.cmsId}} -> replaced by a metadata field with the handle cmsId

If isPrimary: true is set for an External System this system will be preferred when only one link in the Editor can be displayed.