icompel Deployment Manager V2.2.0 Set up and manage a large, multichannel digital signage network that spans many locations. Monitor and remotely manage multiple icompel units and groups. V2.2.0 (23283M)
icompel Deployment Manager Federal Communications Commission and Industry Canada Radio Frequency Interference Statements This equipment generates, uses, and can radiate radio-frequency energy, and if not installed and usedproperly, that is, in strict accordance with the manufacturer s instructions, may cause inter-ference to radio communication. It has been tested and found to comply with the limits for a Class A computing device in accordance with the specifications in Subpart B of Part 15 of FCC rules, which are designed to provide reasonable protection against such interference when the equipment is operated in a commercial environment. Operation of this equipment in a residential area is likely to cause interference, in which case the user at his own expense will be required to take whatever measures may be necessary to correct the interference. Changes or modifications not expressly approved by the party responsible for compliance could void the user s authority to operate the equipment. This digital apparatus does not exceed the Class A limits for radio noise emis-sion from digital apparatus set out in the Radio Interference Regulation of Industry Canada. Le présent appareil numérique n émet pas de bruits radioélectriques dépassant les limites applicables aux appareils numériques de la classe A prescrites dans le Règlement sur le brouillage radioélectrique publié par Industrie Canada. 2
NOM Statement Instrucciones de Seguridad (Normas Oficiales Mexicanas Electrical Safety Statement) 1. Todas las instrucciones de seguridad y operación deberán ser leídas antes de que el aparato eléctrico sea operado. 2. Las instrucciones de seguridad y operación deberán ser guardadas para referencia futura. 3. Todas las advertencias en el aparato eléctrico y en sus instrucciones de operación deben ser respetadas. 4. Todas las instrucciones de operación y uso deben ser seguidas. 5. El aparato eléctrico no deberá ser usado cerca del agua por ejemplo, cerca de la tina de baño, lavabo, sótano mojado o cerca de una alberca, etc.. 6. El aparato eléctrico debe ser usado únicamente con carritos o pedestales que sean recomendados por el fabricante. 7. El aparato eléctrico debe ser montado a la pared o al techo sólo como sea recomendado por el fabricante. 8. Servicio El usuario no debe intentar dar servicio al equipo eléctrico más allá a lo descrito en las instrucciones de operación. Todo otro servicio deberá ser referido a personal de servicio calificado. 9. El aparato eléctrico debe ser situado de tal manera que su posición no interfiera su uso. La colocación del aparato eléctrico sobre una cama, sofá, alfombra o superficie similar puede bloquea la ventilación, no se debe colocar en libreros o gabinetes que impidan el flujo de aire por los orificios de ventilación. 10. El equipo eléctrico deber ser situado fuera del alcance de fuentes de calor como radiadores, registros de calor, estufas u otros aparatos (incluyendo amplificadores) que producen calor. 11. El aparato eléctrico deberá ser connectado a una fuente de poder sólo del tipo descrito en el instructivo de operación, o como se indique en el aparato. 12. Precaución debe ser tomada de tal manera que la tierra fisica y la polarización del equipo no sea eliminada. 13. Los cables de la fuente de poder deben ser guiados de tal manera que no sean pisados ni pellizcados por objetos colocados sobre o contra ellos, poniendo particular atención a los contactos y receptáculos donde salen del aparato. 14. El equipo eléctrico debe ser limpiado únicamente de acuerdo a las recomendaciones del fabricante. 15. En caso de existir, una antena externa deberá ser localizada lejos de las lineas de energia. 16. El cable de corriente deberá ser desconectado del cuando el equipo no sea usado por un largo periodo de tiempo. 17. Cuidado debe ser tomado de tal manera que objectos liquidos no sean derramados sobre la cubierta u orificios de ventilación. 18. Servicio por personal calificado deberá ser provisto cuando: A: El cable de poder o el contacto ha sido dañado; u B: Objectos han caído o líquido ha sido derramado dentro del aparato; o C: El aparato ha sido expuesto a la lluvia; o D: El aparato parece no operar normalmente o muestra un cambio en su desempeño; o E: El aparato ha sido tirado o su cubierta ha sido dañada. 3
Trademarks Used in this Manual Black Box and the Double Diamond logo are registered trademarks of BB Technologies, Inc. Any other trademarks mentioned in this manual are acknowledged to be the property of the trademark owners. All rights reserved. No parts of this work may be reproduced in any form or by any means - graphic, electronic, or mechanical, including photocopying, recording, taping, or information storage and retrieval systems - without the written permission of the publisher. Products that are referred to in this document may be either trademarks and/or registered trademarks of the respective owners. The publisher and the author make no claim to these trademarks. While every precaution has been taken in the preparation of this document, the publisher and the author assume no responsibility for errors or omissions, or for damages resulting from the use of information contained in this document or from the use of programs and source code that may accompany it. In no event shall the publisher and the author be liable for any loss of profit or any other commercial damage caused or alleged to have been caused directly or indirectly by this document. Printed: October 2011 4
icompel Deployment Manager - Quick Start Guide (V2.2.0) Glossary Table of Contents 1. idm Overview...8 1.1 1.2 2. Reporting Access account 8 Summary 8 Initial Setup...10 2.1 2.2 2.3 2.4 3. Find the idm on your network 10 Initial Configuration 10 Organizations 11 Users 12 2.4.1 Username... 12 2.4.2 Default Player Organization... 12 2.4.3 Organizations... 12 2.4.4 Permissions... 13 2.4.5 Password & Confirm... Password 13 2.4.6 Adding Players... 13...16 Organization Options 3.1 3.2 3.3 4. Alarm Configuration 3.1.1 CPU Overheat... 3.1.2 Data Disk Free Space... 3.1.3 Disk Overheat... 3.1.4 Schedule Not Normal... 3.1.5 Publisher Transfer... Late 3.1.6 Report Overdue... 3.1.7 Slow CPU Fan... 3.1.8 Slow System Fan... 3.1.9 Software Version... 3.1.10 Subscriber Transfer... Late 3.1.11 Subscriber Not Using... New Channel 3.1.12 System Disk Free... Space 3.1.13 System Overheat... 3.1.14 Subscriber Activate... Late 3.1.15 Publisher Error... 3.1.16 Subscriber Has No... Publisher 3.1.17 Subscriber Channel... Has Multiple Publishers 3.1.18 Publisher Inactive... Channel is Incomplete 3.1.19 Publisher Duplicate... Channel 3.1.20 Channel Manager... Initializing E-mail Configuration 3.2.1 Set global e-mail... settings 3.2.2 Set per-organization... e-mail settings Operating Hours Configuration 16 17 17 18 18 18 18 18 18 18 19 19 19 19 19 19 19 19 20 20 20 20 20 21 22 Home views...26 4.1 Summary 26 5
icompel Deployment Manager - Quick Start Guide (V2.2.0) 4.2 4.3 4.4 4.5 4.6 5. 5.2 5.3 VPN 6.1 6.2 7. 26 27 28 28 29 Reporting...31 5.1 6. Players Thumbnails Map View Alarms Manage Home views Prerequisite setup 5.1.1 idm user account... setup 5.1.2 Enable reporting for... each playlist item 5.1.3 Enable reporting for... the icompel globally 5.1.4 Enable reporting for... each zone Media Audit Reporting Custom reports and 3rd party access 31 31 31 31 32 32 35...37 idm Configuration 37 icompel Configuration 37 Glossary...39 7.1 7.2 7.3 7.4 7.5 7.6 7.7 7.8 7.9 7.10 7.11 CPU DHCP DNS idm Firewall IP address icompel SMTP TLS UDP VPN Index 6 39 39 39 39 39 39 39 40 40 40 40 0
Part I idm Overview
icompel Deployment Manager - Quick Start Guide (V2.2.0) 1. idm Overview The icompel Deployment Manager (idm) forms part of the Black Box Network Services Digital Signage Platform. Accessed through a website, the idm allows centralized management and reporting of 1000 icompel's from a central location, enabling administrators to manage their networks remotely from any location. Each icompel in the network is setup to periodically report its status to the idm. This status information is stored in a database and so can be search and queried by administrators to produce specific reports. 1.1 Reporting Access account With a VPN or HTTP link established between an icompel and the idm, they need to be configured to handle reports. The idm is setup with a specific user account to allow icompel's to submit media audit reports. Likewise the icompel needs to be told of the credentials to logon to this dedicated reporting account on the idm. Please see section 2.4 for details of setting up general user accounts. Please see section 5.1.1 to setup an account on the idm to receive Media Audit reports. Please see section 5.1.3 to set up the icompel to access the dedicated idm reporting account Once a report has been sent, the HTTP or VPN connection is closed. 1.2 Summary For an icompel to successfully report to a idm: idm: Add organizations, users and players idm: Assign icompels to organizations, and organization to users idm: Add a specific user to the idm to accept reports from icompel idm: Setup the HTTP connection details, or VPN if required to allow icompels to connect. icompel: Set the playlist item, zone and icompel to allows media audit reports icompel: Setup HTTP, or VPN if required with the details of the specific idm reporting account. 8
Part II Initial Setup
icompel Deployment Manager - Quick Start Guide (V2.2.0) 2. Initial Setup This covers the initial setup of a new unit, with a focus on new users unfamiliar with the idm. To manage advanced options such as Media Audit Reporting please see section 5. 2.1 Find the idm on your network By default the idm will use DHCP to set it IP address automatically so it s unlikely you will know its IP address in order to access it during first use. If the DHCP server allows connecting computers to add their hostname to the DNS server, you may be able to access the idm using its name. The hostname (or network name) of the idm is derived from icompel Deployment Manager then its serial number found on the units back or side. Type into your web browsers address bar: http://idm<serial> For example: http://idm154229 If you do not know its DHCP IP address or can t access the idm using its name, you will need to connect a screen to the idm and restart it. Its IP address is displayed on the screen during each boot. Type its IP address into your web browsers address bar, for example: http://192.168.1.44 The default login credentials are: Username: remote Password: 9999 2.2 Initial Configuration Each idm is shipped with no configuration except for a single administrative login remote - see section 2.1 for the logon credentials. After login you will see the default home screen: 10
Initial Setup This screen can also be accessed by selecting on the idm Home > Summary from the grey menu bar. An organization needs to be allocated to a user before it can be managed, and an organization needs to be added before icompel can be assigned to it. So the order in which things are configured is in reverse to what you may expect: Add new users Add organization Assign organization to user & set user permissions. Add icompel Add icompel's to an organization Configure HTTP or VPN for reporting Configure playlist items to report 2.3 Organizations icompel's are arranged into organizations enabling multiple independent signage networks to be managed by a single network service provider, or by grouping icompel into organizations by store, for example. At least one organization needs to be set up first before any icompel's can be associated with one. Organizations is found within the System menu. Go to the Add Organization tab, enter your new organization name and click Add Organization. You are then taken to the Organizations overview tab, where you will see a warning telling you that the newly added organization is not assigned to a user: 11
icompel Deployment Manager - Quick Start Guide (V2.2.0) 2.4 Users Go to the Users tab Note: you cannot delete your own account while logged in. Select the Add User tab, or select Edit if you want to edit an existing user. The Edit and Add User tabs are identical, except for you cannot change the username when editing an existing user. Click the Add User or Save Changes to commit your changes. 2.4.1 Username This is the name used as the username when logging on to the idm. This cannot be edited if editing an existing user. 2.4.2 Default Player Organization When an icompel attempts to report to the idm, if that icompel has been manually added to the idm and associated with an organization, the icompel will join that organization. If a new icompel tries to report into the idm and is unknown (hasn t been manually registered), the icompel can either be: Ignored, and thus won t be able to report to the idm. or Automatically added to the organization selected from the drop down box. 2.4.3 Organizations The selected organisation(s) that this user is allowed to view and manage. 12
Initial Setup 2.4.4 Permissions This selects which pages the user can access. The four columns of tick boxes broadly align to types of user role: User: Column 1, the things a typical user will want to do. Reporting: Column 2, options required for a icompel to report in. Remote Access: Column 3, Advanced option for external access for databases and FTP. Administration: Column 4, Access to the admin level configuration options and backup. 2.4.5 Password & Confirm Password Used to set the password for that user. 2.4.6 Adding Players After setting up users and organizations, the home screen (on the idm Home > Summary) changes to show your organization and its icompel members: Because we have not yet registered any icompel players, none have reported in. We are notified that no players have reported in by the grey notice underneath the menu bar. Note: some additional menu options have appeared due to setting up additional permissions. To reduce administrative overhead, icompel Players can be added automatically to the idm while reporting see section 2.4.2. If a greater degree of control is required, players can be added and managed manually from the idm System > Players menu. The Add Player tab allows you to enter the icompel's serial number, select a home organization, set a friendly display name and whether the idm should accept reports from this icompel. If the name is left blank, the serial number is used for identification. After adding the player, the page returns to the Players overview tab. 13
icompel Deployment Manager - Quick Start Guide (V2.2.0) The Edit button takes you to a similar page to the Add Player tab, except you cannot change the icompel player serial number. The red X button allows you to delete the icompel player. The idm is now setup to know about reports coming from individual icompel's, but the idm and each icompel still need configuration to allow the VPN connection between them. Please see section 5.1.1 for setting the idm VPN to allow icompel's to connect Please see section 5.1.4 for setting up the icompel to connect to the idm via VPN 14
Part III Organization Options
icompel Deployment Manager - Quick Start Guide (V2.2.0) 3. Organization Options Each organization can have Alarm, Email and Operating Hours options configured for it, with each organization being accessed under the Organization menu, as shown below: 3.1 Alarm Configuration The alarm defaults for the icompel are set on the idm > System > Alarm Configuration. Alarms have three states: Alarming : red Acknowledged : Orange Cleared : Green And operate as follows: An alarm is raise (alarm unacknowledged) A manager or administrator updates the alarm with a "reason" (e.g. engineer en-route to fix) and it becomes acknowledged. Problem is resolved and the alarm is lowered. The following per-organization alarm settings allow the global defaults to be overridden. Select on the idm Organization > your organization > Alarm Configuration. 16
Organization Options All the alarms contain an Inherit/Ignore/Observe Alarm setting: Inherit Alarm Use Use whatever is defined in System > Alarm Configuration on the idm. This is the default. Ignore Alarm All incoming alarms will be ignored. This overrides the System > Alarm Configuration setting on the idm. Observe Alarm All incoming alarms will be observed. This overrides the System > Alarm Configuration setting on the idm. Many of the alarms also have an Override Default Alarm Settings option that allows customization of the options of each alarm. 3.1.1 CPU Overheat The CPU has maximum temperature that it can operate. By default an alarm is raised if the temperature rises to within 5 of this maximum temperature. The Alarm is lowered when the temperature is 10 or more below this temperature. The default raise and lower thresholds can be overridden per-organization by setting the check box and entering the new values. 3.1.2 Data Disk Free Space The data disk has upper and lower free space limits by default. An alarm is raised when the free disk space goes below 20MiB. The alarm is lowered when the data disk free space exceeds 100MiB The default raise and lower alarm thresholds for the data disk can be overridden per-organization by setting the check box and entering the new values. 17
icompel Deployment Manager - Quick Start Guide (V2.2.0) 3.1.3 Disk Overheat This alarm only applies to icompel models that have a HDD. Models with a SSD do not have this alarm. The disk has maximum temperature that is can operate. By default an alarm is raised if the reported temperature rises to within 2 of this maximum temperature. The Alarm is lowered when the temperature is 5 or more below this temperature. The default raise and lower thresholds can be overridden per-organization by setting the check box and entering the new values. 3.1.4 Schedule Not Normal This alarm is raised when an icompel's normal schedule is overridden and hasn t returned to normal during a set period of time. This can happen because of two conditions: The icompel has been told to audition The icompel has been told to use a Schedule Override The wait period is specified in hours and minutes and defaults to 1 hour. The wait period can be overridden per-organization by setting the check box and entering the new duration. 3.1.5 Publisher Transfer Late Alarm is raised when the player is overdue to publish by the threshold time. It will be lowered when the player reports in that it is publishing.. The default threshold time is 1 hour and is specified in hours and minutes The time can be overridden per-organization by setting the check box and entering the duration. 3.1.6 Report Overdue This alarm is raises if a report from an icompel is more that a set duration overdue, and if the expected report time is within the defined operating hours. The default is 1 hour and can be specified in days, hours and minutes. The lateness alarm of the reports can be overridden per-organization by setting the check box and entering the duration. 3.1.7 Slow CPU Fan This alarm only applied to models that have a CPU fan. The defaults are to raise an alarm if the CPU fan speed goes below 1 RPM, or goes above 1000 RPM. The alarm is lowered if the fan speed returns to between 1 and 1000 RPM Checking the override box allow per-organization overrides for these values. 3.1.8 Slow System Fan This alarm only applied to models that have a System fan The defaults are to raise an alarm if the System fan speed goes below 1 RPM, or goes above 1000 RPM. The alarm is lowered if the fan speed returns to between 1 and 1000 RPM Checking the override box allow per-organization overrides for these values. 3.1.9 Software Version Raises an alarm in the software version installed on the icompel does not match a specified version. The default value is blank but is specified as major.minor.update, for example 7.4.2. The alarms is lowered when the versions match. This allows incompatible software version between icompel's and the idm to be avoided Checking the override box allow per-organization overrides for the software version check. 18
Organization Options 3.1.10 Subscriber Transfer Late This alarm is raised when a player acting as a subscriber is late to start subscribing to its channel by the given time. It will be lowered when the player reports that it is subscribing. The default is 1 hour and is specified in hours and minutes. The maximum transfer duration can be overridden per-organization by setting the check box and entering the duration. 3.1.11 Subscriber Not Using New Channel An alarm is raised when a subscriber is late switching to a new channel by more than configurable time period. The default is 1 minute and is specified in minutes and seconds. Checking the override box allow per-organization overrides for the alarm delay for a late switching subscriber 3.1.12 System Disk Free Space The system disk has upper and lower free space limits by default. An alarm is raised when the free system disk space goes below 20MiB. The alarm is lowered when the system disk free space exceeds 100MiB The default raise and lower thresholds for the system disk can be overridden per-organization by setting the check box and entering the new values. 3.1.13 System Overheat By default an alarm is raised if the core system temperature rises above 50. The Alarm is lowered when the temperature drops to 45 or lower. The default upper and lower thresholds can be overridden per-organization by setting the check box and entering the new values. 3.1.14 Subscriber Activate Late If a channel has an "Activate after" time specified and the Subscriber has not activated the channel by this time the alarm is raised. There are no options for this alarm. 3.1.15 Publisher Error Raise an alarm if there is a channel publisher error, and this alarm will be lowered when the publisher manages to publish the channel without errors. Details of the error will be found on the publisher. There are no options for this alarm. 3.1.16 Subscriber Has No Publisher This alarm is raise if the idm cannot find an icompel that published the channel being used by the subscriber. This typically means: The subscriber is configured to use the wrong channel The publisher has not been configured to report to the idm There are no options for this alarm 3.1.17 Subscriber Channel Has Multiple Publishers If a subscriber is subscribed to a publisher but there is more than one publisher of the same name, an alarm is raised. This alarm will be lowered if the channel names among the publishers are made unique. There are no options for this alarm 19
icompel Deployment Manager - Quick Start Guide (V2.2.0) 3.1.18 Publisher Inactive Channel is Incomplete This alarm is raised when a multi-channel publisher reports that an inactive channel has not completed publishing. This alarm will be lowered when the particular channel has been published successfully. 3.1.19 Publisher Duplicate Channel Alarm is raised when multiple publishers publish their reports but are using the same channel name. The alarm will be lowered when channel names within an organization are made unique. 3.1.20 Channel Manager Initializing An alarm is raised when the channel manager responsible for either publishing or subscribing is initializing at the time of the report. This alarm will be lowered once a report is received that indicates that the channel manager has finished initializing. 3.2 E-mail Configuration Before e-mail can be configured for an organization, global email settings must be configured on the idm first. 3.2.1 Set global e-mail settings On the idm, select Setup > System Setup > E-mail Settings The configure tab allows you to set the SMTP server, Authentication details and TLS if required. Once saved the Test tab allows a test e-mail to be sent: You will be notified if the test e-mail was a success or a failure, with the technical error message included if it failed: 20
Organization Options 3.2.2 Set per-organization e-mail settings After successfully testing the global e-mail settings, on the idm select Organization > your organization > E-mail Configuration The Configure tab allows the general organizations e-mail details to be configured, such as the Recipient and From fields, the message footer and header, language and the time and date format. The main body of the e-mail comes for the alarms itself. 21
icompel Deployment Manager - Quick Start Guide (V2.2.0) After the organizations e-mail settings have been saved, a test e-mail can be sent from the Test tab: The Alarms tab allows each alarm to be configured to send an e-mail when it is raised, and when the alarm is lowered. Click Save Changes when finished. 3.3 Operating Hours Configuration Alarms that are raised when an icompel is off are useless, such as when a store is close, as the icompel's are supposed to be off. Therefore the alarms should be suppressed out of hours. The idm allows Operating Hours for an organization to be set, silencing alarms outside of these operating hours. On the idm select Organization > your organization > Operating Hours Configuration. 22
Organization Options The Add Rule tab allows a rule to be added, enabling operating hours to be defined. Each rule is for a single time period per day and can be assigned to multiple days. A starting and end date/ time range for the rule can be specified, also selecting the days that rule applies to and the actual operating time. This allows for example: 9:00 to 19:00 Monday to Friday 8:00 to 21:00 Saturday 10:00 to 16:00 Sunday In this typical example, to describe opening hours throughout the week requires three time ranges, so the above three rules are required. The Operating Hours Rules tab shows an overview of the rules for the current organization. 23
icompel Deployment Manager - Quick Start Guide (V2.2.0) 24
Part IV Home views
icompel Deployment Manager - Quick Start Guide (V2.2.0) 4. Home views The Home screen found at Home > Summary on the idm features 6 options along to top right of the main table: Summary Players Thumbnails Map View Alarms Manage The selected option highlights in dark blue: 4.1 Summary The Summary option shows all the organizations with a status bar showing the proportion of icompel's that are OK, Acknowledged or in Error within that organization. 4.2 Players The Players view allows details of each player to be view within the selected organization. The Select Displayed Columns button allows the columns to be configured to show the exact icompel details as required. The columns can be dragged into a new order as needed. Selecting one of the links in the Name or Serial column takes you to full details for that player, and allows editing of the display name of the player: 26
Home views 4.3 Thumbnails The thumbnails view displays screenshots of the output of each icompel when the report was submitted. The thumbnails are only sent if configured on each icompel. 27
icompel Deployment Manager - Quick Start Guide (V2.2.0) 4.4 Map View The map view overlays push-pins representing the locations of icompels of an Organization on a map. If multiple icompels are present in a location they are represented as a push-pin cluster. The alarm state of each icompel is also indicated by the color of the push-pin. 4.5 Alarms The Alarms section provides details of the faults on alarming icompel's. Selecting the link in the Alarm Name column allows the alarms to be acknowledged (silenced), and allows adding a reason for the acknowledgment. 28
Home views In this example, a reason for a icompel not reporting could be that is has been removed because the store has closed. 4.6 Manage The manage option allows further grouping of icompel's within an organization by allowing them to be organized into folders: Folders allow the 1000 icompel's in an organization to be grouped more logically, such as into stores, or by content type to be displayed. 29
Part V Reporting
Reporting 5. Reporting All the data reported from each icompel is stored in the idm database and so usage, reliability and other reports can be generated on demand. 5.1 Prerequisite setup A number of components need to be configured before media audit reporting is successful. 5.1.1 idm user account setup A user account must be created on the idm to accept the media audit reports from the icompel. On the idm: Go to the System > Users menu Select the Add User tab (or select an existing user to edit), Ensure that Accept Report and Establish VPN are the only two permissions selected. Make a note of the username and password as they will be needed later. You cannot set the remote user with the above permissions and so will need to use a different user. 5.1.2 Enable reporting for each playlist item Reporting needs to be set for the individual item in the playlist On each icompel: Go to the Playlists menu and then select the playlist, then the zone containing the items you want to audit. Select the Edit button on each playlist item you want to audit. Go to the Advanced tab Ensure that Media Audit it set to enabled, or inherit if the zone has it enabled. 5.1.3 Enable reporting for the icompel globally Reporting must be setup for each icompel globally, so on each icompel: Go to Setup > System Setup > Reporting if you don t see Reporting, you may not have a reporting license installed. Enable reporting using HTTP or VPN if network security is particularly tight. HTTP: Enter the name or IP address of the target idm. VPN: enter the target VPN IP address and port. The default port number is 1194, resulting in ipaddress:port e.g. 192.168.0.1:1194 VPN uses the UDP protocol Decide whether to include a screenshot of the icompel at the time of reporting. Configure a time that each icompel reports its logs and ensure the option is selected. Enter either the Hostname or IP address of the HTTP or VPN idm destination, depending which mechanism being used, Enter the Username and Password of the user setup in section 5.1.1 above to allow the icompel to leave reports on the idm. 31
icompel Deployment Manager - Quick Start Guide (V2.2.0) 5.1.4 Enable reporting for each zone Reporting must be set-up for each desired zone on each icompel Go to each icompel: Select a layout from the Layouts menu, Select the Zone tab and select a zone from the layout editor, Click on the Zone Properties button, Select the Properties tab in the floating window. Ensure the Media Audit check box is ticked to enable media auditing for that zone on that layout. You must do this for each zone, on each layout, on each icompel you want media auditing. 5.2 Media Audit Reporting Reporting can be accessed by going to Home > Media Audit Reporting on the idm. You will only see this option if the administrator has given you permission, and you will only see data in this view if the icompel's have been told to, and have successfully sent logs to the idm. Additionally, only played clips will be reported, so continuous live TV for example will not produce a media audit report to the idm. Assuming all is well and a log has been left on the idm, the Home > Media Audit Reporting screen will look like this: 32
Reporting Various options exist: Produce a summary report or comprehensive listing Audit a particular player, or an entire channel Select the date and time range for the report Generate a Excel compatible CSV file containing the data The following is an example of a Summary, where each item is listed once with a count showing the total number of plays: The following is an example of the Listing report, where each play instance is individually listed: 33
icompel Deployment Manager - Quick Start Guide (V2.2.0) When Output: as a CSV file is selected you will get a file download dialog box and no on-screen list: 34
Reporting 5.3 Custom reports and 3rd party access Third party systems and applications can access the idm database to get access to the raw data to produce custom reports. Please contact Black Box Network Services support during office hours for help and advice. 35
Part VI VPN
VPN 6. VPN For networks that are locked down and do not allow inbound connections to a icompel from a idm, the idm can optionally act a Virtual Private Network (VPN) server allowing icompel's to access the idm through firewalls VPN needs to be setup on the idm and each icompel 6.1 idm Configuration Go to Setup > System Setup >Licensing Under VPN Service settings ensure the Enable VPN tick box is checked. The default port number is 1194. It may be necessary to change this port number to fall in line with an internal IT policy. Changing the port number is not recommended unless there is a good reason to. VPN uses the UDP protocol. 6.2 icompel Configuration Go to Setup > System Setup > Reporting On the Settings tab, select Report Status to a idm via VPN In the Report Delivery section, in the Report to idm via a VPN box type in the IP address of the idm followed by the VPN port number set on the idm: ipaddress:port For example 192.168.0.1:1195 37
Part VII Glossary
Glossary 7. Glossary 7.1 CPU Central Processing Unit. The brain of the computer 7.2 DHCP Dynamic Host Configuration Protocol If a computer is configured with DHCP, it will get allocated an IP address by the DHCP server. This means it IP address may be different every time it asks for one. Computers configured with a static IP address will always have the same manually configured IP address, and do not have it set automatically by DHCP. For more information please visit: http://en.wikipedia.org/wiki/dhcp 7.3 DNS Domain Name Server/System A DNS Server keeps a record of computer names with their IP addresses, enabling user to type in computer names which are easier to remember, rather than IP addresses. The DNS server looks up the IP address of the computer the name represents, and forwards the request to the actual computer. For more details please visit: http://en.wikipedia.org/wiki/domain_name_system 7.4 idm Digital Signage Manager Part of the Black Box Network Services Digital Signage Platform. Provides a central location that icompel's can report to, and enables centralized reporting and alarm aggregation for 1000s of icompel'ss grouped into organizations. 7.5 Firewall A firewall blocks traffic into and out of a computer. Firewalls typically allow certain applications such as web browsers and updating software to request out on a specific network port and allow responses back through the same port. This prevents unwanted external network traffic, which includes Viruses and Trojans, from gaining access to the computer. For more details please visit: http://en.wikipedia.org/wiki/firewall_(computing) 7.6 IP address Internet Protocol Address A unique numerical identifier for a network connection (typically a computer) on a network. IP4 is the older and more common variant and is in the format a.b.c.d, for example 192.168.0.1 For more details please visit: http://en.wikipedia.org/wiki/ip_address 7.7 icompel icompel The Black Box Network Services digital signage media player, designed to play a wide variety of media included video, images, flash HTML RSS data and Audio to produce suitable digital signage for any organization. Forms part of the wider Black Box Network Services Digital Signage Platform 39
icompel Deployment Manager - Quick Start Guide (V2.2.0) 7.8 SMTP Simple Mail Transfer Protocol A easy way of sending simple e-mails to systems. For more details please see: http://en.wikipedia.org/wiki/smtp 7.9 TLS Transport Layer Security A security mechanism used to encrypt information sent over Ethernet networks. Used in the idm for the VPN and to securely transfer mail using SMTP (only possible if the mail server itself supported TLS). TLS supersedes SSL - Secure Socket Layer. For more details please visit: http://en.wikipedia.org/wiki/transport_layer_security 7.10 UDP User Datagram Protocol. One of the simplest ways of packaging data to send from one network connected computer to another. It can be considered a send and hope way of getting packets of data from one computer to another as there is no receive acknowledgment, retries or timeouts. The order that UDP packets are sent is not guaranteed to be the same order they are received. The lightweight nature UDP makes it suited to real-time network applications such as video streaming. For more details please visit: http://en.wikipedia.org/wiki/user_datagram_protocol 7.11 VPN Virtual Private Network An isolated, secure and encrypted network protocol that creates tunnels between a VPN server and a client, and is used to communicate through firewalls. For more details please visit: http://en.wikipedia.org/wiki/vpn 40
About BlackBox Black Box Network Services is your source for more than 118,000 networking and infrastructure products. You ll find everything from cabinets and racks and power and surge protection products to media converters and Ethernet switches all supported by free, live 24/7 Tech support available in 30 seconds or less. Copyright 2010. All rights reserved. Black Box and the Double Diamond logo are registered trademarks of BB Technologies, Inc. Any third-party trademarks appearing in this manual are acknowledged to be the property of their respective owners. ICOMP, rev. 1 (build: V2.2.0 (23283M)) 41