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.
...
| Info | ||
|---|---|---|
| ||
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. |
Broadcasting Messages
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, perform the following steps:
| Excerpt |
|---|
...
|
...
|
...
|
...
|
...
What if Messaging is not Enabled?
...
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
| Companyname |
|---|
...
Using a REST Request to Send a Message
It is possible to You can also construct an HTTP request with specific attributes and parameters to send a message without logging in to the system. The , 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:
| Code Block | ||
|---|---|---|
| ||
httphttp://myewserver:8080/ewws/EWBroadcast?$KB=Demo& $table=chatmessage&$login=admin& $password=your_password&$lang=en |
In this case, the KB attribute expects the name of your knowledgebase. The login and password pair should identify an admin user with enough privileges to send a broadcast message.
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 login to credentials for the admin console.
| Code Block | ||
|---|---|---|
| ||
http://myewserver:8080/ewws/EWBroadcast?$KB=admin& $table=chatmessage&$login=admin& $password=your_password&$lang=en |
...
Custom Message
To send your own message, you will need to use include two additional attributes: messagekey=clear_message and messageparam=your message text.
For example, this request URL would send the To send a message "Please save your work!", the request URL should look like this:
| Code Block | ||
|---|---|---|
| ||
http://myewserver:8080/ewws/EWBroadcast?$KB=Demo& $table=chatmessage&$login=admin& $password=qwerty&$lang=en&messagekey=clear_message& messageparam=Please save your work! |
...
System Text Custom Message
As part of localization solution , the system uses a properties file . This file that contains all
| Companyname |
|---|
The file contains pairs of keys and values. If you know the key name, you can access the value.
To download the file, go to Setup > Localization > Translate. In this screen you can download the Program Translation File, with a name in the format GUI2_XX.properties, where XX is the Java localization code.
For For broadcasting using REST, we employ this concept to access predefined, often parameterized, text messages, that also can be translated in different languages.It is recommended to consult with customer support by submitting a ticket if you would like to add a new key/value pair, otherwise existing ones can be used with any parameters.
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:
| Code Block | ||
|---|---|---|
| ||
http://myewserver:8080/ewws/EWBroadcast?$KB=Demo& $table=chatmessage&$login=admin&$password=qwerty&$lang=en &messagekey=server.isdown.soon&messageparam=15 |
This results in the following message being sent:
| Code Block | ||
|---|---|---|
| ||
PleasePlease save your work and logoff, the server is going to be restarted for the system checks in 15 minutes. It will be available in 10 minutes. |
...
If you have login access to the server itself, you can send a broadcast message from the command line (Unix/Linux)Unix or Linux command line. The message is sent to all KBs on that server.
Navigate to the
| Companyname |
|---|
| Code Block | ||
|---|---|---|
| ||
echo The server will be restarted for a system check. > ./tmp/message2broadcast |
...
| Hide If | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
Related articles
|