Documents

Devices with a connected display (i.e. digital sign or LCD screen) can have a number of document types enabled. A document is formatted content that will appear on the display when activated or played.

Multiple types of document are available based on the display hardware, capability and features subscribed. Each document type has its own specialised editor to perform the functions and programming required, see Document editors.

Document Registry

Any number of documents can be registered to appear concurrently (e.g., a document may be scheduled to appear all day on a Wednesday, and another document may be scheduled to appear between 10am and 2pm every Wednesday). This is called the "Document Registry".

By default, when multiple documents are registered to appear at a specific time, the display will cycle through each document once before looping back to display the first.

This behaviour can be overridden by taking into account a document's context and its priority.

Document Context

The document context is a way to keep track of why a document has been registered to appear. There are five possible contexts:

Manual Activation

This is the simplest context, and indicates that a document has been registered to appear from the "Documents Browser" page. Only one manually activated document can be played at a time - if another document is manually played, the first manually played document will stop playing.

Scheduled Activation

This indicates that a document has been registered to appear from the device schedule. A scheduled activation may be recurring, non-recurring, all day, or for a specific date and time only.

Scripted Activation

This indicates that a device script has become active, and has specified a document to appear.

Application Activation

This is a special document context that can only be used for a specialised "Application" module that may be installed, for example "Scoreboard".

Emergency Activation

This is a special document context that can only be used in case of an emergency, such as a natural disaster.

Document Priority

The document priority determines which documents will appear if there are multiple documents registered at the same time. If the priority of all documents registered is the same, all documents will be displayed. If there are documents with higher priority, only the higher priority document(s) will appear.

Low Priority

A document with low priority will only appear if there are no other documents that are not also of low priority.

Normal Priority

A document with normal priority will only appear if there are no other documents of higher priority, while any documents with low priority will not appear.

High Priority

A document with high priority is the highest that a user can select. When a high priority document is registered to appear, low and normal priority documents will not appear.

Application Priority

Any document with an application context will also appear with application priority. When an application document is registered to appear, any documents of low, normal or high priority will not appear.

Emergency Priority

Any document with an emergency context will also appear with emergency priority. This is the highest priority level, and a registered document with emergency priority will always appear, and any document with a lower priority will not be displayed.