DEP Documentation DEP/EM User Manual

Version: 04.00 Classification: Public

Haachtsesteenweg 1442 1130 Brussels

Belgium

DEP/EM User Manual

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.

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.

s a A t o s W o r l d l i n e n v – C h a u s s é e d e H a e c h t 1 4 4 2 H a a c h t s e s t e e n w e g B - 1 1 3 0 B r u x e l l e s - B r u s s e l - B e l g i u m

1.

TABLE OF CONTENTS

1. TABLE OF CONTENTS ... 4

2. SCOPE OF THE DOCUMENT ... 5

2.1. REFERENCES ... 5

2.2. CONTACTINGATOSWORLDLINE ... 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

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.

R

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

For the documentation visit

For support on issues related to DEP, customers, partners, resellers, and distributors can send an email to the DEP Hotline:

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

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.

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.

• 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.

F

M

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.

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:

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.

V

M

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

• 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.

S

M

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.

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.

H

M

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.

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:

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

Key Shortcut signification

F1 Opens the help file F4 Opens the audit trail F5 Starts the listening server F6 Stops the listening server

CTRL +N Opens a new empty general window

CTRL +O Allows the user to open an existing file containing events CTRL + S 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 Description

Information

Module x enters the state OFFLINE/GOOD

Module x is locked by the DEP/NMS application and can process messages. Module x enters the state

ONLINE/GOOD

Module x is unlocked and available to process messages.

Printhandler installation detected and started

The Printhandler service is present in the VENUS and started.

Printhandler already started The Printhandler application is already started.

Printhandler installation not present The Printhandler service is not present in installed VENUS package.

DEP handler started successfully The VENUS DEP handler application is started successfully.

DEP handler stopped successfully VENUS DEP handler application is stopped successfully.

Module x pulled out of the pool Module x is pulled out of the pool (failover mechanism).

Module x put back in the pool Module x is put back in the pool (failover mechanism).

Host handler stopped successfully VENUS Host handler application is stopped successfully.

Host handler started successfully VENUS Host handler application is started successfully.

Beginning remote CZDEP call Starting remote C-ZAM/DEP session via DEP/NMS.

Platform enters the locked state The Platform has been locked. Platform enters the unlocked state The platform has been unlocked.

Platform is forced unlocked The platform has been forced unlocked. Module x is forced unlocked The Module x has been forced unlocked. Communication protocol set to PDP The PDP protocol is set for communication

between the hosts and the DEP Platform. Communication protocol set to TCP/IP The TCP/IP protocol is set for

communication between the hosts and the DEP Platform.

Application protocol modified Application protocol settings are modified via DEP/NMS.

NMS connection closed The DEP/NMS application is disconnected from the DEP platform.

NMA handler stopped successfully VENUS NMA handler application is stopped successfully.

NMA handler started successfully VENUS NMA handler application is started successfully.

NMA handling stopped VENUS NMA functionality is stopped. TCP/IP disconnection succeeded on

module(s) x of platform k

The TCP/IP disconnection is succeeded on module(s) x of platform k.

Setting communication host protocol in PDP succeeded on platform k

The communication host protocol is successfully set to PDP on Platform k. Setting communication host protocol in

TCP succeeded on platform k

The communication host protocol is successfully set to TCP/IP on Platform k. Setting application host protocol

succeeded on platform k

The application host protocol is successfully set on Platform k. Setting module configuration

succeeded on module(s) x of platform k

Setting the configuration of Module x of Platform k is succeeded.

Setting the configuration of the platform succeeded on platform k

Setting the configuration of the Platform k is succeeded.

Forcing unlock of module is succeeded on module(s) x of platform k

The Module x of Platform k is successfully unlocked.

Forcing unlock of platform succeeded on platform k

The Platform k is successfully unlocked. Resetting the DEP alarm processor

succeeded on module x of platform k

The DEP alarm processor is successfully reset on Module x of Platform k.

Ending application succeeded on module(s) x of platform k

Application is successfully ended on Module x of Platform k.

Errors

Module x enters the state OFFLINE/FATAL

Module x is locked by the DEP/NMS application and is in FATAL state. Module x enters the state

ONLINE/FATAL

Module x is unlocked and is in FATAL state.

Module x enters the state ONLINE/FATAL after timeout

Module x is unlocked and is in FATAL state.

No license installed please contact your vendor.

No VENUS license (applicable for DEP/XP platforms) is found.

Message send to host failed Sending the message to the host is failed. Message received from host is

corrupted

The message received from the host is corrupted.

Message receive time out aborting connection

Message received time out. The connection is aborting.

Message is too big to fit in buffer aborting connection

Message is too big to fit in the buffer. The connection is aborting.

Host Handler cannot be started check COM port number !

VENUS Host handler application cannot be started. Check the COM port number (relevant for PDP communication). Platform shutdown in progress Platform shutdown is in progress. DEP handling stopped VENUS DEP handler service has been

stopped.

Host communication handling stopped Host communication handling is stopped. Loading communication DLL failed Internal failure, loading the communication

DLL is failed.

NMA handler failed to startup VENUS NMA handler application is failed to startup.

TCP/IP connection (timeout) error on platform k

An error occurred during the TCP/IP connection (timeout) on Platform k. Restoring a backup of keys from file

error on module(s)

An error occurred while restoring the backup of keys from file.

Setting communication host protocol in PDPerror on platform

An error occurred while setting the communication host protocol to PDP. Setting communication host protocol in

TCPerror on platform

An error occurred while setting the communication host protocol to TCP/IP. Setting application host protocol error

on platform

An error occurred while setting the application host protocol.

Setting module configuration error on module(s) x

An error occurred while setting the module configuration.

Setting the configuration of the platform error on platform

An error occurred while setting the platform configuration.

Preparing Cloning Master error on module(s) x

An error occurred while preparing the master module.

module(s) x Cloning Master.

Cloning Data AC error on module(s) An error occurred while writing the SWAC to clone module.

Cloning Data In error on module(s) An error occurred while writing the data to clone module.

Cloning Data Out error on module(s) x An error occurred while reading the data from master module.

Cloning SWAC error on module(s) x Wrong SWAC is entered.

Cloning SW Out error on module(s) x An error occurred while reading the SWAC from master module.

Preparing Cloning Clone error on module(s) x

An error occurred while preparing clone module.

Starting Cloning Clone error on module(s) x

An error occurred while starting the cloning.

Forcing unlock of module error on module(s) x

An error occurred while forcing unlock the module.

Forcing unlock of platform error on platform k

An error occurred while forcing unlock the platform.

Resetting the DEP alarm processor error on module(s) x

An error occurred while resetting the DEP alarm processor.

Warnings

Printhandler installation detected but start failed

The installation of Printhandler service is detected but failed to start.

Environment variable / install directory ""DS3_ROOT""

Displayed when DS3_ROOT environment variable is not defined on target DEP platform system.

NMA handler started with HOST functionality down

VENUS NMA handler application is started, but the HOST functionality is down.

NMA handler started with HOST functionality up and running

VENUS NMA handler is started and the HOST functionality is up and running. NMA handler unloads from process VENUS NMA handler application is

unloaded from process

NMA handler shutdown failed VENUS NMA handler application shutdown is failed.

Module x is resetting the alarm board. Program code and keys will be lost !

DEP Application Software and keys will be lost while resetting the alarm board.

Module x enters boot level application will be lost

An Application software will be removed from Module x while entering the boot level.

Setting communication host protocol in PDP cancelled on platform k

Setting communication host protocol in PDP is cancelled on platform k.

Setting communication host protocol in TCP cancelled on platform k

Setting communication host protocol in TCP is cancelled on platform k

Setting application host protocol cancelled on platform k

Setting application host protocol is cancelled on platform k

Setting module configuration cancelled on module(s) x

Setting module configuration is cancelled on module(s)

Setting the configuration of the platform cancelled on platform k

Setting the configuration of the platform is cancelled on platform k

Forcing unlock of module cancelled on module(s) x

Forcing unlock of module is cancelled on module(s) x

Forcing unlock of platform cancelled on platform k

Forcing unlock of platform is cancelled on platform k

Resetting the DEP alarm processor cancelled on module(s) x

Resetting the DEP alarm processor is cancelled on module(s) x

Restoring a backup of keys from file 'ds3_keys.dat' cancelled on selected module(s)

Restoring a backup of keys from

'ds3_keys.dat' file is cancelled on selected module(s).