User Guide. Data Gatherer 1.1 6/20/2014. Edition: A

Transcription

1 Data Gatherer 1.1 6/20/2014 Edition: A

2 Data Gatherer 1.1 Publication Information 2014 Imagine Communications. Proprietary and Confidential. Imagine Communications considers this document and its contents to be proprietary and confidential. Except for making a reasonable number of copies for your own internal use, you may not reproduce this publication, or any part thereof, in any form, by any method, for any purpose, or in any language other than English without the written consent of Imagine Communications. All others uses are illegal. This publication is designed to assist in the use of the product as it exists on the date of publication of this manual, and may not reflect the product at the current time or an unknown time in the future. This publication does not in any way warrant description accuracy or guarantee the use for the product to which it refers. Imagine Communications reserves the right, without notice to make such changes in equipment, design, specifications, components, or documentation as progress may warrant to improve the performance of the product. Trademarks Infocaster and Infocaster Manager are trademarks or trade names of Imagine Communications or its subsidiaries. Microsoft and Windows are registered trademarks of Microsoft Corporation. All other trademarks and trade names are the property of their respective companies. Contact Information Imagine Communications has office locations around the world. For domestic and international location and contact information, visit our Contact page ( Support Contact Information For domestic and international support contact information see: Support Contacts ( ecustomer Portal ( Academy Training ( Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 2

3 Data Gatherer Contents Contents Chapter 1 Data Gatherer Basics... 6 Network Components... 6 About Data Sets... 6 About Data Sources... 6 About Data Gathering... 7 About Mobile Handset Transmission... 7 Chapter 2 Install Data Gatherer... 8 Supported Operating Systems... 8 Infocaster Manager... 8 Install Silverlight Install Java... 9 Set Up Auto Login... 9 Troubleshoot Login Problems... 9 Install SQL Server 2008 R Configure SQL Server... 9 Install Data Gatherer Configure the Data Gatherer SQL Settings Create HarrisManagementSources Database Configure the Data Gatherer ODBC Settings Define Supported ODBC Field Types Define Supported ODBC Drivers Create Shared Folder for FTP and HTTP Settings Change FTP and HTTP Folder Default Troubleshoot SQL Connection Dispatcher Configuration Manager Use Dispatcher Configuration Manager Configure Mobile Handheld Transmission Configure Data Gatherer Configure Infocaster Manager Expose the Transmission Folder Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 3

4 Data Gatherer Contents Configure Infocaster Players Configure Roundbox Setup Chapter 3 Manage Data Sets Open the Landing Page Data Set List Sort the List View Data Sets in Pages Search Columns in the Data Set List Data Set List Details Activate or Deactivate Data Sets Message Bar Edit a Data Set Duplicate a Data Set Delete a Data Set Delete Data Sources View Diagnostic Logs Create a New Data Set Chapter 4 Create and Edit Data Sets Navigate Between Steps Specify Name and Description Select Data Type Set Source and Configuration Access Database Calendar Events Oracle Database RSS Feed Spreadsheet SQL Server Database Text Database XML File Create Filter Define a Rule Rules and Filter Sets Add Rules to a Filter Set Add a Filter Set Preview Filtered Data Set Delete a Rule Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 4

5 Data Gatherer Contents Save the Data Set Connect Players to Data Sets Connect Players Where Gathered Data is Saved Example of Gathered Data Where Images are Saved Where Mobile Handheld Transmission Data is Saved Access a Gathered XML File Connect a Title to an XML File Index Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 5

6 Data Gatherer Chapter 1 Data Gatherer Basics Chapter 1 Data Gatherer Basics Data Gatherer allows you to create, view, and manage the data sets which connect to your player content. These data sets are intermediaries between raw data sources and your downstream players. Network Components Data Gatherer is installed on an Infocaster Manager server system. It is part of a larger network which consists of the following components The Data Gatherer server application: Gathers data from data sources, configures the data into XML files, and hosts the XML files for access by players via HTTP. The Infocaster Manager server: Hosts the Data Gatherer server application, and can receive and distribute gathered XML files for mobile handheld transmission. Data Gatherer clients: Remote systems which access the Data Gatherer server in a browser window. Clients manage the data sets which Data Gatherer uses to configure and filter data sources. External data RSS or XML sources: Accessed by Data Gatherer via HTTP or FTP. Infocaster players: Accesses the gathered data for use in their content projects. About Data Sets Data Gatherer allows you to create and manage data sets. A data set is an intermediary between a raw data source and a player. At the times you specify, data sets retrieve selected data from a data source, filter it, and make it available to players via HTTP. Player systems can access the data and use it in their own content. Data Gatherer allows you to create and edit data sets. You can also use Data Gatherer to manually activate and deactivate the data sets you have created, and set them to automatically expire at certain times. About Data Sources Each data set can access a single external data source. The following data types are supported. Access Database: An ODBC Access Database provider. Calendar Events: A Microsoft Exchange Server Calendar events provider. Oracle Database: An ODBC Oracle Database provider. RSS Feed: A simple provider for RSS feeds Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 6

7 Data Gatherer Chapter 1 Data Gatherer Basics Spreadsheet: An ODBC Excel Database provider. SQL Server Database: An ODBC SQL Server Database provider. Text: An ODBC Text Database provider. XML File: A simple provider for XML data. About Data Gathering When a data set gathers data, it accesses its data source to obtain the values for the data items it has been configured to monitor, and it filters these values if any filter rules have been defined. When all the data has been gathered, it stores the data in an XML file in its DGHostFeeds HTTP location. Players can access the XML file for inclusion in their content. Data sets gather data either manually or according to their retrieval settings. About Mobile Handset Transmission If mobile handset transmission has been enabled for a data set, it will send its data to Infocaster Manager for distribution to player systems. The data set will also store an XML file as usual. Note: Mobile handset transmission is only supported with RSS and XML data types Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 7

8 Data Gatherer Chapter 2 Install Data Gatherer Chapter 2 Install Data Gatherer Before you can install the Data Gatherer server, you must prepare the system which will be hosting Data Gatherer. This involves the following steps. If you will be using Mobile Handheld Transmission, ensure that Infocaster Manager is installed on the system. Preconfigure the Data Gatherer system by installing the applications and technologies which Data Gatherer relies on. Install and set up the SQL server which Data Gatherer will use for data manipulation. When these steps are complete, you can install Data Gatherer. Note: Depending on the data types you wish to use, you may need to configure Data Gatherer and your data source servers to work together after installation. Supported Operating Systems The Data Gatherer server is supported on the following operating systems. Windows Server 2008 R2 Windows 7 Infocaster Manager If you will be using Mobile Handheld Transmission, the system must already have Infocaster Manager installed on it. To learn how to install Infocaster Manager, please consult the Infocaster Manager User Guide. Install Silverlight 5.0 Data Gatherer requires the Microsoft Silverlight 5.0 application framework. It must be downloaded and installed on the Data Gatherer server system. The download site you ll use depends on your region. To find the correct site for you, we recommend using a search engine to search for "install microsoft silverlight". Follow the steps on the site to download and install Silverlight Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 8

9 Data Gatherer Chapter 2 Install Data Gatherer Install Java Data Gatherer requires the 32-bit Oracle Java platform. It must be downloaded and installed on the Data Gatherer server system. Consult your IT technician to learn which version of Java is required for your system. Set Up Auto Login The O/S which will host the Data Gatherer server components must be: Configured for automatic login into Windows. The user account used for automatic login must be a super user. The process for doing this depends on your version of Windows and your system configuration. Please consult your IT technician for full instructions. Troubleshoot Login Problems If you do not configure the O/S for automatic login, the following problems may occur, depending on your system s security settings. Data Gatherer may refuse to launch. The Data Gatherer user interface may be empty or missing data sets. Logging errors may indicate that communication pipes are invalid or security violations have occurred while trying to access sockets. If you see this behavior, ensure that the account which the O/S is using for automatic login is a super user and that the automatic login settings are correctly configured for that account. To ensure this, check the physical server box after a reboot and confirm that the O/S is not showing an error about the user being invalid. Remote desktop applications will not show these errors, as they create their own unique sessions when logging into the machine. Install SQL Server 2008 R2 Data Gatherer uses Microsoft SQL Server to store its data. SQL Server 2008 R2 must be installed on the Data Gatherer system. Please consult your SQL Server documentation or your IT technician for installation instructions. After you have installed SQL server, you must configure it and create a Data Gatherer user. Configure SQL Server 1. Launch SQL Server. The Connect to Server window appears Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 9

10 Data Gatherer Chapter 2 Install Data Gatherer 2. In the Connect to Server window, select SQL Server Authentication from the Authentication drop-down list. Figure 1: Connect to the SQL Server 3. Enter your server name, login, and password. Note: If you choose a server name which is not localhost, you will need to change the server name in the DGSQLCore_Settings.config file, as described in Configure the Data Gatherer SQL Settings (on page 12). 4. Click the Connect button. SQL Server opens. 5. In the left-hand pane, right-click Database and choose Properties. The Server Properties window opens. 6. In the left-hand pane of the Server Properties window, select Security. 7. Select the SQL Server and Windows Authentication Mode radio button. Figure 2: Server Authentication 8. Click OK to close the Server Properties window. 9. In the left-hand pane, right-click Logins and choose New Login. The Login Properties window opens. 10. In the left-hand pane of the Login Properties window, select General. 11. Configure the user that will connect to the SQL Server. Enter a login name. Select the SQL Server Authentication radio button. Enter and confirm the user s password Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 10

11 Data Gatherer Chapter 2 Install Data Gatherer Uncheck the Enforce Password Policy checkbox. If you wish to choose different settings, you may need to consult your SQL Server technician to ensure all the settings are applicable and correct. Figure 3: Configure Login User Note: The login name and password must later be entered in the DGSQLCore_Settings.config file, as described in Configure the Data Gatherer SQL Settings (on page 12). 12. In the left-hand pane of the Login Properties window, select Server Roles. 13. Ensure that the following server roles are checked. dbcreator public serveradmin sysadmin Figure 4: Server Roles 14. Click OK to close the Login Properties window. SQL Server is now configured Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 11

12 Data Gatherer Chapter 2 Install Data Gatherer Install Data Gatherer After you have followed the above steps, you are ready to install Data Gatherer on the Infocaster Manager system. Note: If you are upgrading from Data Gatherer 1.0, installing a newer version of Data Gatherer on the same system will remove any data you created in 1.0. To retain your data after the upgrade, please contact technical support. See Support Contact Information (on page 2). 1. Make sure the Infocaster Manager dongle is attached to one of the system s USB ports. 2. Run the installer for Data Gatherer. 3. When the Welcome screen appears, click Next. 4. Accept the default destination folder by clicking Next. 5. Click Next to install Data Gatherer. Data Gatherer is installed on your system. 6. When prompted, reboot your system to complete the installation. Configure the Data Gatherer SQL Settings After you have installed Data Gatherer, you need to configure its SQL settings. You can also determine how image paths are represented in the gathered XML files if you plan to gather images. These instructions explain how to use the Core Configuration Manager Editor for configuration. It has the advantage of allowing you to save your settings in an encrypted file. If you do not wish to encrypt your settings you can manually edit any of the.config files instead. 1. Use Windows Explorer to navigate to the Data Gatherer install folder. 2. Open the DGControlManager subfolder Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 12

13 Data Gatherer Chapter 2 Install Data Gatherer 3. Double-click the CoreConfiguration_UI_Manager.exe application to launch it. The Core Configuration Manager Editor opens. Figure 5: Core Configuration Manager Editor 4. Click the Open Config button. An Open dialog appears Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 13

14 Data Gatherer Chapter 2 Install Data Gatherer 5. Navigate to Configurations\DGSQLCore_Settings.config and click Open. Figure 6: Open DGSQLCore_Settings.config The file opens, displaying the top layer of its elements. 6. Select the configuration_entries row. A browser button appears in the row. Figure 7: Configuration Browser Button 2014 Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 14

15 Data Gatherer Chapter 2 Install Data Gatherer 7. Click the browser button. The Dynamic_Properties Collection Editor opens. Figure 8: dynamic_properties Collection Editor 8. Select the first member in the Members list. This member contains connection information for the internal SQL server database. 9. In the window on the right-hand side, select the Value row. A Browser button appears in the row. Figure 9: dynamic_properties Browser Button 2014 Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 15

16 Data Gatherer Chapter 2 Install Data Gatherer 10. Click the Browser button. The Value Collection Editor opens. Figure 10: Values for dg_connect 11. Change the values to point to the SQL data source you have created, and set the username and password required for accessing it. These must match the server name and login settings you defined in Configure SQL Server (on page 9). 12. Click the OK button. You are returned to the dynamic_properties Collection Editor. 13. You can also choose to define a hosting end point for serving up image data, as described in Where Images are Saved (on page 87). a. Click the second member in the Members list. This member defines a hosting end point for serving up image data. Figure 11: Second Member in the Collection Editor b. In the window on the right-hand side, select the Value row. A Browser button appears in the row. c. Click the Browser button. The Value Collection Editor opens. Figure 12: Value for machine_and_port d. Change the value to select the new endpoint where image files will be saved. When image data is collected, the image URLs will be edited to point to this location. e. Click the OK button. You are returned to the dynamic_properties Collection Editor. 14. Click OK until you have returned to the main screen of the Core Configuration Manager menu Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 16

17 Data Gatherer Chapter 2 Install Data Gatherer 15. If you wish to encrypt your settings, check the Save with Encryption checkbox. Figure 13: Save with Encryption 16. Click the Save Config button. Your changes are saved. 17. Close the Core Configuration Manager. Note: If you have installed the SQL server on a system other than where Data Gatherer is installed, you must run a batch file to create the HarrisManagementSources database. See Create HarrisManagementSources Database (on page 17). Create HarrisManagementSources Database If you have installed the SQL server on a system other than where Data Gatherer is installed, you must run the sqlserver_harrismanagementsources.bat file after you configure the Data Gatherer SQL Settings. This file is located in the DBCreationScripts subfolder. When you double-click the file, the HarrisManagementSources database is created on the SQL server that you defined in the DGSQLCore_Settings.config file (see Configure the Data Gatherer SQL Settings (on page 12)). Configure the Data Gatherer ODBC Settings The following data types use ODBC functionality. Access Databases Oracle Databases Excel Spreadsheets SQL Server Databases Text Databases If you are using one of these data types: See Define Supported ODBC Field Types (on page 18) if you must add additional ODBC field types to Data Gatherer. See Define Supported ODBC Drivers (on page 21) to ensure that the names of the ODBC drivers on your system match the preconfigured names in Data Gatherer Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 17

18 Data Gatherer Chapter 2 Install Data Gatherer Define Supported ODBC Field Types Data Gatherer is preconfigured with common field types particular to each ODBC data type, and it will only recognize these field types. If your data sources uses field types which are not recognized, these field types will appear disabled when you select items in Data Gatherer. Figure 14: Disabled Field Type Follow these steps to define additional ODBC field types to Data Gatherer. These instructions explain how to use the Core Configuration Manager Editor for configuration. It has the advantage of allowing you to save your settings in an encrypted file. If you do not wish to encrypt your settings you can manually edit any of the.config files instead. 1. Use Windows Explorer to navigate to the Data Gatherer install folder. 2. Open the DGControlManager subfolder. 3. Double-click the CoreConfiguration_UI_Manager.exe application to launch it. The Core Configuration Manager Editor opens. Figure 15: Core Configuration Manager Editor 4. Click the Open Config button. An Open dialog appears. 5. Navigate to Configurations\ODBCProvider_State.config and click Open. The file opens, displaying the top layer of its elements Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 18

19 Data Gatherer Chapter 2 Install Data Gatherer 6. Select the configuration_entries row. A browser button appears in the row. Figure 16: Configuration Browser Button 7. Click the browser button. The Dynamic_Properties Collection Editor opens. Figure 17: dynamic_properties Collection Editor 8. Members 2-6 in the Members list each contain information about a specific ODBC data type. Select a member to view the data type in the right-hand window. The data types are: ACCESS_COL_TYPES EXCEL_COL_TYPES MICROSOFT_SQL_SERVER_COL_TYPES ORACLE_COL_TYPES TEXT_COL_TYPES 2014 Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 19

20 Data Gatherer Chapter 2 Install Data Gatherer 9. After you have selected the member you want to edit, select the Value row in the right-hand window. A browser button appears in the row. Figure 18: dynamic_properties Browser Button 10. Click the Browser button. The Value Collection Editor opens. Figure 19: Value Collection Editor Each member in the Members list contains a value. This value equals a supported field type for the selected ODBC data type. You can view the field types which are currently supported by clicking individual members. 11. To add a new supported field type, click the Add button. A new member appears at the bottom of the Members list. 12. Select the member. Its blank value appears in the right-hand window. 13. Click within the blank value and enter the name of the new supported field type. 14. Click OK until you have returned to the main screen of the Core Configuration Manager menu. 15. If you wish to encrypt your settings, check the Save with Encryption checkbox Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 20

21 Data Gatherer Chapter 2 Install Data Gatherer Figure 20: Save with Encryption 16. Click the Save Config button. Your changes are saved. 17. Close the Core Configuration Manager. Define Supported ODBC Drivers Data Gatherer is preconfigured with a list of supported ODBC driver names. In most cases, when you install a database driver on your system, the standard name is provided, and Data Gatherer has been preconfigured to recognize it. However, some drivers (Oracle for example) allow you to change the name at installation time. The names of the ODBC drivers on your system must match the preconfigured names in Data Gatherer. Follow these steps to ensure that the driver names are the same. Note: Data Gatherer does not support 64-bit ODBC drivers. Check Installed Database Driver Names Follow these steps to check the names of your installed ODBC drivers. You will compare these names to the ones in Data Gatherer. 1. Within Windows, open up the ODBC Data Source Administrator. Note: If you search for this with the Windows "Search Programs and Files" field, it may be called Data Sources (ODBC). 2. Switch to the Drivers tab. Figure 21: ODBC Data Source Administrator 3. Check the names of the following drivers. Microsoft Access Driver 2014 Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 21

22 Data Gatherer Chapter 2 Install Data Gatherer Note: Data Gatherer requires the ODBC Access 32-bit driver which supports the *.accdb extension. Oracle Note: Data Gatherer supports the Oracle driver. Other drivers may not be compatible. Microsoft Excel Driver SQL Server Native Client Microsoft Text Driver You will compare these driver names with the ones preconfigured for Data Gatherer, as described in the next section. Confirm Preconfigured Driver Names in Data Gatherer After you have checked the names of your installed ODBC database drivers (see Check Installed Database Driver Names (on page 21)), follow these steps to ensure that the ODBC driver names on your system match the preconfigured names in Data Gatherer. These instructions explain how to use the Core Configuration Manager Editor for configuration. It has the advantage of allowing you to save your settings in an encrypted file. If you do not wish to encrypt your settings you can manually edit any of the.config files instead. 1. Use Windows Explorer to navigate to the Data Gatherer install folder. 2. Open the DGControlManager subfolder. 3. Double-click the CoreConfiguration_UI_Manager.exe application to launch it. The Core Configuration Manager Editor opens Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 22

23 Data Gatherer Chapter 2 Install Data Gatherer Figure 22: Core Configuration Manager Editor 4. Click the Open Config button. An Open dialog appears. 5. Navigate to Configurations\ODBCHelper_Settings.config and click Open. The file opens, displaying the top layer of its elements. 6. Select the configuration_entries row. A browser button appears in the row. Figure 23: Configuration Browser Button 7. Click the browser button. The Dynamic_Properties Collection Editor opens. Figure 24: dynamic_properties Collection Editor 8. Select the first member in the Members list. The id in the right-hand window displays ODBCDriverTypes_Default. Figure 25: ODBCDriverTypes_Default Member 2014 Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 23

24 Data Gatherer Chapter 2 Install Data Gatherer 9. Select the Value row in the right-hand window. A browser button appears in the row. Figure 26: dynamic_properties Browser Button 10. Click the Browser button. The Value Collection Editor opens. Figure 27: Value Collection Editor Each member in the Members list contains the name of a specific ODBC driver Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 24

25 Data Gatherer Chapter 2 Install Data Gatherer 11. Check every driver name by clicking each member and looking at the Value field. The text in the value field must be identical to the corresponding driver's text in the ODBC Data Source Administrator. Figure 28: Matching Driver Text 12. To edit a value, click inside the Value field and enter the correct driver text. 13. Click OK until you have returned to the main screen of the Core Configuration Manager menu. 14. If you wish to encrypt your settings, check the Save with Encryption checkbox. Figure 29: Save with Encryption 15. Click the Save Config button. Your changes are saved. 16. Close the Core Configuration Manager. Create Shared Folder for FTP and HTTP Settings If you will be accessing any data sources from FTP or HTTP sites, you must set up a shared folder where Data Gatherer will store the data that it downloads for text, Excel, and Access data sources. By default, Data Gatherer expects to store data in the following folder: \\localhost\odbc_for_ftp_and_http Follow these steps to create the folder on your Data Gatherer system. 1. On your Data Gatherer system, navigate to your root drive. 2. Create a folder called ODBC_For_FTP_And_HTTP Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 25

26 Data Gatherer Chapter 2 Install Data Gatherer Note: You can create a folder with a different name and/or put it in a different location. If you do this, see Change FTP and HTTP Folder Default (on page 26) after you have created it, shared it, and exposed its rights as described in the next step. 3. Share the folder, exposing full rights to: Read Write Create Delete Note: The files in this folder are for internal Data Gatherer use only. Do not create data sets from these files. Change FTP and HTTP Folder Default If you chose to create an FTP or HTTP folder with a name or location other than the default, follow these steps to tell Data Gatherer where to find it. These instructions explain how to use the Core Configuration Manager Editor for configuration. It has the advantage of allowing you to save your settings in an encrypted file. If you do not wish to encrypt your settings you can manually edit any of the.config files instead. 1. Use Windows Explorer to navigate to the Data Gatherer install folder. 2. Open the DGControlManager subfolder. 3. Double-click the CoreConfiguration_UI_Manager.exe application to launch it. The Core Configuration Manager Editor opens. Figure 30: Core Configuration Manager Editor 2014 Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 26

27 Data Gatherer Chapter 2 Install Data Gatherer 4. Click the Open Config button. An Open dialog appears. 5. Navigate to Configurations\ODBCProvider_State.config and click Open. The file opens, displaying the top layer of its elements. 6. Select the configuration_entries row. A browser button appears in the row. Figure 31: Configuration Browser Button 7. Click the browser button. The Dynamic_Properties Collection Editor opens. 8. Select the first member in the Members list (with the id UNC_SAVE_PATH). 9. Select the Value row in the right-hand window. A browser button appears in the row. Figure 32: dynamic_properties Browser Button 10. Click the Browser button. The Value Collection Editor opens. Figure 33: Value Collection Editor 2014 Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 27

28 Data Gatherer Chapter 2 Dispatcher Configuration Manager 11. In the right-hand window, click within the Value row and enter the UNC file path to the folder you created and shared (See Create the Shared Folder). 12. Click OK until you have returned to the main screen of the Core Configuration Manager menu. 13. If you wish to encrypt your settings, check the Save with Encryption checkbox. Figure 34: Save with Encryption 14. Click the Save Config button. Your changes are saved. 15. Close the Core Configuration Manager. Troubleshoot SQL Connection If the meta data creation scripts failed, navigate to the Data Gatherer install folder and run the DGMetaDataSetupScript.cmd file. If you are still having problems, double-check that your SQL settings match the settings in the DGSQLCore_Settings.config file. Dispatcher Configuration Manager Use the Dispatcher Configuration Manager if you wish to change the default virtual path names for your Data Gatherer Client interface or the host feed location where gathered data is placed. Note: The Conductor.exe service must be running before you launch Dispatcher Configuration Manager. It will start itself automatically after you install Data Gatherer, and will always start itself after you reboot the Data Gatherer system, but it may be delayed a few seconds. If the Dispatcher Configuration Manager does not launch properly, open the Windows Task Manager and wait for the Conductor.exe service to appear before trying again. Use Dispatcher Configuration Manager 1. Open a browser. 2. Navigate to the Dispatcher Configuration Manager at: Gatherer Server]:8890/WebbHostConfig/WebbHostConfig.html 2014 Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 28

29 Data Gatherer Chapter 2 Dispatcher Configuration Manager The Dispatcher Configuration Manager opens in your browser, displaying the items for your Data Gatherer Client interface and host feed. Figure 35: Dispatcher Configuration Manager 3. View the two items. DGUI: This is the location of the Data Gatherer Client interface (the "Landing Page"). When clients connect to Data Gatherer to edit their data sets, they will navigate to the DGUI virtual path by default. For example, if your Data GathererData Gatherer server is zyx.station.com, clients will open a browser and navigate to See Use Data Gatherer to learn how to use the Data Gatherer Client interface. DGHostFeeds: This is where gathered data will be stored for access by player systems, with the default virtual path of DGHostFeeds. As in the above example, remote players would navigate to to locate gathered data. See Connect Players (on page 86) to learn how to connect a player to a gathered data source. 4. If you want to change a virtual path name, click the Edit Item button beside the item you want to change. Figure 36: Edit a Dispatcher Item 5. The EditEntry window opens. Change the Virtual Path Name of the item Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 29

30 Data Gatherer Chapter 2 Configure Mobile Handheld Transmission Figure 37: EditEntry Window Note: Do not change the other values for the item. The only value which we recommend for editing is the Virtual Path Name. 6. Click the Save and Close button to save your changes. Configure Mobile Handheld Transmission If you wish to use Roundbox transmission to distribute your data via Infocaster Manager, you must configure the following systems. Configure Data Gatherer to connect with your Infocaster Manager server. Define Infocaster Manager s transmission folder. Configure an FTP server which exposes the transmission folder, so Roundbox can access it. Define the reception folders on the player systems. Configure your Roundbox setup to move data from Infocaster Manager s transmission folder to the reception folders on the player systems. Note: Mobile handset transmission is only supported with RSS and XML data types. Configure Data Gatherer You must manually edit the NMServerCommunication_State.config file to allow Data Gatherer to connect to your Infocaster Manager server. 1. Use Windows Explorer to navigate to the Data Gatherer install folder. 2. Open the DGControlManager subfolder. 3. Open the Configurations subfolder. 4. Double-click the NMServerCommunication_State.config file to edit it in a text editor. Figure 38: NMServerCommunication_State.config File 5. Edit the value for NMServerIPAddress so it points to your Infocaster Manager server. 6. Edit the value for NMServerPort to the port used to access your Infocaster Manager server. 7. Save the file and exit the text editor Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 30

31 Data Gatherer Chapter 2 Configure Mobile Handheld Transmission Configure Infocaster Manager You must define the transmission folder which Data Gatherer will send data to. 1. On the system, create a folder called DDSRoundBoxMultiCast. 2. Share the folder. Your Roundbox setup must be able to read the folder s content. 3. Open Infocaster Manager. 4. Within Infocaster Manager, select Tools > Multicast Mode Groups. The Multicast Mode Groups window opens. Figure 39: Multicast Mode Groups Window 5. Click the New button. The Add New Multicast Mode Group window opens. 6. In the Name field, enter DDSRoundBoxMultiCast. 7. Click the Browse button and select the shared DDSRoundBoxMultiCast folder you created Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 31

32 Data Gatherer Chapter 2 Configure Mobile Handheld Transmission 8. Select Roundbox from the Mode drop-down list. Figure 40: Define the Transmission Folder 9. Click OK. The transmission folder is saved. 10. Click OK to exit the Multicast Mode Groups window. Note: This is a basic configuration. Consult the Infocaster Manager for information about other Multicast Mode Group options. Expose the Transmission Folder Because Roundbox will access the files in this transmission folder, you must set up an FTP server on the Infocaster Manager system which exposes the transmission folder to Roundbox. The steps for doing this depend on which FTP server you want to use and which security considerations you must address. Consult your IT technician for full instructions. Configure Infocaster Players On each Infocaster player system you must define the reception folder where transmitted data will arrive. 1. On a player system, create a folder which will receive transmitted data. 2. Share the folder. Your Roundbox setup must be able to write content to the folder. 3. Open Infocaster. 4. Within Infocaster, select Edit > Preferences. The Infocaster Configuration Utility opens. 5. Switch to the Multicast Mode Distribution tab Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 32

33 Data Gatherer Chapter 2 Configure Mobile Handheld Transmission 6. Click the New button. Figure 41: Define a New Reception Folder A browser dialog opens. 7. Navigate to the reception folder you created. You must navigate to the folder through the network, so the player s machine name is included in the file path. 8. Select the folder and click OK. The folder is added. Figure 42: Added Reception Folder 9. Click OK to exit the Infocaster Configuration Utility. Configure Roundbox Setup Your Roundbox setup must be configured to move data from the transmission folder to the reception folders. Consult your Roundbox documentation for instructions Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 33

34 Data Gatherer Chapter 3 Manage Data Sets Chapter 3 Manage Data Sets When you access Data Gatherer, you automatically arrive at the Landing page. The Landing page is where you create, edit, view, and manage your data sets. View your data sets in the Data Set list. Use the Status drop-downs in the list to activate or deactivate your data sets. Create a new data set. Edit an existing data set. Duplicate or delete your data sets. Open the Landing Page To access the Data Gatherer Landing page, open a browser and navigate to the Data Gatherer server s DGUI page. By default, this will be in the form of: Gatherer Server]:8890/DGUI/ Note: The name of the server s DGUI page may be customized. See Dispatcher Configuration Manager (on page 28) for more information. Data Set List The Data Set list allows you to quickly view the data sets on the Data Gatherer server. You can sort manage, and edit your data sets with the list. Sort the List Sort the Data Set list by clicking on any of the column headings. An upward-pointing triangle appears in the column heading when it is sorted in ascending order, and a downward-pointing triangle appears when the list is sorted in descending order. To toggle the sorting order of a column, click the column heading again Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 34

35 Data Gatherer Chapter 3 Manage Data Sets Figure 43: Sort the Data Set List Some column headings contain a Filter link. To display only the data sets which meet a column s filter criteria, click the Filter link and use the checkboxes to define your filter. Figure 44: Filter a Column For a description of each column in the list, see Columns in the Data Set List (on page 36). View Data Sets in Pages By default, Data Gatherer displays one page of the list at a time. Each page can display 25 sets. Use the Page controls to navigate between the pages in the list. Figure 45: Page Controls Click a page number to display that page. The highlighted number is the page which is currently being displayed. Click the small back or forward arrows to display the previous or next page. Click the first or last buttons to display the first or last page. To display all the data sets, click the Show All button. Click the Show All button again to display only the current page. Search By default, the Data Set list displays all the data sets on the Data Gatherer server. If you are having difficulty finding data sets within the list, enter text in the Search field to display only the sets which contain the text in their names, descriptions, source paths, or types. Figure 46: Search Field 2014 Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 35

36 Data Gatherer Chapter 3 Manage Data Sets To cancel a search, click the X button in the Search field. Columns in the Data Set List The list displays the following columns for each data set. Column Name Description Source Path Type Retrieval Expiry Status Tools Description The name of the data set. The data set's description. The path to the set's data source. The data set's type. The retrieval settings for the data set. When the data set will expire, if applicable. Whether the data set is active or inactive. The tools allow you to edit, duplicate, or delete a data set. Data Set List Details Within the Data Set list, click the triangle beside a data set to view details about its history. Figure 47: Data Set Details To retrieve the latest information from the Data Gatherer server, click the Refresh button. To immediately gather data from the data source, click the Gather Data Now button. See About Data Sets (on page 6) for more information. You can view when the data set was added, when it was last modified, and which user updated and/or modified it. The Comments box displays any comments which were entered when the data source was created or edited. The Update History box displays a list of all updates which have been made to the data set Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 36

37 Data Gatherer Chapter 3 Manage Data Sets The Failure History includes a list of all failures associated with updating the data set or gathering its data. You can show or hide the details for each individual failure by clicking the triangle beside its date. See View Diagnostic Logs (on page 40) for information about viewing data set failures. Figure 48: Failure History Activate or Deactivate Data Sets Within the Data Set list, you can use the Status drop-down to activate or deactivate a data set. Figure 49: Status Drop-Down When a data set is deactivated, it stops gathering data from its data source, and it stops writing updates. You can reactivate a data set as long as it has not expired in the meantime. For more information, see About Data Sets (on page 6). Message Bar A message bar appears at the top of the screen to report successes, warnings, and errors. The left-hand section of the bar displays the latest report. Figure 50: Message Bar Report 2014 Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 37

38 Data Gatherer Chapter 3 Manage Data Sets If there are any errors to report, the right-hand section of the bar displays the number of errors which have occurred. Click the Error entry to view the errors in the Report window. See View Diagnostic Logs (on page 40) for more information. Figure 51: Message Bar Errors To close the message bar click the X button. Edit a Data Set To edit a data set, click its Edit button in the Tools column of the Data Set list. See Create and Edit Data Sets (on page 41) to learn more about editing a data set. Figure 52: Edit a Data Set Duplicate a Data Set You can duplicate a data set by clicking its Duplicate button in the Tools column of the Data Set list. Figure 53: Duplicate a Data Set When you click the button, you are prompted to enter a name and description for the data set. The new name must be different from the name of the original data set Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 38

39 Data Gatherer Chapter 3 Manage Data Sets Delete a Data Set To delete a data set, select it in the list and click the Delete button. You will be prompted to confirm the deletion. Figure 54: Delete a Data Set with the Delete Button You can also delete a data set by clicking its X in the Tools column. Figure 55: Delete a Data Set with an X Button Delete Data Sources Data Gatherer uses ODBC to manage the following types of data sources. Access Oracle Spreadsheet SQL server Text When you add these types of data sources to Data Gatherer, they are automatically registered with the appropriate ODBC drivers. If you manually delete a data source file which has been registered with ODBC, it may remain registered with ODBC and therefore continue to appear within Data Gatherer. Ensure that the file's DSN is removed from the ODBC Data Source Administrator as part of the deletion process. Consult your IT technician for more information about managing ODBC data sources in your system Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 39

40 Data Gatherer Chapter 3 Manage Data Sets View Diagnostic Logs To view the diagnostic logs for Data Gatherer, click the Diagnostic Logs button at the top of the window. Figure 56: View Diagnostic Logs A second window opens which allows you to view messages, warnings, and errors related to Data Gatherer operation. Create a New Data Set Click the New Data Set button to create a new data set. See Create and Edit Data Sets (on page 41) for more information. Figure 57: New Data Set Button 2014 Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 40

41 Data Gatherer Chapter 4 Create and Edit Data Sets Chapter 4 Create and Edit Data Sets When you click the New Data Set button to create a data set, or when you choose to edit a data set, a create/edit window opens to guide you through the steps of the process. Specify name and description. Set source and configuration. Create filter Navigate Between Steps The buttons in the create/edit window allow you to navigate between the steps in the following ways. Click the Next button to go to the next step when you have finished entering the information in the current step, or when you are editing an existing data set that has already been created. Click the Previous button to go to the previous step. When the numbered buttons at the top of the window are enabled, you can select a button to jump to a different step. Figure 58: Step Buttons To save the changes you have made to a data set which you are editing, click the Save and Close button. To cancel creating or editing a data set, click the Cancel button at the top of the window. When you have finished entering information on the final step, click the Finish button to save the data set and exit the create/edit window. Specify Name and Description The first step of defining a data set is to give it a unique name. After you have clicked the New Data Set button, the Name and Description section of the window allows you to create or edit the data set s name, and provide an optional description and comment. Name: The unique name for your data set. The name can be up to twenty characters long, and must consist of alphanumeric characters without any spaces. You can use underscores ("_") if required Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 41

42 Data Gatherer Chapter 4 Create and Edit Data Sets Description: An optional description for your data set. The description can be up to 500 characters long. Add New Comment: An optional comment for your data set, up to 200 characters long. Comment History: Each time you edit a data set you can add a new comment to explain the changes you have made. These comments are displayed in the Comment History field when you are editing a data source, and also appear in the Detail View on the Landing page. Select Data Type Use the Select Data Type section of the window to select the type of data source the set will connect to. You can only select a data type when you are creating a new data set. Access Database: An ODBC Access Database provider. Calendar Events: A Microsoft Exchange Server Calendar events provider. Oracle Database: An ODBC Oracle Database provider. RSS Feed: A simple provider for RSS feeds. Spreadsheet: An ODBC Excel Database provider. SQL Server Database: An ODBC SQL Server Database provider. Text: An ODBC Text Database provider. XML File: A simple provider for XML data. Figure 59: Data Types When you have selected a data type, click the Next button to continue. Set Source and Configuration The next step of defining a data set is to select its source and build its configuration. Use the Source and Setting and the Configuration windows to select the data source and configure it Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 42

43 Data Gatherer Chapter 4 Create and Edit Data Sets The steps you follow will depend on the data type you have chosen. Access Database (on page 43). Calendar Events (on page 48). Oracle Database (on page 51). RSS Feed (on page 56). Spreadsheet (on page 62). SQL Server Database (on page 67). Text Database (on page 72). XML File (on page 78). Access Database Follow these steps to configure an Access database. Note: Data Gatherer requires the ODBC Access 32-bit database which supports the *.accdb extension. Select an Access Database Source Use the Select Database list to select a database which has already been registered with ODBC. Figure 60: Select Database If you wish to add a new Access database instead of selecting an existing one, see Add an Access Database Source (on page 46). Authentication If Data Gatherer is unable to access the data source, you will be prompted for a username and password. Figure 61: Authentication Prompt 2014 Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 43

44 Data Gatherer Chapter 4 Create and Edit Data Sets This information might be required if you are accessing the data source from an HTTP, HTTPS, or FTP location which requires authentication. You must only go through this procedure the first time you attempt to access the source. If the source's authentication information changes in the future, you will be asked to enter an updated username and password. Note: If you feel that the problem is not due to authentication, please consult your server logs for more details about why the connection failed. Polling Schedule Use the fields in the Polling Schedule section to specify when the data set gathers data from its source. Figure 62: Polling Schedule Data can be gathered either daily or weekly. If you select the Weekly option from the drop-down list, use the checkboxes to select which days the data is gathered on. If you select the Daily option, data is gathered every day. You can choose whether to gather data at a specific time during each day, or at intervals throughout the days. Select the At option from the drop-down list to specify when the the data is gathered each day. Select the Every option to define the interval between each data gathering operation. Data Expiration You can configure your data sets to never expire, or to expire automatically at some point in the future. Expired data sets will stop gathering new data from their sources, but any data that they have already gathered will remain available to players. Figure 63: Expiration Settings If you do not want the data set to expire, select the Does Not Expire radio button. If you want the data set to expire, select the Expire On radio button and use the fields to choose an expiry date. After you have selected and configured your source, click the Next button to continue to the Configuration window Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 44

45 Data Gatherer Chapter 4 Create and Edit Data Sets Configure Access Database Use the Build Configurations window to select which data source items will be included in the data set. The data in the items will be gathered when you choose to gather data, and the data in the other items will be ignored. Select Access Database Columns In the Configuration window, use the Table drop-down list to select a table from your database. Only one table can be used per data set. Figure 64: Select Table The columns in your table appear in the Select Table Columns list. Check the checkboxes beside each column you want to access. The columns are added to the Item list in the order that you select them. Figure 65: Select Table Columns Note: If your data sources uses field types which are not recognized by Data Gatherer, these field types will appear disabled and cannot be added to the Item list. See Define Supported ODBC Field Types (on page 18) to learn how to add new supported field types to Data Gatherer. The Item list displays the following information. The name of each item. The header text that will be used when configuring each item on a player. The type of each item. For ODBC database sources, this will always be Text. Remove Access Database Items from the Item List Use the following methods to remove items from the Item list. Click the Clear button at the bottom of the Select Table Columns list. All the items in the Item list are removed and all the columns are unchecked. In the Select Table Columns list, uncheck the items you want to remove Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 45

46 Data Gatherer Chapter 4 Create and Edit Data Sets In the Items list, check the checkbox in the first column of the header to automatically select all the items, then click the Remove Selected button. All the items are removed. In the Items list, check the checkboxes beside the items you want to remove, then click the Remove Selected button. The items you selected are removed. Configure Access Database Items Use the Item list to preview and configure the items in your data set. Each time you select an item in the Item list, the Preview at the bottom of the window updates to show the most recent data from the data source. Figure 66: Item Previews The data displayed in the Preview is automatically truncated so it will fit within the columns. To view all of a truncated item s data, click the magnifying glass beside the item you want to view. The full data displays in a pop-up window. Edit Access Database Header Text Double-click within the Header column of the Item list if you wish to change an item s header text. This is the header text that will be used when the data set is being configured on a player. Figure 67: Edit Header Text When you have finished configuring your items, click the Next button to choose the filter options for your data set. See Create Filter (on page 83) for more information. Add an Access Database Source Follow these steps to add a new Access database source instead of selecting an existing one. Note: Data Gatherer uses the Microsoft Access Driver to process Access databases Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 46

47 Data Gatherer Chapter 4 Create and Edit Data Sets 1. In the Source and Settings window, click the Add a Database button under the database list. The Add a Database window opens. 2. Enter the database file location. This can be the following type of path. \\[machine name]\[path to database] ftp://[ftp server name]/[path to database] server name]/[path to database] server name]/[path to database] Note: Local file paths are not supported. 3. Click OK to access your database. Figure 68: Enter Database File Location 4. If Data Gatherer is unable to access the database, you will be prompted for a username and password. Figure 69: Authentication Prompt This information might be required if you are accessing a database which requires authentication. You must only go through this procedure the first time you attempt to access the database. If its authentication information changes in the future, you will be asked to enter an updated username and password. Note: If you feel that the problem is not due to authentication, please consult your server logs for more details about why the connection failed. 5. Your database will be registered with ODBC, so you must provide an ODBC name. A name is automatically chosen based on your data set's name and type. Enter a new name in the ODBC Name field if you wish to change it. 6. Enter an optional ODBC description for the database in the Description field. Figure 70: ODBC Name and Description 7. Click OK. You are returned to the Source and Settings window and your database is added to the database list. See Select an Access Database Source (on page 43) to learn how to select and configure it Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 47

48 Data Gatherer Chapter 4 Create and Edit Data Sets Calendar Events Follow these steps to configure a Calendar Events database. Select an Exchange Server Database Source Use the Select a Calendar list to select a database which has already been registered with ODBC. Figure 71: Select a Calendar You can perform the following actions on your selected calendar. Use the Room List drop-down to select the room list you want to monitor. A preview of the database appears in the Preview Room List section of the window. Click the Edit Server link to display your server settings. Edit the server's name, location, URL, username, and password settings and click Save if you wish to change your settings. Figure 72: Edit Server Settings Click the Delete Server link if you wish to delete the calendar. If you wish to add a new Exchange Server calendar instead of selecting an existing one, see Add an Exchange Server (on page 50) Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 48

49 Data Gatherer Chapter 4 Create and Edit Data Sets Polling Schedule Use the fields in the Polling Schedule section to specify when the data set gathers data from its source. Figure 73: Polling Schedule Data can be gathered either daily or weekly. If you select the Weekly option from the drop-down list, use the checkboxes to select which days the data is gathered on. If you select the Daily option, data is gathered every day. You can choose whether to gather data at a specific time during each day, or at intervals throughout the days. Select the At option from the drop-down list to specify when the the data is gathered each day. Select the Every option to define the interval between each data gathering operation. After you have selected and configured your source, click the Next button to continue to the Configuration window. Configure Exchange Server Database Use the Build Configurations window to select which data source items will be included in the data set. The data in the items will be gathered when you choose to gather data, and the data in the other items will be ignored. Select Exchange Rooms and Data In the Configuration window, the meeting rooms from your room list appear. Check the checkboxes beside each room you want to access. The events from the rooms appear in the Configuration Results Preview, with each event as a separate row. Figure 74: Rooms List Use the Data Collection Window drop-down list to select the range of events which are collected during each refresh Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 49

50 Data Gatherer Chapter 4 Create and Edit Data Sets Day: Data is collected for the next day. Two Days: Data is collected for the next two days. Week: Data is collected for the next week. Month: Data is collected for the next month. This # of Days: Data is collected for a specific number of days. Type the number of days into the field. When you change the selection, the Configuration Results Preview displays the specified range of events. Figure 75: Data Collection Window Drop-Down List Check the checkboxes in the Event Information list to specify the columns in your data set. To select all columns, check the Select All checkbox at the top of the list. Uncheck the Select All checkbox to deselect all columns. Figure 76: Event Information List When you have finished configuring your items, click the Next button to choose the filter options for your data set. See Create Filter (on page 83) for more information. Add an Exchange Server When adding an Exchange Server, ensure the following: The Exchange Web Services must be installed and correctly set up on the Exchange environment's network. The Exchange ASMX file should be accessible from a regular browser and return a listing of Exchange Web Service methods. Data Gatherer does not support HTML, so MeetingDetails text must be plain text only. Any HTML formatting will appear as visible text tags in Data Gatherer. Follow these steps to add a new Exchange Server calendar instead of selecting an existing one Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 50

51 Data Gatherer Chapter 4 Create and Edit Data Sets 1. In the Source and Settings window, click the Add an Exchange Server button under the database list. The Add an Exchange Server window opens. 2. In the Select Server Location section of the window, use the fields to identify the Exchange server. a. Enter a name for the server. This is the name that will be used in Data Gatherer. b. Enter the server's name. Data Gatherer will connect to servers which are accessible to its installed domain. Note: Local file paths are not supported. c. Enter the URL for Exchange server's web service. Figure 77: Select Exchange Server Location 3. Enter the username and password which you will use for accessing the Exchange server. Figure 78: Enter Username and Password 4. Click OK. You are returned to the Source and Settings window and your database is added to the database list. See Select an Exchange Server Database Source (on page 48) to learn how to select and configure it. Oracle Database Follow these steps to configure an Oracle database. Select an Oracle Database Source Use the Select Database list to select a database which has already been registered with ODBC. Figure 79: Select Database 2014 Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 51

52 Data Gatherer Chapter 4 Create and Edit Data Sets If you wish to add a new Oracle database instead of selecting an existing one, see Add an Oracle Database Source (on page 55). Authentication If Data Gatherer is unable to access the database, you will be prompted for a username and password. Figure 80: Authentication Prompt This information might be required if you are accessing a database which requires authentication. You must only go through this procedure the first time you attempt to access the database. If its authentication information changes in the future, you will be asked to enter an updated username and password. Note: If you feel that the problem is not due to authentication, please consult your server logs for more details about why the connection failed. Polling Schedule Use the fields in the Polling Schedule section to specify when the data set gathers data from its source. Figure 81: Polling Schedule Data can be gathered either daily or weekly. If you select the Weekly option from the drop-down list, use the checkboxes to select which days the data is gathered on. If you select the Daily option, data is gathered every day. You can choose whether to gather data at a specific time during each day, or at intervals throughout the days. Select the At option from the drop-down list to specify when the the data is gathered each day. Select the Every option to define the interval between each data gathering operation Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 52

53 Data Gatherer Chapter 4 Create and Edit Data Sets Data Expiration You can configure your data sets to never expire, or to expire automatically at some point in the future. Expired data sets will stop gathering new data from their sources, but any data that they have already gathered will remain available to players. Figure 82: Expiration Settings If you do not want the data set to expire, select the Does Not Expire radio button. If you want the data set to expire, select the Expire On radio button and use the fields to choose an expiry date. After you have selected and configured your source, click the Next button to continue to the Configuration window. Configure Oracle Database Use the Build Configurations window to select which data source items will be included in the data set. The data in the items will be gathered when you choose to gather data, and the data in the other items will be ignored. Select Oracle Database In the Configuration window use the Table Owner drop-down list to select the owner of the Oracle database, then select one of the owner's tables from the Table drop-down list. Figure 83: Table Owner and Table Selection The columns in your table appear in the Select Table Columns list. Check the checkboxes beside each column you want to access. The columns are added to the Item list in the order that you select them Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 53

54 Data Gatherer Chapter 4 Create and Edit Data Sets Figure 84: Select Table Columns Note: If your data sources uses field types which are not recognized by Data Gatherer, these field types will appear disabled and cannot be added to the Item list. See Define Supported ODBC Field Types (on page 18) to learn how to add new supported field types to Data Gatherer. The Item list displays the following information. The name of each item. The header text that will be used when configuring each item on a player. The type of each item. For ODBC database sources, this will always be Text. Remove Oracle Database Items from the Item List Use the following methods to remove items from the Item list. Click the Clear button at the bottom of the Select Table Columns list. All the items in the Item list are removed and all the columns are unchecked. In the Select Table Columns list, uncheck the items you want to remove. In the Items list, check the checkbox in the first column of the header to automatically select all the items, then click the Remove Selected button. All the items are removed. In the Items list, check the checkboxes beside the items you want to remove, then click the Remove Selected button. The items you selected are removed. Configure Oracle Database Items Use the Item list to preview and configure the items in your data set. Each time you select an item in the Item list, the Preview at the bottom of the window updates to show the most recent data from the data source. Figure 85: Item Previews The data displayed in the Preview is automatically truncated so it will fit within the columns. To view all of a truncated item s data, click the magnifying glass beside the item you want to view. The full data displays in a pop-up window Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 54

55 Data Gatherer Chapter 4 Create and Edit Data Sets Edit Oracle Database Header Text Double-click within the Header column of the Item list if you wish to change an item s header text. This is the header text that will be used when the data set is being configured on a player. Figure 86: Edit Header Text When you have finished configuring your items, click the Next button to choose the filter options for your data set. See Create Filter (on page 83) for more information. Add an Oracle Database Source Follow these steps to add a new Oracle database source instead of selecting an existing one. Note: Data Gatherer uses the OraClient11g_home client to process Oracle databases. 1. In the Source and Settings window, click the Add a Database button under the database list. The Add a Database window opens. 2. In the Database Server field, enter the name of the database server. Data Gatherer will connect to servers which are accessible to its installed domain. Note: Local file paths are not supported. 3. Click OK to access your database. Figure 87: Enter Database Server Location 4. If Data Gatherer is unable to access the database, you will be prompted for a username and password. Figure 88: Authentication Prompt This information might be required if you are accessing a database which requires authentication. You must only go through this procedure the first time you attempt to access the database. If its authentication information changes in the future, you will be asked to enter an updated username and password Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 55

56 Data Gatherer Chapter 4 Create and Edit Data Sets Note: If you feel that the problem is not due to authentication, please consult your server logs for more details about why the connection failed. 5. Your database will be registered with ODBC, so you must provide an ODBC name. A name is automatically chosen based on your data set's name and type. Enter a new name in the ODBC Name field if you wish to change it. 6. Enter an optional ODBC description for the database in the Description field. Figure 89: ODBC Name and Description 7. Click the triangle to reveal the optional ANSI settings. Figure 90: Optional ANSI Settings Check the Use ANSI Quoted Identifiers checkbox to put ANSI quotes around the identifiers in SQL statements. This allows the use of identifiers which contain spaces and reserved keywords. Check the Use ANSI Nulls, Paddings, and Warnings checkbox to change the behavior of nulls, paddings, and warnings in SQL statements. Consult your SQL server's documentation for more information. 8. Click OK. You are returned to the Source and Settings window and your database is added to the database list. See Select an Oracle Database Source (on page 51) to learn how to select and configure it. RSS Feed Follow these steps to configure an RSS Feed database. Select an RSS Source Use the Enter Source field to specify the location of the RSS feed. You can access a source via HTTP or FTP. Figure 91: Enter Source Field 2014 Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 56

57 Data Gatherer Chapter 4 Create and Edit Data Sets Authentication If the source requires user authentication, check the This Source Location Requires Authentication checkbox and enter the following information. Enter the username in the User Name field. Note: If the user is on a different domain, enter the domain name in the User Name field. For example, a user named tinali on the marketing domain should be entered in the User Name field as marketing\tinali. If this method of authentication fails, try entering the domain name in the Domain field instead. Enter the user's password in the Password field. Click the Verify Authentication button to ensure the user has permission to access the source. Mobile Handheld Transmission When data is gathered from XML or RSS sources, you can choose to send the data to your Infocaster Manager server for mobile handheld distribution. See Configure Mobile Handheld Transmission (on page 30) to learn how this is configured and how it occurs. Figure 92: Enable Mobile Handheld Transmission 1. Click the Enable checkbox to enable mobile handheld distribution. Along with being distributed through Infocaster Manager, your data will still be gathered into an XML file, as described in About Data Sets (on page 6). 2. Select the multicast folder you want to use for distribution. 3. Use the Duration field to set the amount of time the data is "alive" on the mobile handheld provider. Polling Schedule Use the fields in the Polling Schedule section to specify when the data set gathers data from its source. Figure 93: Polling Schedule Data can be gathered either daily or weekly Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 57

58 Data Gatherer Chapter 4 Create and Edit Data Sets If you select the Weekly option from the drop-down list, use the checkboxes to select which days the data is gathered on. If you select the Daily option, data is gathered every day. You can choose whether to gather data at a specific time during each day, or at intervals throughout the days. Select the At option from the drop-down list to specify when the the data is gathered each day. Select the Every option to define the interval between each data gathering operation. Data Expiration You can configure your data sets to never expire, or to expire automatically at some point in the future. Expired data sets will stop gathering new data from their sources, but any data that they have already gathered will remain available to players. Figure 94: Expiration Settings If you do not want the data set to expire, select the Does Not Expire radio button. If you want the data set to expire, select the Expire On radio button and use the fields to choose an expiry date. After you have selected and configured your source, click the Next button to continue to the Configuration window. Configure XML Database Source Use the Build Configurations window to select which data source items will be included in the data set. The data in the items will be gathered when you choose to gather data, and the data in the other items will be ignored. Select Elements The Select Data Set to Configure list displays all the record sets within your data source Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 58

59 Data Gatherer Chapter 4 Create and Edit Data Sets Within the Select Data Set to Configure list, click the triangle beside the data set you want to access. The items within the data set are revealed. Figure 95: Element List Check the checkboxes beside each item you want to access. The items are added to the Item list in the order that you select them. Figure 96: Add Items to the Item List The Item list displays the following information. The root path to the set you have chosen. The name of each item. The relative path to each item within the root path. The header text that will be used when configuring each item on a player. The type of each item Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 59

60 Data Gatherer Chapter 4 Create and Edit Data Sets If you want to add all of the items within the data set instead of choosing individual ones, simply check the data set s checkbox. Figure 97: Add Entire Record Set Note: Each XML or RSS data set can only access one set in the data source. If you attempt to select items from multiple sets, you will be warned that the existing items in the Item list will be removed first. If you wish to access multiple sets from the data source, you must create a data set for each one. Change Item Type In the Item list, use the Type drop-down to change the type of an item, if desired. Figure 98: Change Item Type You can choose the following types. Be sure to choose the type best suited to each item. Text Number XML Image To learn more about image types. see Where Images are Saved (on page 87). Remove RSS Feed Items from the Item List Use the following methods to remove items from the Item list. Click the Clear button at the bottom of the Select Data Set to Configure list. All the items in the Item list are removed and all the columns are unchecked Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 60

61 Data Gatherer Chapter 4 Create and Edit Data Sets In the Select Data Set to Configure list, uncheck the items you want to remove. In the Items list, check the checkbox in the first column of the header to automatically select all the items, then click the Remove Selected button. All the items are removed. In the Items list, check the checkboxes beside the items you want to remove, then click the Remove Selected button. The items you selected are removed. Configure RSS Feed Items Use the Item list to preview and configure the items in your data set. Each time you select an item in the Item list, the Preview at the bottom of the window updates to show the most recent data from the data source. Figure 99: Item Previews The data displayed in the Preview is automatically truncated so it will fit within the columns. To view all of a truncated item s data, click the magnifying glass beside the item you want to view. The full data displays in a pop-up window. Edit RSS Feed Header Text Double-click within the Header column of the Item list if you wish to change an item s header text. This is the header text that will be used when the data set is being configured on a player. Figure 100: Edit Header Text When you have finished configuring your items, click the Next button to choose the filter options for your data set. See Create Filter (on page 83) for more information Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 61

62 Data Gatherer Chapter 4 Create and Edit Data Sets Spreadsheet Follow these steps to configure a Spreadsheet database. Select a Spreadsheet Database Source Use the Select Database list to select a database which has already been registered with ODBC. Figure 101: Select Database If you wish to add a new Excel spreadsheet database instead of selecting an existing one, see Add a Spreadsheet Database Source (on page 65). Authentication If Data Gatherer is unable to access the data source, you will be prompted for a username and password. Figure 102: Authentication Prompt This information might be required if you are accessing the data source from an HTTP, HTTPS, or FTP location which requires authentication. You must only go through this procedure the first time you attempt to access the source. If the source's authentication information changes in the future, you will be asked to enter an updated username and password. Note: If you feel that the problem is not due to authentication, please consult your server logs for more details about why the connection failed Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 62

63 Data Gatherer Chapter 4 Create and Edit Data Sets Polling Schedule Use the fields in the Polling Schedule section to specify when the data set gathers data from its source. Figure 103: Polling Schedule Data can be gathered either daily or weekly. If you select the Weekly option from the drop-down list, use the checkboxes to select which days the data is gathered on. If you select the Daily option, data is gathered every day. You can choose whether to gather data at a specific time during each day, or at intervals throughout the days. Select the At option from the drop-down list to specify when the the data is gathered each day. Select the Every option to define the interval between each data gathering operation. Data Expiration You can configure your data sets to never expire, or to expire automatically at some point in the future. Expired data sets will stop gathering new data from their sources, but any data that they have already gathered will remain available to players. Figure 104: Expiration Settings If you do not want the data set to expire, select the Does Not Expire radio button. If you want the data set to expire, select the Expire On radio button and use the fields to choose an expiry date. After you have selected and configured your source, click the Next button to continue to the Configuration window. Configure Spreadsheet Database Use the Build Configurations window to select which data source items will be included in the data set. The data in the items will be gathered when you choose to gather data, and the data in the other items will be ignored Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 63

64 Data Gatherer Chapter 4 Create and Edit Data Sets Select Spreadsheet Columns In the Configuration window, use the Tab/Table drop-down list to select a table from your database. Only one table can be used per data set. Figure 105: Select Tab/Table Note: Microsoft Excel will sometimes create hidden tables for advanced functionality. There may be circumstances when you will see names in the Tab/Table list that do not appear in the spreadsheet itself. These tables are created and hidden by Excel and should not be used. The columns in your table appear in the Select Worksheet Columns list. Check the checkboxes beside each column you want to access. The columns are added to the Item list in the order that you select them. Figure 106: Select Worksheet Columns Note: If your data sources uses field types which are not recognized by Data Gatherer, these field types will appear disabled and cannot be added to the Item list. See Define Supported ODBC Field Types (on page 18) to learn how to add new supported field types to Data Gatherer. The Item list displays the following information. The name of each item. The header text that will be used when configuring each item on a player. The type of each item. For ODBC database sources, this will always be Text. Remove Spreadsheet Items from the Item List Use the following methods to remove items from the Item list. Click the Clear button at the bottom of the Select Worksheet Columns list. All the items in the Item list are removed and all the columns are unchecked. In the Select Worksheet Columns list, uncheck the items you want to remove. In the Items list, check the checkbox in the first column of the header to automatically select all the items, then click the Remove Selected button. All the items are removed Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 64

65 Data Gatherer Chapter 4 Create and Edit Data Sets In the Items list, check the checkboxes beside the items you want to remove, then click the Remove Selected button. The items you selected are removed. Configure Spreadsheet Items Use the Item list to preview and configure the items in your data set. Each time you select an item in the Item list, the Preview at the bottom of the window updates to show the most recent data from the data source. Figure 107: Item Previews The data displayed in the Preview is automatically truncated so it will fit within the columns. To view all of a truncated item s data, click the magnifying glass beside the item you want to view. The full data displays in a pop-up window. Edit Spreadsheet Header Text Double-click within the Header column of the Item list if you wish to change an item s header text. This is the header text that will be used when the data set is being configured on a player. Figure 108: Edit Header Text When you have finished configuring your items, click the Next button to choose the filter options for your data set. See Create Filter (on page 83) for more information. Add a Spreadsheet Database Source Use the Add a Spreadsheet window to register a new Excel spreadsheet with ODBC. Note: Data Gatherer uses the Microsoft Excel Driver to process Excel spreadsheets. 1. Click the Add a File button under the database list. A new window opens. 2. Enter the file location. This can be the following type of path: 2014 Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 65

66 Data Gatherer Chapter 4 Create and Edit Data Sets \\[machine name]\[path to file] ftp://[ftp server name]/[path to file] server name]/[path to file] server name]/[path to file] Note: Local file paths are not supported. 3. Click OK to access your file. 4. If Data Gatherer is unable to access the data source, you will be prompted for a username and password. Figure 109: Authentication Prompt This information might be required if you are accessing the data source from an HTTP, HTTPS, or FTP location which requires authentication. You must only go through this procedure the first time you attempt to access the source. If its authentication information changes in the future, you will be asked to enter an updated username and password. Note: If you feel that the problem is not due to authentication, please consult your server logs for more details about why the connection failed. 5. Use the Spreadsheet Details section of the window to configure your database access. a. Select the Excel version from the drop-down list. b. Choose the number of rows to scan when setting up column and column data types. You can specify between 1 and 16 rows. c. If you want to prevent other applications from modifying the spreadsheet while Data Gatherer is accessing it, check the Read Only checkbox. 6. Your database will be registered with ODBC, so you must provide an ODBC name. A name is automatically chosen based on your data set's name and type. Enter a new name in the ODBC Name field if you wish to change it. 7. Enter an optional ODBC description for the database in the Description field. Figure 110: ODBC Name and Description 8. Click OK. You are returned to the Source and Settings window and your database is added to the database list Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 66

67 Data Gatherer Chapter 4 Create and Edit Data Sets SQL Server Database Follow these steps to configure an SQL Server database. Select an SQL Database Source Use the Select Database list to select a database which has already been registered with ODBC. Figure 111: Select Database If you wish to add a new SQL database, see Add an SQL Database Source (on page 70). Authentication If Data Gatherer is unable to access the database, you will be prompted for a username and password. Figure 112: Authentication Prompt This information might be required if you are accessing a database which requires authentication. You must only go through this procedure the first time you attempt to access the database. If its authentication information changes in the future, you will be asked to enter an updated username and password. Note: If you feel that the problem is not due to authentication, please consult your server logs for more details about why the connection failed Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 67

68 Data Gatherer Chapter 4 Create and Edit Data Sets Polling Schedule Use the fields in the Polling Schedule section to specify when the data set gathers data from its source. Figure 113: Polling Schedule Data can be gathered either daily or weekly. If you select the Weekly option from the drop-down list, use the checkboxes to select which days the data is gathered on. If you select the Daily option, data is gathered every day. You can choose whether to gather data at a specific time during each day, or at intervals throughout the days. Select the At option from the drop-down list to specify when the the data is gathered each day. Select the Every option to define the interval between each data gathering operation. Data Expiration You can configure your data sets to never expire, or to expire automatically at some point in the future. Expired data sets will stop gathering new data from their sources, but any data that they have already gathered will remain available to players. Figure 114: Expiration Settings If you do not want the data set to expire, select the Does Not Expire radio button. If you want the data set to expire, select the Expire On radio button and use the fields to choose an expiry date. After you have selected and configured your source, click the Next button to continue to the Configuration window. Configure SQL Database Use the Build Configurations window to select which data source items will be included in the data set. The data in the items will be gathered when you choose to gather data, and the data in the other items will be ignored Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 68

69 Data Gatherer Chapter 4 Create and Edit Data Sets Select SQL Database In the Configuration window, use the Table drop-down list to select a table from your database. Only one table can be used per data set. Figure 115: Select Table The columns in your table appear in the Select Table Columns list. Check the checkboxes beside each column you want to access. The columns are added to the Item list in the order that you select them. Figure 116: Select Table Columns Note: If your data sources uses field types which are not recognized by Data Gatherer, these field types will appear disabled and cannot be added to the Item list. See Define Supported ODBC Field Types (on page 18) to learn how to add new supported field types to Data Gatherer. The Item list displays the following information. The name of each item. The header text that will be used when configuring each item on a player. The type of each item. For ODBC database sources, this will always be Text. Remove Spreadsheet Items from the Item List Use the following methods to remove items from the Item list. Click the Clear button at the bottom of the Select Table Columns list. All the items in the Item list are removed and all the columns are unchecked. In the Select Table Columns list, uncheck the items you want to remove. In the Items list, check the checkbox in the first column of the header to automatically select all the items, then click the Remove Selected button. All the items are removed. In the Items list, check the checkboxes beside the items you want to remove, then click the Remove Selected button. The items you selected are removed. Configure SQL Database Items Use the Item list to preview and configure the items in your data set Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 69

70 Data Gatherer Chapter 4 Create and Edit Data Sets Each time you select an item in the Item list, the Preview at the bottom of the window updates to show the most recent data from the data source. Figure 117: Item Previews The data displayed in the Preview is automatically truncated so it will fit within the columns. To view all of a truncated item s data, click the magnifying glass beside the item you want to view. The full data displays in a pop-up window. Edit SQL Database Header Text Double-click within the Header column of the Item list if you wish to change an item s header text. This is the header text that will be used when the data set is being configured on a player. Figure 118: Edit Header Text When you have finished configuring your items, click the Next button to choose the filter options for your data set. See Create Filter (on page 83) for more information. Add an SQL Database Source Use the Add a Database window to register a new SQL database with ODBC. Note: Data Gatherer uses the SQL Server Native Client 10.0 to process SQL databases. 1. In the Source and Settings window, click the Add a Database button under the database list. The Add a Database window opens. 2. In the Database Server field, enter the name of the database server. Data Gatherer will connect to servers which are accessible to its installed domain. Note: Local file paths are not supported. 3. Click OK to access your database. The databases which are hosted by the server appear in the list. 4. Select the database you wish to use Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 70

71 Data Gatherer Chapter 4 Create and Edit Data Sets 5. If Data Gatherer is unable to access the database, you will be prompted for a username and password. Figure 119: Authentication Prompt This information might be required if you are accessing a database which requires authentication. You must only go through this procedure the first time you attempt to access the database. If its authentication information changes in the future, you will be asked to enter an updated username and password. Note: If you feel that the problem is not due to authentication, please consult your server logs for more details about why the connection failed. 6. Your database will be registered with ODBC, so you must provide an ODBC name. A name is automatically chosen based on your data set's name and type. Enter a new name in the ODBC Name field if you wish to change it. 7. Enter an optional ODBC description for the database in the Description field. Figure 120: ODBC Name and Description 8. Click the triangle to reveal the optional ANSI settings. Figure 121: Optional ANSI Settings Check the Use ANSI Quoted Identifiers checkbox to put ANSI quotes around the identifiers in SQL statements. This allows the use of identifiers which contain spaces and reserved keywords. Check the Use ANSI Nulls, Paddings, and Warnings checkbox to change the behavior of nulls, paddings, and warnings in SQL statements. Consult your SQL server's documentation for more information. 9. Click OK. You are returned to the Source and Settings window and your database is added to the database list Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 71

72 Data Gatherer Chapter 4 Create and Edit Data Sets Text Database Follow these steps to configure a text database. Select a Text File Database Source Use the Select File Location list to select a text file which has already been registered with ODBC. Figure 122: Select Text File To search for a text file, type your search text into the Search field above the list. Filenames which match your search text will appear in the list. Click the X button beside the search field to show all files again. Click the View Details button beside a text file to view its file path and ODBC DSN (Data Source Name). Figure 123: Text File Details If you wish to add a new text file database instead of selecting an existing one, see Add a Text File Data Source (on page 76) Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 72

73 Data Gatherer Chapter 4 Create and Edit Data Sets Authentication If Data Gatherer is unable to access the data source, you will be prompted for a username and password. Figure 124: Authentication Prompt This information might be required if you are accessing the data source from an HTTP, HTTPS, or FTP location which requires authentication. You must only go through this procedure the first time you attempt to access the source. If the source's authentication information changes in the future, you will be asked to enter an updated username and password. Note: If you feel that the problem is not due to authentication, please consult your server logs for more details about why the connection failed. Polling Schedule Use the fields in the Polling Schedule section to specify when the data set gathers data from its source. Figure 125: Polling Schedule Data can be gathered either daily or weekly. If you select the Weekly option from the drop-down list, use the checkboxes to select which days the data is gathered on. If you select the Daily option, data is gathered every day. You can choose whether to gather data at a specific time during each day, or at intervals throughout the days. Select the At option from the drop-down list to specify when the the data is gathered each day. Select the Every option to define the interval between each data gathering operation. Data Expiration You can configure your data sets to never expire, or to expire automatically at some point in the future. Expired data sets will stop gathering new data from their sources, but any data that they have already gathered will remain available to players Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 73

74 Data Gatherer Chapter 4 Create and Edit Data Sets Figure 126: Expiration Settings If you do not want the data set to expire, select the Does Not Expire radio button. If you want the data set to expire, select the Expire On radio button and use the fields to choose an expiry date. After you have selected and configured your source, click the Next button to continue to the Configuration window. Configure Text File Use the Build Configurations window to select which data source items will be included in the data set. The data in the items will be gathered when you choose to gather data, and the data in the other items will be ignored. Select Text File Columns The columns in your table appear in the Select Table Columns list. Check the checkboxes beside each column you want to access. The columns are added to the Item list in the order that you select them. Figure 127: Select Table Columns Note: If your data sources uses field types which are not recognized by Data Gatherer, these field types will appear disabled and cannot be added to the Item list. See Define Supported ODBC Field Types (on page 18) to learn how to add new supported field types to Data Gatherer. The Item list displays the following information. The name of each item. The header text that will be used when configuring each item on a player. The type of each item. For ODBC database sources, this will always be Text Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 74

75 Data Gatherer Chapter 4 Create and Edit Data Sets Remove Text File Items from the Item List Use the following methods to remove items from the Item list. Click the Clear button at the bottom of the Select Table Columns list. All the items in the Item list are removed and all the columns are unchecked. In the Select Table Columns list, uncheck the items you want to remove. In the Items list, check the checkbox in the first column of the header to automatically select all the items, then click the Remove Selected button. All the items are removed. In the Items list, check the checkboxes beside the items you want to remove, then click the Remove Selected button. The items you selected are removed. Configure Text File Items Use the Item list to preview and configure the items in your data set. Each time you select an item in the Item list, the Preview at the bottom of the window updates to show the most recent data from the data source. Figure 128: Item Previews The data displayed in the Preview is automatically truncated so it will fit within the columns. To view all of a truncated item s data, click the magnifying glass beside the item you want to view. The full data displays in a pop-up window. Edit Text File Header Text Double-click within the Header column of the Item list if you wish to change an item s header text. This is the header text that will be used when the data set is being configured on a player. Figure 129: Edit Header Text When you have finished configuring your items, click the Next button to choose the filter options for your data set. See Create Filter (on page 83) for more information Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 75

76 Data Gatherer Chapter 4 Create and Edit Data Sets Add a Text File Data Source Use the Add a Text File window to register a new text file with ODBC. Note: Data Gatherer uses the Microsoft Text Driver to process text files. This driver cannot read "UTF-8 with BOM" encoding, and will display invalid characters if a file encoded with that method is added to Data Gatherer. Both ANSI encoding and "UTF-8 encoding without BOM" are supported. 1. Click the Add a File button under the database list. A new window opens. 2. Enter the file location. This can be the following type of path: \\[machine name]\[path to file] ftp://[ftp server name]/[path to file] server name]/[path to file] server name]/[path to file] Note: Local file paths are not supported. Figure 130: Enter File Location 3. Select the type of delimiter which will be used for separating each line of the text file into separate columns. CSV Delimited: Columns in the text file are delimited by commas. TAB Delimited: Columns in the text file are delimited by TABs. Custom Delimited: Columns in the text file are delimited by a custom character, which you can enter in the custom field. 4. Choose character set standards with the Character Type drop-down list. ANSI: The text file uses the ANSI character set. OEM: The text file uses an OEM character set. 5. Check the Use First Row as Column Header Names checkbox to set the first line of the text file to be the column header names. 6. Click OK to access your database. 7. If Data Gatherer is unable to access the data source, you will be prompted for a username and password. Figure 131: Authentication Prompt 2014 Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 76

77 Data Gatherer Chapter 4 Create and Edit Data Sets This information might be required if you are accessing the data source from an HTTP, HTTPS, or FTP location which requires authentication. You must only go through this procedure the first time you attempt to access the source. If its authentication information changes in the future, you will be asked to enter an updated username and password. Note: If you feel that the problem is not due to authentication, please consult your server logs for more details about why the connection failed. 8. A preview of your headers appears in the table. Use the table to set your header names and data types. Figure 132: Text File Headers Double-click the header names in the table to change their header text. This is the header text that will be used when the data set is being configured on a player. Use the Type drop-down to change the data type of each column, if desired. 9. Your database will be registered with ODBC, so you must provide an ODBC name. A name is automatically chosen based on your data set's name and type. Enter a new name in the ODBC Name field if you wish to change it. 10. Enter an optional ODBC description for the database in the Description field. Figure 133: ODBC Name and Description 11. Click OK. You are returned to the Source and Settings window and your database is added to the database list. Add Text Files with Identical Filenames Be aware of the following restrictions when adding text files which have identical filenames. A filename is considered "identical" when both its filename and extension are the same. Text files added from a UNC location (\\[machine name\[path to file]): Only a single DSN can point to a file in this location. You cannot create additional DSNs which point to the same file. Text files added from an FTP, HTTP, or HTTPS location: The same file in the same directory can be referred to multiple times, provided they have different DSNs. Note: Manual ODBC DSNs are not accepted Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 77

78 Data Gatherer Chapter 4 Create and Edit Data Sets XML File Follow these steps to configure an XML file database. Select an RSS Source Use the Enter Source field to specify the location of the XML feed. You can access a source via HTTP or FTP. Figure 134: Enter Source Field Authentication If the source requires user authentication, check the This Source Location Requires Authentication checkbox and enter the following information. Enter the username in the User Name field. Note: If the user is on a different domain, enter the domain name in the User Name field. For example, a user named tinali on the marketing domain should be entered in the User Name field as marketing\tinali. If this method of authentication fails, try entering the domain name in the Domain field instead. Enter the user's password in the Password field. Click the Verify Authentication button to ensure the user has permission to access the source. Mobile Handheld Transmission When data is gathered from XML or RSS sources, you can choose to send the data to your Infocaster Manager server for mobile handheld distribution. See Configure Mobile Handheld Transmission (on page 30) to learn how this is configured and how it occurs. Figure 135: Enable Mobile Handheld Transmission 1. Click the Enable checkbox to enable mobile handheld distribution. Along with being distributed through Infocaster Manager, your data will still be gathered into an XML file, as described in About Data Sets (on page 6). 2. Select the multicast folder you want to use for distribution. 3. Use the Duration field to set the amount of time the data is "alive" on the mobile handheld provider Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 78

79 Data Gatherer Chapter 4 Create and Edit Data Sets Polling Schedule Use the fields in the Polling Schedule section to specify when the data set gathers data from its source. Figure 136: Polling Schedule Data can be gathered either daily or weekly. If you select the Weekly option from the drop-down list, use the checkboxes to select which days the data is gathered on. If you select the Daily option, data is gathered every day. You can choose whether to gather data at a specific time during each day, or at intervals throughout the days. Select the At option from the drop-down list to specify when the the data is gathered each day. Select the Every option to define the interval between each data gathering operation. Data Expiration You can configure your data sets to never expire, or to expire automatically at some point in the future. Expired data sets will stop gathering new data from their sources, but any data that they have already gathered will remain available to players. Figure 137: Expiration Settings If you do not want the data set to expire, select the Does Not Expire radio button. If you want the data set to expire, select the Expire On radio button and use the fields to choose an expiry date. After you have selected and configured your source, click the Next button to continue to the Configuration window Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 79

80 Data Gatherer Chapter 4 Create and Edit Data Sets Configure XML Database Source Use the Build Configurations window to select which data source items will be included in the data set. The data in the items will be gathered when you choose to gather data, and the data in the other items will be ignored. Select Elements The Select Data Set to Configure list displays all the record sets within your data source. Within the Select Data Set to Configure list, click the triangle beside the data set you want to access. The items within the data set are revealed. Figure 138: Element List Check the checkboxes beside each item you want to access. The items are added to the Item list in the order that you select them. Figure 139: Add Items to the Item List The Item list displays the following information. The root path to the set you have chosen Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 80

81 Data Gatherer Chapter 4 Create and Edit Data Sets The name of each item. The relative path to each item within the root path. The header text that will be used when configuring each item on a player. The type of each item. If you want to add all of the items within the data set instead of choosing individual ones, simply check the data set s checkbox. Figure 140: Add Entire Record Set Note: Each XML or RSS data set can only access one set in the data source. If you attempt to select items from multiple sets, you will be warned that the existing items in the Item list will be removed first. If you wish to access multiple sets from the data source, you must create a data set for each one. Change Item Type In the Item list, use the Type drop-down to change the type of an item, if desired. Figure 141: Change Item Type You can choose the following types. Be sure to choose the type best suited to each item. Text Number XML Image To learn more about image types. see Where Images are Saved (on page 87) Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 81

82 Data Gatherer Chapter 4 Create and Edit Data Sets Remove RSS Feed Items from the Item List Use the following methods to remove items from the Item list. Click the Clear button at the bottom of the Select Data Set to Configure list. All the items in the Item list are removed and all the columns are unchecked. In the Select Data Set to Configure list, uncheck the items you want to remove. In the Items list, check the checkbox in the first column of the header to automatically select all the items, then click the Remove Selected button. All the items are removed. In the Items list, check the checkboxes beside the items you want to remove, then click the Remove Selected button. The items you selected are removed. Configure RSS Feed Items Use the Item list to preview and configure the items in your data set. Each time you select an item in the Item list, the Preview at the bottom of the window updates to show the most recent data from the data source. Figure 142: Item Previews The data displayed in the Preview is automatically truncated so it will fit within the columns. To view all of a truncated item s data, click the magnifying glass beside the item you want to view. The full data displays in a pop-up window. Edit RSS Feed Header Text Double-click within the Header column of the Item list if you wish to change an item s header text. This is the header text that will be used when the data set is being configured on a player. Figure 143: Edit Header Text When you have finished configuring your items, click the Next button to choose the filter options for your data set. See Create Filter (on page 83) for more information Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 82

83 Data Gatherer Chapter 4 Create and Edit Data Sets Create Filter You can create filters to specify the data which will be included when the data source is gathered. Only data which matches the filter conditions will be included during the gathering process. Each time you update your rules, the Preview at the bottom of the window displays your filtered data. Within the window, a blank filter rule is automatically added to the Rules list. Create filter rules to filter the data that arrives from the data source. Define a Rule Within the Rules list, define a rule by specifying its column, operator, and value. The column is one of the data items you selected while configuring your data set. The operator defines the way Data Gatherer compares the data item with a specific value. The available operators are Contains and Equals. The value is the value against which the data is compared. Figure 144: Rule Definition Note: Some database applications replace the actual value in a data item with a more convenient name. This is especially true with boolean operators, where some database applications return "true" or "false" when queried, though the data is internally stored as "1" or "0." Ensure that you are using the actual data value when you create your rules (eg. "1" or "0"). Rules and Filter Sets The rules for your data set consist of one or more filter sets. A filter set is a group of one or more rules which are connected with All ("AND") or Any ("OR") logic. Filter sets can be combined to allow complex filtering of your data. Figure 145: Filter Set 2014 Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 83

84 Data Gatherer Chapter 4 Create and Edit Data Sets Add Rules to a Filter Set To add a rule to a filter set, click the + button in one of the set s rules. A new blank rule is added. Figure 146: Add New Rule Use the Match drop-down list to specify how the rules in the filter set are evaluated. Figure 147: Match Drop-Down List All: The data is filtered out if it does not pass all the rules ("AND"). Any: The data is filtered out if it does not pass any of the rules ("OR"). Add a Filter Set To add a new filter set, click the Add Filter Set button within a rule. The new filter set is added below the rule. Figure 148: Add Filter Set Preview Filtered Data Set Click the Show Filtered button to display the results of your filter in the Preview window. Figure 149: Show Filter Button 2014 Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 84

85 Data Gatherer Chapter 4 Create and Edit Data Sets To remove the filter from your preview, click the Show All button. Delete a Rule Click the X button within a rule to delete it. Figure 150: Delete a Rule Save the Data Set When you have finished creating or editing your data set, click the Finish button to save the set and return to the Landing page. Figure 151: Finish Button 2014 Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 85

86 Data Gatherer Chapter 5 Connect Players to Data Sets Chapter 5 Connect Players to Data Sets Connect your players to data sets and access your gathered XML file. Connect Players Players must be able to access the gathered data which will be incorporated into their content. Where Gathered Data is Saved When data is gathered by a data set, the gathered data is stored in an XML file which players can access via HTTP. The XML files are placed in subfolders of the Data Gatherer server s host feeds folder. Note: By default, the virtual path of the host feeds folder is DGHostFeeds, but you can change it with the Dispatcher Configuration Manager. See Dispatcher Configuration Manager (on page 28) for more information. Inside the host feeds folder, each data set creates a subfolder named after the data set, followed by _TR. For example, a data set called Weather will create a subfolder called Weather_TR. Inside this subfolder, the folder structure depends on the type of data set used. ODBC Folder Structure For each ODBC data set (Access, Excel, SQL, Oracle, or text), Data Gatherer creates an XML file which contains the gathered data. The file s name is [Data Set Name]_Filter.xml Figure 152: Three ODBC Data Sets with Gathered Data RSS, XML, and Calendar Folder Structure For each RSS, XML, or Calendar data set, Data Gatherer creates another subfolder which represents the configuration and filter settings of the data set. This folder is called [Data Set Name]_Filter Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 86

87 Data Gatherer Chapter 5 Connect Players to Data Sets Inside this subfolder, Data Gatherer places the XML file which contains the gathered data. The file s name is [Data Set Name]_Filter.xml Figure 153: Three XML Data Sets with Gathered Data Example of Gathered Data The following is an example XML file consisting of two items (title and description). Figure 154: Gathered XML File Where Images are Saved A data set can access data sources which reference image files. See Step Three: Build Configurations to learn how to specify when a data set s item is a reference to an image. If a data set accesses a data source which references image files, Data Gatherer performs extra processing. The image files are copied to the Data Gatherer server system. If you wish to copy the image files to a different system, see Configure the Data Gatherer SQL Settings (on page 12). When Data Gatherer writes a gathered XML file, the image references in the file are changed to point to the location where the images were copied Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 87

88 Data Gatherer Chapter 5 Connect Players to Data Sets When images are gathered by a data set, the gathered images are stored in an additional subfolder. The subfolder follows the same convention as the subfolders for other XML/RSS data types, but it is followed by the image item s header name. For example, the images gathered from an item called url would be placed in a subfolder called [Data Set Name]_Filter_url. Figure 155: Gathered Images Note: The original URL paths are maintained in Data Gatherer s internal SQL Server database. The paths are only modified in the gathered XML file which Data Gatherer provides to players. Where Mobile Handheld Transmission Data is Saved If mobile handheld transmission is used to send data to players, the XML files and image files will be located in the player s reception folder. See Configure Mobile Handheld Transmission (on page 30) for more information. Access a Gathered XML File The following steps provide an example connection between a Title item on an Infocaster player and the text in a gathered XML file, using the player s Data Source Wizard. Note: If you wish to access image references instead, create a Graphic Importer item and link its Graphic tag to the XML file s image references. The process is similar to the one outlined below, and is described in the Infocaster Data Source Wizard Guide. Please consult that guide to learn more about the Data Source Wizard features Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 88

89 Data Gatherer Chapter 5 Connect Players to Data Sets In this example we have created a Title item within Infocaster. On the Content tab of the Title Quick Editor, we have created two tags named Title and Description. Figure 156: Title with Two Tags 1. Check the External Data Source checkbox. 2. Click the Setup button to open the Data Source Wizard. 3. In the Data Source Wizard, select the Create New RSS/XML Data Source radio button. Figure 157: Create New RSS/XML Data Source 4. Click the Next button to proceed to the next window. 5. Click the Browse button. An Open window appears Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 89

90 Data Gatherer Chapter 5 Connect Players to Data Sets 6. Navigate to your gathered XML file on the Data Gatherer server. Figure 158: Open the Gathered XML File Note: If the XML file was sent via mobile handset transmission, it will be located in your player s transmission folder. See Configure Mobile Handheld Transmission (on page 30) for more information. Click the Open button.the full path to the gathered XML file appears in the Data Source Wizard. 7. Enter a name for the data source. Figure 159: Name the Data Source 8. Click the Next button. The elements in the gathered XML file appear in the Data File Structure list. 9. Browse to the first ddr element. 10. Select the title item and add it to the Selected Data Source list by clicking the > button Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 90

91 Data Gatherer Chapter 5 Connect Players to Data Sets 11. Select the description item and add it to the Selected Data Source list by clicking the > button. Figure 160: Select Items from the Gathered XML File 12. Click the Next button. The new window allows you to change the data type of each item, if desired. It also gives internal names to the three columns in the data source. F1: The index number of each row. This is automatically created. F2: The first column (title). F3: The second column (description). 13. Click the Next button. The new window allows you to assign your Infocaster tags to the items in the data source. a. In the Field drop-down list, select the Title tag. b. In the Column drop-down list, select the F2 column. c. Click Add. Infocaster s Title tag is assigned to column F2 (the title item in the gathered XML file). d. In the Field drop-down list, select the Description tag. e. In the Column drop-down list, select the F3 column. f. Click Add. Infocaster s Description tag is assigned to column F3 (the description item in the gathered XML file). Figure 161: Assign Tags to Items 14. Click the Next button. The final window allows you to establish rules for retrieving and presenting data playback. Click the Finished button. The tags in your Infocaster item are connected to the data in the gathered XML file, and will be updated when the file changes Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 91

92 Data Gatherer Chapter 5 Connect Players to Data Sets Connect a Title to an XML File In this example we have created a Title item within Infocaster. On the Content tab of the Title Quick Editor, we have created two tags named Title and Description. Figure 162: Title with Two Tags 1. Check the External Data Source checkbox. 2. Click the Setup button to open the Data Source Wizard. 3. In the Data Source Wizard, select the Create New RSS/XML Data Source radio button. Figure 163: Create New RSS/XML Data Source 4. Click the Next button to proceed to the next window. 5. Click the Browse button. An Open window appears Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 92

93 Data Gatherer Chapter 5 Connect Players to Data Sets 6. Navigate to your gathered XML file on the Data Gatherer server. Figure 164: Open the Gathered XML File Note: If the XML file was sent via mobile handset transmission, it will be located in your player s transmission folder. See Configure Mobile Handheld Transmission (on page 30) for more information. Click the Open button.the full path to the gathered XML file appears in the Data Source Wizard. 7. Enter a name for the data source. Figure 165: Name the Data Source 8. Click the Next button. The elements in the gathered XML file appear in the Data File Structure list. 9. Browse to the first ddr element. 10. Select the title item and add it to the Selected Data Source list by clicking the > button Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 93

94 Data Gatherer Chapter 5 Connect Players to Data Sets 11. Select the description item and add it to the Selected Data Source list by clicking the > button. Figure 166: Select Items from the Gathered XML File 12. Click the Next button. The new window allows you to change the data type of each item, if desired. It also gives internal names to the three columns in the data source. F1: The index number of each row. This is automatically created. F2: The first column (title). F3: The second column (description). 13. Click the Next button. The new window allows you to assign your Infocaster tags to the items in the data source. a. In the Field drop-down list, select the Title tag. b. In the Column drop-down list, select the F2 column. c. Click Add. Infocaster s Title tag is assigned to column F2 (the title item in the gathered XML file). d. In the Field drop-down list, select the Description tag. e. In the Column drop-down list, select the F3 column. f. Click Add. Infocaster s Description tag is assigned to column F3 (the description item in the gathered XML file). Figure 167: Assign Tags to Items 14. Click the Next button. The final window allows you to establish rules for retrieving and presenting data playback. 15. Click the Finished button. The tags in your Infocaster item are connected to the data in the gathered XML file, and will be updated when the file changes Imagine Communications. Proprietary and Confidential. 6/20/2014 Page 94