Message queue

Message queue helps administrators send messages across the user interface.

Helps administrators send a message to all logged-in users to indicate the system will be halted and automatically log out the users 5 minutes after they receive the message.

The application sends messages to a user when a background process has been completed.

The application sends warnings to a user about an action that is not allowed.

Among other messages.

Allowed parameters in the body of the messages:

ParameterSampleDescription
uuid

<uuid>48b29080-57d9-558e-a306-a7b48314983d</uuid>

The UUID of a node.

taskInstance

<taskInstanceId>19</taskInstanceId>

The task instance ID of a workflow.

taskId

<taskId></taskId>

The ID of a task.

The queue of messages is shown in a table structure:

Date

Action

Message

To All

To Users

To Roles

Message parameters:

FieldDescriptionRequired

Date

Date of the message.

Automatically set by the application.

true

Action

Available values:

  • Logout (force users who receive it to log out)

false

Message

The text of the message.

true

To All

When present, the message is sent to all users.

*

To Users

When present, indicates a set of users to send the message.

*

To Roles

When present, indicates a set of users who are members of any of these roles.

*

* At least one of the options.

Send a message

  • Click on the New message icon.
  • Fill in the fields.
  • Click on the Create button.

Edit a message

  • Click on the  Edit message icon.
  • Modify the fields.
  • Click on the Edit button.

Delete a message

  • Click on the  Delete message icon.
  • Click on the Delete button.

Delete all messages in the queue

  • In the top right, click on  Clear button.

This operation cannot be reverted. The entire message queue will be deleted.

Refresh the message queue

  • In the top right, click on  Refresh button.