manualshive.com logo in svg

Black Box ICOMP, User Manual

Share
Download
Black Box ICOMP User Manual Download Page 5

iCompel Data Engine - User Guide (V3.1.2)

Contact Black Box

Copyright (c) 2009 - 2012 Black Box Corporation

724-746-5500   |   blackbox.com 

5

Table of Contents

1.

......................................................................................................................................................8

iCompel Data Engine Overview

2.

......................................................................................................................................................10

Building a Connection

................................................................................................................................... 10

2.1

The Connection Editor Application 

................................................................................................................................... 10

2.2

QuickStart 

................................................................................................................................... 11

2.3

Connectors and Data Sources 

................................................................................................................... 12

2.3.1

Microsoft Excel Connector 

....................................................................................................................................................................... 12

- Basic Settings

....................................................................................................................................................................... 14

- Advanced Settings

................................................................................................................... 16

2.3.2

Microsoft Exchange Server Connector 

....................................................................................................................................................................... 16

- Basic Settings

................................................................................................................... 17

2.3.3

Google Calendar Connector 

....................................................................................................................................................................... 17

- Settings

................................................................................................................... 18

2.3.4

SQL Connector 

....................................................................................................................................................................... 19

- Advanced Settings

................................................................................................................... 19

2.3.5

XML Connector 

....................................................................................................................................................................... 20

- Settings

................................................................................................................... 21

2.3.6

Text Connector 

....................................................................................................................................................................... 22

- Basic Settings

....................................................................................................................................................................... 23

- Format Settings

....................................................................................................................................................................... 25

- Advanced Settings

................................................................................................................................... 26

2.4

Results 

................................................................................................................... 27

2.4.1

XML Output Format 

................................................................................................................... 28

2.4.2

Locating Media Items using the Media Item Finder 

....................................................................................................................................................................... 29

- Copying and Modifying Media Items

................................................................................................................... 30

2.4.3

Text Output Format 

................................................................................................................... 32

2.4.4

Custom Output Formats using a Presentation Format File 

................................................................................................................... 36

2.4.5

Specifying the Destination Players and Limiting Output Size 

................................................................................................................... 37

2.4.6

Applying a Player DATA IN license 

................................................................................................................................... 38

2.5

Specifying when to execute 

................................................................................................................................... 38

2.6

Connection Properties 

................................................................................................................................... 38

2.7

Testing a Connection 

3.

......................................................................................................................................................40

Monitoring and Managing Connections

................................................................................................................................... 40

3.1

Creating a new Connection QuickStart 

................................................................................................................................... 41

3.2

System Status 

................................................................................................................................... 41

3.3

Monitoring Active Connections 

................................................................................................................................... 42

3.4

Managing Connections 

................................................................................................................... 42

3.4.1

Managing Active Connections 

................................................................................................................... 43

3.4.2

Outstanding Actions 

................................................................................................................... 44

3.4.3

View Status 

................................................................................................................................... 45

3.5

Bulk Modify Connections 

................................................................................................................................... 47

3.6

Connection Retry and Backoff Policies 

................................................................................................................................... 47

3.7

Configuration 

4.

......................................................................................................................................................50

Application Licensing

Summary of Contents for ICOMP

Page 1: ...iCompel Data Engine V3 1 2 V3 1 2 30971 Set up vibrant real time digital displays easily and affordably All in one plug and display unit works right out of the box...

Page 2: ...case the user at his own expense will be required to take whatever measures may be necessary to correct the interference Changes or modifications not expressly approved by the party responsible for co...

Page 3: ...del alcance de fuentes de calor como radiadores registros de calor estufas u otros aparatos incluyendo amplificadores que producen calor 11 El aparato el ctrico deber ser connectado a una fuente de po...

Page 4: ...isher Products that are referred to in this document may be either trademarks and or registered trademarks of the respective owners The publisher and the author make no claim to these trademarks While...

Page 5: ...vanced Settings 26 2 4 Results 27 2 4 1 XML Output Format 28 2 4 2 Locating Media Items using the Media Item Finder 29 Copying and Modifying Media Items 30 2 4 3 Text Output Format 32 2 4 4 Custom Out...

Page 6: ...System 58 6 3 Connecting to a Black Box iDigitalManager 7 62 Using the Excel Connector 62 7 1 Advanced Excel Settings 8 66 Using the Microsoft Exchange Connector 66 8 1 Advanced Exchange Server Setti...

Page 7: ...Part I iCompel Data Engine Overview...

Page 8: ...em The iCompel Data Engine product comprises of three components A manager application the Connection Manager which allows the user to manage which queries will be run automatically The Connection Man...

Page 9: ...Part II Building a Connection...

Page 10: ...ervice 2 1 The Connection Editor Application The iCompel Data Engine iDE Connection Editor is a Microsoft Windows application that allows the user to create view update and test iDE Connections This s...

Page 11: ...st Query button and confirm that no errors are shown Please refer to the Connection Manager QuickStart section for details on how to add and automatically execute this Connection 2 3 Connectors and Da...

Page 12: ...y the changes Note This Connector may require an additional license to operate 2 3 1 1 Basic Settings The Excel Filename field specifies the Microsoft Excel file the iCompel Data Engine iDE should pro...

Page 13: ...t a named range then enter the range name only To select a range of cells from different worksheets then enter the specify worksheet name and cell range as above and surround with square brackets sepa...

Page 14: ...y to provide hints to the iCompel Data Engine iDE about how dates and numbers are represented in the spreadsheet This is particularly important when the file contains values whose interpretation is la...

Page 15: ...e spreadsheets By default this option is enabled Specifying Advanced Query Settings The Advanced Settings mode provides fine grained control over the data processed and written by the iDE It will not...

Page 16: ...Pack 1 and above If earlier versions of Exchange Server are in use please use the WebDAV query method instead The query method in use is summarized at the bottom of the the Exchange page and can be al...

Page 17: ...anced Microsoft Exchange Server Settings page provides fine grained control over the settings used to query the Exchange Server It will not normally be necessary to modify these settings 2 3 3 Google...

Page 18: ...C to access and query the database In order to use the SQL Connector the user must create one or more valid ODBC System Data Source Name System DSN entries on the local PC Further information on this...

Page 19: ...es it will be necessary to write data values using a specific locale representation The Write all data values using the following culture setting controls this If this option is enabled then a summary...

Page 20: ...he XML Location page specifies where the XML will be retrieved from Schema Page The Schema page defines which element and attributes should be retrieved This setting allows the fields unused by the me...

Page 21: ...the Schema tree Expand only Enabled Items Expands all enabled items and collapses the remainder Enable all Items This will enable all items Disable all Items Disables all items 2 3 6 Text Connector T...

Page 22: ...Copyright c 2009 2012 Black Box Corporation 724 746 5500 blackbox com 22 iCompel Data Engine User Guide V3 1 2 2 3 6 1 Basic Settings The Text page specifies where the text data will be retrieved from...

Page 23: ...mat if applicable This is the default setting Use custom schema information settings The specified settings will be used This option provides very fine grained controlled over the file format Please r...

Page 24: ...ecifying Column Headings The Column headings entry indicates how the iCompel Data Engine should detect column headings in the data The following options are available First row contains column heading...

Page 25: ...eted as 1st of April in the UK or the 4th of January if in the US The Processing setting specifies the culture setting used when processing dates and numbers Note this setting does not control how dat...

Page 26: ...tings will be shown the Text page Click the Advanced Settings button on the Text page to view or modify the settings Check the Enable advanced query capability box to configure the advanced query sett...

Page 27: ...equired Note This format should be used when displaying included results on a iCOMPEL iCOMPEL Please ensure the included media Widgets Layout Packages are installed on each Destination Player before p...

Page 28: ...tten on each iCOMPEL will be dependent upon to the Media Folder folder setting for the specified Username for each destination iCOMPEL The Media Folder folder setting is set per user on the Users page...

Page 29: ...ng the Copy button These features are described on the following page Only the media items that are able to display the specified Data Source are displayed To display all results enable the Show all M...

Page 30: ...mn are placed in a single folder providing easy grouping The Text file output format allows the results to be formatted displayed and managed using native iCOMPEL mechanisms which offers a number of b...

Page 31: ...ination Players setting The exact location written on each iCOMPEL will be dependent upon the Media Folder folder setting the user specified for each destination iCOMPEL The Media Folder folder settin...

Page 32: ...be written Filename Filename Content ftp Player11407 media media dynamic_sample output row Name 00001 txt Joe Blogs ftp Player11407 media media dynamic_sample output row Name 00002 txt Janes Smith ftp...

Page 33: ...ia item on the iCOMPEL should be set to UTF 8 Presentation Format File The Presentation Format file can be any text based format including HTML and XML and can have any extension Within the Presentati...

Page 34: ...will be substituted exactly Encoding Data Values To ensure content is correctly interpreted values written to XML or HTML files will be encoded escaped The following characters are replaced Character...

Page 35: ...and containing leading zeros The ext is the filename extension and is identical to the Presentation Format filename Note during the query execution exiting files in the folder which match the above p...

Page 36: ...to copy results to are specified in the following control The list shows all iCOMPEL s the result s will be copied to At least one iCOMPEL s must be specified in order to successfully execute the que...

Page 37: ...or network bandwidth concern when copying large numbers of results To use this setting check the Enable limit option and specify a number greater than zero in the limit count entry Note for performan...

Page 38: ...plied when the Connection is made Active and not when the Connection is tested in the Connection Editor Please refer to the Managing Active Connections section for more information 2 6 Connection Prop...

Page 39: ...Part III Monitoring and Managing Connections...

Page 40: ...Connection Manager application will show a warning message if the iDE Service could not be contacted To automatically execute the Connection according to the schedule specified by the Connection it m...

Page 41: ...citly requested to do so Please ensure anti virus and firewall software is set to allow the iCompel Data Engine to communicate with the iCompel Data Engine Service The Connection Manager application w...

Page 42: ...nection open the Connection menu and select View Status Messages 3 4 Managing Connections The Active page shows the details and status for all Active executing Connections and allows Active Connection...

Page 43: ...Actions page Undo or revert Changes If an action has been successfully performed a record of the action will be added to the Outstanding actions page The action can be undone by either Selecting the A...

Page 44: ...then click the View button To view the currently Active Connection select the Connection in the Active page If there are modifications then the original Active Connection will be marked as read only...

Page 45: ...status messages can be retrieved by clicking the Refresh button 3 5 Bulk Modify Connections If a new iCOMPEL iCOMPEL is added to an existing signage network or a iCOMPEL is replaced or user credentia...

Page 46: ...Player network host name or IP address The Username and Password field specify the credentials for iCOMPEL defined user All fields must be specified Note the player is not added if doing so would exce...

Page 47: ...al to complete and automatically delays for a period of time if two scheduled simultaneous execution times have been missed The backoff time is dependent upon the Connection schedule as follows Period...

Page 48: ...e Log messages will configure the Service to show detailed status messages These are typically used to diagnose problems Clear Log file when Service is started This setting is typically used to assist...

Page 49: ...Part IV Application Licensing...

Page 50: ...o receive the product License file Note the license is specific to the machine running the Wizard and is not transferable Licensing will need to be completed successfully on each Windows machine that...

Page 51: ...n Licensing Adding a new License A new License can be added from the Add page Only licenses for this iCompel Data Engine installation on the local machine can be applied The application will restart w...

Page 52: ...Copyright c 2009 2012 Black Box Corporation 724 746 5500 blackbox com 52 iCompel Data Engine User Guide V3 1 2...

Page 53: ...Part V Deployment Considerations...

Page 54: ...report The iDE media deployed to the Publisher must contain all required data values and special media to extract and correctly process Local Information values This is more flexible but has the same...

Page 55: ...Media Folder is set to the folder containing the iDE media If deploying to multiple Players from a single Connection all Users referenced by the Connection must specify the same iCOMPEL User Home Fol...

Page 56: ...Part VI Using the SQL Connector...

Page 57: ...lp file 6 2 Using the SQL Connector on a 64bit Operating System This section is only relevant if the iCompel Data Engine is deployed to a 64bit operating system While the iCompel Data Engine will run...

Page 58: ...tgreSQL ODBC driver psqlodbc_08_03_0400 zip from http wwwmaster postgresql org download mirrors ftp odbc versions msi psqlodbc_08_03_0400 zip 2 Open the ZIP file and execute the file psqlodbc msi This...

Page 59: ...the Save button The System DSN should now appear in the list in the System ODBC Data Source Name list on the SQL Command tab in the Connection Editor You may need to click the Refresh button to updat...

Page 60: ...data series orientation row Normally if we have a single row of data we don t have enough data to auto detect row headings Force detection for single row results such as this data process row_heading...

Page 61: ...Part VII Using the Excel Connector...

Page 62: ...is is specified by the Cell Range field The contents of the SELECT field will be processed to ensure field names are surrounded by square brackets Surround the SELECT field entry with double quotes to...

Page 63: ...data output Note the result should be displayed using tabular media as only one record is present Data Detection and Scan Settings By default the Excel driver will examine the first 8 rows of data to...

Page 64: ...Copyright c 2009 2012 Black Box Corporation 724 746 5500 blackbox com 64 iCompel Data Engine User Guide V3 1 2...

Page 65: ...Part VIII Using the Microsoft Exchange Connector...

Page 66: ...grained control over the settings used to query the Exchange Server It will not normally be necessary to modify these settings If Advanced Settings have been specified then a summary of the current se...

Page 67: ...A call call name galfind If OWA is not enabled on your Exchange Server or is not accessible then please disable this feature If this feature is disabled then the resource alias must be entered in the...

Page 68: ...Part IX Using the Google Calendar Connector...

Page 69: ...c Please refer to the Google documentation to determine how to make your Calendar public Determine the unique Google Calendar URL 1 Open the Google Calendar page in a web browser 2 Click the Settings...

Page 70: ...Part X Media Widgets...

Page 71: ...d in the Widget Settings section 10 1 Installing Sample Layouts and Widgets All Media Widgets can be installed directly on the player using the iCOMPEL Layout Package feature Layout Packages are self...

Page 72: ...t will be shown indefinitely To resume the programmed Schedule click the Activate Schedule and Layouts button at the top of the screen 10 2 Charts and Tabular Widgets Tabular Widget The Tabular widget...

Page 73: ...Copyright c 2009 2012 Black Box Corporation 724 746 5500 blackbox com 73 Media Widgets Bar Chart Widget Using the default bar chart Widget settings results are shown as follows...

Page 74: ...opyright c 2009 2012 Black Box Corporation 724 746 5500 blackbox com 74 iCompel Data Engine User Guide V3 1 2 Line Chart Widget Using the default line chart Widget settings results are shown as follow...

Page 75: ...Copyright c 2009 2012 Black Box Corporation 724 746 5500 blackbox com 75 Media Widgets Pie Chart Widget Using the default pie chart Widget settings results are shown as follows...

Page 76: ...x com 76 iCompel Data Engine User Guide V3 1 2 Source Microsoft Excel spreadsheet The above screen shots use the following spreadsheet top left cell is A1 This spreadsheet is included in the Black Box...

Page 77: ...ow event summaries for between a week and a month The diary Widget shows all events with all day events spanning the days on which they apply and appear with a solid background Up to six different res...

Page 78: ...ll events except all day events are shown Up to six different resources can be represented on a single Timeline widget Different resources are shown in different colors and in separate columns The min...

Page 79: ...file as it is possible to stop the media from displaying correctly If this is done the original configuration file can be found in the Black Box iDE Media media source folder Many other options are a...

Page 80: ...tyle and Update Options application display_style This mandatory parameter specifies how the data should be shown One of the following values must be specified case is not important TABULAR LINE_CHART...

Page 81: ...O Examine the data to determine if row headings are present This is the default value YES Assume first row is column headings NO Assume no column labels are present data headings column_labels data he...

Page 82: ...e shown on alternate row a zebra strip Default is true specifying the zebra strip will be shown tabular zebra background_colour Optional value which specifies the Zebra strip background color If the c...

Page 83: ...he bar colors Specified as a list of colors with prefixing hex symbol with the pipe symbol separating values chart series line_width The width in pixels of each Line Chart series line Optional and def...

Page 84: ...ARY TIMELINE ROOM_SUMMARY Diary and Timeline Display Options calendar options day_count Number of days to display If specified this must be a positive number For the Timeline Widget this defaults to 3...

Page 85: ...splay The following views are available DAY WEEK MONTH The default is week calendar diary week_starts_on Day number the week starts on expressed as 0 6 where 0 is Sunday Defaults to 1 for Monday 10 4...

Page 86: ...central readout panel The default value is Available calendar room_summary label event free The label used for free timeline events The default value is Free calendar room_summary label timeline toda...

Page 87: ...Part XI Contact Black Box...

Page 88: ...com 88 iCompel Data Engine User Guide V3 1 2 11 Contact Black Box If you have any questions about the iCompel Data Engine or iCOMPEL please contact Black Box Network Services on Name Contact Email te...

Page 89: ...us Messages 44 Connection Windows Service Overview 40 Connector Microsoft Excel 12 Microsoft Exchange Server 16 SQL 18 Text 21 22 23 25 Text Connector query settings 25 Text format 23 XML 19 20 Contac...

Page 90: ...g installed Licenses 50 Limiting record count 36 Log Files Configuration 47 Diagnostics 47 View 47 M Managing Connections Adding 42 Creating 42 Outstanding Actions 43 Overview 42 Removing 42 Viewing o...

Page 91: ...t Details and settings 30 U Updating Media Item properties 29 User Management 55 V View Status Messages Overview 41 44 W Widget Configuration Bar chart 82 Bar chart Widget settings 80 Diary 85 Diary W...

Page 92: ...tection products to media converters and Ethernet switches all supported by free live 24 7 Tech support available in 30 seconds or less Copyright 2010 All rights reserved Black Box and the Double Diam...

Reviews:

No comments

Brands by name

Popular brands

Load more brands