Documentation Center

Viz Ticker User Guide

Version 3.1 | Published May 27, 2020 ©

Technical Reference for Field Linking

This section contains information on the following topics:

Feed Linking Formats

Viz Ticker supports Atom 1.0 formatted feeds.

The feed browser supports two types of feeds:

  • Flat feeds.

  • Hierarchical feeds (folder structure).

Linking to Social Media Sources

Some of the most popular web feeds, such as Twitter and Facebook, output content in non-supported formats or they use proprietary APIs. In order to get these and other Social feeds working together with Viz Ticker, the Ticker System must be combined with Vizrt’s Social TV solution (Feed Streamer). The Social TV solution then captures content from the social feeds and pushes moderated content to Viz Ticker wrapped in an open standard based network container format (example: Atom/XML) that can be combined with Ticker.

XML Namespaces

The following XML Namespace Prefixes are used when referring to XML elements:

XML Namespace Prefixes

Prefix

URL

atom

http://www.w3.org/2005/Atom

viz

http://www.vizrt.com/types

vaext

http://www.vizrt.com/atom-ext

media

http://search.yahoo.com/mrss/

thr

http://purl.org/syndication/thread/1.0

opensearch

http://a9.com/-/spec/opensearch/1.1/

Example: The notation <atom:entry> is to be interpreted as referring to the same element as <entry xmlns=”http://www.w3.org/2005/Atom”>.

The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.

Elements in Atom Feed

Elements that should be present in the <atom:feed> for the full user experience:

Elements in Atom Entry

Elements that should be present in the <atom:entry> for the full user experience:

Up Link

<atom:link rel="up" type="application/atom+xml;type=feed" href="http://..." />

  • The up link must have a HREF value that is the URL of the feed the entry is in.

    • The up link must have a type value equal to "application/atom+xml;type=feed".

    • Needed in combination with the self link for remembering and showing the selected feed entry in a folder structure.

Fields that can be Linked

Field

Details

<atom:author>

The personal details of the author of the selected <atom:entry>, which might be an individual person or an organization. The data is provided in child elements as follows:

  • <atom:name>: The name of the author. The value of the <atom:name> element inside the first <atom:author> element that applies for the entry is recorded as the field value. This child element is required if you are specifying the <atom:author> element.

  • <atom:uri>: A URL associated with the author, such as a blog site or a company web site. The value of the <atom:uri> element inside the first <atom:author> element that applies for the entry is recorded as the field value. This child element is optional.

  • <atom:email>: The email address of the author. The value of the <atom:email> element inside the first <atom:author> element that applies for the entry is recorded as the field value. This child element is optional.

<atom:content>

  • Both inline and URL content is supported.

  • There is no type match, so it is up to the Viz Ticker operator to figure out what content can be used.

  • For URL content the resource is downloaded first and then applied as the value. If you just want the URL you should use <atom:link>.

<atom:entry>

The whole entry XML.

<atom:link>

This element defines a reference from an entry to a Web resource; in other words this is the value of the href attribute.

<vaext:locator>

The text of the Vizrt Atom Extension <vaext:locator> element which has a vaext:type attribute equal to the "mediatype" attribute of <viz:fielddef> element in the model.

<atom:published>

This element is a Date construct indicating the initial creation or first availability of the entry. The value of the <atom:published> element in the entry is recorded as the field value.

<atom:summary>

This element is a Text construct that conveys a short summary, abstract, or excerpt of an entry. The content of the <atom:summary> element in the entry is recorded as the field value.

<atom:thumbnail>

The value of the URL attribute of the first thumbnail element in the entry is recorded as the field value.

<atom:title>

This element is a Text construct that conveys a human readable title for an entry or feed; the title of the selected <atom:entry>.

<atom:updated>

This element is a Date construct indicating the most recent instant in time when the selected <atom:entry> was modified. The value of the <atom:updated> element in the entry is recorded as the field value.

Fields that cannot be Linked

  • <atom:category>

  • <atom:id>

  • <atom:rights>

  • Any other elements.

See Also