Define NTS Classes

Processing performed by NTS is determined by class definitions.

In a given network, there are various different types of sessions and resources. You may want NTS to collect specific types and amounts of data for each different session type, and require different forms of processing for different session types. You may also want to map session data to the underlying resource hierarchy.

You can achieve these objectives by defining the following types of NTS classes to suit your installation needs:

By default, only SAW data is collected, and for all sessions, which may not suit your installation. No accounting, RTM, or resource statistics data is collected until you define your classes.

More information:

Understanding the Session Awareness Interface

Specify the DEFCLASS Command

To define the attributes of the various categories or classes of session that control how NTS is to collect and process data, use the DEFCLASS command.

For more information about the attributes used to set up the class definitions, see the online help.

To define classes

  1. Decide which classes you need and the attributes each class should have.
  2. Specify the DEFCLASS SESSION, RESOURCE, SAW, and RTM commands, and appropriate operand values in your initialization procedure (normally $NSINIT).
  3. Periodically review the data collected by NTS and adjust any class definitions to suit new requirements.

To subsequently add class definitions, issue a DEFCLASS command from OCS. You must enter all operands, except those that have default values. If you do this while the region is running, the new class definitions do not affect any existing sessions NTS is aware of but are used by any new sessions.

Define Session Classes

Session class definitions provide the following:

Each session class definition contains the following information:

Valid characters for operands in session classes include the following:

Character

Description

*

Can be used in any position to represent a single wild character.

>

Can be used as a suffix to indicate one or more trailing wild characters.

-

Can be used as a suffix (for an LU only) to indicate one or more trailing wild characters for LU names that are not displayed.

Note: If any session class selection operands are omitted, any value of the omitted parameter is considered valid. For example, if no PRI operand is specified, any primary name is considered valid.

Valid Values for the DEFCLASS SESSION Command Operands

Operand

Values

Associated Action

SAWCLASS

=sawclass

Sessions take their SAW class attributes from this class.

RTMCLASS

=rtmclass

Sessions take their RTM class attributes from this class.

PRI

=name

Names the primary resources consider in this session class.

SEC

=name

Names the secondary session partner for sessions considered as being in this session class.

COS

=cosname

Specifies the cosname of sessions considered as being in this session class.

APPNCOS

=cosname

Specifies the APPN cosname of sessions considered as being in this session class.

ER

=0-7

Provides the Explicit Route number (0 - 7) that sessions must have for them to be considered as being in this session class.

VR

=0-7

Provides the Virtual Route number (0 - 7) that sessions must have for them to be considered to be in this session class.

TP

=0-2

Provides the Transmission Priority number (0 - 2) that sessions must have for them to be considered to be in this session class.

APPNTP

=0-3

Provides the APPN Transmission Priority number (0 - 3) that sessions must have for them to be considered to be in this session class.

SCLASS

=SD
=XD
=XN

Provides the class of session as SD (same domain), XD (cross domain), or XN (cross network) that sessions must be for them to be considered as being in this session class.

STYPE

=LL
=SL
=SP
=SS
=MAI
=CC

Provides the type of session as LL (LU-LU), SL (SSCP-LU), SP (SSCP-PU), SS (SSCP-SSCP), MAI (Multiple Application Interface), or CC (CP-CP) that sessions must be in for them to be considered as being in this session class.

SOURCE

=LOCAL
=REMOTE
=ALL

Provides the source of the session as LOCAL (sourced from VTAM on this system) or REMOTE (sourced from an ISR link with another NTS region), or ALL (sourced from local or remote).

SSCP

=sscpname

Valid if SOURCE=REMOTE is specified. Provides the name of the SSCP at the system where a session was sourced.

Example: Session Class Definition

The following is an example of a session class definition:

DEFCLASS     SESSION=TSOB  PRI=TSO>  SEC=ASYD>
             SAWCLASS=NOLOG  RTMCLASS=TSO

In this example, the session class is called TSOA. For this class:

Use Generic Names for Logging

All information logged to the NTS database is session-related and is stored under the session partner names. Together, the two network-qualified session partner names form a session name pair.

To limit the number of session name pairs stored in the NTS database, your session class definition parameters can specify generic session names (or part names), where possible.

For example, an application such as TSO has many ACB names that all begin with a common prefix, TSO>. This means that different sessions between a terminal and various TSO ACBs can all be logged under the same session pair name (that is, TSO>).

Define Resource Classes

Resource class definitions determine the way NTS processes information for different network resources or groups of resources.

Resource class definitions contain the following information:

Valid characters for operands in resource classes include the following:

Character

Description

*

Can be used in any position to represent a single wild character.

>

Can be used as a suffix to indicate one or more trailing wild characters.

-

Can be used as a suffix (for an LU only) to indicate one or more trailing wild characters for LU names that are not displayed.

If you specify parameters other than the parameter that defines the level of the resource class, this has the effect of limiting the range of resources that match the resource class definition.

For example, if you specify the PU and the LU parameters in the same resource class definition, the range of matching LUs is narrowed to those owned by the nominated PU(s). Because all resources should have unique names, this level of detail is worthwhile only if the value of the hierarchically lowest parameter in the class definition is generic, for example: LU=TSO>.

Valid Values for the DEFCLASS RESOURCE Command Operands

Operand

Values

Associated Action

LINK

=name

Provides the full or partial link name that must be used by resources that are to be considered as being in this resource class.

PU

=name

Provides the full or partial PU name that must be used by resources that are to be considered as being in this resource class.

LU

=name

Provides the full or partial LU name of any LUs that are to be considered as being in this resource class.

STATS

=YES
=NO

Provides the resource accounting statistics collection option for resources in this class.

LIMIT

=0-255

Valid when STATS=YES is specified only. Specifies in minutes (0 to 255) the interval to occur before the statistics for the oldest interval are overwritten.

RTMCLASS

=rtmclass

Specifies the RTM class name from which resources are to take their RTM class attributes if RTM summarization is required for this class.

Examples: Resource Class Definitions

The following shows two examples of resource class definitions:

DEFCLASS     RESOURCE=ALLINK  LINK=>  STATS=YES
             RTMCLASS=CICS
DEFCLASS     RESOURCE=TSO  LU=TSO>  STATS=YES

In the first example, the resource class is called ALLINK. For this class:

In the second example, the resource class is called TSO. For this class:

Define SAW Classes

Each SAW class that you define to NTS describes a set of processing options for all session awareness information, including whether to retain such information. Therefore, SAW classes can be used to ensure that no unwanted session data is collected, thereby saving processing time and storage space.

SAW class definitions contain the following information:

The following table shows the valid operands for the DEFCLASS SAW command, and the valid values for each operand. Default values are underscored.

Operand

Values

Associated Action

ACCT

=YES

Accounting data is accumulated for this class.

=NO

No accounting data is accumulated for this class.

EVENT

=YES

Generates $$NTS.xxx events.

=NO

Does not generate events.

KEEP

=YES

Keeps data for this class.

=NO

Does not keep data for this class.

=LOCAL

Sends data to a remote NTS.

LOG

=SUMMARY

Logs all data (except for trace data) at normal end of session; if session ends in error, all data, including trace data, is logged.

=DATA

Logs all data if any exists, otherwise logs no session data.

=ERROR

Logs all data if session ends in error.

=ALL

Logs all data.

=NO

Does not log any data.

TRACE

=(n,n)

Sets depth of the initial and final trace queue (default is 4,20).

Examples: SAW Class Definitions

Two examples of SAW class definitions are shown and explained below.

DEFCLASS    SAW=KEEP                 ACCT=YES  KEEP=YES  LOG=ALL
                                               TRACE=(4,20)
DEFCLASS    SAW=NOKEEP               KEEP=NO

In the first example, the SAW class is, aptly, called KEEP. It specifies the following:

Associate only the type of sessions for which you specifically wanted to retain all data with this SAW class.

In the second example, the SAW class is called NOKEEP.

Because KEEP=NO is specified, NTS discards SAW data for any sessions with which this class is associated. This means that no information about these sessions is available and no other NTS information can be collected for such sessions; therefore, there is no reason to specify other operands for this class. This avoids the collection of unwanted session data.

Define RTM Classes

To enable NTS to collect RTM information from network control units, you need to define one or more RTM classes. In addition, your control units (which can be 3274s, 3174s, or compatible devices) must have the required RTM hardware or microcode level support for the collection of RTM data, and have a host-modifiable RTM definition configured.

RTM class definitions contain the following information:

When NTS receives a session for which RTM data is collected, the boundary values for that class are set in the control unit, and retained for the duration of the session.

The objective response times and objective percentage for the class are used to monitor network response times, and can lead to the automatic generation of attention messages.

The following table shows the available operands for the DEFCLASS RTM command and the valid values for each operand. Default values are underscored.

Operand

Values

Associated Action

OBJTIME

=mm:ss.t

Specifies the acceptable response time for the session. Range is from 0.1 seconds to 30 minutes. Can also be specified as mm:ss, ss, or ss:t (where t is a tenth of a second). This value must correspond to one of the boundary values.

OBJPC

=1-100

Specifies the objective percentage for this class.

BOUNDS

=(value 1, value 2, ...value 4)

Specifies up to four boundary values that are to be set in the control unit. One of the boundary values must be the same as the objtime.

RTMDEF

=FIRST

Response time measured until the first character of the host data stream is received.

=KEYBD

Response time measured until the keyboard is unlocked.

=CDEB

Response time measured until an SNA Change Direction or End Bracket order is received.

=LAST

Response time measured until the last character of the host data stream is received.

Examples

The following shows two examples of RTM class definitions:

DEFCLASS    RTM=CICS  OBJTIME=1.0  OBJPC=90 
            BOUNDS=(0.5, 1.0, 2.0, 5.0)

DEFCLASS    RTM=TSO  OBJTIME=2.0  OBJPC=80 
            BOUNDS=(1.0, 2.0, 5.0, 10.0)  RTMDEF=CDEB

In the first example, the RTM class is called CICS. For this class:

Because the RTMDEF operand is not specified, response time is measured until the first character of the host data stream is received (this is the default).

In the second example, the RTM class is called TSO. For this class:

Modify NTS Class Definitions

After you have been using NTS for a time, you may want to modify one or more NTS class definitions. You would normally do this while session awareness is inactive.

Display Definitions

To display NTS class definitions

  1. Use the SHOW DEFCLASS command.
  2. Specify the type of class or classes you want to display—session, SAW, RTM, or resource—and, if you want to limit the display, the class name or partial name.

Example: Display Definitions

This is an example of the use of the SHOW DEFCLASS command.

SHOW DEFCLASS RTM=CICS

All RTM classes starting with the letters CICS are listed.

Update Class Definitions

To replace or delete class definitions, use the REPCLASS and DELCLASS commands.

To change one or more attributes of a class, use the REPCLASS command to redefine the entire class. This command shares the same operands as the DEFCLASS command.

Example: Update Class Definitions

To delete the RTM class called CICS, issue the following command:

DELCLASS RTM=CICS


Copyright © 2010 CA. All rights reserved.