Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

After the configuration is saved, it should look similar to below:

...

Manual Publish of Files

At this point, everything should be configured to send files from MQTT Transmission to MQTT Engine.

...

Note
The files will be left on the originating filesystem after a successful publish and will need to be removed manually

Auto Publish of Files

Create a File record following the steps in Configure MQTT Transmission to publish files checking the 'Enable Auto-Publish' and configuring the Tag Folder Path to "files_auto".

At this point, everything should be configured to send files from MQTT Transmission to MQTT Engine. Open Ignition Designer on the system running MQTT Transmission. You should see the control and information tags created in the specified tag provider and folder as shown below:

...

The control and information tags created in the folder are:

Name

Type

Description

Last Published FileStringName of last published file
Last Published Sequence NumberIntegerSequence number of last published file since last reset of metrics
Percent CompletedBytePublish completion percent for file being published
Publish File CountLongNumber of files published since last reset of metrics
Publish File in TransitStringName of current file being published
Publish Files FolderStringFull path to the target folder containing the files to publish over MQTT
Publish Operation StatusStringStatus description of current publish operation
Publish Operation Status CodeIntegerStatus code for current publish operation
ResetBooleanTrigger to reset publish metrics


At this point, we just need to tell MQTT Transmission which file to send. Download and unzip this sample file to some location and note that location.

This sample_file.zip contains two text files which are:

  • sample_file.txt

    • This is a text file with an arbitrary string. But, it could be a file of any type. This is purely for demonstration purposes.
  • sample_file.txt.md5

    • This is a text file that contains only the md5 sum of the sample_file.txt



Note

Certain characters have special meanings when used in filenames such as "*" for wildcards, and "\" in filename paths. If a file you are trying to publish contains any of the characters listed below, it will prevent files from being written to the file system.

" * : < > ? / \ |

Leading and trailing spaces in filenames and filenames ending in '.' are also not supported.

...