Skip to content

Element notices

Intro

Elements can change from time-to-time. These updates can affect the progress of an element for a Flowcode user so it is sometimes important that a Flowcode user is made aware of significant updates on an element.

The element update notices can be used to notify a Flowcode user when a significant change has been made to an element. These notifications can be set to expire so that users are only shown relevant recent update notices.

Creating notices

Update notices can be added to an element in the Notices tab when viewing an element. Here you can view all past notices, as well as create a new notice.

When creating a notice you can add:

  • Notice title: A helpful title of the notice to the end-user
  • Notice description: A helpful description outlining the update for the end-user in more detail
  • Notice expiry: A date and time that the notice will no longer show on the element

Active notices

Active notices are notices that have been created and have not yet expired on an element. If an element has an active notice, there will then be an indicator on the element card, as well as on the element view page. This indicator will show until the notice has expired.

Viewing a notice

A Flowcode user can click the notice indicator to open the notice in a global notice modal. The modal will show all notices that are active for the given element.

Catalogue notices

If a catalogue has elements with active notices, the notice indicator will also show on the catalogue card. Opening the notice modal will show all the active notices within the catalogue elements

Notice data structure

The notices are stored in the DB table element_notices which use the model ElementNotice. The data structure of the model is as follows:

  • ID
  • element_id
  • title
  • description
  • expiry_at
  • timestamps

Notice relationships

Elements have a belongsTo relationship with the ElementNotice model.

Catalogues have a custom method to get notices as it is through the catalogue elements.

Appending the notices

Both elements and catalogues have an append method set up to append the notices to the models for use on the front-end

Notices can be appended to elements