Documentation Center

Viz Channel Branding User Guide

Version 5.2 | Published June 05, 2024 ©

Integrations Hub

The Integrations Hub provides a standard, easy to use interface for Direct Integration modules that can read playlists and schedule data from automation systems, integrating this information with Viz Channel Branding.

In addition, the Integrations Hub provides a REST-based interface for services and components to integrate with the solution. Representational state transfer (REST) is a way to create, read, update or delete information on a server using simple HTTP calls. It is beyond the scope of this manual to fully explain REST-based architecture. For general information the Wikipedia article REST (external link) can be a good starting point.

The Integrations Hub offers Direct Integration modules provided by Vizrt; and customers and 3rd party system vendors and integrators can create additional services with the REST interface.

The Direct Integration (DI) and Direct Integration modules are software tools that directly integrate with automation systems. The integration module handles all the details of interfacing the automation systems and will thereafter deliver the data in a standard http-format to Viz Channel Branding using the REST interface.

This section presents:

Note: For REST documentation, see sections:

Configuration Check

The component will by default connect against the local Media Sequencer and open a couple of ports to receive incoming orders to.

Important! The Integrations Hub runs as a Windows Service process. It is recommended that the Integrations Hub service process is enabled to start automatically and that the Integrations Hub is run as an Administrator service level process.

The default ports it opens at are port 9990 and 9991.

  1. Check the installation using Integrations Hub v1:
    Perform a GET towards http://localhost:9990/restapi
    Expected response: HTTP-answer listing all channels
    OR

  2. Check the installation using Integrations Hub v2:
    perform a GET towards EITHER http://localhost:9990/v2 OR http://localhost:9991/api/channels

The /v2 is a request for information the address to version 2 of the API, the second link is the answer given. The reply to the second link is a overview of all available channels in the local Media Sequencer.

Selecting the Integrations Hub Media Sequencer

By default, the Integrations Hub service connects to the local Media Sequencer - the Media Sequencer running at localhost = 127.0.0.1. If required, use the following steps to direct the Integrations Hub to connect to a Media Sequencer at another host: 

  1. Open Windows File Explorer and browse to the programdata directory for Integrations Hub. The environment variable %PROGRAMDATA% will point to the actual location of the Program Data directory, normally the full path expanded will be C:\ProgramData\Vizrt\Viz Channel Branding\Integrations Hub

    Note: \ProgramData is normally a hidden Windows directory so you may need to explicitly enter the path \ProgramData in Windows File Explorer

  2. In the programdata directory, open the IntegrationsHub.config file with a text editor, for example Notepad.

  3. Find node appsettings.

    Change the attributes as needed. Example file:

    <?xml version="1.0" encoding="utf-8"?>
    <configuration>
    <appSettings>
    <add key="MseHost" value="localhost" />
    <add key="ContentFillingWaitTime" value="2" />
    <!--LogMode can be Off, Basic, Full-->
    <add key="LogMode" value="Basic" />
    <add key="ChannelCacheTime" value="30" />
    <!-- V1 and V2 Port is a port number or 0 if api is disabled.-->
    <add key="V1Port" value="9990" />
    <add key="V2Port" value="9991" />
    </appSettings>
    </configuration>

    MseHost: IP address or hostname of server the Media Sequencer (MSE) is running on.

    ContentFillingWaitTime: Time in seconds the application will wait before performing fill content.
    This is a method to improve performance of the application due to the burst notifications from integration systems.

    ChannelCacheTime: Time in seconds cache data will be used.
    Value is dependent on usage, but values between 15-30 secs should be reasonable. When this cache-time is elapsed, the application will fetch new data.
    It is important to be aware that ChannelCacheTime will affect settings, rules and pages. If ChannelCacheTime is set to, say, 60 seconds, Channel Settings set via Viz Channel Branding Client could be up to 60 seconds delayed before acted upon.
    Although using cache can improve throughput in an application, it could have side effects due to delay that are hard to catch - always consider your options carefully.

  4. Save the file.

  5. Restart the windows service.

See Also