Set up a listener in Web Messenger

Learn how to set up a listener in Web Messenger such as a content management system or digital asset management system.

Overview

A listener is an application that receives and reads the messages from Web Messenger, for example:

  • Vernon Browser.

  • Your website’s content management system.

  • Your digital asset management system.

For Vernon Browser, see Set up Web Messenger for Vernon Browser.

For all other applications, continue reading.

Steps

  1. Go to the Tools menu, then Public Access, then Web Messenger, then click Configuration.

  2. Enter the listener details:

    1. In the Listener ID field, enter an ID.

    2. In the Name field, enter a name.

    3. Optional: In the Notes field, enter a description or notes about the listener.

  3. Set the capturing details:

    1. Tick the Capturing checkbox.

    2. If you want to use synchronous mode to process the messages in the queue, tick the Synchronous checkbox.

    3. In the Tester Program field, you can determine how Web Messenger should generate a message for a captured record. This field is used in addition to, or instead of, the Datafile conditions. You may need to enter details in the Additional Parameters table.

    4. If you want to capture changes for all files in Vernon CMS, tick the All Datafiles checkbox. To use only specified files, leave the checkbox clear.

    5. In the Datafile column of the table, enter the files that Web Messenger should capture.

    6. Optional: In the Flag Field column of the table, enter the field from the file which flags records as publishable. This can be a user symbolic field if you have more complex data requirements for when a record is published.

    7. Optional: In the Saved List column, enter a saved list of records. If you use a saved list instead of a flag field, Web Messenger captures changes for all records in the list. Web Messenger processes records that are not on your saved list as Delete messages. The listener ignores or removes records that are not on the saved list.

    8. Optional: In the Argument column, record any additional parameters that are specific to the files.

  4. Set the sending details:

    1. Tick the Sending checkbox.

    2. In the Groups/Users field, select the security process which defines which users or workstations are 'send servers'. You can use an existing security process such as Menu Tools System Maintenance which only Supervisor users typically have access to. If you leave this field blank, all users can send messages to the listener.

    3. In the Packager Program field, enter the program that builds the messages and sends them.

    4. Under Web Service Settings:

      1. In the URL field, enter the URL (web address) for the listener website.

      2. Optional: In the User field, enter a user name to include in the URL of each message.

      3. Optional:  In the Password field, enter a password to include in the URL of each message.

      4. Optional: In the Timeout (sec) field, enter the number of seconds the sender will wait for a response from the listener.

      5. Optional: In the Interval (sec) field, enter the number of seconds to delay messages. This will allow the listener more time to process messages. Ideally this should be no more than a few seconds. If unspecified, Web Messenger sends messages without delay. Web Messenger Monitor shows a send status of 'pause' when the message is delayed.

      6. Optional: In the OLE field, enter the Microsoft OLE component used to send HTTP messages.

  5. Set any additional parameters:

    1. In the Additional Parameters table, in the Name column, enter the name of an additional parameter.

    2. In the Value column, enter a value for each parameter.

  6. Under Log Level, select the level of detail that you want to record in the log (None, Exceptions, Process, Detail). We recommend that you select Exceptions, which will only log errors.

  7. Click Save Listener.

Video

See also