System Messages

System messages are an API-based solution that triggers a yellow warning banner for selected users, implemented within the SCIL framework. It was originally created to notify users if their session has expired, prompting them to re-authenticate. Partners sometimes also need a reliable method to notify users when authentication to their system has expired, and this is where System messages come in handy.

• Regular users cannot send messages to others, but they can send reminders to themselves.
• Admin or system users can send messages to other users.

System messages support standard Markdown.

​

KeepAlive

To ensure timely delivery of messages and prevent indefinite queuing, system messages are tightly integrated with the KeepAlive system. The KeepAlive system periodically makes API calls to check the user’s authentication status. When the KeepAlive is called, the server event plugin will checks for any pending messages associated with the current associate. If relevant system messages are found, they are returned in the KeepAlive response.

​

Dismissing messages

When a user closes the banner (clicking ❌ button), RemoveSystemMessage is called, which will remove the message from the database.

​

Send system message

The DiagnosticsAgent_SendSystemMessage method puts a new system message into the message table for a specific user. Parameters:

​

Remove system message

The DiagnosticsAgent_RemoveSystemMessage method removes a message from the message table for a specific associate. A system user or user administrator rights are required to remove other’s messages. Parameters:

​

Get system messages

The DiagnosticsAgent_GetSystemMessages method retrieves system messages for a specific associate. Parameters:

​

SystemMessageType