3.2.3. Messages

Polaris Workflow and Polaris Workflow Analytics will send window post messages.
You can send these messages to your application or analytics collector.
You can display or hide a loader for example, see the example.

Specification

The message will be in the following format.

export interface Message {
    type: 'PROCESS_CHANGED' |
          'START_LOADING' |
          'END_LOADING' |
          'ERROR' |
          'VALIDATION_ERROR' |
          'WORKFLOW_CHANGING' |
          'WORKFLOW_CHANGED' |
          'UN_AUTHORIZED';
    description?: string;
    metadata?: {
          process: string?,
          activity: string?,
          activityType: string?,
          timestamp: number
   }
}

Metadata	Description
process	The name of the process.
activity	The name of the activity.
activityType	The type of the activity, page-activity for example.
timestamp	The time stamp of the message.

Add the following script to listen to the messages.

<script>
    window.addEventListener('wfMessage', (event) => {
        const msg = event.detail;

        switch (msg.type) {
          case "ERROR": return this.logAnalytics(msg);
          .....
          .....
          case "WORKFLOW_CHANGED": return logAnalytics(msg);
        } 
    });
</script>

Messages

Message	Description
ERROR	An exception occurred in the flow.
UN_AUTHORIZED	You are not authorised to access the remote resource, you must login.
START_LOADING	A long running process started, a http call for example.
END_LOADING	The long running process is finished.
PROCESS_CHANGED	A new process is loaded.
VALIDATION_ERROR	A validation on your form failed.
WORKFLOW_CHANGING	A new activity is going to be executed.
WORKFLOW_CHANGED	The new activity has been executed.