define_3270

The define_3270_diag command specifies the 3270 diagnostics parameters for the SNAplus2 system, such as the parameters used to record and display response-time data and the 3270 user alerts that users can send to the host NetView program. The command can be used to define 3270 diagnostics parameters for the first time or to modify an existing definition.

This command is not associated with a particular node because the 3270 diagnostics parameters are defined as domain resources.

Supplied Parameters

Parameter name            Type           Length        Default
[define_3270_diag]
rtm_overflow              constant                     NO
rtm_unbind                constant                     NO
rtm_timer_option          constant                     RTM_SCREEN
rtm_thresh1               decimal                      0.5
rtm_thresh2               decimal                      1.0
rtm_thresh3               decimal                      2.0
rtm_thresh4               decimal                      5.0
{alert_3270_data}
description               character      53            (null string)
parameter1                character      33            (null string)
parameter2                character      33            (null string)
parameter3                character      33            (null string)

(You can include 0-20 alert_3270_data subrecords.)

Supplied parameters are:

rtm_overflow

Specifies whether to send RTM data to the host every time one of the RTM counters overflows (reaches its maximum value). There is a counter for each of the intervals defined by the rtm_thresh values. Possible values are:

YES: Send RTM data to the host every time a counter overflows.
NO: Do not send RTM data to the host at counter overflow. SNAplus2 discards the RTM data.

rtm_unbind

Specifies whether to send RTM data to the host every time a 3270 session is unbound (ends). Possible values are:

YES: Send RTM data to the host every time a session ends.
NO: Do not send RTM data to the host at session end. SNAplus2 discards the RTM data.

rtm_timer_option

Specifies how the host response time is measured. The response time is measured by the interval between the user pressing ENTER or other AID key to send data to the host, and one of the following events:

RTM_SCREEN: The first data from the host reaches the user's screen
RTM_UNLOCK: The host unlocks the user's keyboard
RTM_DIRECTION: The host gives the 3270 emulation program direction, so that the user can send more data

rtm_thresh1 through rtm_thresh4

Specifies the threshold values used to classify response times. These values divide the range of possible response times into five intervals as follows: below rtm_thresh1, between rtm_thresh1 and rtm_thresh2, between rtm_thresh2 and rtm_thresh3, between rtm_thresh3 and rtm_thresh4, and above rtm_thresh4. SNAplus2 maintains a counter for each of these intervals. Each time a host response is received, SNAplus2 determines which of these intervals the response falls into and increments the appropriate counter.

For each threshold, specify a number in seconds and optionally tenths of seconds (2 for 2 seconds or 2.5 for 2.5 seconds). The values must be in the range 0.1-100 seconds, and must be in ascending order (rtm_thresh2 must be higher than rtm_thresh1, rtm_thresh3 must be higher than rtm_thresh2, and so on).

alert_3270_data subrecords

The host NetView program identifies each alert by a number in the range 1-20; consult the NetView administrator for the host to determine which alert numbers are used and the meaning of each alert. The alert_3270_data subrecords supplied to this command are assigned to these numbers in sequence (the first subrecord is assigned to alert number 1, the second subrecord to alert number 2, and so on). If the host does not use all the alert numbers in the range, include a blank alert subrecord (including only the subrecord descriptor with no parameters specified) for each unused number. For example, if the host uses only alert numbers 10 and 11, include nine blank alert subrecords followed by the subrecords for alerts 10 and 11.

You can include 0-20 alert_3270_data subrecords.

For each alert, an alert_3270_data subrecord is required with the following information:

description

A text description of the alert. This description is a string of 1-53 characters.

This description is displayed in the 3270 user interface to identify the alert to the user. It is not sent to NetView; the NetView operator identifies the alert by its number.

parameter1 through parameter3

Text strings describing any parameters that the user should enter for the alert. Each one is a string of 1-33 characters.

Consult the NetView administrator for the host to determine the parameters required for each alert. An alert may not require all three parameters; do not specify any parameters that are not required. The user will only be prompted for a parameter if you specify a description for it.

Error Return Codes

If the command cannot be executed, SNAplus2 returns a primary return code to indicate the type of error and a secondary return code to provide specific details about the reason for unsuccessful execution.

Parameter Check

If the command does not execute because of a parameter error, SNAplus2 returns the following parameters:

primary_rc

PARAMETER_CHECK

secondary_rc

Possible values are:

INVALID_RTM_THRESHOLD: One or more of the supplied RTM threshold values was not in the valid range, or the values were not in ascending order.

State Check

No specific state errors, other than those listed in Appendix A “Common Return Codes from snapadmin Commands” occur for this command.

Other Conditions

Appendix A “Common Return Codes from snapadmin Commands” lists combinations of primary and secondary return codes that are common to all commands.

Returned Parameters

No parameters are returned by SNAplus2 when this command executes successfully.

define_3270_diag

Technical documentation

» Table of Contents