Skip to main content
MediaBeacon University

Exporting MediaBeacon data to an Amazon Web Service queue

Version: 2018.1


Using the MediaBeacon Visual Workflow, metadata can be sent to third-party applications via AWS SQS (Simple Queue Service). The application of this method is primarily for integrating with third-party systems using out-of-the-box MediaBeacon configuration. In this case, third-party applications interact and access data from an associated AWS SQS rather than using MediaBeacon’s API directly.

This enables MediaBeacon to send system data to other systems on triggered events such as: files being added to specific folders, specific metadata fields being edited. This allow the data sent to SQS to accurately reflect the data as entered in MediaBeacon.

MediaBeacon’s Visual Workflow editor contains the REST node, which allows REST calls to be compiled in a worksheet for distribution to target URLs. Information can be sent and received using a REST node but the purpose of this article, we will only be focusing on sending data to an SQS queue using the Post method.


This method requires a queue be configured in the AWS web interface, and that the MediaBeacon intance's IP and/or domain name be given POST permission.


  1. Log in as a Global Administrator user.
  2. Menubar > Manage > Workflows.
  3. Click the "circle +" icon to display the Create dialog.
  4. Enter a name for the workflow.
  5. Choose "Visual  workflow.
  6. Click "Create".
  7. Add a new REST node to your visual workflow by dragging and dropping the node from the right hand column to your workflow on the left.
  8. Double click the placed REST node to access the node's configuration options:
  9. URL: Value will consist of 2 parts:
    1. An URL associated with the queue to which you will POST.
    2. An associated action: ?Action=SendMessage.
    3. Final example URL will be similar to:<identifyingidcode>/?Action=SendMessage.
  1. Method: "POST".
  2. Attached File: UNCHECKED.
  3. Parameter Name: enter “MessageBody”.
  4. Parameter Value: This field contains the data to be sent to the AWS SQS, in JSON format. This array consists of paired identifiers:
    1. A field identifier, in quotes.
    2. A field value, in quotes. This value will be added via The Visual Workflow editors SmartName function.
    3. To add a SmartName click the green brackets icon, and in the SmartName dialog, choose a field. This SmartName will use the value of that field in each asset processed by the visual workflow.
    4. An example JSON array in this field:
{"FileName":"[Filename]", "FileSize":"[Raw File Size]", "FileType":"[File Format]", "ModDate":"[Modification Date]", "CreateDate":"[File Creation Date]", "RecordID":"[Asset ID]"}

Note: The text above is shown as  the string is displayed in the interface. When copied, the string is as follows:

{"FileName":"[Filename:database name]", "FileSize":"[Raw File Size:http$$$// rawFileSize]", "FileType":"[File Format:http$$$// format]", "ModDate":"[Modification Date:http$$$// ModifyDate]", "CreateDate":"[File Creation Date:http$$$// file_creation_date]", "RecordID":"[Asset ID:database assetId]"}
  1. The data posted to the AWS SQS will be a similar JSON object, replacing the SmartNames with the representative values from the asset triggering your workflow. Example posted data:
{"FileName":"Test", "FileSize":"500mb", "FileType":"jpeg", "ModDate":"11-10-2018", "CreateDate":"10-31-2018", "RecordID":"329754890"}