Broadcast messages are an effective way for admin users to send real-time notifications or urgent updates to any group of logged in users. For instance, a server restart or maintenance message, or an urgent notice relevant only to certain user teams.
To use Messaging in the Power User Interface, make sure Messaging is included in your navigation menu (User Menu > Preferences > Navigation Menu Setup) and that your group has permission to send messages (Setup > Access > Manage Groups, edit the group, and select the "Allow access to Messaging wizard" checkbox on the General tab). Only admin users can edit group permissions.
You can broadcast messages at the Knowledgebase or the server level. Broadcasting at the server level sends the message to every KB on the server, so it requires access to the Administrator Console.
Messaging All Users in a Knowledgebase
To send a broadcast within one Knowledgebase to all logged-in users:
- Click Messaging in the navigation menu.
- Enter the message content in the Message field.
- Under Recipients, choose whether to message everyone or only certain people. You can also choose not to show the message to yourself. If you select "Only these people," you can select teams, users, and chat users, in any combination. You can message end user teams using these options.
- Press Send. The message is delivered shortly as a pop-up to logged-in recipients.
Messaging All Users on a Server
To send a message to everyone, meaning every user logged in to any knowledgebase on the same instance of Agiloft, log in to the Admin Console and go to Setup > Broadcast.
Using a REST Request to Send a Message
You can also construct an HTTP request with specific attributes and parameters to send a message without logging in to the system, but the request must include credentials for an admin user.
Server Restart Message
You can send this default message when you are about to restart the server:
To do that, use this request with your server name, the name of your KB, and the credentials for an admin user with the "Allow access to Messaging wizard" permission enabled:
The same request can be used to send the default restart message to all KB's installed on your server. For that, you need to use admin as the KB name and valid credentials for the admin console.
To send your own message, you need to include two additional attributes:
messageparam=your message text.
For example, this request URL would send the message "Please save your work!":
System Text Custom Message
As part of localization, the system uses a properties file that contains all Agiloft system messages and interface text. For example, the text you read in any wizard or dialog screen is contained in this file. You should not edit this file unless you are adding Localization support for a new language, and if you want to add new content to it, you should contact Support. However, you can use the default file content to send messages without hard-coding the text.
The file contains pairs of keys and values. If you know the key name, you can access the value. For broadcasting using REST, we employ this concept to access predefined, often parameterized, text messages, that also can be translated in different languages.
To download the file, go to Setup > Localization > Translate, select the language you want to use, and download the GUI2_XX.properties file, where XX is the Java localization code.
See the example below, where we use the GUI2.properties key
server.isdown.soon as a
messagekey and value 15 as a parameter:
This results in the following message being sent:
Using SSH Connection to the Server
If you have login access to the server itself, you can send a broadcast message from the Unix or Linux command line. The message is sent to all KBs on that server.
Navigate to the Agiloft installation directory and run the following: