GET_UC_SETTING

Script Function: Reads current system settings.

Syntax

GET_UC_SETTING (Setting,Component,Option)

Syntax	Description/Format
Setting	The system setting that should be read. Format: AE name, script literal or script variable Allowed values: WORKLOAD_ACTUAL_FT = Resources currently used provided by the agent for file transfers. WORKLOAD_ACTUAL_JOB = Resources currently used provided by the agent for jobs. WORKLOAD_MAX_FT = Maximum number of resources provided by the agent for file transfers. WORKLOAD_MAX_JOB = Maximum number of resources provided by the agent for jobs. SET_TRACE = Trace options for the work processes of an AE system. SERVER_MODE = Type of server process. SERVER_OPTIONS = Server settings. QUEUE = Queue object's settings.
Component	The system setting of a component to be read depending on the parameter Setting Format: AE name, script literal or script variable For WORKLOAD_ACTUAL_FT, WORKLOAD_ACTUAL_JOB, WORKLOAD_MAX_FT and WORKLOAD_MAX_JOB: Agent's name. For SET_TRACE: AE system's name. For SERVER_MODE: Server process' name. For SERVER_OPTIONS: No component indicated.
Option	The value of an option or status of a specified Queue object to be read. Format: AE name, script literal or script variable Only specify this parameter if the setting is QUEUE and the value of a Queue object should be read. Allowed values: ACTIVE_COUNT = Number of queue slots currently used. CONSIDER_ERT = ERT considered for exceptions. MAX_SLOTS = The queue slot maximum. PRIORITY = The current priority (for exceptions, this value can differ from the default priority). STATE = The queue's current status. Only specify this parameter if the setting is SET_TRACE and the component is an AE server process. Allowed values: TRACE_TARGET = Target traces are written into. MAX_BUFFER_SIZE = Size of memory provided to be written. SERACH_KEY = Text to be searched for within the traces.

Syntax

Description/Format

Setting

The system setting that should be read.

Format: AE name, script literal or script variable

Allowed values:

WORKLOAD_ACTUAL_FT = Resources currently used provided by the agent for file transfers.
WORKLOAD_ACTUAL_JOB = Resources currently used provided by the agent for jobs.
WORKLOAD_MAX_FT = Maximum number of resources provided by the agent for file transfers.
WORKLOAD_MAX_JOB = Maximum number of resources provided by the agent for jobs.
SET_TRACE = Trace options for the work processes of an AE system.
SERVER_MODE = Type of server process.
SERVER_OPTIONS = Server settings.
QUEUE = Queue object's settings.

Component

The system setting of a component to be read depending on the parameter Setting

Format: AE name, script literal or script variable

For WORKLOAD_ACTUAL_FT, WORKLOAD_ACTUAL_JOB, WORKLOAD_MAX_FT and WORKLOAD_MAX_JOB:

Agent's name.

For SET_TRACE:

AE system's name.

For SERVER_MODE:

Server process' name.

For SERVER_OPTIONS:

No component indicated.

Option

The value of an option or status of a specified Queue object to be read.

Format: AE name, script literal or script variable

Only specify this parameter if the setting is QUEUE and the value of a Queue object should be read.

Allowed values:

ACTIVE_COUNT = Number of queue slots currently used.
CONSIDER_ERT = ERT considered for exceptions.
MAX_SLOTS = The queue slot maximum.
PRIORITY = The current priority (for exceptions, this value can differ from the default priority).
STATE = The queue's current status.

Only specify this parameter if the setting is SET_TRACE and the component is an AE server process.

Allowed values:

TRACE_TARGET = Target traces are written into.
MAX_BUFFER_SIZE = Size of memory provided to be written.
SERACH_KEY = Text to be searched for within the traces.

Return Codes

The script function has the following returns codes depending on the parameters that you specify.

QUEUE

ACTIVE_COUNT
- Number of queue slots currently in use
CONSIDER_ERT

0
ERT is not considered
1
ERT is considered when tasks start with regard to queue exceptions

MAX_SLOTS

Maximum number of queue slots
UNLIMITED
Queue slots are not limited

PRIORITY

Current priority of the Queue

STATE

0
GO
1
STOP

SERVER_MODE

A

Java communication process (JCP)
C

Communication process (CP)
D

Dialog process (DWP)
J

Java work process (JWP)
N

Nonstop process
P

Primary work process (PWP)
W

Work process (WP)
The system returns a blank if the server process is inactive

SERVER_OPTIONS

Complete string that contains the server options
Tip: Use the script elements MID, SUBSTR or STR_CUT to read a specific server option. For more information, see Script Elements for Editing Strings.

SET_TRACE

No option specified
- 1 to 9
  Trace level of the work process
  For more information, see Processes & Usage.
- 0
  Tracing is disabled
TRACE_TARGET

FILE

Traces are written to a file
MEMORY

Traces are written in the memory

MAX_BUFFER_SIZE

Size of memory provided for writing traces (in MB)

SEARCH_KEY

Search text

WORKLOAD_ACTUAL_FT and WORKLOAD_ACTUAL_JOB

Resources currently used provided by the agent for file transfers and Jobs
UNKNOWN
Resources are not limited

WORKLOAD_MAX_FT and WORKLOAD_MAX_JOB

Maximum number of resources provided by the agent for file transfers and Jobs
UNLIMITED
Resources are not limited

Comments

Trace options are specified in the Administration perspective's Server category. The script function GET_UC_SETTING returns a 16-digit number, each number referring to one of the 16 available areas (such as TCP/IP).

The administrator can define the Server options in the variable UC_SYSTEM_SETTINGS by using the SERVER_OPTIONS key. The GET_UC_SETTING returns the complete string. To read a specific Server option, you can use the script elements MID, SUBSTR or STR_CUT.

GET_UC_SETTING causes all the script's open transactions to be written to the AE database.

Examples

The following example retrieves the maximum number of resources that the agent WIN01 provides for jobs. The result is written to the activation protocol.

:SET &RET# = GET_UC_SETTING(WORKLOAD_MAX_JOB, "WIN01")
:PRINT &RET#

The second example reads the trace options of the AE system AEPROD.

:SET &RET# = GET_UC_SETTING(SET_TRACE, "AEPROD")

This example retrieves the type of the Server process AE#WP003.

:SET &RET# = GET_UC_SETTING(SERVER_MODE, "AE#WP003")

The following scripting lines read the third digit of the Server options. This setting defines whether the statistical records should be checked when the system is cold booted.

:SET &RET# = GET_UC_SETTING(SERVER_OPTIONS)
:SET &OPTION# = SUBSTR(&RET#,3,1)

The next example retrieves the current status of a Queue object and writes it to the activation protocol.

:SET &RET# = GET_UC_SETTING(QUEUE,QUEUE.JOBS,STATE)
:IF &RET# = 0
: PRINT "QUEUE.JOBS - Status = GO"
:ELSE
: PRINT "QUEUE.JOBS - Status = STOP"
:ENDIF

The following example reads the maximum slot of a Queue object and writes it to the activation protocol.

:SET &RET# = GET_UC_SETTING(QUEUE,QUEUE.JOBS,MAX_SLOTS)
: PRINT "Queue QUEUE.JOBS - Max Slots: &RET#"

These last examples read additional trace options for a current AE system.

:SET &RET# = GET_UC_SETTING(SET_TRACE, &$SYSTEM#, TRACE_TARGET)
: PRINT "Traces are being written into &RET#"

:SET &RET# = GET_UC_SETTING(SET_TRACE, &$SYSTEM#, MAX_BUFFER_SIZE)
: PRINT "The maximum buffer size for the memory trace is defined as followed: &RET#"

:SET &RET# = GET_UC_SETTING(SET_TRACE, &$SYSTEM#, SEARCH_TEXT)
: PRINT "The AE system has to search for the following text: &RET#"