# 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

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2F39lZXehiaV5pTNTHqRES%2FScreenshot%202025-05-08%20at%2010.45.14%E2%80%AFAM.png?alt=media&#x26;token=6b2fd1fb-72f5-42f0-928b-7818857d4250" alt=""><figcaption><p>Send message</p></figcaption></figure>

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

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2FfvcWr9cqoie3EWkiKZbb%2FScreenshot%202025-05-08%20at%2011.08.25%E2%80%AFAM.png?alt=media&#x26;token=3bbcc654-5115-4db6-a61f-ae5bddcf3320" alt="" width="375"><figcaption><p>Successfully send message</p></figcaption></figure>

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2FjDxlCVKdDBnp0DLT6l1U%2FScreenshot%202025-05-08%20at%2011.10.06%E2%80%AFAM.png?alt=media&#x26;token=f1ac66d5-bf1e-4dc4-944a-6c1bb0b33221" alt=""><figcaption><p>Recipient list</p></figcaption></figure>

#### Receive a Message

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

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2F4CLvEFWGVR5NwXOUT8VK%2FScreenshot%202025-05-08%20at%2011.14.04%E2%80%AFAM.png?alt=media&#x26;token=d343fcd1-79ea-4a1d-ad16-a5eedb157ea9" alt=""><figcaption><p>File download subscribe channel list</p></figcaption></figure>

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

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2FPhtlc8bC57IA57nNU1Gw%2FScreenshot%202025-05-08%20at%2011.17.17%E2%80%AFAM.png?alt=media&#x26;token=971e7fdc-7a03-4d95-9208-08ee980280f3" alt=""><figcaption><p>File download topic list</p></figcaption></figure>

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

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2FyuJT20iZETouDNcFKZFZ%2FScreenshot%202025-05-08%20at%2011.20.10%E2%80%AFAM.png?alt=media&#x26;token=9dae46af-beb1-4404-b716-28bae7281036" alt=""><figcaption><p>Received message</p></figcaption></figure>

4. Click `Download` to save the message as JSON file&#x20;

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2FQXKoLFeG8yLxDiuaimjt%2FScreenshot%202025-05-08%20at%2011.22.37%E2%80%AFAM.png?alt=media&#x26;token=e2067b0e-5229-4e6a-b754-496f180200a0" alt="" width="375"><figcaption><p>Message preview</p></figcaption></figure>

### 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

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2FrAMvagnWgln8ath0o1zy%2FScreenshot%202025-05-08%20at%202.26.51%E2%80%AFPM.png?alt=media&#x26;token=38946256-326b-4d99-a69c-d81c89108087" alt=""><figcaption><p>Send large data file</p></figcaption></figure>

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

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2FwC2qizBkALXkFlObzKLw%2Fimage.png?alt=media&#x26;token=336e2441-9ad4-45a7-82f2-9acdd6712644" alt="" width="375"><figcaption><p>Successfully sent a message</p></figcaption></figure>

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2F4PaCXleWZuVdHoRqsX89%2Fimage.png?alt=media&#x26;token=75a8a86b-e899-4176-9c2d-5a872710dc30" alt=""><figcaption><p>Recipient list</p></figcaption></figure>

#### Downloading a File

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

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2FuvCVQNWbRZvqo7l5P9Oq%2FScreenshot%202025-05-08%20at%202.30.54%E2%80%AFPM.png?alt=media&#x26;token=da6c540e-fc41-4cff-832e-fc6eb19292e0" alt=""><figcaption><p>Large Data Messaging subscribe channels</p></figcaption></figure>

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

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2FQBiCjUYbhS407P0vGiOP%2Fimage.png?alt=media&#x26;token=0ddc8359-b825-4b03-ae9f-afdcf94a972f" alt=""><figcaption><p>Large Data Messaging topics</p></figcaption></figure>

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

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2F3zT1r5yqztjX0YteH5Dt%2FScreenshot%202025-05-08%20at%202.36.06%E2%80%AFPM.png?alt=media&#x26;token=bf874343-18d9-4cc0-a413-64b5249c1f79" alt=""><figcaption><p>Received large data message</p></figcaption></figure>

### 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` &#x20;

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2Ft38CRfSFJyfqjeFy6dJM%2FScreenshot%202025-05-08%20at%203.06.25%E2%80%AFPM.png?alt=media&#x26;token=e9976177-e53d-468e-ae88-b1eaf020ceb6" alt=""><figcaption><p>Message Box > New Message menu</p></figcaption></figure>

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

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2FY7HAhaKUhZrzKTJjAf53%2FScreenshot%202025-05-08%20at%203.03.18%E2%80%AFPM.png?alt=media&#x26;token=2f40b556-e195-4cfb-b091-339f962eec64" alt=""><figcaption><p>Select channel and topic</p></figcaption></figure>

3. Fill the form and click `Next`

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2FzRo3a8iS6greGH8kO8sy%2FScreenshot%202025-05-08%20at%203.04.34%E2%80%AFPM.png?alt=media&#x26;token=e2c30fc7-8bd0-482e-b150-6089f869cd06" alt=""><figcaption><p>New message form</p></figcaption></figure>

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

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2FdkqHNtwADCJCw7fOVgpv%2FScreenshot%202025-05-08%20at%203.05.16%E2%80%AFPM.png?alt=media&#x26;token=40d0fb97-17fe-41ee-9654-f1b07e017745" alt=""><figcaption><p>Review message</p></figcaption></figure>

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

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2FQobKUYWdnhRgT0hSODbA%2FScreenshot%202025-05-08%20at%203.05.59%E2%80%AFPM.png?alt=media&#x26;token=1f1c3b24-8c6a-437f-a9c9-7a1bb8d5d659" alt="" width="375"><figcaption><p>Successfully sent a message</p></figcaption></figure>

#### Receiving a message

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

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2Fv9rchUUmMbsFJ6DZGq4Z%2FScreenshot%202025-05-08%20at%203.23.18%E2%80%AFPM.png?alt=media&#x26;token=b649f69b-325c-453b-9ba3-55fc708468b9" alt=""><figcaption><p>My messages channel list</p></figcaption></figure>

2. Click on `View Message` to see the message content

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2Fs8WgKgpj3pYuC7Gt4v8P%2FScreenshot%202025-05-08%20at%203.24.09%E2%80%AFPM.png?alt=media&#x26;token=97582852-ff8d-4d2d-b895-410fa5173c9f" alt=""><figcaption><p>Received messages list</p></figcaption></figure>

3. 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

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2F9THzQVz6ox5Oclwzt0KN%2FScreenshot%202025-05-08%20at%203.26.14%E2%80%AFPM.png?alt=media&#x26;token=6037e93f-e5cc-445b-aedd-95036b7b2dba" alt=""><figcaption><p>View message</p></figcaption></figure>

#### Replying a message

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

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2FsTpex4NTfd0B4Mqcbeic%2FScreenshot%202025-05-08%20at%203.24.27%E2%80%AFPM.png?alt=media&#x26;token=240b47e3-ad9d-480d-a677-5454187945ee" alt=""><figcaption><p>Reply message action</p></figcaption></figure>

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

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2FUKnGKAlyOyG4uU2BTy7h%2FScreenshot%202025-05-08%20at%203.26.33%E2%80%AFPM.png?alt=media&#x26;token=d3011b67-aaaa-4059-95fa-c3a364eb6fe3" alt=""><figcaption><p>Select channel and topic</p></figcaption></figure>

3. Fill in the reply form and click `Next`

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2FltBc1xYLKvp27TzqGlgP%2FScreenshot%202025-05-08%20at%203.44.44%E2%80%AFPM.png?alt=media&#x26;token=e0c85b6e-40f9-46b3-ae78-e3b7855990b6" alt=""><figcaption><p>Reply form</p></figcaption></figure>

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

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2FENTQAqGThlnmsfA7XWSx%2FScreenshot%202025-05-08%20at%203.27.34%E2%80%AFPM.png?alt=media&#x26;token=b1e60047-9b57-46b5-8cd5-4bb167eb9822" alt=""><figcaption><p>Review message</p></figcaption></figure>

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

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2FMTc8MdLlKcC6iOZgKGy6%2FScreenshot%202025-05-08%20at%203.28.22%E2%80%AFPM.png?alt=media&#x26;token=f385456f-66f3-43ca-b058-a98bdd949131" alt="" width="375"><figcaption><p>Successfully sent a message</p></figcaption></figure>

#### 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

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2FShqLds6XTEPQRiYaxuoT%2FScreenshot%202025-05-08%20at%203.48.30%E2%80%AFPM.png?alt=media&#x26;token=5a1df70e-643b-4dcc-a5ce-8a7f022390d7" alt=""><figcaption><p>Sent messages channel list</p></figcaption></figure>

2. Click on `View message`&#x20;

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2FNCL1W8k0wNtxiukR01YV%2FScreenshot%202025-05-08%20at%203.49.23%E2%80%AFPM.png?alt=media&#x26;token=1798e39d-02e5-4738-884c-283883b0cb82" alt=""><figcaption><p>Sent message list</p></figcaption></figure>

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

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2FINhssmRcTyCeNAIq1rN6%2FScreenshot%202025-05-08%20at%203.50.25%E2%80%AFPM.png?alt=media&#x26;token=8c522abc-4473-4d3e-9461-909067b678c6" alt=""><figcaption><p>View Message</p></figcaption></figure>

#### Viewing sent messages recipients

1. Click on `View recipients` in the sent messages page

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2FNlitpL6s0CCjxj24WWgy%2FScreenshot%202025-05-08%20at%203.49.23%E2%80%AFPM%20copy.png?alt=media&#x26;token=a3b64d10-302c-44f6-88b6-0f2657ba91cc" alt=""><figcaption><p>View recipients action</p></figcaption></figure>

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

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2FVwgt9KYuz67IhUllvO0P%2FScreenshot%202025-05-08%20at%203.50.38%E2%80%AFPM.png?alt=media&#x26;token=ba397144-2661-4851-8cc1-e72c884fdab6" alt=""><figcaption><p>Message recipient list</p></figcaption></figure>
