Use Liberator Explorer to request and send data

Here’s how to use Liberator Explorer to examine Liberator’s data and to send (contribute) data to the Liberator.

Liberator Explorer is only intended for use in development environments. It isn’t secure enough to use in production systems
These instructions apply to the Liberator Explorer provided with Liberator 6.2.2 and later

Connecting to a Liberator

You can start Liberator Explorer from a running Liberator’s home page:

  1. From the Menu, select Diagnostics

  2. On the Diagnostics page that’s displayed, select the Liberator Explorer link.

  3. Supply a valid username and password if requested (for a newly installed Liberator, these are admin, admin)

Liberator Explorer runs in a new browser tab and connects (via StreamLink JS) to the Liberator that hosts it.

Now you can connect to other running Liberators:

  1. Select the cog icon:

    Liberator Explorer cog icon
  2. Type in the name of your new connection at the top; then type 'enter' or select the plus (+) button:

    Liberator Explorer Manage Connections with plus button
  3. Add the server (Liberator) address in the format <hostname>:<port>

    Liberator Explorer new connection dialog
  4. Enter authentication information:

    If the Liberator’s configured to use simple username+password authentication (the default for a newly installed Liberator), select Basic Authentication and enter a username and password that are valid for that Liberator. For a newly installed Liberator, the username is admin and the password is admin.

    If the Liberator’s configured to use KeyMaster, select Keymaster Authentication and enter the KeyMaster URL. The URL must point directly to the Keymaster servlet URL, like this:
  5. Select Save to add the new connection. Liberator Explorer will attempt to connect to the additional Liberator.

    Or you can select Cancel to discard your changes.

Viewing the connection status

  1. Select the connection panel to view the status of a Liberator connection:

    Connection panel
  2. You’ll be given some information about the connection, the statuses of the DataSource applications connected to the Liberator (typically Integration Adapters), and the state of the Liberator’s data services (if you have permission to view that information).

    Connection status display

Subscribing to a subject

  1. Select the Subjects tab in the sidebar, type in the name of your new subject in the box, then type 'enter' or select the plus (+) button:

    Subject input box
  2. Once the subject’s been added to the list, it’s automatically subscribed to and its values appear in the grid:

    Subject in grid
  3. To subscribe to a different subject, just change the subject name in the grid.

    You can only subscribe to one subject in the grid. Selecting another subject in the list of subjects will subscribe to that one instead.
  1. Select the Directory tab in the sidebar:

    Directory tab
  2. Select the root directory '/', which should then show the items in the next level of the directory:

    Expanded root directory
    If you can’t open a directory, it’s most likely because you don’t have permission to view its items.
  3. Double click on a child item to subscribe to its subject in the grid. The subject is added to the list of subjects.

    Selecting a child element of a directory

Publishing data (contributions)

In Liberator Explorer contributions are called "contribs".
  1. In the Contributions box, select the cog icon:

    Contributions box with cog icon
  2. Type in the name of your new contribution; then type enter' or select the plus (+) button:

    Contributions box: entering a new contribution
  3. Add the subject of the contribution and the fields you want to send in it.

    The fields must be in the format <field>=<value> and each field must be on a new line in the Data box.

    For example:

    Entering contribution subject and fields
  4. Select Save to add the new contribution.

    Or select Cancel to discard your changes.

  5. To send the contribution to the Liberator, select it from the drop-down list and select the Play button.

    Sending a contribution using the Play button

Using the log

Here’s an example of Liberator Explorer’s log:

Log display

Manage the log using these items:

Log level dropdown

Change the logging level by selecting from the dropdown list.

Bin / Trashcan icon

Use the bin (trashcan) icon to clear the logs.

Log download icon

Select the down-arrow icon to download the logs to a text file.

Scroll lock icon

Select the lock icon to scroll the page to the end of the log so you can see each new log entry as it’s added. The log will stay in that position until you manually scroll it back up or you add some filter text.

Log filter box

Use the filter text box to select just those log lines that contain the text you enter.

See also: