EDITRAN/EA Statistics and monitorization Windows/Unix User and installation manual INDRA 17/03/17
INDEX 1. INTRODUCTION... 1-1 2. EDITRAN/E MANAGEMENT (UNIX)... 2-1 2.1. STATISTICS AND MONITORIZATION... 2-1 2.1.1. Interrupted presentations... 2-2 2.1.1.1. Presentation incidences... 2-3 2.1.1.2. Statistics of the application data uploaded or received... 2-4 2.1.1.3. Transmissions associated to an interrupted presentation... 2-5 2.1.1.4. Evolution and incidence data of a transmission... 2-6 2.1.2. Current or ended presentations... 2-7 2.1.2.1. Transmissions associated to a presentation... 2-8 2.1.3. Interrupted transmissions... 2-9 2.1.4. Current or ended transmissions... 2-10 2.1.5. History of presentations ended without incidences... 2-11 2.1.6. History of presentations ended with incidences... 2-12 2.1.7. History of presentations... 2-12 2.2. ALARM SYSTEM... 2-13 2.2.1. Log monitoring... 2-13 2.2.2. Administration... 2-15 2.3. COMMUNICATIONS MONITOR... 2-18 2.3.1. Service status... 2-19 2.3.2. Settings... 2-19 2.3.2.1. Modification... 2-19 2.3.2.2. Consulting... 2-21 3. EDITRAN/E MANAGEMENT (WINDOWS)... 3-1 3.1. Main screen... 3-1 3.1.1. Optional search parameters... 3-1 3.1.2. EDITRAN/EA tree... 3-2 3.1.3. Information list... 3-2 3.1.4. Toolbar... 3-3 3.2. Statistics branch... 3-3 3.2.1. Incidences of the presentation... 3-3 3.2.2. Transmissions... 3-4 3.2.2.1. Evolution data and incidences of a transmission... 3-4 3.2.3. Statistics... 3-5 3.2.3.1. Files of the presentation... 3-5 3.3. Alarm management branch... 3-6 3.3.1. Administration... 3-6 3.3.2. Alarm registration... 3-8 4. EDITRAN/E API... 4-1 4.1. Functions exported from the API... 4-1 4.1.1. Int LeerSecRegistroHistorico(long *poffset, t_historico * phistorico);... 4-1 4.1.2. int LeerSecRegistroEstadoHistorico (long *poffset, t_pres_sts * pestado);... 4-2 4.1.3. LeerSecRegistroRelacionHistorico (FILE * fp, long *poffset, t_file_sts * pfile);... 4-2 4.1.4. ReadLogBufferHistorico (LogDisplayRecType ** plogbuffer, long offset);... 4-3 4.2. Structures used... 4-4 4.2.1. Structure t_historico... 4-4 4.2.2. Structure t_date... 4-4 4.2.3. Structure t_pres_sts... 4-5 4.2.4. Structure t_file_sts... 4-6 4.2.5. Structure t_log... 4-7 4.2.5.1. Structure PrimaryKey_st... 4-7 4.2.5.2. Structure SecondaryKey_st... 4-8 4.2.6. Structure LogDisplayRecType... 4-8 4.2.6.1. Structure Line_st... 4-8 4.2.6.2. Structure LongDisplay_st... 4-8 4.2.6.3. Structure ShortDisplay_st... 4-8 4.3. Example of programming for the EditranE API... 4-9 5. EDITRAN/AL API... 5-1 5.1. Funciones exportadas por el API... 5-1 5.1.1. Int EDItranAL_Req(char *presentacion, char *mensaje);... 5-1 INDRA. All rights reserved. EDITRAN/EA
1.Introduction 1. Introduction The goal of the statistics and monitorization subsystem is to facilitate detecting problems that cause the interruption of the normal evolution of the EDITRAN platform processes in each of the phases of the presentation and transmission of data. The subsystem also facilitates obtaining information about incidences that don t interrupt the processes but delay them or cause undesired effects. It is also useful to collect information about the amount of data and about the treatments to which they are subjected before and afther their transmission. It is not about getting comprehensive information about all the steps through which passes a session (for this, we have already EDITRAN/P log and EDITRAN/G log), but about obtaining a relation of the interrupted sessions, in order to act on them and to correct the incidences detected during the transmission. Thus, we can refine its operation. With the alarm management subsystem will be easier to detect those errors causing the discontinuance of a presentation, and to notificate the user about the incidences, if we wish. We can specify an alarm for a set of sessions, so when a serious mistake is detected during the sending, an email or a mobile SMS are sent, or a program is executed. This document describes the system management and the possibilities it offers the user. There are two ways to obtain information about the sessions situation: the online monitoring mode, using a graphic interface, and the API mode, that allows developers exploiting the file with the resulting data of the sessions activity. Each of this options will be described in the document. INDRA. All rights reserved. EDITRAN/EA Page 1-1
2.EDITRAN/E MANAGEMENT (UNIX) 2. EDITRAN/E MANAGEMENT (UNIX) When executing editrane in the EDITRAN folder, we will activate the following main menu of the EDITRAN/E manager: 17/10/2014 - GESTOR DE EDItran/E - EDItran/E V5.1.# 12:11:26 1.- ESTADISTICAS Y MONITORIZACION 2.- SISTEMA DE ALARMAS 3. MONITOR DE COMUNICACIONES OPCION : F1? Ayuda On-Line F2 Campo por defecto F3 Fin entrada F4 Pantalla por defecto F6 Shell OS ESC Menu previo Option (Opción): The values specified in the screen will be allowed. 2.1. STATISTICS AND MONITORIZATION We must select the option 1 of the main menu to access the statistics menu. 17/10/2014 - GESTOR DE EDItran/E - EDItran/E V5.1.# 12:11:26 - ESTADISTICAS Y MONITORIZACION - 1.- PRESENTACIONES INTERRUMPIDAS 2.- PRESENTACIONES EN CURSO O FINALIZADAS 3.- TRANSMISIONES INTERRUMPIDAS O EN ESPERA DE FINALIZACION 4.- TRANSMISIONES EN CURSO O FINALIZADAS 5.- HISTORICO DE PRESENTACIONES FINALIZADAS 6.- HISTORICO DE PRESENTACIONES NO FINALIZADAS 7.- HISTORICO DE PRESENTACIONES OPCION : SENTIDO (E/R) : SESION : FECHA (DD/MM/AAAA) : / / HORA (HH/MM/SS) : : : F1? Ayuda On-Line F2 Campo por defecto F3 Fin entrada F4 Pantalla por defecto F6 Shell OS ESC Menu previo Option (Opción): The values specified in the screen will be allowed. Considering that the first options are used to check the last activity of the sessions, and the two last options give access to the activity of the presentations that have been completed over time. Direction (Sentido): INDRA. All rights reserved. EDITRAN/EA Page 2-1
2.EDITRAN/E MANAGEMENT (UNIX) The value E indicates we want to consult transmission sessions, R indicates reception, and if we use blanks, sessions on both directions will be displayed. Session (Sesión): We can select a specific presentation or transmission session, the ones containing a specific string, or all of them, if we don t enter any text in that field. Date and time (Fecha y Hora): If we enter a time, it is mandatory to enter the date as well. If we enter the date but not the time, it will be assumed that the time is 00.00:00. If we don t enter date or time In consultations on the historical file, the presentations will be displayed beggining with the ones finished in the last place. For the rest of consultations, the presentations/sessions will be displayed sorted by session code. If we enter date and time In consultations on the historical file, presentations ended from that date and time will be displayed. For the rest of consultations, the sessions started from that date and time will be displayed sorted by session code. 2.1.1. Interrupted presentations This will display those presentation sessions having incidences that have stopped the uploading/downloading or the data transmission processes. 17/10/2014 - ESTADISTICAS Y MONITORIZACION - EDItran/E V5.1.# 12:15:20 - PRESENTACIONES INTERRUMPIDAS - INICIO ------ INCIDENCIA ------- S PRESENTACION E/R FECHA/HORA ORIGEN FECHA/HORA GODELLO R 30061998 121458 EDItran/P 30061998 121459 PC83COMS E 30061998 121512 EDItran/P 30061998 121516 BARRANTE R 30061998 121443 EDItran/P 30061998 121444 F1? Ayuda On-Line F2 Campo por defecto F3 Fin entrada F4 Pantalla por defecto F6 Shell OS ESC Menu previo S: This is an entry selection field that can have the following values: I : For consulting EDITRAN/G incidences. E: For consulting presentation statistics. T: For consulting the transmission sessions associated to the presentation. Presentation (Presentación): Code of the presentation session. INDRA. All rights reserved. EDITRAN/EA Page 2-2
2.EDITRAN/E MANAGEMENT (UNIX) E/R: Indicates whether it is a data transmission or reception. Starting date-time (Fecha - Hora inicio): It displays the starting date and time of the presentation. Origin of the incidence (Origen de la incidencia): Indicates whether the incidence has been detected during the upload/download process (EDITRAN/G) or during the transmission one (EDITRAN/P). Incidence date-time (Fecha - Hora incidencia): Displays the date and time when the incidence occurred. 2.1.1.1. Presentation incidences This map is displayed when we enter the value I in the selection field corresponding to the desired presentation session. It displays the incidences detected during the processes before and after the transmission. 17/10/2014 - ESTADISTICAS Y MONITORIZACION - EDItran/E V5.1.# 12:15:45 - INCIDENCIAS DE LA PRESENTACION - PRESENTACION DE RECEPCION : GODELLO FECHA HORA MENSAJE 30/06/1998 12:14:59 Sesion EDItran interrumpida (A7I) R030 GODELLO TCP 1 PgUp Ctrl-U Pagina Anterior PgDn Ctrl-D Pagina Siguiente ESC Salir Each line displays an incidence, showing: Incidente date-time (Fecha - Hora incidencia): Indicates the date and time when the incidence occurred. Message (Mensaje): Describes the incidence and its associated code. INDRA. All rights reserved. EDITRAN/EA Page 2-3
2.EDITRAN/E MANAGEMENT (UNIX) 2.1.1.2. Statistics of the application data uploaded or received We access this information when we enter an E in the selection field of a presentation. Each line displays the data related to an application file transmitted or received through the selected presentation. 17/10/2014 - ESTADISTICAS Y MONITORIZACION - EDItran/E V5.1.# 12:16:47 - FICHEROS DE LA PRESENTACION - PRESENTACION DE EMISION : GODELLO S ORDEN NOMBRE DEL FICHERO TIPO L.REG N.REG ESTADO 0001 72.var B 04020 000112 Pendiente 0002 FIJO.TXT B 04020 000008 Pendiente 0003 HIBRIDO.TXT B 04020 000010 Pendiente 0004 KI.EGDI.ZTAP.FTES(ZTAPOSS1) B 04020 000038 Pendiente 0005 KI.EIDC.IGA.FICHFV B 04020 000112 Pendiente 0006 VARIABLE.TXT B 04020 000008 Pendiente 0007 bak.exe B 04020 000015 Pendiente 0008 ckeys.h B 04020 000002 Pendiente 0009 cwindow.h B 04020 000004 Pendiente 0010 editrane.hlp B 04020 000001 Pendiente 0011 editrang.hlp B 04020 000003 Pendiente 0012 editrang.log B 04020 000001 Pendiente F1? Ayuda On-Line F2 Campo por defecto F3 Fin entrada F4 Pantalla por defecto F6 Shell OS ESC Menu previo The columns in the map are the following: S: Is an input field that admits the value S to request more information about the corresponding application file. Order (Orden): Specifies the position of the file in the profiles of the transmitter extreme node. Name of the file (Nombre del fichero): Pysical name of the file. Type (Tipo): Format of the file ( FIXED (FIJO), VARIABLE, HYBRID (HÍBRIDO) or BINARY (BINARIO )). Record length (Longitud de registro): Length applied to the file in order to transmit. It is the maximum for the variable type ones. Number of records (Número de registros): Size of the file (in number of record) prepared to be transmitted. INDRA. All rights reserved. EDITRAN/EA Page 2-4
2.EDITRAN/E MANAGEMENT (UNIX) If we check the selection field with an S, the following screen will present all the data corresponding to the available application file, as well as the manipulations performed during the uploading process. 17/10/2014 - ESTADISTICAS Y MONITORIZACION - EDItran/E V5.1.# 12:16:47 - FICHEROS DE LA PRESENTACION - PRESENTACION DE EMISION : GODELLO NRO. ORDEN : 0001 NOMBRE : 72.var FORMATO : Binario ALFABETO DATOS : ASCII CREACION FICHERO : 13031998-090911 MODIFIC. FICHERO : 15061998-143935 LONGITUD REG. NUMERO REG. NUMERO BYTES REL. COMPRESION ------------- ------------ ------------ --------------- ORIGINAL : 04020 000000000112 000000450000 COMPRIMIDO : 00000 000000000000 000000000000 0.00 % COMPRIMIDO : No CIFRADO : No ESTADO : Pendiente de envio Pulse una tecla para continuar The parameters in the screen are self explanatory. The data about zipping and reception are significative only if the processes have taken place. 2.1.1.3. Transmissions associated to an interrupted presentation This screen is displayed when we enter a T in the selection field of an interrupted presentation. Each line displays one of the transmission sessions associated to the presentation. 17/10/2014 - ESTADISTICAS Y MONITORIZACION - EDItran/E V5.1.# 12:17:29 - SESIONES DE TRANSMISION DE PRESENTACION - PRESENTACION DE EMISION : GODELLO INICIO FIN S SESION FECHA/HORA FECHA/HORA ESTADO GODELLO TCP 1 30061998 121513 30061998 121513 Transmitiend F1? Ayuda On-Line F2 Campo por defecto F3 Fin entrada F4 Pantalla por defecto F6 Shell OS ESC Menu previo INDRA. All rights reserved. EDITRAN/EA Page 2-5
2.EDITRAN/E MANAGEMENT (UNIX) The columns in the map are the following: S: It is an input selection field admitting the value S to request evolution data about the session, and its incidences. If we choose this option, will be displayed the information about incidences on the transmission session. Transmission session: Code of the transmission session (in CICS, will be displayed the code of the internal session). Starting date - Time: It displayes the starting date and time of the first time we refer to that session. Status: It indicates the status of the session. Date time of the incidence: It displays the date and time when happened the incidence that caused the status of the transmission or reception session. 2.1.1.4. Evolution and incidence data of a transmission This screen is displayed when we select I in a specific transmission session. It indicates the status of the transmission session, through the data obtained during its last cycle. 17/10/2014 - ESTADISTICAS Y MONITORIZACION - EDItran/E V5.1.# 12:25:15 - INCIDENCIAS DE LA SESION - SESION DE RECEPCION : PC83COMS TCP 1 FECHA HORA MENSAJE 17/10/2014 11:38:31 Fichero tampon de emision no preparado R150 PC83COMS TCP 1 17/10/2014 11:39:15 Fichero tampon de emision no preparado R030 PC83COMS TCP 1 PgUp Ctrl-U Pagina Anterior PgDn Ctrl-D Pagina Siguiente ESC Salir INDRA. All rights reserved. EDITRAN/EA Page 2-6
2.EDITRAN/E MANAGEMENT (UNIX) 2.1.2. Current or ended presentations It will display the presentation sessions progressing normally, and the ones correctly ended. 17/10/2014 - ESTADISTICAS Y MONITORIZACION - EDItran/E V5.0 12:16:27 - PRESENTACIONES EN CURSO O FINALIZADAS - INICIO FIN S PRESENTACION E/R FECHA/HORA FECHA/HORA GODELLO E 30061998 121513 00000000 000000 Transmitiendo PC83COMS R 14051998 114156 00000000 000000 Transmitiendo BIERZO R 30061998 121504 00000000 000000 Cargado CSB BIERZO E 24061998 155253 24061998 155258 No cargada F1? Ayuda On-Line F2 Campo por defecto F3 Fin entrada F4 Pantalla por defecto F6 Shell OS ESC Menu previo S: It is an input selection field that can have the following values: T To consult the transmission sessions associated to the presentation. This option is described in the section 2.1.2.1. E To consult the statistics of the presentation that gives access to the data described in the section 0. I To consult the data of the incidence that will display the screen in the section 2.1.1.1. Presentation: Code of the presentation session E/R: E or R, depending on whether the presentation is a transmission (E) or a reception (R) one. Starting date - time: It displays the starting date and time of the presentation. Ending date time: It displays the ending date and time of the presentation. INDRA. All rights reserved. EDITRAN/EA Page 2-7
2.EDITRAN/E MANAGEMENT (UNIX) 2.1.2.1. Transmissions associated to a presentation This screen is displayed when we type T in the selection field of a presentation that is progressing normally. Each line displays one of the transmission sessions associated to the presentation. 17/10/2014 - ESTADISTICAS Y MONITORIZACION - EDItran/E V5.1.# 12:16:10 - SESIONES DE TRANSMISION DE PRESENTACION - PRESENTACION DE RECEPCION : GODELLO INICIO --- INCIDENCIA ---- S SESION FECHA/HORA CODIGO FECHA/HORA ESTADO GODELLO TCP 1 30061998 121458 030 30061998 121459 Interrum F1? Ayuda On-Line F2 Campo por defecto F3 Fin entrada F4 Pantalla por defecto F6 Shell OS ESC Menu previo The columns in the map are the following: S: Is an input selection field that admits the value I to request data about the evolution of the transmission session and its incidences. If we perform this operation, it will display the same incidence information of the transmission session displayed in section 2.1.1.4. Session (Sesión): Code of the transmission session. Status (Estado): It indicates the situation of the session. Starting date time (Fecha - Hora inicio): It displays the starting date and time of the transmission. End date time (Fecha - Hora fin): It displays the end date and time of the transmission. INDRA. All rights reserved. EDITRAN/EA Page 2-8
2.EDITRAN/E MANAGEMENT (UNIX) 2.1.3. Interrupted transmissions This will display the transmissions whose incidences cause the interruption of the transmission / reception processes, or the ones that have requested a process after transmission / reception and are waiting to be ended. 17/10/2014 - ESTADISTICAS Y MONITORIZACION - EDItran/E V5.1.# 12:18:13 - TRANSMISIONES INTERRUMPIDAS - INICIO INCIDENCIA S SESION E/R FECHA/HORA FECHA/HORA ESTADO GODELLO TCP 1 R 30061998 121458 30061998 121459 Interrumpido PC83COMS TCP 1 E 30061998 121512 30061998 121516 Interrumpido BARRANTE E 30061998 121606 30061998 121607 Interrumpido BARRANTE R 30061998 121443 30061998 121444 Interrumpido F1? Ayuda On-Line F2 Campo por defecto F3 Fin entrada F4 Pantalla por defecto F6 Shell OS ESC Menu previo By each transmission session can be displayed two lines in the map. One of them is for the data related to the transmission, and the other one is related to the reception. The displayed data, described below, will be updated with the key Enter if we don t type anything in the selection column. Selection (Selección): This is an input field, that admits the value S to request data and incidences corresponding to the transmission session, and that will be displayed in the same way described in section 2.1.1.4. Transmission session (Sesión de transmisión): Code of the transmission session (in CICS, will be displayed the code of the internal session). Starting date time (Fecha - Hora inicio): It displays the starting date and time of the first incoming or outgoing connection attempt, or of the local request of transmission or reception. Direction (Sentido): It specifies the direction associated to the transmission. E for transmission and R for reception. Status (Estado): It indicates the situation of the session. Values that can be displayed: 14: Waiting for the process after transmission or reception (according to what we indicated in the column E/R) to end. 07: The session has been interrupted without trying the transmission. 17: The session has been interrupted after trying the transmission. Incidence date time (Fecha - Hora incidencia): INDRA. All rights reserved. EDITRAN/EA Page 2-9
2.EDITRAN/E MANAGEMENT (UNIX) It displays the date and time when occurred the incidence that is causing the status of the transmission or reception session. 2.1.4. Current or ended transmissions It will display the transmission sessions normally running, and the ones correctly ended. 17/10/2014 - ESTADISTICAS Y MONITORIZACION - EDItran/E V5.1.# 12:19:17 - TRANSMISIONES EN CURSO O FINALIZADAS - INICIO FIN S SESION E/R FECHA/HORA FECHA/HORA ESTADO GODELLO TCP 1 E 30061998 121513 30061998 121513 Transmitiendo PC83COMS TCP 1 R 14051998 114156 14051998 114156 Transmitiendo BIERZO TCP 1 R 30061998 121504 30061998 121541 No cargado BIERZO TCP 1 E 24061998 155253 24061998 155258 No cargado F1? Ayuda On-Line F2 Campo por defecto F3 Fin entrada F4 Pantalla por defecto F6 Shell OS ESC Menu previo The displayed data, described below, will be updated with the key Enter if we didn t type anything in the selection column. S: Is an input selection field, that admits the value I to request data and incidences corresponding to the transmission session. If we chose this option, the information displayed will be the same for the transmission session incidences, described in section 2.1.1.4. Session (Sesión): Code of the transmission session. Starting date time (Fecha - Hora inicio): It displays the starting date and time of the transmission. End date - time (Fecha - Hora fin): It displays the end date and time of the transmission. E/R: E or R, depending on whether the transmission is a transmission or a reception one. Status (Estado): It indicates the situation of the session. INDRA. All rights reserved. EDITRAN/EA Page 2-10
2.EDITRAN/E MANAGEMENT (UNIX) 2.1.5. History of presentations ended without incidences We get to this screen after chosing the option 5 in the general menu of the monitoring subsystem. In the screen will be displayed the ended presentation sessions, during the period selected from the general menu, without incidences, sorted by the end date and time of the presentation. S: 17/10/2014 - ESTADISTICAS Y MONITORIZACION - EDItran/E V5.1.# 12:23:43 - HISTORICO DE PRESENTACIONES FINALIZADAS - INICIO FIN S PRESENTACION E/R FECHA/HORA FECHA/HORA GODELLO R 13051998 175422 13051998 175426 No cargada GODELLO E 13051998 175430 13051998 175432 Transmitida GODELLO R 13051998 175449 13051998 175452 No cargada GODELLO E 14051998 091306 14051998 091308 Transmitida PC83COMS R 14051998 113831 14051998 114057 No cargada BIERZO R 21051998 084556 21051998 084726 No cargada BIERZO E 21051998 084609 21051998 084814 Transmitida GODELLO E 21051998 084936 21051998 084951 Transmitida GODELLO R 13051998 175632 21051998 085012 No cargada GODELLO E 21051998 085037 21051998 085040 Transmitida GODELLO R 21051998 085048 21051998 085229 No cargada BIERZO R 21051998 085129 21051998 085327 No cargada GODELLO E 21051998 085118 21051998 085425 Transmitida F1? Ayuda On-Line F2 Campo por defecto F3 Fin entrada F4 Pantalla por defecto F6 Shell OS ESC Menu previo This is an input selection field, that can have the following values: E: To consult the statistics for the presentation. It gives way to the data described in section 0. T: To consult the transmission sessions associated to the presentation. In this case, it presents the map from section 0. I: It must not have any content, as it would display the incidences associated to the selected presentation, and in this option it has no incidences. Starting date time (Fecha - Hora inicio): It displays the starting date and time of the presentation. End date time (Fecha - Hora fin): It displays the end date and time of the presentation. Presentation (Presentación): Code of the presentation session. E/R: E or R, according to whether the presentation is a transmission or a reception one. INDRA. All rights reserved. EDITRAN/EA Page 2-11
2.EDITRAN/E MANAGEMENT (UNIX) 2.1.6. History of presentations ended with incidences We get to this screen after chosing the option 6 in the general menu of the monitoring subsystem. In the screen will be displayed the ended presentation sessions, during the period selected from the general menu, with incidences, sorted by the end date and time of the presentation. 17/10/2014 - ESTADISTICAS Y MONITORIZACION - EDItran/E V5.1.# 12:25:33 - HISTORICO DE PRESENTACIONES NO FINALIZADAS - INICIO ------ INCIDENCIA ------- S PRESENTACION E/R FECHA/HORA ORIGEN FECHA/HORA GODELLO E 13051998 172659 EDItran/P 13051998 172952 BARRANTE R 18061998 104638 EDItran/P 18061998 104726 BARRANTE E 18061998 104804 EDItran/P 18061998 110348 F1? Ayuda On-Line F2 Campo por defecto F3 Fin entrada F4 Pantalla por defecto F6 Shell OS ESC Menu previo Selection (Selección): Is an input field, that can have the following values: I To consult the data of the incidence. It will display the screen described in section 2.1.1.1. E To consult the presentation statistics that give way to the data described in section 0. T To consult the transmission sessions associated to the presentation. When we chose this option, will be displayed the screen described in section 2.1.1.3. Starting date time (Fecha - Hora inicio): It displays the starting date and time of the presentation. End date time (Fecha - Hora fin): It displays the end date and time of the presentation. Presentation session (Sesión de presentación): Code of the presentation session. Direction (Sentido): E or R, depending on whether the presentation is a transmission or a reception one. Number of incidences (Número de incidencias): It indicates the number of incidences detected during the presentation. 2.1.7. History of presentations We get to this screen after chosing the option 7 in the general menu of the monitoring subsystem. In the screen will be displayed the ended presentation sessions, correctly or with incidences, during the period selected from the general menu, sorted by the end date and time of the presentation. The information displayed is the same described in section 0. INDRA. All rights reserved. EDITRAN/EA Page 2-12
2.EDITRAN/E MANAGEMENT (UNIX) 2.2. ALARM SYSTEM The target of the alarm system in EDITRAN/E is providing an immediate notification mechanism for the incidences occurred during the transmissions performed by EDITRAN. The user stablishes, using profiles, the notifications to be made for a sessions domain. Also, the system maintains a log with information about the occurred events. We have to select the option 2 from the main menu to access the alarm system menu. 17/10/2014 - GESTOR DE EDItran/E - EDItran/E V5.1.# 12:11:26 - SISTEMA DE ALARMAS - 1.- CONSULTA DE LOG 2.- ADMINISTRACION OPCION : F1? Ayuda On-Line F2 Campo por defecto F3 Fin entrada F4 Pantalla por defecto F6 Shell OS ESC Menu previo 2.2.1. Log monitoring +-----------------------------------------------------------------------------+ 17/10/2014 - SISTEMA DE ALARMAS - EDItran/E V5.1.# 10:24:49 - CONSULTA DE LOG - +-----------------------------------------------------------------------------+ SESION : FECHA (DD/MM/AAAA) : / / HORA (HH/MM/SS) : : : F1? Ayuda On-Line F2 Campo por defecto F3 Fin entrada F4 Pantalla por defecto F6 Shell OS ESC Menu previo +-----------------------------------------------------------------------------+ Log monitoring, according to the sessions it affects, can be divided into: General. We get it if we don t specify anything for SESSION SESIÓN). It displays the messages for all the sessions. Specific. We get it when we enter a specific session. Partial. We get it when we used the wildcard * in the SESSION name. For example, LOCAL* will display the messages for all the sessions whose name begins with LOCAL. INDRA. All rights reserved. EDITRAN/EA Page 2-13
2.EDITRAN/E MANAGEMENT (UNIX) According to the momento when the messages were processed: If we don t enter any date or time, will be displayed all the messages matching the criteria for the SESSION selection. If we enter the date and time, will be displayed the messages from that date and time. 17/10/2014 - SISTEMA DE ALARMAS - EDItran/E V.5.1.# 10:26:35 - CONSULTA DE LOG - SESION : FECHA : 26/03/2003 HORA : 00:00:00 SESION FECHA HORA MENSAJE 000099910000099930PRUEBA 26/03/2003 13:21:13 Error al cifrar/descifrar el fich 000099910000099930PRUEBA 26/03/2003 14:04:23 No hay ficheros de aplicación par 000099910000099990TCP000 26/03/2003 15:13:43 Excepcion operador 000099910000099990TCP000 26/03/2003 15:15:26 Excepcion Tampon remoto incorre 000099910000099990TCP001 27/03/2003 09:03:21 Excepcion liberacion 000099910000099940TEXTOS 27/03/2003 11:20:34 Excepcion Exceso de reintentos 000099910000099940TEXTOS 27/03/2003 11:25:17 Excepcion Exceso de reintentos 000999910000000120PRUEBA 28/03/2003 03:30:21 Error al ejecutar script de usuar 000999910000000120PRUEBA 28/03/2003 08:42:20 Excepcion liberacion Ctrl-U Pag. Anterior Ctrl-D Pag. Siguiente ESC Salir F2 Ver mas Once we access log monitoring, we will navigate within it using PgUp or Ctrl-U to go to the previous page, and PgDn or Ctrl-D to go to the next page. Using Esc, we will go back to the screen for monitoring options. Each line presents a log entry, displaying: the presentation session that caused the alarm, the date and time when it occurred, and the message transmitted to the recipient. If we place the cursor on a line and click F2, will be also displayed the following screen, with additional information about the event. 17/10/2014 - SISTEMA DE ALARMAS - EDItran/E V.5.1.# 10:26:35 - CONSULTA DE LOG - SESION : 000999910000000120PRUEBA FECHA : 26/03/2003 HORA : 03:30:21 MENSAJE Error al ejecutar script de usuario ------------------------------------------------------------------------------ NOTIFICACIONES ------------------------------------------------------------------------------ Por MAIL a editran@indra.es: enviado correctamente ------------------------------------------------------------------------------ Pulse una tecla para continuar INDRA. All rights reserved. EDITRAN/EA Page 2-14
2.EDITRAN/E MANAGEMENT (UNIX) 2.2.2. Administration We can access the alarm administration selecting the option 2 from the alarm system menu. The following screen will be displayed: +-----------------------------------------------------------------------------+ 17/10/2014 - SISTEMA DE ALARMAS - EDItran/E V5.1.# 10:31:39 - ADMINISTRACION - +-----------------------------------------------------------------------------+ A.- ALTA B.- BAJA C.- CONSULTA M.- MODIFICACION OPCION : DOMINIO CODIGO LOCAL : CODIGO REMOTO : APLICACION : F1? Ayuda On-Line F2 Campo por defecto F3 Fin entrada F4 Pantalla por defecto F6 Shell OS ESC Menu previo +-----------------------------------------------------------------------------+ In Registration (Alta) we need to define a domain typing the complete local, remote and application codes. Domain (Dominio): it identifies the group of sessions to wich will be applied the treatment conditions indicated by the set of parameters associated to the alarm. To define them, one or more of the fields local code, remote code or application will be an asterisk. For example, if the fields remote and application are *, the domain would include all the sessions whose local code matches the indicated one. In this case, will be displayed the settings screen described later. For the rest of options (Deleting, Consulting and Modifyind), there are two different ways of entering codes: Specific: We must type the full 3 codes, even the local code. Then will be displayed the screen for the corresponding session or domain settings. Generic: Any of the three codes can be left blank, what implies that we will selecta ll the domains, regardless their corresponding code. When we use this way, it will display the following screen, showing all the sessions matching the specified criteria. For example, keeping blank the fields local, remote and application, would display a list with all the defined alarms. INDRA. All rights reserved. EDITRAN/EA Page 2-15
2.EDITRAN/E MANAGEMENT (UNIX) +-----------------------------------------------------------------------------+ 17/10/2014 - ADMINISTRACION - EDItran/E V5.1.# 10:31:39 - LISTA DE ALARMAS - +-----------------------------------------------------------------------------+ S DOMINIO DESCRIPCION ----------------------------------------------------------------------------- **PRUEBA Alarmas definidas para la aplicación de PRUEBA *000035350TEXTOS Alarma para remoto y aplicación concretos ----------------------------------------------------------------------------- F1? Ayuda On-Line F2 Campo por defecto F3 Fin entrada F4 Pantalla por defecto F6 Shell OS ESC Menu previo +-----------------------------------------------------------------------------+ We will select, from the previous list, the alarms we want to consult or modify, typing S in the corresponding lines. Once they are selected, their data will be displayed in the following settings screen: +-----------------------------------------------------------------------------+ 17/10/2014 - ADMINISTRACION DE ALARMAS- EDItran/E V5.1.# 10:31:39 - MODIFICACION - +-----------------------------------------------------------------------------+ DOMINIO CODIGO LOCAL : * CODIGO REMOTO : 000035350 APLICACIÓN : PRUEBA DESCRIPCION Alarma para remoto y aplicación concretos ACTIVADA (S/N) : S NOTIFICAR LA ALARMA Enviando correo a : editran@indra.es Enviando SMS a : 906253525 Ejecutando : F1? Ayuda On-Line F2 Campo por defecto F3 Fin entrada F4 Pantalla por defecto F6 Shell OS ESC Menu previo +-----------------------------------------------------------------------------+ Domain (Dominio): This key identifies the group of sessions that will be applied the treatment conditions indicated by the set of parameters associated to the domain. It is formed by concatenating the following fields: Local code: An EDITRAN local code, or * for any local one. Remote code: An EDITRAN remote code, or * for any remote one. Application: An EDITRAN defined application, or * for any application. Description: Space to write any comment describing the objective of the alarm. INDRA. All rights reserved. EDITRAN/EA Page 2-16
2.EDITRAN/E MANAGEMENT (UNIX) Activated: We can temporary disable a specific alarm, typing in this field the value N. In this status, the events associated to this alarm are not processed at all, neither notified nor registered in the log. Notifications: In the following fields are specified the actions performed to notify the user about the occurred alarm. If you wish an email containing the information about the alarm, write down the mail address of the recipient user. By default, in the Unix environments the email will be sent using the command sendmail of the OS. In version 5.02 has been incorporated the possibility to send it through an SMTP client, implemented in the product itself. In this case, this field must have the following format: smtp:<destination> Some valid examples are: smtp:editran@indra.es The email will be sent to the account editran@indra.es through the SMTP server, whose settings will be requested in the next screen. smtp:editran@indra.es;personal@gmail.com It sends the email to the addresses editran@indra.es and personal@gmail.com through the SMTP server, whose settings will be requested in the next screen. If we wish an SMS to be sent when the alarm occurs, we will have to enter the recipient phone number. If we wish to run a program when the alarm occurs, we will enter the access path and the name of the program. The alarm system will run the program, adding as a command line argument the message to be notified. Only in the cases where we have entered smtp protocol in the mail destination, will appear the following screen to set the SMTP server data. +-----------------------------------------------------------------------------+ 30/03/2003 - ADMINISTRACION DE ALARMAS- EDItran/E V5.1.# 10:31:39 - MODIFICACION - +-----------------------------------------------------------------------------+ SMTP MAIL SERVIDOR : smtp.indra.es USUARIO : editran PASSWORD : ****** F1? Ayuda On-Line F2 Campo por defecto F3 Fin entrada F4 Pantalla por defecto F6 Shell OS ESC Menu previo +-----------------------------------------------------------------------------+ INDRA. All rights reserved. EDITRAN/EA Page 2-17
2.EDITRAN/E MANAGEMENT (UNIX) SERVER (SERVIDOR): Name or IP address of the mail server. USER (USUARIO): If the service requires identification, this field must be filled with the user who will sent the mail. In this version, the only authentication type supported is LOGIN. PASSWORD: Password used during the authentication process. 2.3. COMMUNICATIONS MONITOR This functionality allows monitoring network resources to check whether they are accessible. The user will set the lines he wants to check, choosing among the following types: x25, tcp-ip and proxy (EDITRAN/PX service). The lines to be checked can be the ones used by EDITRAN, but also any external ones given by the user. The detected events, both line failures and recoveries, are notified to the user through the EDITRAN alarm system. For this, we need that there is a previous alarm set with the following domain: local code *, remote code * and application EDITMN. Then we will select option 3 from the main menu to access the communications monitor menu. INDRA. All rights reserved. EDITRAN/EA Page 2-18
2.EDITRAN/E MANAGEMENT (UNIX) 2.3.1. Service status The monitoring service is performed by a demon process named editranmn. This process is executed in background and the user can run and stop it when he considers, using this menu option. As we can see in the following screen, this option also displays the current status of the process (Running or Stopped) and the user who started it. During the execution, the demon tries periodically to connect with all the network elements defined. Only changes in the line status will be notified, that is to say, failure and later restablishment, if it occurs. The connections sampling interval is, by default, 2 minutes. If the user wants to modify this value, he can use the environment variable MN_INTERVALO. The value to define the intervale must be indicated in seconds. 2.3.2. Settings The option 2 from the menu Communications monitor is the one to be selected by the user for the administration of the lines he wants to check. We can consult the defined devices any time, but to make modifications or to define new resources, the monitoring process must be stopped. 2.3.2.1. Modification This option allows setting the network resources that will be checked. Here, the user will be able to do the following: Stablishing the types of connection to be verified for the lines used as EDITRAN local resources. Adding other network elements. To modify an element, we will move within the list and we will click on <enter>. Then, the detail window will be displayed and, depending on the type of network, will be also displayed the connections to verify. If the network is Tcp or Proxy, the options are Ping and EDITRAN, for X25 In, Out and EDITRAN. Now we will detail the action performed in each case: Ping: it checks the access to the IP address through the system ping command. INDRA. All rights reserved. EDITRAN/EA Page 2-19
2.EDITRAN/E MANAGEMENT (UNIX) X25 In: checks whether incoming calls can be received. To check it, a Call Request is sent, and the called NRI is the one given in the settings. X25 Out: checks whether outcoming calls can be made. To check it, a Call Request is sent, and the calling NRI is the one given in the settings, and the calle done is 999999999999999 (unaccessible number). Any release cause different from the expected one (0x0D) is considered as a failure in the network. EDItran: In this case, we check whether we can reach the specified address. We also verify whether there is an EDITRAN server listening through it. To add a new resource, we will place the cursor in the list position where we want to insert it, and then we will click on F2. In the detail window, we will assign the network type: T (Tcp), X (X25) or P (Proxy) and the corresponding address. To delete a resource, we will place the cursor in the element from the list, and we will click on F3. Before deleting it, the user will be requested a confirmation. INDRA. All rights reserved. EDITRAN/EA Page 2-20
2.EDITRAN/E MANAGEMENT (UNIX) 2.3.2.2. Consulting The following screen is an example of the information displayed when we perform the consultation. In the upper window appears the list of defined resources. If we click <enter> on the element marked with an S, it will display more information: Whether it is being used as a local resource in EDITRAN and, in its case, whether the profile value matches or has been modified since the monitorization began. The type of connections that are being tested. INDRA. All rights reserved. EDITRAN/EA Page 2-21
3.EDITRAN/E MANAGEMENT (Windows) 3. EDITRAN/E MANAGEMENT (Windows) 3.1. Main screen This is the main screen in EDITRAN/EA for Windows. It contains four parts, separated by their functionality: 3.1.1. Optional search parameters This method will allow us limiting information to find a specific session, or a specific date or time. Session (Sesión): if we fill this field, only will be displayed information about the sessions containing the indicated string. Date (Fecha): if we fill this field, it will display information stored from the indicated date. Time (Hora): if we fill this field, it will display information stored from the indicated time. INDRA. All rights reserved. EDITRAN/EA Page 3-1
3.EDITRAN/E MANAGEMENT (Windows) 3.1.2. EDITRAN/EA tree In a visual way (simulating the use of Windows File Explorer), this tree allows specifying which information we want to be displayed in the list. Like in the File Explorer, there are also two ways to open and close the branches: Clicking +/- in the branch. In this way, we will open the branch without reading information from the file. Double clicking on the branch. The branch will be opened, and we will read the information displayed in the list. One the branches are open, we can read their information clicking on the specific branch we want to display. 3.1.3. Information list Here will be displayed the information we read, that has passed the selection filters using the EditranEA tree and, facultatively, the Optional search parameters (Parámetros opcionales de búsqueda). The list can be sorted alphabetically, clicking on the header of the column by which we want to sort it. This feature is very important when it comes about finding information. We also can reduce or enlarge the the width of the columns, if we want to display information whose width is larger than them. INDRA. All rights reserved. EDITRAN/EA Page 3-2
3.EDITRAN/E MANAGEMENT (Windows) 3.1.4. Toolbar Updating data from the list: If we click on this icon from the toolbar, we will forcé an updating of the data from the list, always having in account the current selection from the EditranEA tree and the Optional search parameters (Parámetros opcionales de búsqueda). Incidences in the presentation. Transmissions. Statistics. Clicking on one of these icons, we will display a dialog with a different list, in which we can see the Incidences in the presentation (Incidencias de Presentación), the Transmissions (Transmisiones) and the Statistics (Estadísticas) of the sessions or presentations we have chosen from the information list (lista de información). At first they are deactivated, as to activate them we have to chose one or several sessions or presentations from the information list (lista de información). Also, depending on the selection made in the EditranE branch, we will activate or deactivate them depending on the information that can be displayed. In the EditranA branch, they will be always deactivated, as they are not applicable. 3.2. Statistics branch 3.2.1. Incidences of the presentation When we chose the incidence icon of the presentation, it will display a dialog with a list, in which we will see the incidences of the presentation or presentations selected from the list in the main page (3.1.3 Information list). The dialog is the following: INDRA. All rights reserved. EDITRAN/EA Page 3-3
3.EDITRAN/E MANAGEMENT (Windows) This is similar to the output in UNIX (2.1.1.1. Presentation incidences). 3.2.2. Transmissions When we chose the transmissions icon, we will display a dialog with a a list, in which we will see the transmissions associated to one ore more presentations selected from the list in the main page (3.1.3 Information list). The dialog is the following: This is similar to the output in UNIX (2.1.1.3. Transmissions associated to an interrupted presentation). We can see the incidences for each transmission double clicking on the desired presentation, or we can select the presentation and then click on the button Incidences (Incidencias). Then, the dialog of the next section will be displayed. 3.2.2.1. Evolution data and incidences of a transmission The dialog shows a list with the incidences of a specific transmission. (similar to the output in UNIX 2.1.1.4. Evolution and incidence data of a transmission). INDRA. All rights reserved. EDITRAN/EA Page 3-4
3.EDITRAN/E MANAGEMENT (Windows) 3.2.3. Statistics When we chose the statistics icon, it will display a dialog with a list, in which we will see the transmissions associated to one or more presentations chosen from the list in the main page (3.1.3 Information list). The dialog is the following: This is similar to the output in UNIX (2.1.1.2 Statistics of the application data uploaded or received). We can display more information about the file of a specific application, double clicking on the presentation or selecting the presentation and then clicking on the button File (Fichero). Then, the screen for the next section will be displayed. 3.2.3.1. Files of the presentation With this dialog, we will see information about the file of an application. This is similar to the output in UNIX (2.1.1.2. Statistics of the application data uploaded or received). INDRA. All rights reserved. EDITRAN/EA Page 3-5
3.EDITRAN/E MANAGEMENT (Windows) 3.3. Alarm management branch 3.3.1. Administration When we click on the branch Alarms (Alarmas) will be displayed a list with the existing alarms. The green icon indicates the alarm is active; the red icon indicates the alar mis temporaty disabled. From this list is possible to register new alarms, to modify the properties of the existing ones, or to delete the ones that don t interest us. It is important to consider that, to save in a disk the performed modifications, we need to select the option Save alarms (Guardar Alarmas) from the menu Alarms (Alarmas). They are also automatically saved when we log off the application. To create a new alarm: Click on the right button on the panel and select the option New alarm (Nueva Alarma ) from the menu. In the following screen, you will have to select the domain of the new alarm. Select a value in the options Local (Local), Remote (Remoto) and Application (Aplicación). Then will be displayed the dialog with the details of the alarm, which are similar to the ones described for UNIX in 2.2.2 Administration. INDRA. All rights reserved. EDITRAN/EA Page 3-6
3.EDITRAN/E MANAGEMENT (Windows) In Windows environments, there are two possibilities to send email: SMTP protocol: In this case, is mandatory to specify the name of the server and, optionally, if the server asks for authentication, we will need to specify a valid user and password. In version 5.02, only LOGIN is a possible authentication mechanism. The alarm system includes the implementation of an own SMTP client, so this option doesn t require any additional software to be used. MAPI for Microsoft Outlook: In this case, we use the Messaging API (MAPI) provided by Microsoft Outlook to create email messages, to store them, etc. This option involves the following previous requirements: 1. To have installed Microsoft Office Outlook 2003 SP3 or higher, with 32 bits. 2. To have at least one mail account in Outlook. In case there are several, the alarm system will use the predetermined one. 3. To run EDITRAN with the user owner of the Outlook mail account set. In both cases, when we specify the mail recipient we can enter several addresses; we have to separate them with semicolon. INDRA. All rights reserved. EDITRAN/EA Page 3-7
3.EDITRAN/E MANAGEMENT (Windows) If we place the cursor on an item from the list, and then we click on the righ button, we will display a contextual menu with the options of a specific alarm: Delete (Suprimir) to eliminate the alarm, Properties (Propiedades) to display and modify the data associated to the alarm, Change domain (Cambiar dominio) and Start / Stop (Iniciar / Detener) the change the alarm status. 3.3.2. Alarm registration When we click on the branch Alarm registration (Registro de alarmas), we will update the Information list (3.1.3) of the main screen, with the data read in the alarm log file. If we double click on an item, we will display a screen with detailed information about the event, similar to the one explained for UNIX in 2.2.1. INDRA. All rights reserved. EDITRAN/EA Page 3-8
4.EDITRAN/E API 4. EDITRAN/E API There is a file we have named history in this document. It contains the data that are accessible with the options 5, 6 and 7 of the main menu for UNIX, or with the branch History (Histórico) in the EditranE tree for Windows. It allows searching by different session parameters (remote, local, application), as well as by date and time, both explicit or generic. This file pretends to give the user the chance to ellaborate his own statistics. To make this work easier, there is an API (common for both UNIX and Windows) that allows exploring this file. In this section we will describe the way to use it properly. 4.1. Functions exported from the API The API is displayed as a dynamic library, that can be incorporated to the proyect in which we want to read the file History (Histórico). The name of the library is libedi_e.dll for Windows. In UNIX, the library is named libedi_e.so (for Solaris and Aix) and libedi_e.sl (for HP-UX). In all the cases, it exports the functions described below. 4.1.1. Int LeerSecRegistroHistorico(long *poffset, t_historico * phistorico); Parameters: Parameter Direction Description long *poffset Input Offset of the file. It will point to the Output position in which the file is being read. It is an input and output parameter, so it will display the last read offset and it will return the new offset. t_historico * phistorico Output It points to a structure of the type t_historico (4.2.1). It will return the information read from the file. Return value: It will return 0 if there are no further logs to be read, and a number different from 0 if there are no unread logs. Observations: This function will read the structure t_historico of the history file (see section 4.2.1), that is stored immediatly after the file offset. It will return the new offset and the structure t_historico completed with the file data. INDRA. All rights reserved. EDITRAN/EA Page 4-1
4.EDITRAN/E API 4.1.2. int LeerSecRegistroEstadoHistorico (long *poffset, t_pres_sts * pestado); Parameters: Parameter Direction Description long *poffset Input Offset of the file. It will point to the Output position in which we are reading the file. This is an input and output parameter, so we will give it the last read offset and it will return the new offset. t_pres_sts * pestado Output It points to a structure of the type t_pres_sts (4.2.3). It will return the information read from the file. Return value: It will return 0 if there are no further logs to be read, or a number different from 0 if there are no unread logs. Observations: This function will read the structure t_pres_sts (see section 4.2.3), that is placed immediatly after the history file offset. It will return the new offset and the structure t_pres_sts completed with the file data. 4.1.3. LeerSecRegistroRelacionHistorico (FILE * fp, long *poffset, t_file_sts * pfile); Parameters: Parameter Direction Description FILE * fp UNUSED NULL long *poffset Input Offset of the file. It will point to the Output position in which we are reading the file. This is an input and output parameter, so we will give it the last read offset and it will return the new offset. t_file_sts * pfile Output It points to a structure of the type t_file_sts (4.2.4). It will return the information read from the file. Return value: It will return 0 if there are no further logs to be read, or a number different from 0 if there are no unread logs. Observations: This function will read the structure t_file_sts (see section 4.2.4), that is placed immediatly after the history file offset. It will return the new offset and the structure t_file_sts completed with the file data. INDRA. All rights reserved. EDITRAN/EA Page 4-2
4.EDITRAN/E API 4.1.4. ReadLogBufferHistorico (LogDisplayRecType ** plogbuffer, long offset); Parameters: Parameter Direction Description LogDisplayRecType **plogbuffer Output It double points to the structure LogDisplayRecType (4.2.6). long offset Input - Offset of the file. It will point to Output the position in which the file is being read. It is an input and output parameter, so we will give it the last read offset and it will return the new offset. Return value: It will return 0 if there are no further logs to be read, and a number different from 0 if there are no unread logs. Observations This function will read the structure LogDisplayRecType (see section 4.2.4), that is placed immediatly after the history file offset. It will return the new offset and the structure t_file_sts completed with the file data. INDRA. All rights reserved. EDITRAN/EA Page 4-3
4.EDITRAN/E API 4.2. Structures used 4.2.1. Structure t_historico This struture contains the data read from the history file: typedef struct { t_tipo tipo; t_date datestamp; char presentacion [SESION_STR_SIZE]; char localcode [CODE_STR_SIZE]; char remotecode [CODE_STR_SIZE]; char aplication [APLC_STR_SIZE]; union { t_pres_sts estado; t_file_sts relacion; t_log log; } data; } t_historico; Member Description T_tipo tipo STS_TYPE = Status (Estado) FILE_TYPE = Relation (Relación) LOG_TYPE = Log T_date datestamp Date and time when it occurred (4.2.2) char presentacion IGA presentation char localcode Local code char remotecode Remote code char aplication EDITRAN application union { Depending on whether we are Reading an STS(4.2.3), FILE(4.2.4) or t_pres_sts estado; LOG (4.2.5), we will fill each of the corresponding structures t_file_sts relacin; t_log log; } data; 4.2.2. Structure t_date It is used to read the date and time. typedef struct { int fecha; int hora; } t_date; Member Int fecha Int hora Description Date, with format yyyymmdd Time, with format hhmmss INDRA. All rights reserved. EDITRAN/EA Page 4-4
4.EDITRAN/E API 4.2.3. Structure t_pres_sts It is used to read historic information about the status of the presentation. typedef struct { char identif[switch_size]; char presentacion[sesion_str_size]; int num_ses_pres; int estado_pres; int pres_pendiente; int msgs; int fecha_inicio; int hora_inicio; char origen_incidencia; int fecha_fin; int hora_fin; idconex tableidconex[tablconex_size]; t_client client; } t_pres_sts; Member char identif char presentacion int num_ses_pres int estado_pres Int pres_pendiente int msgs int fecha_inicio int hora_inicio char origen_incidencia int fecha_fin int hora_fin Idconex tableidconex t_client client Description Date, with format yyyymmdd Time, with format hhmmss Number of sessions of the presentation Status of the presentation Message Starting date ddmmyyyy Starting time hhmmss Origin of the incidence (P,G) End date ddmmyyyy End time hhmmss Connections table Structure t_cliente INDRA. All rights reserved. EDITRAN/EA Page 4-5
4.EDITRAN/E API 4.2.4. Structure t_file_sts It is used to read historic information about the relation files. typedef struct { char identif[switch_size]; char presentacion[sesion_str_size]; int idpres; long sincronismo; char fichtampon[file_size]; long regtampon; char fichaplic[file_size]; long regaplic; char msgid[file_size]; long estado; char tipo; char alfabeto; char comprimido; char cifrado; long long_reg; long num_reg; long bytes; long long_reg_cmp; long num_reg_cmp; long bytescmp; long creat_date; long creat_time; long modif_date; long modif_time; } t_file_sts; Member Description char identif E = Transmission, R = Reception char presentacion Name of the presentation int idpres Identification of the presentation long sincronismo Synchronism char fichtampon Name of the buffer file long regtampon Logs of the buffer file char fichaplic Application file long regaplic Logs of the application file char msgid long estado 0 = SEND PENDING 1 = SENT 2 = CANCELLED 3 = RECEIVED 4 = CSB DOWNLOADED char tipo 'B' = Binary 'F' = Fixed 'V' = Variable 'H' = Hybrid char alfabeto 'N' = ASCII 'S' = EBCDIC INDRA. All rights reserved. EDITRAN/EA Page 4-6
4.EDITRAN/E API char comprimido 'N' = NO (unzipped) S = SI (zipped) char cifrado 'N' = NO (unencrypted) S = SI (encrypted) long long_reg Log length long num_reg Number of logs long bytes Bytes long long_reg_cmp Log lenght of the zipped file long num_reg_cmp Number of logs of the zipped file long bytescmp Bytes of the zipped file long creat_date Creation date of the file ddmmyyyy or dmmyyyy long creat_time Creation time of the file hhmmss or hmmss long modif_date Modification date of the file ddmmyyyy or dmmyyyy long modif_time Modification time of the file hhmmss or hmmss 4.2.5. Structure t_log Used t oread the historic information of the log. typedef struct LogEntry_st { PrimaryKeyType PrimaryKey; char Separator1; char Sentido; char Separator2; SecondaryKeyType SecondaryKey; char Separator4; char TextLog[TEXT_COD_SIZE]; char Separator5; char TextAux[TEXT_AUX_SIZE]; char Separator6; char Terminator; } t_log; Member Description PrimaryKeyType PrimaryKey Session (4.2.5.1) char Separator1 Separator 1 char Sentido (direction) Transmission Reception (4.2.5.2) char Separator2 Separator 2 SecondaryKeyType Date and time SecondaryKey char Separator4 Separator 4 char TextLog Text char Separator5 Separator 5 char TextAux Auxiliary text char Terminator Terminator character 4.2.5.1. Structure PrimaryKey_st typedef struct PrimaryKey_st { char Sesion[SESION_STR_SIZE - 1]; } PrimaryKeyType; INDRA. All rights reserved. EDITRAN/EA Page 4-7
4.EDITRAN/E API 4.2.5.2. Structure SecondaryKey_st typedef struct SecondaryKey_st { DateType Date; TimeType Time; } SecondaryKeyType; 4.2.6. Structure LogDisplayRecType Used to read the log information. It is a union of three structures: Line_st (4.2.6.1), LongDisplay_st (4.2.6.2) and ShortDisplay_st (4.2.6.3). typedef union { LineType Line; LongDisplayType LongDisplay; ShortDisplayType ShortDisplay; } LogDisplayRecType; Member Description LineType Line Structure Line_st (4.2.6.1). Information formatted in a text line LongDisplayType LongDisplay Long format. Structure LondDisplay_st (4.2.6.2) ShortDisplayType ShortDisplay Short format. Structure ShortDisplay_st (4.2.6.3) 4.2.6.1. Structure Line_st typedef struct Line_st { char A[LINE_SIZE]; } LineType; 4.2.6.2. Structure LongDisplay_st typedef struct LongDisplay_st { char Sesion[SESION_MSK_SIZE]; char Days[DAYS_MSK_SIZE]; char Mont[MONT_MSK_SIZE]; char Year[YEAR_MSK_SIZE]; char Hour[HOUR_MSK_SIZE]; char Mins[MINS_MSK_SIZE]; char Secs[SECS_MSK_SIZE]; char Text[TEXT_MSK_SIZE]; } LongDisplayType; 4.2.6.3. Structure ShortDisplay_st typedef struct ShortDisplay_st { char Days[DAYS_MSK_SIZE]; char Mont[MONT_MSK_SIZE]; char Year[YEAR_MSK_SIZE]; char Hour[HOUR_MSK_SIZE]; char Mins[MINS_MSK_SIZE]; char Secs[SECS_MSK_SIZE]; char Text[TEXT_MSK_SIZE]; } ShortDisplayType; INDRA. All rights reserved. EDITRAN/EA Page 4-8
4.EDITRAN/E API 4.3. Example of programming for the EditranE API To finish the section about EditranE API, we will show a brief example of its use: /***************************************************************************** * Soluciones de comunicaciones * * (C) INDRA, S.A Octubre,2002 * * <sample.c> *****************************************************************************/ /*--------------------------------------------------------------------------- System includes ---------------------------------------------------------------------------*/ #include <stdio.h> /*--------------------------------------------------------------------------- Project includes ---------------------------------------------------------------------------*/ #include "historico.h" /*--------------------------------------------------------------------------- main ---------------------------------------------------------------------------*/ int main(void) { long offset = 0L; t_historico Historico; } while (!LeerSecRegistroHistorico(&offset, &Historico)) { switch (Historico.tipo) { case STS_TYPE: printf("sts "); break; case FILE_TYPE: printf("file "); break; case LOG_TYPE: printf("log "); break; default: printf("error "); } printf("%s %s %s %s ", Historico.presentacion, Historico.localcode, Historico.remotecode, Historico.aplication); printf("%d %.6d ", Historico.datestamp.fecha, Historico.datestamp.hora); printf("\n"); } return (1); In this example, we have used the function LeerSecRegistroHistorico, to sequentially read the historic log. This function and its parameters are described in section 4.1.1. This example is just a console program that returns a print screen of information about the statistics historic file. INDRA. All rights reserved. EDITRAN/EA Page 4-9
5.EDITRAN/AL API 5. EDITRAN/AL API Those processes that consider interesting to notify errors of a presentation have an API that allows them connecting with the alarm system. 5.1. Functions exported by the API The API is displayed as a dynamic library that will be incorporated to the proyect within which we want to send an alarm. The name of the library is libedi_al.dll for Windows. In UNIX, the library is named libedi_al.so (Solaris and Aix), and libedi_al.sl (HP-UX), and it exports in every case the functions described below. 5.1.1. Int EDItranAL_Req(char *presentacion, char *mensaje); Parameters: Parameter Directio n Description Char *presentacion Input Presentation session to which we want to associate the alarm message to be sent. Char *mensaje Input Message describing the error situation we want to modify. Return value: It will return 0 if it couldn t send the request to the alarm system. Observations: This function requests the alarm server to notify the error message corresponding to the given presentation. The presentation parameter in this case is not an alias, but a concatenation of local, remote and application. INDRA. All rights reserved. EDITRAN/EA Page 5-1
Centros de Competencia ecommerce Avda. de Bruselas 35 28108 Alcobendas. Madrid, España T. +34 91 480 80 80 T. +34 91 480 50 00 www.indracompany.com INDRA. All rights reserved. EDITRAN/EA Page 5-1