Reading/Sending a Message

Navigation:  Managing a Site > Data Sync > Messagebox >

Reading/Sending a Message

Previous pageReturn to chapter overviewNext page

 

Overview

 

It is possible to read a message that has been sent to a Mobile to Back-end and/or a Back-end to Mobile topic as well as send a message to the topic itself. Both features are mainly used for  testing/maintenance (the "Messagebox Service's" purpose is to facilitate message exchange between the devices and a back-end).

 

If you intend to send a message onto the selected topic, make use of its "Message Template" tab (in the topic's "...Topic Details" page) to create a message model with the necessary headers - the template is automatically applied to any message you send onto that topic.

Any necessary editing of a header's name is done in the "Message Template" tab. Editing a Topic - Message Template tab.

 

Check the following links to access the intended step-by-step:

See To Read a Topic's Message below.

See To Send a Message to a Topic.

 

 

To Read a Topic's Message

 

This "Read Message" operation reads the queued messages that were sent to the current topic.

This is mainly used for testing purposes.

 

Note

This option is ONLY available for "Mobile to Back-end" and "Back-end to Mobile" topic types.

The topic's "...Topic Details" page MUST be in view mode so you can access the corresponding button.

 

 

Step-by-step

 

1. Click Data Sync Button_Site in the Site Dashboard's "Control Panel" and, then, Messagebox Button.

 

SD_Messagebox Topics Page

 

2. In the resulting "Topics" page, click the name of the topic (displayed in light blue) to access the corresponding details page.

 

SD_Messagebox Topic Details Page

 

3. With the "...Topic Details" page in view mode, click Topic Read Message Button to open a "Message Receiver Tool" window.

 

SD_Topic Message Receiver Tool 1

 

4. Click Topic Read Msg Button to access the first message on queue and read it.

 

SD_Topic Message Receiver Tool 2

 

The window displays the message's content (Headers and Body) and the following info:

 

Message Info

Sent

When the message was sent to the current topic (date/time).

Body Size

The size of the message's content.

Message ID

The message's ID.

Checksum

The checksum for message validation.

 

There are also other operations available:

 

Topic Export Header Button Use this button to download a "*.csv" file with the message's header (index number, name, value information).

 

Topic Export Body Button Click this button to download a "*.txt" file with the message's body.

 

Topic Image Button Click this button to view the message's content in image format.

 

Topic JSON Button Use this button to view the message's body in JSON format.

 

Topic XML Button Click this button to view the message's body in XML format.

 

Topic TXT Button Use this button to view the body's content to a TXT format.

 

5. Click Topic Read Msg Button to read the next message.

 

6. If required, use the enabled Delete Read Message Button button to delete the message you are currently reading from the topic.

The button includes a 20 second timeout during which the "delete" operation is available.

 

7. If you are done, click Topic Close Msg Button to close the window and return to the topic's details page.

 

 

To Send a Message to a Topic

 

Use this "Send Message" operation to create/send a message to the currently open topic.

This is mainly used for testing purposes.

 

 

Note

This option is ONLY available for "Mobile to Back-end" and "Back-end to Mobile" topic types.

The topic's "...Topic Details" page MUST be in view mode so you can access the corresponding button.

 

NoteThe message size limit is 1 MB.

 

 

Step-by-step

 

1. In the Site Dashboard's "Control Panel", click Data Sync Button_Site. Then, click the Messagebox Button sub-module to open the "Topics" page.

 

SD_Messagebox Topics Page

 

2. Click the name of the topic you want to send a message to (displayed in light blue).

 

SD_Messagebox Topic Details Page

 

3. In the resulting "...Topic Details" page, click Topic Send Message Button. This opens a "Message Sender Tool" window.

 

Topic Message Sender Tool 1

 

 

Note

If you have previously created a message template, in the "Message Template" tab, it is applied to this message - the intended "Message Headers" are already filled in.

 

 

4. Fill in the defined "Message Headers" with the required values.

 

5. In the "Message Body" box, enter the intended information manually.

As an alternative, use the Topic Msg Sender Tool Load IMG Button button to load an image file or Topic Msg Sender Tool Load TXT Button to load a ".txt" file onto the message's body.

Both buttons open an OS browse window so you can browse for the intended file.

 

6. If necessary, use the Topic Msg Sender Tool Clear Button button of each section ("Message Headers" and/or "Message Body") to clear the fields/box and restart.

 

7. Once you've added the necessary information (in the message's Header and/or the Body), click Topic Send Msg Button and wait for the success message that includes the message's ID.

 

Topic Message Sender Tool 2

 

8. If you want to send more messages to this topic, repeat the previous steps (steps 4 to 7).

If you are done, click Topic Close Msg Button.