li-distribution-dates

Notice: The li-distribution-dates plugin is only available if the Planning System is enabled.

Supported Features

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

Description

Stores the dates when a document needs to be ready for distribution, for example on the website, in a newsletter or in print. A document can have several distribution dates. The dates are used by the Planning Board and the Planning Calendar.

UI Configuration

Precision

The precision configuration option controls whether editors can set both date and time or only the date.

{
  handle: 'distributionDates',
  type: 'li-distribution-dates',
  ui: {
    config: {
      precision: 'date' // Options: 'datetime' (default) or 'date'
    }
  }
}

Configuration Options:

  • precision: 'datetime' (default): Editors can set both date and time
  • precision: 'date': Editors only set the date; time is automatically set to 12:00 (noon) for timezone consistency

Planning Board Config

// Excerpt from project config
module.exports = {
  dashboards: [
    {
      type: 'planningBoard', // automatically adds main column and distribution dates column, has custom sorting and filtering
      handle: 'daily',
      pageTitle: {en: 'Daily Planning', de: 'Tagesplanung'},
      interval: 'day',
      baseFilters: [{key: 'contentType', term: ['regular', 'simple', 'pitch', 'bundle']}],
      displayFilters: [{metadataPropertyName: 'team'}, {metadataPropertyName: 'effort'}],
      additionalMetadataProperties: ['team', 'effort'] // Puts these columns between main column and distribution dates column
    }
  ]
}

Planning Calendar

Distribution dates can also be planned on a calendar. See Planning Calendar.

Default UI

Metadata form and Table Dashboard Cell

Storage Format

[
  {
    id: <String>,
    date: <ISO8601 String>,
    done: <Boolean>
  }
]

Content Type Config

{
  handle: 'myContentType',
  // ...
  metadata: [
    {
      handle: 'myHandle',
      type: 'li-distribution-dates',
      ui: {
        config: {
          precision: 'datetime' // Options: 'datetime' (default) or 'date'
        }
      }
    }
    // ...
  ]
}