Application Notes
Application Notes
Application notes are intended to display information to MLM users in a notification bar at the top of the screen. This bar can include a link to a pop-up screen with additional information, or a link to a specific page. This feature is useful for notifications about updates, upcoming system downtime, to inidicate that an export is ready, or any other information you want to notify users about.
To manage application notes, go to the Cog menu in the top right corner and click “Application Notes”. You can add a new note by clicking “+ New Note” in the top right corner.
The “Start of note display” and “End of note display” are used to indicate when the application note will be shown to users. Both of these are required in order for the note to become visible to users.
The “Subject” is the text shown in the notification. For example, this could be “A new update has been released!”.
The “Body” is the pop-up that will show when you click for more information. This body can include HTML formatting. Instead of this body, you can also link to a specific page that the user will be directed to instead.
You can add a URL in “Link for more information” if you want the user to be directed to a specific page. If left blank, the contents of the “Body” will be shown instead.
The “Text to display for more information” is the text that will link to the Body text or the indicated URL above. For example, this could be “Click here for more information”.
The “Show when people log on” checkbox will show the note upon login. This is required for the notification to show up.
When “Dismissible” is checked, users can dismiss the pop-up, but it will show again the next time they log in.
When “Dismissible by default” is checked and “Dismissible” is checked as well, the user can check a box within the pop-up to indicate they never want to see the notification again.
When only “Dismissible by default” is checked, the note will only be shown once by default, without the user having to confirm that they do not want to see the pop-up again.
The “Language code” is not needed and only for advanced usage.
The “Visible permission” can be used to only show this notification to a specific set of users with the selected permission.
The “Note type” will not be shown, but can be useful for administrative purposes.