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
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
Send message
Success message will be shown, click Close to close modal or View recipients to see the recipient list and delivery status
Successfully send message
Recipient list
Receive a Message
Navigate to Data Messaging > File Download and choose a channel by clicking on it
File download subscribe channel list
You will be redirected to topic list page, click on a topic to proceed
File download topic list
The message will be displayed, click on View details to see message content
Received message
Click Download to save the message as JSON file
Message preview
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
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
Send large data file
Success message will be shown, click Close to close modal or View recipients to see the recipient list and delivery status
Successfully sent a message
Recipient list
Downloading a File
Navigate to Large Data Messaging > File Download and choose a channel by clicking on it
Large Data Messaging subscribe channels
You will be redirected to topic list page, click on a topic to proceed
Large Data Messaging topics
The message will be displayed, click on download button to download the received file
Received large data message
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
Navigate to Message Box > New Message
Message Box > New Message menu
Select a channel, topic name and version. Click Next to proceed
Select channel and topic
Fill the form and click Next
New message form
Review the JSON generated based on your form input in the previous step. Click Send Message to proceed
Review message
Success message will be shown, click Dismiss to close modal
Successfully sent a message
Receiving a message
Navigate to Message Box > My Messages and click on the channel you would like to view message from
My messages channel list
Click on View Message to see the message content
Received messages list
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
View message
Replying a message
Click Reply directly in the view message modal or in the received messages list
Reply message action
Select a channel, topic name and version before clicking Next
Select channel and topic
Fill in the reply form and click Next
Reply form
Review the JSON generated based on your form input in the previous step. Click Send Message to proceed
Review message
Success message will be shown, click Dismiss to close modal
Successfully sent a message
Viewing sent messages
Navigate to Message Box > Sent and click on the channel you would like to view messages that you have sent to
Sent messages channel list
Click on View message
Sent message list
The message will be displayed. You may also switch between entry or JSON view. Refer to the next section for viewing recipients
View Message
Viewing sent messages recipients
Click on View recipients in the sent messages page
View recipients action
The recipient list will be displayed. Click x to close modal
