Flash Messages Application (Pro)

Last modified by Administrator on 2024/02/18 00:00

Flash Messages Application (Pro)

Schedule and display flash announcements to one or multiple groups. Messages can be set as one off or recurring events. The app can be purchased individually or part of the XWiki Pro package. Try it free.

viewAdminFlashIndex.png
CategoryApplication
Active Installs16
Rating
0 Votes
LicenseGNU Lesser General Public License 2.1
Minimal XWiki version supported XWiki 13.10
SourcesIssues

This application allows admin users to create programmed flash messages aimed 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 will be available below the page header.

The app can be accessed from the following two locations:

  • the Applications panel located on the left side of the page
  • the Other section from the global administration of the wiki

applicationsPanel.png

otherAdminSection.png

viewFlashIndex.png

Flash messages index view in the app home

viewAdminFlashIndex.png

Flash messages index view from the Global Administration > Other > Flash Messages section

 

Topics

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 13.10 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.

Installing Paid Apps on Subwikis

If you want to install an application on the whole farm (main wiki + subwikis), you can do so directly from the main wiki’s Extension Manager, as seen below:

step4.png

Extensions can also be installed only on a particular subwiki by global admins. Subwiki admins will not be able to install these extensions due to their limited rights.

Options

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

Support / Users 10 25 50 100 250 500 1000 2500 5000 10000 20000
Silver
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.7.2

Upgrades:

  • #61 Upgrade Licensor dependency to version 1.25

v1.7.1

Upgrades:

  • #59 Upgrade Licensor dependency to version 1.24.3

v1.7

Tasks done:

#58 Upgrade parent to 13.10-3

Upgraded licensing version to 1.24.1.

v1.6.3

Update the Licensing dependency version to 1.22

v1.6.2

Bugs fixed:
#57 Implicit XWikiAllGroup membership is not supported

Upgrade the Licensing Application dependency to version 1.21.1

v1.6.1

Update the Licensing dependency to version 1.20

v1.6

#56 Update parent version to 11.10.

v1.5

Bugs fixed:
#10 Flash Messages Application's recurrency not working.
#46 Many warnings when using Flash Messages App on XWiki 12.1.
#49 The 'groups' column filter (select input) causes a Java Heap error in wikis with large amounts of groups.
#55 Update the template provider for the flash to replace the usage of the deprecated "spaces" property.

Improvements:
#43 Update parent version to 9.11.

Update the Licensing dependency to version 1.16.1.

v1.4.8

Bugs fixed:
#42 Flash functionality changed from default Repeat "No" to "Yes".

v1.4.5

Bugs fixed:
#23 'Null' value displayed when no repeat frequency is selected.
#38 Bullets aren't automatically selected for each Flash message so the slider isn't working properly.

v1.4.4

Bugs fixed:
#22 Label of an external link is not correctly displayed in the pop-up box.
#31 Styling is not working in the pop-up, lists disappear in the top bar.
#33 New empty line appears after installing the Flash Message PRO.

Improvements:
#26 The 'Groups' drop-down filter box should display only groups added on entries (instead of all existing groups on the wiki).
#34 Styling is not working in the pop-up, lists disappear in the top bar.

v1.4.3

Update the Licensing dependency to version 1.13.8.

v1.4.2

Update the Licensing dependency to version 1.13.4.

v1.4.1

Update the Licensing dependency to version 1.13.3.

v1.4

Bugs fixed:
#9 UI doesn't look good in the pop-up.
#13 Flash Messages template is not preselected when creating a new entry.
#27 Flash Entries title from livetable is WebHome.

Update the Licensing dependency to version 1.13.2.
Updated translations

  • French

v1.3.4

Bugs fixed:
#11 Group picker is missing from the Group field in edit mode which prevents sending messages.
#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 13.10 or above.

Installable with the Extension Manager

Dependencies

  • com.xwiki.licensing:application-licensing-licensor-api 1.25
  • org.xwiki.platform:xwiki-platform-livetable-ui 13.10
  • org.xwiki.platform:xwiki-platform-rendering-macro-velocity 13.10
  • org.xwiki.platform:xwiki-platform-rendering-macro-code 13.10
  • org.xwiki.platform:xwiki-platform-rendering-macro-include 13.10
  • org.xwiki.rendering:xwiki-rendering-macro-html 13.10
  • org.xwiki.platform:xwiki-platform-rendering-macro-script 13.10
  • org.xwiki.platform:xwiki-platform-uiextension-api 13.10
Tags:
Created by Administrator on 2018/02/26 13:11
XWiki SAS Copyright © 2024