Important We are integrating BMC AMI LOBMaster technology into the BMC AMI Reorg product and discontinuing BMC AMI LOBMaster as a separate product. For the latest integrated documentation, see BMC AMI Reorg for Db2 13.1.

_cdbvar() function


The _cdbvar() function provides values for a series of environmental variables that are active during any BMC AMI Utility job. The utility can use these values to determine whether processing should proceed or be postponed.

Syntax

x=_cdbvar('<NGTVariable>')

The NGTVariable parameter is a string that contains a valid BMC AMI Utilities variable name as described in the following table. Enclose the variable name in quotation marks.

Values returned

The values that the _cdbvar function returns depends on the string value that you provide as input. The following table describes the value that is returned for each BMC AMI Utilities variable that you supply:


BMC AMI Utilities variable

Description

Possible values

ACCOUNT

Account code from the JOB statement

Not applicable

CLASS

Class from the JOB statement

Not applicable

DB2_VERSION

Active DB2 version

3-digit indicator of the DB2 level (for example, 910 indicates Db2 9)

GROUP

IBM DB2 data sharing group name

8-character name

GROUPATTACH

DB2 data sharing group attachment name

4-character name

GROUP_ID 

GROUP value from the JOB statement

8-character name

JOBLIB

Name of the IBM DB2 load library, passed from the primary job

This value is blank if it is not defined or in use.

Not applicable

JOBNAME

Job name from the JOB statement

Not applicable

JOBTYPE

Type of job that is running

  • UTILITY
  • SERVER

MEMBER

DB2 data sharing member name

8-character name

MSGCLASS

Message class from the JOB statement

Not applicable

MSGLEVEL

Message level from the JOB statement

Not applicable

PLAN

DB2 plan name

Plan name specified by the +PLAN global parameter

If the +PLAN global parameter is not specified, this value is the plan name specified by the +PLAN parameter supplied during installation.

PRIORITY

JES job priority

Not applicable

PROGRAMMER

Programmer name from the JOB statement

Not applicable

RESTART

Restart parameter

  • RESTART
  • NORESTART
  • INVALID

RESTART_PARM

Restart parameter

Value of the restart parameter on the EXEC statement

SCHENV

Name of the WLM scheduling environment

Not applicable

SSID

DB2 subsystem ID

4-character subsystem ID

STEPLIB

Name of the BMC AMI Utilities load library, passed from the primary job

This value is blank if it is not defined or in use.

Not applicable

STEPNAME

Name of the currently active step

Not applicable

UID

Utility ID of the main utility

String of up to 32 characters

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*