li-kordiam-integration

Supported Features

Document✔
Media✗
Include✗
Document Creation Flow✗
Push Message✗
Table Dashboard✔
Display Filter✗
Search Indexing✔
System Metadata✗
Webhook Conditions✗

Description

Added in: release-2024-11. Prior to release-2024-11, li-kordiam-integration was known as li-desknet-integration.
Support for li-kordiam-integration will eventually be removed. Please use li-kordiam-global instead. To migrate, please refer to our Kordiam Global Integration migration guide.

This plugin is used to connect Kordiam stories with Livingdocs documents. There are numerous options available to synchronise data between the two platforms. Further details can be found in the Kordiam Platform Integration Guide.

Default UI

Document Metadata: Read-only link to Kordiam distribution entry
Table Dashboard: Read-only Kordiam publication/platform status

Storage Format

{
  id: <Integer>,
  publicationId: <Integer>,
  platformId: <Integer>,
  categoryId: <Integer>,
  publicationStatusId: <Integer>
}

Content Type Config

{
  handle: 'myContentType',
  // ...
  metadata: [
    {
      handle: 'myHandle'
      type: 'li-kordiam-integration',
      config: {
        publicationStatus: {
          fallbackPublicationStatusId: '2',
          // The order of matchers is important. The array is iterated through from first to last,
          // with the publicationStatusId taken from the earliest document state match.
          matchers: [
            {
              type: 'publication',
              value: 'published', // Only 'published' supported
              publicationStatusId: '5'
            },
            {
              type: 'task',
              taskName: 'proofreading',
              value: 'completed', // 'requested', 'accepted', 'completed'
              publicationStatusId: '4'
            },
            {
              type: 'metadata',
              propertyName: 'prepared',
              value: true, // <String>, <Number>, <Boolean>, <Array>, <Object>
              publicationStatusId: '3'
            }
          ]
        }
      },
      ui: {
        label: 'Kordiam',
        config: {
          publicationStatus: {
            labels: [
              {
                publicationStatusId: '5',
                label: 'Published',
                // optional, any SVG (ideally using viewBox)
                icon: '<svg viewBox="0 0 9 9" xmlns="http://www.w3.org/2000/svg"><path d="M0 0h9v9H0z"/></svg>',
                // optional, any CSS colour string
                color: '#f00'
              }
            ]
          }
        }
      }
    }
    // ...
  ]
}