Messaging

Overview

The Client Gateway supports the transmission and reception of messages and large files. Alternatively, participants can exchange messages through the Message Box when the Message Forms option is enabled. In this case, users can leverage a dynamically generated form, automatically populated based on the structure defined in the uploaded JSON schema.

User Guide

Pre-requisites

• Authorization to Client Gateway

• Subcribe/publish channels

• Topics

Simple Messaging

A message can be sent by uploading a JSON file that defines the desired channel and topic in Data Messaging File Upload and vice versa.

Send a Message

1. Navigate to Data Messaging > File Upload. Choose channel name, topic and version before uploading a json file that matches the selected topic schema. Click Save to send the message

1. Success message will be shown, click Close to close modal or View recipients to see the recipient list and delivery status

Receive a Message

1. Navigate to Data Messaging > File Download and choose a channel by clicking on it

1. You will be redirected to topic list page, click on a topic to proceed

1. The message will be displayed, click on View details to see message content

1. Click Download to save the message as JSON file

Large Data Messaging

Schema types such as XML, TSV and CSV are classified as large data types and are being handled under Large Data Messaging within the Client Gateway.

Uploading a File

1. Navigate to Large Data Messaging > File Upload. Choose channel name, topic and version before uploading a file that matches the selected topic schema. Click Save to send the message

1. Success message will be shown, click Close to close modal or View recipients to see the recipient list and delivery status

Downloading a File

1. Navigate to Large Data Messaging > File Download and choose a channel by clicking on it

1. You will be redirected to topic list page, click on a topic to proceed

1. The message will be displayed, click on download button to download the received file

Messaging UI

An alternative method for sending and receiving messages is through the Messaging UI. Instead of uploading a JSON file containing the message content, users can use the dynamic form to complete required and optional fields as defined by the selected topic's schema.

Sending a message

1. Navigate to Message Box > New Message

1. Select a channel, topic name and version. Click Next to proceed

1. Fill the form and click Next

1. Review the JSON generated based on your form input in the previous step. Click Send Message to proceed

1. Success message will be shown, click Dismiss to close modal

Receiving a message

1. Navigate to Message Box > My Messages and click on the channel you would like to view message from

1. Click on View Message to see the message content

1. Entry view will be shown by default, you may also switch to JSON view to see the received message. Refer to the next section for replying a message

Replying a message

1. Click Reply directly in the view message modal or in the received messages list

1. Select a channel, topic name and version before clicking Next

1. Fill in the reply form and click Next

1. Review the JSON generated based on your form input in the previous step. Click Send Message to proceed

1. Success message will be shown, click Dismiss to close modal

Viewing sent messages

1. Navigate to Message Box > Sent and click on the channel you would like to view messages that you have sent to

1. Click on View message

1. The message will be displayed. You may also switch between entry or JSON view. Refer to the next section for viewing recipients

Viewing sent messages recipients

1. Click on View recipients in the sent messages page

1. The recipient list will be displayed. Click x to close modal