> For the complete documentation index, see [llms.txt](https://docs.editran.onesait.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.editran.onesait.com/documentacion-editran/ibm-editran-v5.3-ims-en/estadisticas-monitorizacion-y-alarmas/consulta-on-line-alarmas.md). # Online Alarms query Access to the alarm system, for administration and consultation, is performed through option 5 of the main menu of the Editran operator transaction. The main menu shows the different options the user has to obtain the desired information. The following shows that menu and each of the options presented in it will be explained. ## Main menu ``` ------------------------------------------------------------------------------ | DD/MM/YY ALARM CONTROL AND MANAGEMENT EDITRAN/EA | | HH:MM:SS 5.3 | ------------------------------------------------------------------------------ | | | | | | | 1 ALARM LOG QUERY | | | | 2 ALARM ADMINISTRATOR (ENVIRONMENT) | | | | 3 ALARM ADMINISTRATOR (SESSION) | | | | 4 ENABLE ALARM MANAGEMENT | | | | 5 DISABLE ALARM MANAGEMENT | | | | | | | | OPTION ---> | | | | | | | ------------------------------------------------------------------------------ ``` * Option: > The values specified on the screen will be allowed. ## Alarm Log Query. The messages recorded in the following situations are displayed: * When incidents occur in the processes before/after the sending and receiving of the data. * In transmission interruption processes (A7I), which cause a state change in the presentation session. * Messages explicitly indicated by the user. Below are the two screens associated with this query. ``` ------------------------------------------------------------------------------ | DD/MM/YY ALARM CONTROL AND MANAGEMENT EDITRAN/EA | | HH:MM:SS ALARM LOG QUERY 5.3 | ------------------------------------------------------------------------------ | | | | | | | LOCAL CODE : x nnnnnnn x | | | | REMOTE CODE : x nnnnnnn x | | | | APPLICATION : xxxxxx | | | | DATE (DD/MM/YY): dd / mm / yyyy | | | | TIME (HH:MM:SS): hh : mm : ss | | | | | | | | | | | | | | | ------------------------------------------------------------------------------ ``` The log query can be divided, as far as the sessions it affects, into: * General. Obtained without typing any of the Codes. Messages from all Sessions are shown. * Specific. Obtained by entering the Local, Remote and Application Codes that make up the Session. Messages from that Session are shown. * Partial. Obtained by not entering or by putting “\*” in any of the three Codes, or by entering the beginning or the end of a Code with a “\*” after or before, respectively, the partial Code, or any combination that does not turn the query into either of the two above. All messages that meet all the selection criteria are shown. Due to the time at which the messages have been processed: * If neither the Date nor the time is entered, the latest messages that meet the Code selection criteria are shown. * If the Date is entered, but not the Time, the first messages of that Date are shown. * If the Date and the Time are entered, the messages from that Date starting at that Time are shown. * The year in the date can be entered with 4 or 2 digits. In the latter case, if it is 96 to 99, it is assumed to be 1996 to 1999; if it is less than 96, it is considered to be from 2000 to 2095. Example of the log query. ``` 04/03/03 15:16:10 ALARM LOG QUERY EDITRAN/EA 5.3 MNG. < e-mail > PRESENTATION SESSION DATE TIME EXT. SMTP UNIX EXT. SMS 000099980 000000010 TEST 03-03-03 08:48:12 99 ZTG0017-ZTBGB244: ERROR IN ZTBGBG40 CONVERTER PROCESS. R-C: 00163 000099980 000000010 TEST 03-03-03 11:55:33 00 00 ABEND CODE ERROR. CHECK JCL OUTPUT. 000099980 000000010 TEST 03-03-03 11:55:35 00 00 ABEND CODE ERROR. CHECK JCL OUTPUT. 000099980 000000010 TEST 03-03-03 11:55:37 00 00 ABEND CODE ERROR. CHECK JCL OUTPUT. 000099980 000000010 TEST 03-03-03 12:04:27 00 00 ZTG0063-AN EMISSION LOAD ERROR IS REPORTED TO EDITRAN (A1R) 000099980 000000010 TEST 03-03-03 15:58:46 00 00 ZTG0211-ZTBGB213: THERE IS NO CATALOGED APPLICATION FILE 000099980 000000010 TEST 03-03-03 16:00:21 00 00 ZTG0063-AN EMISSION LOAD ERROR IS REPORTED TO EDITRAN (A1R) 000099980 000000010 TEST 03-03-03 16:02:11 00 00 ZTG0211-ZTBGB213: THERE IS NO CATALOGED APPLICATION FILE 000099980 000000010 TEST 03-03-03 16:12:20 00 00 ZTG0019-EMISSION PRESENTATION LOAD REQUEST 000099980 000000010 TEST 04-03-03 12:32:34 00 00 ZTG0019-EMISSION PRESENTATION LOAD REQUEST ``` ## Alarm Administrator - Environment. When option 2 of the main menu is chosen, a screen appears with the data stored in the environment. ``` ------------------------------------------------------------------------------ | DD/MM/YY ALARM ADMINISTRATOR EDITRAN/EA | | HH:MM:SS LOCAL ENVIRONMENT 5.3 | ------------------------------------------------------------------------------ | GENERAL DATA FOR CONNECTION TO EXTERNAL MANAGERS: | | Called program via CALL: xxxxxxxx | | Data passed to program: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | | GENERAL DATA FOR E-MAIL CONNECTION: | | To: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | | GENERAL DATA FOR SMS CONNECTION: | | Phone Number (SMS): nnnnnnnnnnnnnnn | | SPECIFIC DATA FOR E-MAIL CONNECTION VIA SMTP: | | From: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | | SMTP Machine Domain Name: xxxxxxxx SMTP Proc. Name/Class: xxxxxxxx x | | SPECIFIC DATA FOR E-MAIL CONNECTION VIA UNIX: | | From: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | | Alarm Process Name: xxxxxxxx | | GENERAL DATA FOR CONNECTION TO EXTERNAL SERVERS (E-MAIL AND SMS) | | Remote TCP/IP Line (DNS/IP-ADDRESS + REMOTE PORT): | | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx nnnnn | | Waiting interval : nnn TCP/IP Region : xxxxxxxx | | | | | ------------------------------------------------------------------------------ ``` GENERAL DATA FOR CONNECTION TO EXTERNAL MANAGERS * Program called via CALL: > Name of the user program that is called from the Editran procedure. * Data passed to program: > Data to pass to the user program. The detailed description of these parameters can be found in the section *"Alarm Administrator - Session"*, in the definition corresponding to “External manager notice data”. GENERAL DATA FOR E-MAIL CONNECTION * To: > Email address of the user to whom the incident is to be notified. The value in this field will be taken as the default when creating sessions. GENERAL DATA FOR SMS CONNECTION * Phone Number (SMS): > Phone number to which the incident is to be notified. The value in this field will be taken as the default when creating sessions. GENERAL DATA FOR E-MAIL CONNECTION VIA SMTP * From: > Email address of the user who notifies the incident. It must be recognized by the SMTP machine. * SMTP Machine Domain Name: > Domain name of the SMTP machine. It is used to identify the domain name of the host that sends the message. * SMTP Procedure/Class Name: > Name of the procedure with which the SMTP server has been started (address space name), normally called SMTP, and output class (spool class) for sent mail. It is recommended to use the system punch class (class B). GENERAL DATA FOR E-MAIL CONNECTION VIA UNIX * From: > Email address of the user who notifies the incident. It must be recognized by the UNIX System Service of OS/390. * Alarm Process Name: > Name of the procedure to start in case the email is sent from the UNIX partition of OS/390. To be able to use it, the program *sendmail* has to be active. At the end of this point, the procedure supplied with the installation is shown: ZTBEPSEN. GENERAL DATA FOR CONNECTION TO EXTERNAL SERVERS (E-MAIL AND SMS) * Remote TCP/IP Line (DNS/IP-ADDRESS + REMOTE PORT): > Address where the Editran server that will resolve the email and SMS is located. * Waiting interval: > Maximum connection time in seconds to the Editran server for external email and SMS. Recommended between 10 and 20 seconds. Up to 300 seconds allowed. * TCP/IP Region: > Name of the installation TCP/IP procedure through which it will connect to the Editran server for external email and SMS. It must be accessible from IMS. Procedure ZTBEPSEN. ```cobol // PROC IDENMAIL=,FCODSMTP= //********************************************************************* //* INDRA - COMMUNICATIONS JANUARY 2003 * //********************************************************************* //* SMTP-FORMAT MAIL SENDING PROCEDURE VIA CLIENT * //* SENDMAIL, RESIDENT IN USS * //********************************************************************* //* RECEIVED DATA: * //* RECEIVES IDENMAIL = A 7-BYTE PARM THAT IDENTIFIES THE * //* MESSAGE TO SEND. STARTS WITH X * //* RECEIVES FCODSMTP = THE FILE TO SEND (UP TO 44 BYTES) * //* THE LAST POINTER IS IDENMAIL * //********************************************************************* //* FILES CREATED IN USS: * //* THE MVS INPUT FILE (X*) IS COPIED TO USS--> M&IDENMAIL * //* A STDOUT IS CREATED --> O&IDENMAIL * //* A STDERR IS CREATED --> E&IDENMAIL * //********************************************************************* //* // SET TMPMODE='SIWUSR,SIRUSR,SIRGRP,SIWGRP,SIROTH,SIWOTH' // SET TMPOPTW='OWRONLY,OCREAT,OTRUNC' // SET TMPOPTR='ORDONLY' //* //********************************************************************* //* WE LOCATE THE WORK FILES AND THE PATH OF THE SENDMAIL PROGRAM * //* WARNING. WORK DIRECTORIES MUST HAVE PERMISSIONS 777, BECAUSE * //* THEY WILL BE EXECUTED WITH USER=CICS, OR OTHER USERS. * //* WARNING. ADAPT THE FOLLOWING TO YOUR INSTALLATION //********************************************************************* // SET DAPLIC='/Editran/mail/' // SET DDATOS='/Editran/mail/' // SET PRSEND='/usr/lpp/tcpip/sbin/sendmail' //* //************************************************************* //* -- WE DELETE ALL FILES USED IN USS --- * //* -- THAT CONTAIN IDENMAIL --- * //************************************************************* //* //PASO010 EXEC PGM=BPXBATCH, // PARM='SH rm &DDATOS.*&IDENMAIL' //* //********************************************************************* //* WE COPY THE INPUT FILE TO THE USS PARTITION * //* CREATING A FILE NAMED M + IDENMAIL * //********************************************************************* //* //PASO020 EXEC PGM=BPXCOPY, // PARM='ELEMENT(M&IDENMAIL) PATHMODE (7,7,7,7) TYPE(TEXT)' //SYSUT1 DD DSN=&FCODSMTP,DISP=SHR //SYSUT2 DD PATH='&DAPLIC' //SYSTSPRT DD SYSOUT=* //* //************************************************************* //* -- WE EXECUTE SENDMAIL TO SEND THE EMAIL --- * //* -- AS LONG AS THE PREVIOUS STEP WAS CORRECT--- * //* -- WE USE THE PARAMETERS --- * //* -- -v (verbose) --- * //* -- t (the message recipients are in --- * //* -- the file we send) --- * //* -- --- * //* -- WE CREATE FILE O + IDENMAIL (stdout) --- * //* -- WE CREATE FILE E + IDENMAIL (stdout) --- * //* -- --- * //* -- WE INCORPORATE THE OUTPUTS GENERATED BY SENDMAIL --- * //* -- TO THE JOB THAT CALLED THE PROCEDURE --- * //************************************************************* //* // IF (PASO020.RC=0) THEN //PASO030 EXEC PGM=BPXBATCH, // PARM='SH &PRSEND -vt' //* //STDIN DD PATH='&DDATOS.M&IDENMAIL', // PATHOPTS=(&TMPOPTR),PATHMODE=(&TMPMODE) //STDOUT DD PATH='&DDATOS.O&IDENMAIL', // PATHOPTS=(&TMPOPTW),PATHMODE=(&TMPMODE) //STDERR DD PATH='&DDATOS.E&IDENMAIL', // PATHOPTS=(&TMPOPTW),PATHMODE=(&TMPMODE) //* //PASO031 EXEC PGM=IEBGENER //SYSPRINT DD DUMMY //SYSIN DD DUMMY //SYSUT1 DD PATH='&DDATOS.O&IDENMAIL', // PATHOPTS=(&TMPOPTR),FILEDATA=TEXT, // RECFM=VB,LRECL=132,BLKSIZE=1000 //SYSUT2 DD DSN=&&FSYSOUT,DISP=(,PASS,DELETE), // SPACE=(CYL,(1,1),RLSE), // DCB=(RECFM=V,LRECL=132) //* //PASO032 EXEC PGM=IEBGENER //SYSPRINT DD DUMMY //SYSIN DD DUMMY //SYSUT1 DD DSN=&&FSYSOUT,DISP=SHR //SYSUT2 DD SYSOUT=*,LRECL=132,RECFM=V //* //PASO033 EXEC PGM=IEBGENER //SYSPRINT DD DUMMY //SYSIN DD DUMMY //SYSUT1 DD PATH='&DDATOS.E&IDENMAIL', // PATHOPTS=(&TMPOPTR),FILEDATA=TEXT, // RECFM=VB,LRECL=132,BLKSIZE=1000 //SYSUT2 DD SYSOUT=*,LRECL=132,RECFM=V //* //************************************************************* //* -- WE DELETE ALL FILES USED IN USS --- * //* -- AS LONG AS THE EMAIL SENDING WENT WELL --- * //* -- OTHERWISE THE ERROR FILE IS LEFT --- * //************************************************************* //* // IF (PASO030.RC=0) THEN //PASO034 EXEC PGM=BPXBATCH, // PARM='SH rm &DDATOS.*&IDENMAIL' //* // ENDIF // ENDIF //* //************************************************************* //* -- WE DELETE THE FILE USED FOR MAIL --- * //* -- REGARDLESS OF WHETHER THE ABOVE WENT WELL --- * //************************************************************* //* //PASO040 EXEC PGM=IEFBR14 //DD1 DD DSN=&FCODSMTP,DISP=(OLD,DELETE,DELETE) //* ``` ## Alarm Administrator - Session To specify the parameters that describe a Session profile, it is essential to have previously created the Environment record. This screen is accessed from option 3 of the Alarm menu (option 5 of the Editran operator). ``` ------------------------------------------------------------------------------ | DD/MM/YY ALARM ADMINISTRATOR EDITRAN/EA | | HH:MM:SS PRESENTATION SESSION 5.3 | ------------------------------------------------------------------------------ | | | A ADD | | | | B DELETE | | | | C QUERY | | | | M MODIFICATION | | | | R ADD WITH COPY | | | | OPTION : x | | LOCAL CODE : x nnnnnnn x | | REMOTE CODE : x nnnnnnn x | | APPLICATION : xxxxxx | | | | | | | | | ------------------------------------------------------------------------------ ``` When adding, it is necessary to type the complete Local, Remote and Application Codes. Two types of entity can be created: * Session: identifies a single session and the Local Code, Remote Code and Application fields are governed by the rules of any Editran session. This will be the only session affected by the parameters indicated * Domain: identifies the group of sessions to which the treatment conditions indicated by the set of parameters associated with the domain will be applied. To define them, one or more of the Local Code, Remote Code and Application fields will be zeros. For example, if the remote and application fields are zeros (000000000 000000), the domain will cover all sessions whose local code matches the one indicated. In Add with copy, the same procedure is followed as in normal Add, but the Session Codes entered must correspond to the one you want to use as a model. In this case, the following lines appear at the bottom of the screen: ``` ¦ IN LOCAL CODE : x nnnnnnn x ¦ ¦ IN REMOTE CODE : x nnnnnnn x ¦ ¦ IN APPLICATION : xxxxxx ¦ ``` The Local, Remote and Application Codes of the Session to be created will be entered. With PF3 these additional lines disappear and you return to the previous situation. The detail screen shown later is already filled in with the data of the model Session, which can be modified as desired. In the other options, Delete, Query and Modify, two different code-entry modes are presented: * Specific: The 3 Codes must be typed in full, including the Local one. The detail screens for the corresponding Session or Domain are displayed directly. * Generic: Any of the three Codes can be entered (whether Session or Domain): * Complete: Initially, all sessions that have the specified Local, Remote or Application Code are selected. * Partial: Sessions whose corresponding Codes begin or end with the specified characters before or after an asterisk, respectively, are selected. * Spaces or “\*”: All sessions are selected regardless of their corresponding Code. When Generic mode is used, the following Selection screen will appear with all sessions that meet the specified criteria: ``` DD/MM/YY ALARM ADMINISTRATOR EDITRAN/EA HH:MM:SS PRESENTATION SESSION MODIFICATION 5.3 S LOCAL REMOTE APPL. PROGRAM PHONE-NUMBER MAIL TO - --------- --------- ------ -------- --------------- ------------------------ x XNNNNNNNX XNNNNNNNX XXXXXX XXXXXXXX NNNNNNNNNNNNNNN xxxxxxxxxxxxxxxxxxxxxxxx ``` The Session or Domain that you want to Delete, Query or Modify will be selected by putting an “S” to the left of the corresponding line, after which the associated detail screen will appear, in which the session code is the only protected data. ``` ------------------------------------------------------------------------------ | 18/01/11 ALARM ADMINISTRATOR EDITRAN/EA | | 10:14:16 PRESENTATION SESSION ADD 5.3 | ------------------------------------------------------------------------------ | | | PRESENTATION SESSION (LOCAL-REMOTE-APPLICATION): XNNNNNNNX XNNNNNNNX XXXXXX | | | | EXTERNAL MANAGER ALARM TYPE (Y/N): x | | CALL PROGRAM NAME : xxxxxxxx | | EXTERNAL MANAGER NOTICE DATA......: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | | | | MVS SMTP E-MAIL ALARM TYPE (Y/N): x | | UNIX USS E-MAIL ALARM TYPE (Y/N): x | | EXTERNAL E-MAIL ALARM TYPE (Y/N): x | | TO: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | | | | SMS ALARM TYPE (Y/N)...........: x | | SMS NOTICE DATA (PHONE NUMBER) : nnnnnnnnnnnnnnn | | | | ALARM LEVEL (0/1/2).........: n 0: ERRORS 1: END TRANS. 2: BOTH | | | ------------------------------------------------------------------------------ ``` For a Session or Domain, more than one alarm type can be activated (telephone, external e-mail, etc.); to do this, an “S” is entered in the desired alarm type field. * Name of Program called via CALL: > Name of the user program that is called from the application procedure. * External Manager Notice Data: > Data passed to the user program when this alarm is active. From the Editran procedure, this program is called with this communication area:
NameLengthFormatDescription
Procedure function2NumProcedure function
Presentation session24Alph.

Presentation session code

Origin (9) – Destination (9) – Application (9)

Error date-time14Alph.Error date-time in ssaammddhhmmss format
Error message68Alph.Error notice data generated by Editran.
Jobname8Alph.Job name with the problem
Jobnumber8Alph.Job number with the problem
External manager notice data30Alph.User-specific data from the notice to EXTERNAL MANAGER that the user included in the Editran profiles.
* To: > Email addresses of the users to whom the incident is to be notified. * SMS Notice Data (Phone Number): > Phone number to which the incident is to be notified. ## Enabling alarm management With options 4 and 5 of the main alarm management menu, the alarm system is enabled and disabled. At the time the Environment is created, alarm management is disabled. Therefore, even if Sessions and Domains with active alarms are created, the system will not start operating until it is enabled from option 4. When you want to deactivate the alarms of all Sessions and Domains, you can use option 5, which disables system management without needing to modify each of the Sessions and Domains. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.editran.onesait.com/documentacion-editran/ibm-editran-v5.3-ims-en/estadisticas-monitorizacion-y-alarmas/consulta-on-line-alarmas.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.