Offline Document Indicator in Experience Manager

One Pager

Scope

“As an editor, I want to see a warning in the UI in Experience Manager if a component in a page has an offline document linked to it, so that I don't publish the page or the website without publishing the document in the component.”

• Show a UI indicator on “Edit document” overlays and component outline overlay in experience manager when there is an offline document in a component
• Create logs when a component references offline documents so that a report for components with offline documents can be created.
• UI changes regarding overlays based on provided [designs
• Content edit button shape change
• Overlay color changes

Requirements

• Show a UI indicator on “Edit document” overlays in experience manager when there is an offline document in a component
• Enable UI indicator when “Edit document” overlays are enabled in the channel
• Make indicator work in real time - if the document is published, indicator should be updated/removed in real time so that components with published and offline documents can be easily identified
• If the user moves to another page or moves to another perspective in the CMS, the UI indicator will be available for components with offline documents when the user opens the channel that the UI indicator is enabled for.
• Indicator will work for rendered documents in the experience manager only. (see out of scope for details)

• This feature should be enabled specifically by customers just like overlays (on top of overlays) if the customer wants to have it.
• Create logs when a component references offline documents so that a report for components with offline documents can be created.
• UI changes regarding overlays based on provided designs
• Content edit button shape change
• Overlay color changes
• Overlay states: Default(default preview state), Active(component is selected), Offline document(offline document is referenced in the component)

Based on the discussion on the solutioning week(August 18) - the solution will cover both type of lists since the implementation doesn't differ for these 2 cases.

• List(e.g. News list)/gallery(e.g. Banner carousel) components

1. Type 1: List/gallery components fed by a query

Example: A news list components checks for all news item in a folder and shows the most recent online documents in a list in the website

We will keep these kinds of lists out of scope for the indicator feature because the invalid state for these components depends on a queried list, not on specific documents referred by the component.

2. Type 2 :List components referencing specific documents to create the list

• These components show hand-selected documents and have direct references to these documents. Example: Banner carousel component
• The indicator will be available for the specific documents offline in the component. The offline document will be also visible in the component details in the right hand side panel so that users can also check the overall list of documents in the component as well. 

• This indicator will be only available for the documents that are rendered in the experience manager while the user previews the channels in the experience manager. This means that;
• For the publication status of the project branches of the documents can be only shown with an indicator when the project branch is previewed in the experience manager so the user should specifically preview the project branch in the experience manager.
• For personalization, publication status of the documents in the different variants of the components can be only shown with an indicator when the related variant is previewed in the experience manager so the user should specifically select and preview the related variant of the component in the experience manager.