x2o data portal · the list of images in the blob open. the source url, blob url, and cache time...

X2O Data Portal

Administrator Guide

Copyright © 2016 X2O Media Inc. All rights reserved. All trademarks are the property of their respective owners.

X2O Platform release 5.5 R12

Document type Administrator guide

Revision 2016-03_v1.2

X2O Data Portal

Table of Contents

i

Table of Contents

Welcome .................................................................................................................................................................................................. 1

Intended Audience.......................................................................................................................................................................... 1

How this Guide is Organized ...................................................................................................................................................... 1

Typographic Conventions ............................................................................................................................................................ 2

Product Support............................................................................................................................................................................... 3

Getting Started ...................................................................................................................................................................................... 4

Access the Data Portal ................................................................................................................................................................... 4

Explore the User Interface ............................................................................................................................................................ 5

Manage User Accounts ...................................................................................................................................................................... 6

Manage Your Account ................................................................................................................................................................... 6

Register a New User ....................................................................................................................................................................... 7

Manage Data Sources......................................................................................................................................................................... 8

Add a Remote Data Source ......................................................................................................................................................... 8

Add a New Access Token .......................................................................................................................................................... 10

Add a Parser Script ...................................................................................................................................................................... 13

Preview Parsed Data .................................................................................................................................................................... 14

Import a Parser Script ................................................................................................................................................................. 15

Export a Parser Script .................................................................................................................................................................. 16

Delete a Parser Script .................................................................................................................................................................. 17

Manage the Cache ............................................................................................................................................................................ 18

View the Text Cache .................................................................................................................................................................... 18

View the Image Blob Cache ..................................................................................................................................................... 19

Clear the Cache ............................................................................................................................................................................. 20

Manage System Logs ....................................................................................................................................................................... 21

View System Logs ......................................................................................................................................................................... 21

Refresh System Logs ................................................................................................................................................................... 23

Clear the System Logs ................................................................................................................................................................ 24

X2O Data Portal

Welcome

1

Welcome

The X2O Data Portal is an intermediate component that sits between the X2O players and the

original data sources—including relational databases, Web services, enterprise applications, flat

files, and XML files. The data portal engine compiles and then executes C# code snippets, called

"custom parser scripts", to fetch, format, and return data in response to requests from the players.

Additionally, it has the ability to cache its responses and fetch files to feed over HTTP/HTTPS.

Intended Audience

The Administrator Guide is intended for advanced users, and serves as a getting started guide for

administration in the X2O Data Portal.

How this Guide is Organized

This guide is organized along the sequence of steps the administrator takes to:

Log in, change passwords, and register new Data Portal users

Manage remote data sources, create access tokens, and upload custom parser scripts

Manage the text and image blobs in the cache

View, refresh, and clear system logs

X2O Data Portal

Welcome

2

Typographic Conventions

X2O technical documents use the following conventions.

Visual Cue Meaning

Bold The name of an interface element the user has to act on

(button names, keys they need to press, the value of an

element).

Italic Text that is replaced by a user-supplied value, variable

content, new terms.

Fix-Width Font Command or file names, code fragments, directory paths, text

that appears on a screen.

SMALL CAPS Key combinations (CTRL + ALT + DEL).

Notes

Warnings

Tips

Troubleshooting

Settings

Sample code is presented as follows:

var r=Math.random();

var x=document.getElementById("demo")

if (r>0.5)

{

x.innerHTML="<a href='http://www.x2omedia.com'>X2O Media Website</a>";

}

else

{

x.innerHTML="<a href= http://www.youtube.com/user/x2omedia'>X2O Media

Youtube</a>";

}

X2O Data Portal

Welcome

3

Product Support

Contact X2O Media if you require standard product support for our applications. The customer

support team is available to take your calls weekdays from 9:00 a.m. to 5:00 p.m. EST, except

Canadian and Quebec holidays.

North America 1-888-987-7557, extension 247

World-wide +1-514-987-7557, extension 247

Email [email protected]

Web http://www.x2omedia.com/support

Postal address 147 St-Paul Street, West

Suite 300

Montreal, Quebec

Canada H2Y 1Z5

X2O Data Portal

Getting Started

4

Getting Started

Learn how to access the X2O Data Portal and get started with the basics of the graphical-user

interface.

Access the Data Portal

Sign in:

1. Launch a Web browser.

2. Enter the Data Portal URL in the address bar: http://[server_name or IP]/DataPortal/.

3. Enter the User name and Password supplied by your administrator or X2O Media.

4. Click Log In.

The Data Portal opens on the Manage Data Sources page.

X2O Data Portal

Getting Started

5

Explore the User Interface

The Data Portal interface has the following controls:

Current user—Change your password or log off.

Menu bar—Click a menu item to manage users, data sources, the cache, or system logs.

Task workspace—View, create, and update the settings of the Data Portal.

Current User

Menu Bar

Task Workspace

X2O Data Portal

Manage User Accounts

6


Learn how to manage your account, and register a new user.

Manage Your Account

It is recommended to change your password periodically to prevent unauthorized entry to the

Data Portal.

The system requires a strong password, so enter a combination of uppercase and lowercase

letters, and numbers.

Change the password:

1. Click the link with your user name in the current user area. The Manage Account page opens.

2. Enter your Current Password.

3. Enter your New Password, then enter it again to Confirm.

4. Click Change Password.

X2O Data Portal


7

Register a New User

Note that this provides users with full access to the tools and information configured in the

system.

Create a new user account:

1. Click User Accounts in the in the menu bar. The Manage User Accounts page opens.

2. Click Add New User. The Create User Account dialog box appears.

3. Enter the User name for the new user.

4. Enter the Password, then enter it again to Confirm.

5. Click OK.

X2O Data Portal

Manage Data Sources

8

Manage Data Sources

The Data Portal engine compiles and then executes custom parser scripts to fetch, format, and

return data in response to requests from the players.

Add a Remote Data Source

Create a new remote data source from a URL to the Data Portal.

Add a data source:

1. Click Data Sources in the menu bar. The Manage Data Sources page opens.

2. Click the Remote Data Sources tab.

3. Click Add Data Source. The Remote Data Source dialog box appears.

4. Enter the URL to the data feed.

5. Enter the data feed Name and Description.

6. Select Enable to store images from the feed locally.

X2O Data Portal

Manage Data Sources

9

7. Enter the number of Cache Seconds in which data from the feed is stored.

8. Click OK to save the feed.

X2O Data Portal

Manage Data Sources

10

Add a New Access Token

Create new access tokens so clients can make authorized calls to the data sources you have

configured in the Data Portal.

Add an access token:

1. Click Data Sources in the menu bar. The Manage Data Sources page opens.

2. Click the Access Tokens tab.

3. Click Add New Token. The Access Token Details dialog box appears.

The Access Token Details has three sections:

General—The common elements of the access token (value, description, and expiration date).

Data Sources—The list of data sources available in the Data Portal.

Custom Parser Scripts—The list of parser scripts available in the Data Portal.

X2O Data Portal

Manage Data Sources

11

Enter general information about the token:

1. Click to expand the General section.

2. Leave the current Value.

3. Enter a Description about the token.

4. Select an Expiry Date for the token from the drop-down calendar.

Select data sources for the token:

1. Click to expand the Data Sources section.

2. Select the required data sources to which the token applies.

X2O Data Portal

Manage Data Sources

12

Select the parser scripts:

1. Click to expand the Custom Parser Scripts section.

2. Select the required scripts for the data sources selected in the previous section.

3. Click OK to save the new access token.

X2O Data Portal

Manage Data Sources

13

Add a Parser Script

Add a script:

1. Click Data Sources in the menu bar.

2. Click the Custom Parser Scripts tab.

3. Click Add New Script. The Edit C# Script dialog box appears.

4. Enter the Script Name and Description.

5. Enter the number of Cache Seconds in which parsed data from a feed should be stored.

6. Update and add Code as required.

7. Click OK to save the script.

The next step is to add your new parser script to the required access token.

Add the parser script to a token:

1. Click the Access Tokens tab on the Manage Data Sources page.

2. Click the required token in the list to open the Access Token Details.

3. Click to expand the Custom Parser Scripts section.

4. Select your parser script and click OK. The script is now associated with the access token.

X2O Data Portal

Manage Data Sources

14

Preview Parsed Data

Preview data generated by a custom parser script:



3. Click the required script in the list. The Edit C# Script dialog box appears.

4. Click Preview in New Tab.

The Data Portal executes the script and generates a data preview in a new browser tab.

X2O Data Portal

Manage Data Sources

15

Import a Parser Script

Custom parser scripts are imported into the Data Portal and are available for viewing, editing, and

exporting when required.

Import a script:



3. Click Import from file. The Import Scripts dialog box appears.

4. Click Choose file, then navigate to the directory where your script data files are stored.

5. Select the required *dat file, then click Open.

6. Click Import. The scripts are added to the Custom Parser Scripts tab.

X2O Data Portal

Manage Data Sources

16

Export a Parser Script

Parser scripts are available for export in the Data Portal.

Export a script:



3. Click Export to file. The Export Scripts dialog box appears.

4. Select the required scripts in the list, or click Select All.

5. Click the Download Selected Scripts link that appears.

The ExportedScripts.dat file is saved to the C:\Users\[user_name]\Downloads folder for

the user currently logged in to Windows.

X2O Data Portal

Manage Data Sources

17

Delete a Parser Script

The custom parser script is removed from the Data Portal permanently. It is recommended to

export the script to restore it when needed.

Remove a script:



3. Select the required parser script in the list. The Edit C# Script dialog box appears.

4. Click Delete This Script.

5. Click OK to confirm. The parser script is removed from the Data Portal.

X2O Data Portal

Manage the Cache

18

Manage the Cache

The Data Portal caches text and image data so requests for that data can be served to X2O players

quickly.

View the Text Cache

The text in the cache is available for viewing in the Data Portal.

View an item in the text cache:

1. Click Cache in the menu bar. The Manage Cache page opens on the Text tab.

The cache URL, text Value, and cache Time for each text item is provided in the tab.

2. Click an item in the list to view detailed information about the text in the cache.

X2O Data Portal

Manage the Cache

19

View the Image Blob Cache

The image blob in the cache is available for viewing in the Data Portal.

View an item in the image blob:


2. Click the Image Blobs tab. The list of images in the blob open.

The Source URL, Blob URL, and cache Time for each image is provided in the tab.

3. Click an item in the list to view detailed information about an image in the blob.

4. Click the thumbnail to view the image at its full size.

X2O Data Portal

Manage the Cache

20

Clear the Cache

The cache is removed from the Data Portal permanently.

Clear the cache:


2. Click Clear Text Cache.

3. Click OK to confirm. The text items are cleared from the cache.

4. Click the Image Blobs tab and click Clear Blob Cache.

5. Click OK to confirm. The images are cleared from the cache.

Specific cached items can also be removed one by one in their details dialog box.

X2O Data Portal

Manage System Logs

21

Manage System Logs

System logs are automatically saved and available for viewing in the Data Portal.

View System Logs

System messages are separated into three distinct logs:

INFO—provides information used for system analysis and reporting

WARN—describes warning conditions that could cause an error if an action is not taken

ERROR—describes errors that are fatal to the operation but not the application or the service

View a log message:

1. Click System Log in the menu bar. The System Log page opens on the View Log tab.

The following information is presented in the tab:

The time the record was logged

The entity that logged the message

The thread ID, used for debugging

The alert level

The message the entity logged

X2O Data Portal

Manage System Logs

22

2. Click an item in the list to view the complete record in the Log Item dialog box.

X2O Data Portal

Manage System Logs

23

Refresh System Logs

Refresh the system logs:


2. Click Refresh.

New logs load in the View Log tab, when available.

X2O Data Portal

Manage System Logs

24

Clear the System Logs

The log records are removed from the Data Portal permanently.

Clear all system logs:


2. Click Clear.

3. Click OK to confirm. All log records are cleared from the list.

System logs can also be removed one by one in the Log Item dialog box.

DISCLAIMER

X2O MEDIA, INC. MAKES NO WARRANTY, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT

LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR

PURPOSE, REGARDING THESE MATERIALS AND MAKES SUCH MATERIALS AVAILABLE SOLELY ON

AN “AS-IS” BASIS. IN NO EVENT SHALL X2O MEDIA, INC. BE LIABLE TO ANYONE FOR SPECIAL,

COLLATERAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES IN CONNECTION WITH OR ARISING

OUT OF PURCHASE OR USE OF THESE MATERIALS. THE SOLE AND EXCLUSIVE LIABILITY TO X2O

Media, INC., REGARDLESS OF THE FORM OF ACTION, SHALL NOT EXCEED THE PURCHASE PRICE

OF THE MATERIALS DESCRIBED HEREIN.

X2O Media, Inc. reserves the right to revise and improve its products at any time and without

notice. This publication describes the state of this product at the time of its publication, and may

not reflect the product at all times in the future.

X2O MEDIA TRADEMARKS

The X2O Data Portal is a trademark of X2O Media, Inc.

THIRD-PARTY TRADEMARKS

All other brand names, product names or trademarks belong to their respective holders.

GOVERNMENT USE

The Software {and Documentation} is provided with RESTRICTED RIGHTS. Use, duplication or

disclosure by the United States Government or any agency, department or instrumentality thereof

is subject to the restrictions set forth in the Commercial Computer Software — Restricted Rights

clause at FAR 52.227-19 or the Commercial Computer Software — Licensing clause at NASA FAR

Supplement 1852.227-86.

X2O Media holds the following patents: United States Patent No. 7,312,803 "Method for

Producing Graphics for Overlay on a Video Source" and United States Patent No. 8,683,340

"Method for automating digital signage applications using self-configuring objects and smart

templates".

SOFTWARE LICENSE AGREEMENT

PLEASE READ THIS DOCUMENT CAREFULLY. THIS IS A LEGAL AGREEMENT BETWEEN THE CUSTOMER

(“YOU”) AND X2O MEDIA INC. (“X2O MEDIA”). BY USING THE SOFTWARE AND ITS DOCUMENTATION

(COLLECTIVELY THE “SOFTWARE”), YOU AGREE TO BE BOUND BY THE TERMS AND CONDITIONS OF THIS

AGREEMENT, INCLUDING THE GRANT OF LICENSE AND DISCLAIMER OF WARRANTIES CONTAINED

HEREIN. IF YOU ARE NOT WILLING TO BE BOUND BY ALL OF THE TERMS OF THIS SOFTWARE LICENSE

AGREEMENT DO NOT INSTALL THIS PROGRAM.

1. GRANT OF LICENSE AND USE RESTRICTIONS FOR X2O MEDIA SOFTWARE. The enclosed SOFTWARE,

developed by X2O MEDIA, is licensed, not sold or assigned, to you by X2O MEDIA. X2O MEDIA grants to

you a personal, non-transferable, non-sublicensable, and non-exclusive license to use the SOFTWARE solely

for internal business purposes. You agree that, where restricting the following is not prohibited by law, you

will not reverse compile, disassemble, reproduce, reverse engineer, modify, adapt, translate, distribute,

network, lease, loan, resell for profit, the SOFTWARE or create derivative works based upon the SOFTWARE

or any portion thereof, except pursuant to a written license from X2O MEDIA. Prior to disposing of any

media or apparatus containing the SOFTWARE, you will ensure that any SOFTWARE contained on such

media or stored in such apparatus has been completely erased or otherwise destroyed.

2. LICENSE AND RESTRICTIONS APPLICABLE TO NON-X2O MEDIA SOFTWARE. This software contains

certain third-party programs. You agree that your use of them is governed by the license terms and

conditions provided with those programs.

3. USE OF DATA SERVICES. The SOFTWARE contains links to DATA CONTENT provided by third parties. You

agree that that you will not alter, copy, resell, reproduce or redistribute any of the DATA CONTENT. You

shall not alter any attributions, copyright notices and credits present on the DATA CONTENT feed. You shall

not alter or change the DATA CONTENT in any way. DATA CONTENT may only appear on the computer

desktop and you shall not, directly or indirectly, reproduce, publish, translate, communicate, broadcast,

rewrite for broadcast or publication or redistribute the DATA CONTENT in any fashion or medium. You may

not store content provided by X2O MEDIA or any portion thereof in a computer. X2O MEDIA shall not be

held liable in any way to you or to any third party or to any other person who may receive information in

the DATA CONTENT or to any other person whatsoever, for any delays, inaccuracies, errors or omissions

there from or in the transmission or delivery of all or any part thereof or for any damages arising from any

of the foregoing or occasioned thereby. X2O MEDIA may, at any time and without notice to you, cease to

provide any links to DATA CONTENT. Any links to third party data providers entered by you are solely your

responsibility.

4. USE OF ALERTS AND NOTIFICATIONS. The SOFTWARE contains functionality that allows users to send

alerts and notifications to other users. X2O MEDIA shall not be held liable in any way to you or to any other

person whatsoever, for any delays, inaccuracies, errors or omissions that result from or in the transmission

or delivery of all or any part thereof.

5. COPY RESTRICTIONS/OWNERSHIP. Nothing in this Agreement transfers title, or the intellectual property

in, any SOFTWARE or DATA CONTENT, or in any copy made there from, to you. Any rights not expressly

granted to you hereunder are reserved by X2O MEDIA, its licensors or by other X2O MEDIA business

partners contributing to the SOFTWARE or DATA CONTENT as the case may be.

6. DISCLAIMER OF WARRANTIES. X2O MEDIA warrants that the SOFTWARE will substantially conform to the

documentation supplied with it. X2O MEDIA does not warrant that the SOFTWARE will be error-free.

Notwithstanding any rights you may have to transfer any other rights granted hereunder, the warranties

described in this section are for the benefit of you only, and cannot be either transferred or assigned to any

third party. THE WARRANTIES IN THIS AGREEMENT ARE IN LIEU OF, AND X2O MEDIA AND ITS LICENSORS

AND SUPPLIERS DISCLAIM, ALL OTHER WARRANTIES, EXPRESS, LEGAL OR IMPLIED, INCLUDING WITHOUT

LIMITATION WARRANTIES OR CONDITIONS OF QUALITY, MERCHANTABILITY OR FITNESS FOR A

PARTICULAR PURPOSE REGARDLESS OF ANY KNOWLEDGE OF YOUR PARTICULAR REQUIREMENTS, AND

ANY WARRANTIES ARISING BY STATUTE OR OTHERWISE IN LAW, OR FROM A COURSE OF DEALING OR

USAGE OF TRADE. X2O MEDIA AND ITS LICENSORS AND SUPPLIERS SPECIFICALLY DO NOT WARRANT

THAT THE FUNCTIONS OR FEATURES OF THE SOFTWARE AND HARDWARE PRODUCTS WILL MEET ALL OF

YOUR REQUIREMENTS, WILL OPERATE IN ALL THE PRODUCT COMBINATIONS WHICH MAY BE SELECTED

FOR USE BY YOU, THAT THE OPERATION OF THE SOFTWARE. DATA CONTENT AND HARDWARE PRODUCTS

WILL BE ERROR-FREE OR UNINTERRUPTED, OR THAT ALL ERRORS OR DEFECTS IN THE SOFTWARE, DATA

CONTENT AND HARDWARE PRODUCTS WILL BE CORRECTED. YOU EXPRESSLY WAIVE ALL WARRANTIES

OR CONDITIONS NOT SPECIFICALLY SET FORTH HEREIN. The SOFTWARE may only be returned subject to

acceptance by X2O MEDIA.

7. DISCLAIMER FOR DATA CONTENT. X2O MEDIA is an aggregator of data from a variety of sources and is

not responsible for editorial content in the DATA CONTENT in any way. Use of the DATA CONTENT is at

your sole risk. You agree and acknowledge that X2O MEDIA is dependent on third party providers and that

this Agreement and the provision of the content is always subject to arrangements and restrictions imposed

by third parties. X2O MEDIA makes no warranty that the supply of particular data will be uninterrupted or

error-free. X2O MEDIA does not accept any liability for failures in network connections and/or end-to-end

connectivity across the Internet and/or performance problems experienced on any Internet or other

networks outside of X2O MEDIA’s control.

8. LIMITATION OF LIABILITY. Except for the express warranties contained herein, X2O MEDIA neither makes

nor grants any other warranties or conditions, express, legal or implied. The express terms of this Software

License Agreement are in lieu of any warranties, conditions, terms, undertakings and obligations implied by

statute, common law, custom, trade usage, course of dealing or otherwise, including but not limited to

implied conditions of quality, fitness and merchantability, all of which are hereby excluded to the fullest

extent permitted by law. In no event shall X2O MEDIA, its licensors or its contributing business partners be

liable to you for any damages (including, without limitation, loss of data, use, profits or goodwill, or

incidental or consequential damages), whether or not X2O MEDIA, the licensor or the contributing business

partner has been advised of the possibility of such loss, however caused and on any theory of liability.

9. INDEMNIFICATION. You agree to indemnify and hold X2O MEDIA and its content providers harmless

against any and all claims, demands, damages, liabilities, losses, costs and expenses of whatever nature

(including any legal and other professional expenses) incurred or suffered by X2O MEDIA directly or

indirectly arising (in whole or in part) from any use, reproduction or distribution by you (or any person

authorized or permitted by you) of the SOFTWARE, DATA CONTENT, any channels, widgets or templates,

or from any formatting by you, or any editorial errors or misrepresentations.

10. LAWS GOVERNING WARRANTIES AND LIABILITY. The laws of a jurisdiction may define the scope of a

warranty or the manner in which liability of a supplier of the SOFTWARE is limited; such law(s) shall govern

this Software License Agreement only to the extent a party protected by such law(s) cannot waive the

protection thereof by contract. Some jurisdictions do not allow the limitation or exclusion of liability for

incidental or consequential damages, or allow the exclusion of implied warranties; in such cases the

limitation and exclusion above may not apply to you, and you may have other rights which vary from

jurisdiction to jurisdiction.

11. EXPORT RESTRICTIONS. You agree that you shall not directly or indirectly export the SOFTWARE (or any

DATA CONTENT) in contravention of any export law.

12. TERMINATION. This Software License Agreement shall automatically, and without notice, terminate

immediately upon the earlier of your failure to fulfill any of your obligations under this Software License

Agreement or upon written notice of termination from X2O MEDIA. Upon termination of this Software

License Agreement, you shall immediately destroy and dispose of all forms and portions of the SOFTWARE.

13. TRANSFER. You may only complete the transfer of SOFTWARE as permitted under this Software License

Agreement where you advise the transferee of and secure his assent to be bound by the terms of this

Software License Agreement.

14. GOVERNING LAW AND DISPUTE. This Software License Agreement shall be governed by and interpreted

in accordance with the laws of the Province of Quebec, Canada, without reference to its conflict of laws

provisions. This Software License Agreement will not be governed by the United Nations Convention on

Contracts for the International Sale of Goods, the application of which is expressly excluded.

15. U.S. GOVERNMENT USERS. The SOFTWARE is a "commercial item" as that term is defined at 48 C.F.R.

2.101, consisting of "commercial computer software" and "commercial computer software documentation"

as such terms are used in 48 C.F.R. 12.212. Consistent with 48 C.F.R. 212 and 48 C.F.R. 227.7202-1 through

227.7202-4, all U.S. Government End Users acquire the SOFTWARE with only those rights set forth herein.

Manufacturer is X2O MEDIA Inc., 147 St Paul Street West, Suite 300, Montreal, Quebec, Canada, H2Y 1Z5.

16. CONTROLLING TERMS. The terms and conditions of this Agreement shall control your license of the

SOFTWARE, and any additional or different terms and conditions of any purchase order or other instrument,

whether in the past or future, submitted by you shall be void and of no effect unless expressly agreed to in

writing by X2O MEDIA.

17. COMPLETE AGREEMENT. This Agreement constitutes the complete and exclusive statement of the

agreement between the parties and supersedes all proposals, oral, or written, and all other communications

between the parties relating to the subject matter of this Agreement. No amendment to this license wil l be

binding unless in writing, signed by both you and X2O MEDIA.

18. LANGUAGE. This Agreement and any documents related thereto have been drawn up in the English

language at the specific request of the parties hereto. Cette convention et tous les documents y afférents

sont rédigés en langue anglaise à la demande expresse des parties aux présentes.

19. SEVERABILITY. Should any clause or term contained in this Agreement be declared invalid by a court of

law, it shall be severed from this Agreement without affecting any other terms which will continue to remain

in full force.

01/12/2016

x2o data portal · the list of images in the blob open. the source url, blob url, and cache time...

Documents