1. Database Administration - GWS User's Guide
  2. Gateway Screening (GWS) Overview
  3. User Interface Requirements
  4. Retrieve Commands

Retrieve Commands

The retrieve commands for each screening function have the same parameters as the enter commands with an additional parameter called all. The all parameter defaults to no, and can only be specified if no other parameters are specified. If the all parameter is specified and is yes, then a detailed output consisting of every entry in each rule of the indicated screening function type is displayed. There are no rules associated with parameter combinations (for example, if the nc parameter is equal to * then the ncm parameter must be “*”). If an entry is specified using a “*”, then only the entries where that parameter is a “*” is output.

If the NSFI has a value other than STOP or FAIL, then the name of the screening reference to be used in the next step of the gateway screening process (NSR) must be specified. The value of the NSR is shown in the NSR/ACT field.

If the NSFI is STOP, no NSR value can be specified. The gateway screening stop action sets can be specified with the actname parameter if the NSFI is STOP. If a gateway screening stop set has been assigned to the screen, the NSR/ACT field shows the name of the gateway screening stop action set. for more information on the gateway screening stop action sets, go to the Configuring Gateway Screening Stop Action Sets procedure.

If the NSFI is FAIL or STOP and no NSR or ACTNAME value is assigned to the screen, the entry ------ is shown in the NSR/ACT field.

The following is an example of a detailed output using the rtrv-scr-opc command with the all=yes parameter specified. 

rlghncxa03w 06-10-25 15:25:30 GMT EAGLE5 36.0.0
SCREEN = ALLOWED OPC
SR    NI       NC       NCM      NSFI    NSR/ACT
IEC   240      001      010&&200 STOP    ------
IEC   241      *        *        CGPA    cg04 
SR      ZONE   AREA     ID       NSFI    NSR/ACT
IEC     1      003      4        BLKOPC  blk1
IEC     1      003      5        STOP    COPY
SR      NPC                      NSFI    NSR/ACT
IEC     00235                    CGPA    cg04
IEC     00240                    CGPA    cg01
SR    NI       NC       NCM      NSFI    NSR/ACT
WRD2  243      015&&075 *        STOP    RDCT
WRD3  243      105      002      CGPA    WRD4
SR      NPC                      NSFI    NSR/ACT
WRD4    00245                    BLKOPC  blk3
WRD4    00247                    STOP    CR

For the rtrv-scrset:all=yes command, the output consists of every screen set and every screening table in each screen set, in addition to the fields displayed from the rtrv-scrset command with no parameters. The following is an example of the detailed output of the rtrv-scrset:all=yes command. 

rlghncxa03w 06-10-25 15:25:30 GMT  EAGLE5 36.0.0

SCRN  NSFI    NSR/ACT  RULES DESTFLD
SS01  OPC     IEC      120   Y
      DPC     GOOP     33
      SIO     WRD1     5
SS02  STOP    ------   0     Y
SS03  DPC     WRD1     56    Y
      SIO     WRD2     10
      BLKDPC  WRD5     30

Parameters that are not specified default to “all possible values” for that parameter. If no parameters are specified (except for the rtrv-scrset command), a summary output is displayed. A summary output consists of three columns of information, the screening references for the specified screen (SR), and an indicator of whether the screen table is referenced or not (REF), and the number of entries in the screening reference (RULES). The following is an example of a summary output using the rtrv-scr-opc command with no parameters. 

rlghncxa03w 06-10-25 15:25:30 GMT EAGLE5 36.0.0
SCREEN = ALLOWED OPC

SR    REF  RULES
IEC   YES     2
WRD2  YES     1
WRD3  NO      4
WRD4  YES     9

For the rtrv-scrset command, if no parameters are specified, the output displays the following information.

  • The capacity of the gateway screening database, as a percentage of the maximum capacity
  • The percentage of the maximum number of the CDPA and AFTPC tables
  • The total number of screen sets in the database with the percentage of the screen set capacity
  • The number of SEAS and EAGLE screen sets being used
  • The screen set name (SCRN)
  • The next screening function that should be used in the gateway screening process (NSFI)
  • The next screening reference or the gateway screening stop action set name (NSR/ACT)
  • The memory capacity (percentage) of each screen set (FULL)
  • The number of entries (rules) in the screen set (RULES)
  • The number of tables in the screen set (TABLES)
  • Whether the automatic allowed affected destination screening (DESTFLD) for network management messages is applied against the routing table, self point codes, and capability point codes. When this parameter is on, the automatic screening is applied at the end of the provisioned screen set.

The following is an example of the output of the rtrv-scrset command with no parameters. 

rlghncxa03w 06-10-25 15:25:30 GMT EAGLE5 36.0.0
ENTIRE GWS DATABASE IS 1% FULL
CDPA + AFTPC TABLES ARE 1% FULL
SCREEN SET TABLE IS (7 OF 255) 2% FULL
THERE ARE 0 SEAS SCREEN SETS USED ( prefix 00nn )
THERE ARE 7 EAGLE SCREEN SETS USED

SCRN  NSFI    NSR/ACT  FULL  RULES  TABLES  DESTFLD
ss01  OPC     opc1      51%  2075   22      Y
ss02  OPC     opc2       2%  75     22      Y
ss03  OPC     opc3       2%  75     22      Y
ss04  OPC     opc1      51%  2075   22      N
ss07  OPC     opc1      51%  2075   22      Y
ss09  OPC     opc1      51%  2075   22      N
ss28  OPC     opc1      51%  2075   22      Y

The outputs of the retrieve commands contains the following fields. There are certain fields that are used with specific commands and these are noted in the description of the field.

AREA – The area value of an ITU international point code, expressed as zone-area-id. This field is used with all screening functions except screen set, allowed SIO, and allowed TT screening functions.

DESTFLD – Whether the automatic allowed affected destination screening for network management messages is applied against the routing table, self point codes, and capability point codes. When this parameter is on, the automatic screening is applied at the end of the provisioned screen set. This field is only used with the screen set function.

FULL – The capacity of allowed memory a given screen set occupies, expressed as percentage. This field is only used with the screen set function.

H0 – The H0 heading code in the service information field. The H0 field shows the first four bits of the message type indicator in the SIO field. This field is only used with the allowed SIO screening function.

H1 – The H1 heading code in the service information field. The H1 field shows the last four bits of the message type indicator in the SIO field. This field is only used with the allowed SIO screening function.

ID – The ID value of an ITU international point code, expressed as zone-area-id. This field is used with all screening functions except screen set, allowed SIO, and allowed TT screening functions.

ISUPMT/TUPMT – The ISUP message type ( ISUPMT ) in the service information field of an ISUP message or the TUP message type ( TUPMT ) in the service information field of a TUP message. This field is used only with allowed ISUP screening functions.

MSA – The main signaling area value of a 24-bit ITU national point code, expressed as msa-ssa-sp. This field is used with all screening functions except screen set, allowed SIO, and allowed TT screening functions.

NC – The network cluster of an ANSI point code, expressed as ni-nc-ncm. This field is used with all screening functions except screen set, allowed SIO, and allowed TT screening functions.

NCM – The network cluster member of an ANSI point code, expressed as ni-nc-ncm. This field is used with all screening functions except screen set, allowed SIO, and allowed TT screening functions.

NI – The network identifier of an ANSI point code, expressed as ni-nc-ncm. This field is used with all screening functions except screen set, allowed SIO, and allowed TT screening functions.

NIC – The network indicator code in the service information octet. This field is only used with the allowed SIO screening function.

NPC – The ITU national point code. This field is used with all screening functions except screen set, allowed SIO, and allowed TT screening functions.

NSFI – The next screening function identifier. The next screening function identifier specifies the next screening function that should be used in the gateway screening process. This field is used with all screening functions.

NSR/ACT – The next screening reference or the gateway screening stop action set name. The next screening reference is the name of the of the next gateway screening entity that should be used in the screening process. The gateway screening stop action set name is the name of the gateway screening stop action set assigned to the screen defining the additional action to be performed on the MSU that passes gateway screening. This field is used with all screening functions.

PRI – The priority of a message in the service information octet. This field is only used with the allowed SIO screening function.

REF – An indicator of whether the specified screening table is referenced by another screening table. This field is used with the summary outputs of all retrieve commands except the retrieve screen set (rtrv-scrset) command.

RI – The routing indicator in the called party address (CDPA). This field is only used with the allowed CGPA screening function.

RULES – The number of entries in the screen. This field is only used with the screen set function.

SCCPMT – The SCCP message type. This field is only used with the allowed calling party address function.

SCMGFID – The SCCP management (SCMG) format ID, which defines the function and format of each SCMG message. This field is only used with the allowed called party address function.

SCRN – The name of the screen set. This field is only used with the screen set function.

SI – The service indicator for the service information octet, which are the last two bits of the subservice field. This field is only used with the allowed SIO screening function.

SP – The signaling point value of a 24-bit ITU national point code, expressed as msa-ssa-sp. This field is used with all screening functions except screen set, allowed SIO, and allowed TT screening functions.

SR – The name of the screening reference. This field is used with all screening functions except the screen set screening function.

SSA – The sub-signaling area value of a 24-bit ITU national point code, expressed as msa-ssa-sp. This field is used with all screening functions except screen set, allowed SIO, and allowed TT screening functions.

SSN – The subsystem number of a given point code. This field is only used with the allowed CGPA, allowed CDPA, and allowed AFTPC screening functions.

TABLES – The number of tables in the screen. This field is only used with the screen set function.

TYPE – The translation type that is allowed for global title translation. This field is only used with the allowed TT screening function.

ZONE – The zone value of an ITU international point code, expressed as zone-area-id. This field is used with all screening functions except screen set, allowed SIO, and allowed TT screening functions.

The ITU international and 14-bit ITU national spare point codes are displayed in the output of the Gateway Screening retrieve commands with the spare point code subtype prefix “s-”.