Haachtsesteenweg 1442 1130 Brussels Belgium DEP Documentation DEP/EM User Manual Version: 04.00
Atos Worldline - Technology & Products / Engineering / DEP Page: 2/19 Version Management Report Version Name(s) Date Comments 01.00 Paul STIENON 25/10/2004 First Draft. 01.01 Paul STIENON 24/11/2004 Second version. 01.02 Paul STIENON 06/04/2005 Third version 01.03 Paul STIENON 30/05/2005 Few typo corrections 01.04 Paul STIENON 02/08/2005 Review from FD and PS 01.05 Paul STIENON 22/09/2005 Adjust to version 1.07 of DEP/EM 01.06 Paul STIENON 21/11/2005 After review of 14/11/2005. 03.00 Paul STIENON 25/04/2006 Change for the versioning, new disclaimer 03.01 Energize Global Services 04/06/2009 Adjust to version 2.0.0.0 of DEP/EM 04.00 Anna Papayan 02/03/2011 Change the template into Atos Worldline, minor changes. Events explanation paragraph added.
Atos Worldline - Technology & Products / Engineering / DEP Page: 3/19 CONFIDENTIALITY The information in this document is confidential and shall not be disclosed to any third party in whole or in part without the prior written consent of Atos Worldline S.A./N.V. COPYRIGHT The information in this document is subject to change without notice and shall not be construed as a commitment by Atos Worldline S.A./N.V. The content of this document, including but not limited to trademarks, designs, logos, text, images, is the property of Atos Worldline S.A/N.V. and is protected by the Belgian Act of 30.06.1994 related to author s right and by the other applicable Acts. The contents of this document must not be reproduced in any form whatsoever, by or on behalf of third parties, without the prior written consent of Atos Worldline S.A./N.V. Except with respect to the limited license to download and print certain material from this document for non-commercial and personal use only, nothing contained in this document shall grant any license or right to use any of Atos Worldline S.A./N.V. s proprietary material. LEGAL DISCLAIMER While Atos Worldline S.A./N.V. has made every attempt to ensure that the information contained in this document is correct, Atos Worldline S.A./N.V. does not provide any legal or commercial warranty on the document that is described in this specification. The technology is thus provided as is without warranties of any kind, expressed or implied, included those of merchantability and fitness for a particular purpose. Atos Worldline S.A./N.V. does not warrant or assume any legal liability or responsibility for the accuracy, completeness, or usefulness of any information, product or process disclosed. To the fullest extent permitted under applicable law, neither Atos Worldline S.A./N.V. nor its affiliates, directors, employees and agents shall be liable to any party for any damages that might result from the use of the technology as described in this document (including without limitation direct, indirect, incidental, special, consequential and punitive damages, lost profits). JURISDICTION AND APPLICABLE LAW These terms shall be governed by and construed in accordance with the laws of Belgium. You irrevocably consent to the jurisdiction of the courts located in Brussels for any action arising from or related to the use of this document. sa Atos Worldline nv Chaussée de Haecht 1442 Haachtsesteenweg B-1130 Bruxelles-Brussel - Belgium RPM-RPR Bruxelles-Brussel - TVA-BTW BE 0418.547.872
Atos Worldline - Technology & Products / Engineering / DEP Page: 4/19 1. TABLE OF CONTENTS 1. TABLE OF CONTENTS... 4 2. SCOPE OF THE DOCUMENT... 5 2.1. REFERENCES... 5 2.2. CONTACTING ATOS WORLDLINE... 5 3. PURPOSE OF THE DEP/EM PROGRAM... 6 4. USER INTERFACE... 7 4.1. FILE MENU... 9 4.1.1. New... 9 4.1.2. Open... 9 4.1.3. Save... 10 4.1.4. Save As... 10 4.1.5. Exit... 11 4.2. VIEW MENU... 11 4.2.1. Status Bar... 11 4.2.2. Toolbar... 11 4.3. SERVER MENU... 12 4.3.1. Start... 12 4.3.2. Stop... 13 4.4. HELP MENU... 13 4.4.1. Help Topics... 13 4.4.2. About DEP/EM... 14 5. ANNEX A: INSTALLATION PROCEDURE... 15 6. ANNEX B: SHORTCUT KEYS... 15 7. ANNEX C: EVENTS EXPLANATIONS... 15
Atos Worldline - Technology & Products / Engineering / DEP Page: 5/19 2. SCOPE OF THE DOCUMENT This document describes the DEP/EM (Event Manager) Program. This PC program is used as a console that will receive the alarms/events coming from the managed DEP Platforms, DEP Crypto Modules and from the connected DEP/NMS. 2.1. REFERENCES This document contains references to other documents about the DEP. This paragraph gives a list of all the documents referred to. DEP/NMS User Manual There are no references made to the following documents, but they could be useful to understand this document. DEP Introduction to DEP DEP Glossary 2.2. CONTACTING ATOS WORLDLINE You can visit Atos Worldline on the World Wide Web to find out about new products and about various other fields of interest. URL: www.atosworldline.com. For the documentation visit http://www.banksys.com web page. For support on issues related to DEP, customers, partners, resellers, and distributors can send an email to the DEP Hotline: mailto:dephotline-atosworldline@atosorigin.com.
Atos Worldline - Technology & Products / Engineering / DEP Page: 6/19 3. PURPOSE OF THE DEP/EM PROGRAM The main purpose of this program is the visualization of events coming from the DEP/NMS application, the DEP Platforms or the DEP Crypto Modules. The versions 01.07 or above of the DEP/EM Program is discussed. This program is intended to be used on a Windows XP or a Windows Vista PC. There are 2 possibilities for using the DEP/EM: Either standalone, all connected DEP/NMS are on other PCs, Or it is on the same PC then the DEP/NMS
Atos Worldline - Technology & Products / Engineering / DEP Page: 7/19 4. USER INTERFACE To start the DEM/EM program, double-click on the DEP_EM.exe file in the installation directory. When starting for the first time, the Configure server window will appear. It allows to define the listening port. The server will start after, showing the received events in a console window:
Atos Worldline - Technology & Products / Engineering / DEP Page: 8/19 When restarting the DEP/EM program, the server is automatically started with the last used values, which leads directly to the window with the events. For each event, the user will have:
Atos Worldline - Technology & Products / Engineering / DEP Page: 9/19 The type of event (information, warning, error), The date and time of its appearance, The name of the sender (name of the concerned DEP Platform or DEP/NMS), The name of the program that reveals the event, The text giving an explanation of the event. For the exhaustive text of events and their explanation refer to the Annex C on page 15. 4.1. FILE MENU The File menu allows to save or to open a new or an already existing file with the list of events, and to exit the DEP/EM Program. 4.1.1. New When selecting New menu item, the DEP/EM Program opens an empty file or asks the user to save the content of the general window into the opened file, in order to open another one: Also a new file can be opened by pressing the CTRL+N function key. 4.1.2. Open To open an existing file, click on the Open menu item in the File menu or simply press CTRL+O and select the appropriate file through a classical Open window.
Atos Worldline - Technology & Products / Engineering / DEP Page: 10/19 4.1.3. Save The content of the general window is saved into the opened file; this can be done also by the function key CTRL+S. 4.1.4. Save As The content of the general window is saved into a file by another name. The name is given through the opening of a classical Save As window:
Atos Worldline - Technology & Products / Engineering / DEP Page: 11/19 4.1.5. Exit The Exit menu item is used to exit the DEP/EM Program. Before quitting, it verifies if the information in general window have been saved and proposes to save it. 4.2. VIEW MENU When selecting the View item, the following list appears: It allows to activate/deactivate the Status Bar and/or the Toolbar. 4.2.1. Status Bar In the status bar, there is some information on the actual state of the DEP/EM Program (from left to right): Description on the button/menu that is under the mouse, Status of the CAPS, NUM LOCK, SCROLL LOCK keys of the keyboard, Number of the port that is used for the listening server, Number of DEP Platforms or the DEP/NMS applications that are connected, Number of received events. To activate/deactivate the Status Bar click on the Status Bar menu item. 4.2.2. Toolbar In the toolbar, there are some shortcuts to some actions: Create a new document: the user can erase the content of the general window, Open an existing document: the user can open already existing file in the general window, in order to continue the logging of the events into it, Save the active document: the user can save the general window into a file, using a rich edit format, Save As the active document: the user can save the general window into another file,
Atos Worldline - Technology & Products / Engineering / DEP Page: 12/19 Start the listening server: starts the listening server on the selected port, Stop the listening server: stops the listening server, Help: opens the help file of the DEP/EM Program. 4.3. SERVER MENU When selecting the Server item, the following list appears: It allows to start and to stop the listening server. 4.3.1. Start To start the listening socket select the Start menu item or simply press the F5 function key. The following window appears, giving the possibility to the user to define the listening port for TCP/IP connections: Click OK to launch the listener or Cancel to stop the operation. Another way to start the server is given by clicking the connect icon.
Atos Worldline - Technology & Products / Engineering / DEP Page: 13/19 Please note that when the listening port has been defined, the listening server is directly started. 4.3.2. Stop To stop the listening server select the Stop menu item or simply press the F6 function key. Another way to stop the server is given by clicking the disconnect icon. 4.4. HELP MENU When selecting Help menu of the console window, the following list appears: A press on the F1 key will also start the help of the DEP/EM program. 4.4.1. Help Topics To open the help file for the DEP/EM program select the Help Topics menu item or simply press F1.
Atos Worldline - Technology & Products / Engineering / DEP Page: 14/19 Help file can also be opened by clicking on the help icon. 4.4.2. About DEP/EM When selecting the About DEP/EM menu item in the Help menu, the following window will appear with the classical information on the DEP/EM program:
Atos Worldline - Technology & Products / Engineering / DEP Page: 15/19 5. ANNEX A: INSTALLATION PROCEDURE No specific installation procedure is required for the DEP/EM Program. It will be installed during the installation of the DEP/NMS application. For more information about the DEP/NMS installation procedure refer to the DEP/NMS User Manual document. 6. ANNEX B: SHORTCUT KEYS All the existing shortcut keys are shown in the table below: Key F1 F4 F5 F6 CTRL +N CTRL +O CTRL + S Shortcut signification Opens the help file Opens the audit trail Starts the listening server Stops the listening server Opens a new empty general window Allows the user to open an existing file containing events Saves the current general window into a file 7. ANNEX C: EVENTS EXPLANATIONS All the possible events that may appear in the list are described in the table below: Event Information Module x enters the state OFFLINE/GOOD Module x enters the state ONLINE/GOOD Printhandler installation detected and started Printhandler already started Printhandler installation not present DEP handler started successfully DEP handler stopped successfully Module x put in the pool Description Module x is locked by the DEP/NMS application and can process messages. Module x is unlocked and available to process messages. The Printhandler service is present in the VENUS and started. The Printhandler application is already started. The Printhandler service is not present in installed VENUS package. The VENUS DEP handler application is started successfully. VENUS DEP handler application is stopped successfully. Module x is put in the pool (failover
Atos Worldline - Technology & Products / Engineering / DEP Page: 16/19 Module x pulled out of the pool Module x put back in the pool Host handler stopped successfully Host handler started successfully Beginning remote CZDEP call Platform enters the locked state Platform enters the unlocked state Platform is forced unlocked Module x is forced unlocked Communication protocol set to PDP Communication protocol set to TCP/IP Application protocol modified NMS connection closed NMA handler stopped successfully NMA handler started successfully NMA handling stopped TCP/IP disconnection succeeded on module(s) x of platform k Setting communication host protocol in PDP succeeded on platform k Setting communication host protocol in TCP succeeded on platform k Setting application host protocol succeeded on platform k Setting module configuration succeeded on module(s) x of platform k Setting the configuration of the platform succeeded on platform k Forcing unlock of module is succeeded on module(s) x of platform k Forcing unlock of platform succeeded on platform k Resetting the DEP alarm processor succeeded on module x of platform k mechanism). Module x is pulled out of the pool (failover mechanism). Module x is put back in the pool (failover mechanism). VENUS Host handler application is stopped successfully. VENUS Host handler application is started successfully. Starting remote C-ZAM/DEP session via DEP/NMS. The Platform has been locked. The platform has been unlocked. The platform has been forced unlocked. The Module x has been forced unlocked. The PDP protocol is set for communication between the hosts and the DEP Platform. The TCP/IP protocol is set for communication between the hosts and the DEP Platform. Application protocol settings are modified via DEP/NMS. The DEP/NMS application is disconnected from the DEP platform. VENUS NMA handler application is stopped successfully. VENUS NMA handler application is started successfully. VENUS NMA functionality is stopped. The TCP/IP disconnection is succeeded on module(s) x of platform k. The communication host protocol is successfully set to PDP on Platform k. The communication host protocol is successfully set to TCP/IP on Platform k. The application host protocol is successfully set on Platform k. Setting the configuration of Module x of Platform k is succeeded. Setting the configuration of the Platform k is succeeded. The Module x of Platform k is successfully unlocked. The Platform k is successfully unlocked. The DEP alarm processor is successfully reset on Module x of Platform k.
Atos Worldline - Technology & Products / Engineering / DEP Page: 17/19 Ending application succeeded on module(s) x of platform k Errors Module x enters the state OFFLINE/FATAL Module x enters the state ONLINE/FATAL Module x enters the state ONLINE/FATAL after timeout No license installed please contact your vendor. Message send to host failed Message received from host is corrupted Message receive time out aborting connection Message is too big to fit in buffer aborting connection Host Handler cannot be started check COM port number! Platform shutdown in progress DEP handling stopped Host communication handling stopped Loading communication DLL failed NMA handler failed to startup TCP/IP connection (timeout) error on platform k Restoring a backup of keys from file error on module(s) Setting communication host protocol in PDP error on platform Setting communication host protocol in TCP error on platform Setting application host protocol error on platform Setting module configuration error on module(s) x Setting the configuration of the platform error on platform Preparing Cloning Master error on module(s) x Application is successfully ended on Module x of Platform k. Module x is locked by the DEP/NMS application and is in FATAL state. Module x is unlocked and is in FATAL state. Module x is unlocked and is in FATAL state. No VENUS license (applicable for DEP/XP platforms) is found. Sending the message to the host is failed. The message received from the host is corrupted. Message received time out. The connection is aborting. Message is too big to fit in the buffer. The connection is aborting. VENUS Host handler application cannot be started. Check the COM port number (relevant for PDP communication). Platform shutdown is in progress. VENUS DEP handler service has been stopped. Host communication handling is stopped. Internal failure, loading the communication DLL is failed. VENUS NMA handler application is failed to startup. An error occurred during the TCP/IP connection (timeout) on Platform k. An error occurred while restoring the backup of keys from file. An error occurred while setting the communication host protocol to PDP. An error occurred while setting the communication host protocol to TCP/IP. An error occurred while setting the application host protocol. An error occurred while setting the module configuration. An error occurred while setting the platform configuration. An error occurred while preparing the master module.
Atos Worldline - Technology & Products / Engineering / DEP Page: 18/19 Starting Cloning Master error on module(s) x Cloning Data AC error on module(s) Cloning Data In error on module(s) Cloning Data Out error on module(s) x Cloning SWAC error on module(s) x Cloning SW Out error on module(s) x Preparing Cloning Clone error on module(s) x Starting Cloning Clone error on module(s) x Forcing unlock of module error on module(s) x Forcing unlock of platform error on platform k Resetting the DEP alarm processor error on module(s) x Warnings Printhandler installation detected but start failed Environment variable / install directory ""DS3_ROOT"" NMA handler started with HOST functionality down NMA handler started with HOST functionality up and running NMA handler unloads from process NMA handler shutdown failed Module x is resetting the alarm board. Program code and keys will be lost! Module x enters boot level application will be lost Setting communication host protocol in PDP cancelled on platform k Setting communication host protocol in TCP cancelled on platform k Setting application host protocol cancelled on platform k An error occurred while starting the Cloning Master. An error occurred while writing the SWAC to clone module. An error occurred while writing the data to clone module. An error occurred while reading the data from master module. Wrong SWAC is entered. An error occurred while reading the SWAC from master module. An error occurred while preparing clone module. An error occurred while starting the cloning. An error occurred while forcing unlock the module. An error occurred while forcing unlock the platform. An error occurred while resetting the DEP alarm processor. The installation of Printhandler service is detected but failed to start. Displayed when DS3_ROOT environment variable is not defined on target DEP platform system. VENUS NMA handler application is started, but the HOST functionality is down. VENUS NMA handler is started and the HOST functionality is up and running. VENUS NMA handler application is unloaded from process VENUS NMA handler application shutdown is failed. DEP Application Software and keys will be lost while resetting the alarm board. An Application software will be removed from Module x while entering the boot level. Setting communication host protocol in PDP is cancelled on platform k. Setting communication host protocol in TCP is cancelled on platform k Setting application host protocol is cancelled on platform k
Atos Worldline - Technology & Products / Engineering / DEP Page: 19/19 Setting module configuration cancelled on module(s) x Setting the configuration of the platform cancelled on platform k Forcing unlock of module cancelled on module(s) x Forcing unlock of platform cancelled on platform k Resetting the DEP alarm processor cancelled on module(s) x Restoring a backup of keys from file 'ds3_keys.dat' cancelled on selected module(s) Setting module configuration is cancelled on module(s) Setting the configuration of the platform is cancelled on platform k Forcing unlock of module is cancelled on module(s) x Forcing unlock of platform is cancelled on platform k Resetting the DEP alarm processor is cancelled on module(s) x Restoring a backup of keys from 'ds3_keys.dat' file is cancelled on selected module(s).