Flash Messages Application (Pro)

Allows you to create Flash messages aiming at one or multiple local groups

viewAdminFlashIndex.png
CategoryApplication
Active Installs4
Rating
0 Votes
LicenseGNU Lesser General Public License 2.1
SourcesIssues

This application allows admin users to create programmed flash messages aiming towards one or multiple groups. When a new flash message is created, it pops up on the screen for all the users from the selected groups, the first time they visit the wiki. After dismissing it, the message is still available just below the header of the page.

Home page

In order to access the home page of the application, the users have to look for Flash Messages entry in one of the following 2 places:

  • the Applications panel located by default in the left panels section of the page
  • the Other section from the global administration of the wiki (this option exists because the application is intended for admin users and it would make sense to have an entry point in the Administration, besides the best practice of listing the application in the Applications panel)

Flash messages index view in the FlashMessages.WebHome page:

viewFlashIndex.png

Flash messages index view in Global Administration > Other > Flash Messages section:

viewAdminFlashIndex.png

Create flash message

In order to create a new message, click Create button from the top of the page and the next step will display a list of available templates where you can find the one corresponding to flash messages.

createFlash.png

Message structure

Each entry requires a start date from which the message will start being displayed, a list of groups to show it to and the actual message.
Optionally, you can provide an end date and set up the event as a recurring one.

viewFlash.png

Recurrency

In order to make an event recurrent, set the repeat property to "Yes".
After this step, a new settings layer will appear in order to configure the repeat period.
Choose your desired settings such as repeat interval, repeat frequency and the days of the week and you're set.
Be sure to keep an eye on the "Repeat summary" to have a human friendly overview of your settings.

editFlash.png

Display

Popup alert

The messages are displayed to a concerned user in form of a popup when the first page is loaded after the start time.

popupFlash.png

Header notification

After the user has viewed the message it is marked as seen and is only displayed in the top slider which contains the three most recent messages. Note that each message is shown for 10s after the slider goes to the next one.

headerFlash.png

Each of the three last messages is marked by a bullet in the right side of the flash bar located just under the header.
These bullets are used not only to display the position of the current message but to navigate through them as well.

toggleFlashes.png

Installation Steps

This paid extensions requires XWiki 8.4 or above. In order to install the extension, follow the next steps inside your XWiki instance (on cloud or on premise).

Navigate to the Extension Manager

In the Applications Panel click on "More Applications..." and then "Install new applications...". Alternatively navigate directly to the Administration and select the "Extensions" section.

step1.png

Install the Extension

Search for the extension you wish to install and use the Install button to install it.

step2.png

Get a License

Navigate to the "Licenses" section of the Administration, fill your details, look for the extension you just installed in the live table and click the buttons to get a trial license or to buy a license.

step3.png

Install the License

If you have selected a trial license then you're good and there's nothing else to do. Your trial license is automatically installed.

However if you've selected to buy a license you'll be redirected to a page to perform the payment. At the end you need to come back to the "Licenses" administration section and click on the "Check for Updates" button. This will download and apply the license you bought.

Use the Extension

Start using the Extension! Refer to the extension's documentation to know how to use it.

Options

The price is per year and varies depending on the support level and the number of users.

Support / Users 25 100 500 1000
Silver
Gold
Flash Messages Application (Pro) is part of the XWiki Pro package. Purchasing this package you will benefit from more extensions at a better price. Check the full offer in XWiki Pro!

Benefits

What do you get when you purchase an XWiki extension?

1 year license

By purchasing an XWiki extension license, you'll benefit from it during one year.

Free updates

You benefit from all the extension updates during one year. You are always up to date.

Support included

If you are facing an issue, you can reach the XWiki support. Our team is always available to help.

How to Buy

To buy, install this extension from inside your XWiki instance and follow the instructions.

Release notes

v1.3.4

Bugs fixed:
#11 Group picker is missing from the Group field in edit mode which prevents sending messages.
#13 Flash Messages template is not preselected when creating a new entry.
#14 Invalid group names can be introduced when creating a new entry.
#18 Improve the display for Flash entries.

v1.3.3

Update the Licensing dependency to version 1.13.

v1.3.2

Update the Licensing dependency to version 1.12.2.

v1.3.1

Update the Licensing dependency to version 1.12.1.
Bugs fixed:
#7 Error message in Administration when there is no licence for the app.

v1.3

Remove the App Within Minutes Application dependency.
Create template provider.
Improve the message displayed when there is no valid license.
Update the Licensing dependency to version 1.8.

v1.2

Initial paid version.

Extension details

This information is only displayed to Administrators. Your users can't see this tab.

License

  • GNU Lesser General Public License 2.1

Sources

Issues

Type

  • xar

Developed by

Compatibility

  • Requires XWiki 8.4 or above.
Installable with the Extension Manager

Dependencies

  • com.xwiki.licensing:application-licensing-licensor-api 1.13
  • org.xwiki.platform:xwiki-platform-livetable-ui 8.4
  • org.xwiki.platform:xwiki-platform-rendering-macro-velocity 8.4
  • org.xwiki.platform:xwiki-platform-rendering-macro-code 8.4
  • org.xwiki.platform:xwiki-platform-rendering-macro-include 8.4
  • org.xwiki.rendering:xwiki-rendering-macro-html 8.4
  • org.xwiki.platform:xwiki-platform-rendering-macro-script 8.4
Tags:
Created by Administrator on 2018/02/26 13:11