insight ii data collection application for windows (dca)

Insight II Data Collection Application for Windows (DCA) Installation Guide (Version 7.20.1.64 and above)

Version 1.6 October 2013 Page 1

Notices

Copyright Notice The material presented in this document is copyright-protected by © EKM4 Limited 2012 and may not be reproduced in any form, by any method for any purpose without the prior written consent of EKM4 Limited. EKM4 Limited, reserves the right to revise and improve Insight II as it sees fit. This document relates to the state of Insight II at the time of this publication and may not reflect the product at all times in the future. E&OE Requests for permission to reproduce this document for the purpose of selling, or distribution should be addressed as shown below: EKM4 Limited 1 Roman Way Crusader Park, Warminster Wiltshire United Kingdom BA12 8SP Telephone: +44(0) 1985 217 920 Email: [email protected]

Document Control

Component Details Document: Windows Insight II Data Collection Application Install Guide Version No: V 1.6 Version date: 02/10/2013

Change History Version Date Author Comments 1.5.2 22/06/2012 NK Validate guide for DCA v 7.20.017. Clarify process for end user. 1.5.1 22/06/2012 MV Additional DCA Console usage details. 1.5.2 15/06/2012 NK New installation procedure DCA v 7.20.013 1.5.3 15/01/2013 NK 5222 alternatives noted 1.5.4 15/03/2013 MV Updated for DCA v 7.20.028. Additional SMTP Email settings added. 1.6 02/10/2013 MV Updated for DCA v 7.20.1.64. References to Java installer removed.

mailto:[email protected]


Contents Installation Media ............................................................................................................................... 3

Product Licensing ................................................................................................................................ 3

Preparing for a New Installation (No previous DCA version installed) ............................................... 3

Preparing for an Upgrade to an Existing Installation .......................................................................... 3

Setup Stage ......................................................................................................................................... 4

Installation Settings Stage – New Installations Only ........................................................................... 6

Service Settings ............................................................................................................................... 6

Product Activation .......................................................................................................................... 7

Local Discovery Option and Creating the Database ........................................................................ 8

Program Configuration Using the DCA Console ................................................................................ 10

Administrator and Standard User Console Modes ....................................................................... 11

Device Discovery and Monitoring Status ...................................................................................... 11

Adding or Modifying Discovery Ranges ........................................................................................ 12

Point Discoveries ........................................................................................................................... 14

Configuring Email .......................................................................................................................... 15

Appendix 1 - Advanced configuration - Proxy Settings ..................................................................... 16

Setting an HTTP Proxy to Access the Internet Licence Server ...................................................... 16

Setting an XMPP Proxy to Access the Service Provider Portal Server .......................................... 17

Appendix 2 - Product Licensing ......................................................................................................... 19

Prerequisites ................................................................................................................................. 19

Appendix 3 - Glossary ....................................................................................................................... 20


Installation Media The Insight II Data Collection Application (DCA) is packaged as a self-extracting installer program in the form of a single Windows executable “Setup” file.

The filename of the Setup file takes one of two forms:

a) Provider-specific, for example ACME_DCA_7.20.1.xx_Setup.exe b) “Vanilla”, for example DCA-7.20.1.xx_Setup.exe

where xx represents the release version build number, for example 64.

The same installer program is run to perform either a new installation or to upgrade an existing DCA installation to the latest version.

It is recommended that the setup file be copied to the machine on which the DCA is to be installed before running, although it can also be launched directly from external media if required.

Product Licensing The Insight II Data Collection Application requires a run-time licence to operate. The licensing model is described in more detail in Appendix 2 - Product Licensing.

If you are upgrading from a previous release your existing licence will remain valid.

Preparing for a New Installation (No previous DCA version installed) The application needs a valid licence to activate the installation. Before installation commences ensure that you have been provided by EKM4 with the following:

• A 12-digit Key Code, for example 112233000019, OR a licence file with the file extension .lic, for example acme.lic

• An executable installer file.

Preparing for an Upgrade to an Existing Installation Upgrade is performed using the same executable installer file as new installations.

Before performing an upgrade install ensure the Insight II Data Collection Application Console window is not open. This is necessary to permit the installer to update application files.


Setup Stage Note that System Administrator privileges are required to perform this installation.

Running the program installer setup file follows the familiar Windows Installer process:

Select the installation destination directory (it is recommended to accept the default location suggested) and click “Next”:

Then select the installation type from the dropdown menu:


• Choose “New installation” if no previous version of the DCA is installed. • To upgrade an existing installation choose “Upgrade from earlier version”.

The installer then displays several further standard options for customising the installation (it is recommended to accept the suggested values for these) before presenting the “Ready to Install” summary window:

Click the “Install” button to begin the program installation process.


Installation Settings Stage – New Installations Only The information in this section is only relevant if the “New installation” option is used. If you are performing an upgrade installation please skip ahead to the section entitled ‘Program Configuration Using the DCA Console’.

After the Setup program has copied program files, you will be presented with a series of screens to enter configuration settings and activation/licencing information.

Service Settings As previously discussed, the option exists for both “vanilla” and provider-specific versions of the installers. The “vanilla” installer (DCA-7.20.1.xx_Setup.exe) displays the following screen:

• Enter an admin email address, for example the email address of the person performing the installation. This is the contact email address associated with the licence, and is also the default address to which the application will send error notification messages if email settings are configured.

• If required enter the service provider code, which will have been supplied with the licence, exactly as supplied.

Note: For provider-specific installers (e.g. ACME_ DCA-7.20.1.xx_Setup.exe) only the admin email address entry field is displayed on this screen; the provider code is pre-configured.

Press the “Continue”button to go to the next stage, the Product Activation screen.


Product Activation This process is a one-off procedure during the installation of the Data Collection Application. Depending on the method of licensing to be used select either of the following two options:

If EKM4 have provided an activation key: Select “I will activate the program via the internet using a supplied key code”. Enter the 12-digit key code provided, e.g. 112233000019.

If EKM4 have provided a .lic file: Select “I have been supplied with an activation licence file”. Then click the “Load licence file…” button and use the file browser to locate and open the supplied .lic file:

Click “Open”. If the licence file is valid the message “Licence file loaded successfully” will be displayed beneath the load button, and the licence number will display (greyed-out) in the key code box as shown below:


Click the “Continue” button to progress to the next stage.

Clicking “Cancel Install” at any stage displays the following message:

Clicking “Yes” will abort the program database configuration, but the main Setup program will continue – the service will be installed but will not function correctly. If you reach this point you will need to uninstall the program and run the installer setup process again. In order to uninstall the program use either the Windows Control Panel or the “Uninstall the InsightII Data Collection Application” shortcut provided in the Start Menu.

Local Discovery Option and Creating the Database After the licence details have been entered the following question window will be displayed, which allows you to choose whether to automatically scan the local network range identified in order to discover network attached printers:

• The actual IP address range shown will differ since it is derived from the IP address of the host computer.

• If you need to specify alternate scan ranges, or want to enter known printer addresses manually, then click the “No” button.

The next stage of installation displays progress messages as the program database is created:


Once complete the Finish button is enabled. Click “Finish” to return to the Setup program for the final step, which starts the “I2E Monitor for Windows” Service and also offers an option to launch the DCA Console, the basic operation of which is described in the next section


Program Configuration Using the DCA Console The DCA Console displays service status information and also allows changing program settings and configuring monitor operation.

When the Console first opens the “Connected to portal server” indicator may take some time (more than a minute) to turn green – it waits for several messages to be delivered to verify correct function. This is normal operation; the messages will be stored in a queue until the portal server is available. The status indicator should then become active:

In the event the service encounters a problem, one or more of the Service Status indicators will display a red cross, as shown below:


If the “Connected to XMPP server” indicator is red it is designed to display an explanatory message in order to assist with diagnostics by your IT network support function. Further information is included in Appendix 1 - Advanced configuration - Proxy Settings.

Administrator and Standard User Console Modes The DCA Console has two levels of access and operation:

• Standard User Mode: allows any user to view the service status and configure local environment settings. Only the Product Information and Environment Settings tabs are visible.

• Administrator Mode: permits administration of the service (starting and stopping) and access to advanced configuration settings. All console tabs are visible.

The Windows Start Menu contains two shortcuts to launch the console in the two modes. On systems implementing User Account Control (UAC) such as Windows 7, Windows Server 2008 and above, elevated (Administrator) privileges are required to run the Console in Admin mode.

Device Discovery and Monitoring Status The Discovery Status section on the Product Information tab displays summary information about the printers and other devices the DCA has discovered and is monitoring on the network. The last network address scanned is shown, followed by the number of devices found and being monitored:


Clicking the “Details…” button displays a window containing additional details ofthese devices:

Also shown in the Discovery Status section is a count of the number of alerts being reported by the monitored devices:

Clicking the “Details…” button displays the current device alerts in a window:

Adding or Modifying Discovery Ranges Within the Application Settings tab of the DCA Console is a “Device Discovery” page that allows the user to add, edit or modify the device discovery ranges as necessary for the network environment. Your Service Provider may add these remotely on your behalf.

If the option was selected at installation time the local sub-network on which the DCA is running will have been automatically added as a discovery range.


Each Discovery Range has a Zone Name and an IP address scanning range. For example, to scan for devices having IP addresses only within the range 10.1.2.100 to 10.1.2.149 and associate these with a zone named “Head Office” the table should contain the values:

Name IP(0) IP(1) IP(2) IP(3) End IP Enabled Head Office 10 1 2 100 149 Y

Double-click on the values in the table to edit them, and press Return when done. The status line at the bottom of the Console displays a message confirming when a discovery has been modified.

Clicking the “Add” button creates a new row in the table allowing the user to configure an additional scanning range.

The “Enable” and “Disable” buttons toggle whether the selected discovery range is activated for scanning.

The “Remove” button removes the selected discovery range.


Point Discoveries The ability to add individual known devices rather than scanning a network address range is included via the Point Discovery function. Each device can be added individually via the “Add” button as shown in the example below:

Alternatively, it is also possible to add a list of devices in one operation. Clicking the “Import…” button opens a window into which the device zone names and addresses can be entered.

Please note the syntax guidance indicated at the bottom of the window. It is recommended that when specifying a large number of devices the list be pre-prepared in a text editor such as Notepad, then copied and pasted into the window. Clicking “Import” will import the list into the DCA.


Configuring Email The DCA can be configured to send certain notification and alert messages as emails directly from the application. To enable this function it is necessary to enter connection settings for an SMTP server using the “SMTP Email” page within the Environment Settings tab in the DCA Console. The settings shown below are typical of the configuration required:

Ask a network administrator to provide the correct settings for your network. If the mail server requires authentication then enter user login username and password in the fields provided. Some mail servers will only accept secure (SSL) connections, if this is the case tick the “Secure connection” checkbox. If the mail server uses a non-standard connection port this can be configured using the “Port” field.

The “Send Test Email” button may be used to test and confirm correct operation by sending a small test message to the configured Helpdesk address using the entered connection settings.

Click the “Save Settings” button to apply the changes.


Appendix 1 - Advanced configuration - Proxy Settings

If the “Connected to XMPP server” status indicator is shown as a red cross it is designed to display a message saying why:

If the message is “Connection error” it may be due to the required TCP/IP network ports (normally 5222, 443 or 80) being blocked by your network firewall. Contact your network administrator to confirm if this is the case. In some cases connection must be made via a proxy server, for which the application needs access details. To provide these go to the Environment Settings tab in the DCA Console to review the proxy settings.

Two sets of proxy settings are used, one for accessing the internet (in order to contact the licence server) via a web proxy, the other for accessing the external XMPP (chat) server via a SOCKS or HTTP proxy.

Setting an HTTP Proxy to Access the Internet Licence Server An example of manual configuration is shown below:

Ask a network administrator to provide the correct settings for your network.

Where no HTTP proxy is required (internet access is directly available) use the configuration below:


Setting an XMPP Proxy to Access the Service Provider Portal Server An example of manual configuration is shown below:

Ask a network administrator to provide the correct settings for your network.


Where no XMPP proxy is required use the configuration below:


Appendix 2 - Product Licensing Each DCA requires a licence to be generated by EKM4 before the installation is performed. The licence can then be supplied to the installer in two forms:

a) As a 12-digit key code, which will be validated with the EKM4 internet licence server to obtain additional configuration parameters, and thus requires internet access via HTTP port 80.

b) As a file containing all necessary configuration parameters, to support the case in which no internet connection to the EKM4 licence server can be made available from the DCA host machine.

Prerequisites EKM4 require the following information from in order to generate a DCA licence:

1. Provider – This is the name of the Print Service Provider. Defines XMPP and Portal server addresses. This is a one off exercise for Service Providers for all their customers.

2. Email Address – contact address for all support communications regarding the installation/licence.

3. Account Name – Also known as CONTRACT at the Portal server. This is the unique identifier and XMPP log in account for the specific DCA installation. This name needs to be rostered to the Portal server’s account at the XMPP server.

4. XMPP Password – password the DCA uses (with Account Name) to log into the XMPP server. 5. Expiry Date – Licences run, by agreement with EKM4, from a 30 day trial period up to a

rolling one year expiry. Expired licences limit DCA functionality. The DCA warns users that the licence has expired. Subject to contractual obligations EKM4 will renew the licence on application.

6. Monitor – The default DCA configuration is that Alerting, Billing, Consumables Monitoring and Discovery functions are enabled. A reduced configuration can be requested.

7. Device limit – The number of devices that the licence allows the DCA to monitor. This number can be increased at any time during the licence validity period, subject to contractual agreements with EKM4.


Appendix 3 - Glossary DCA Insight II Data Collection Application.

HTTP Hypertext Transfer Protocol. The basis of data communication for the World Wide Web.

IP Internet Protocol. An Internet Protocol address (IP address) is a numerical label assigned to a device (e.g. computer, printer) participating in a computer network that uses the Internet Protocol for communication.

Proxy A proxy server is a server that acts as an intermediary for requests from a local application or service (e.g. Insight II DCA) to send and receive information from external networks.

SMTP Simple Mail Transfer Protocol is an internet standard for electronic mail (e-mail) transmission across IP networks.

TCP Transmission Control Protocol. This is a set of rules (protocol) used along with the Internet Protocol (IP) to send data in the form of message units between computers over the Internet.

Vanilla The standard version of a software/program without any customisation.

XMPP Extensible Messaging and Presence Protocol is an open technology for real-time communication, which powers a wide range of applications including instant messaging, presence, multi-party chat, voice and video calls.

insight ii data collection application for windows (dca)

Documents