MPIB gate, GET_NEXT_POLICY_RULE function
Returns information about the next policy rule in the browse.
Input Parameters
- BROWSE_TOKEN
- The token that identifies the browse operation as returned by the associated START_BROWSE_POLICY_RULE function call.
Output Parameters
- ACTION
- Optional parameter
- The action that is taken when this rules threshold is exceeded.
- The values of this parameter are:
- ABEND_TASK
- EVENT
- MESSAGE
- ABEND_CODE
- Optional parameter
- The value of abend code if ACTION is abend_task, all blanks otherwise.
- APPLICATION_NAME
- Optional parameter
- The name of the application this rule applies to.
- APPL_MAJOR_VERSION
- Optional parameter
- The application major version this rule applies to, or -1 if it applies to all major versions.
- APPL_MINOR_VERSION
- Optional parameter
- The application minor version this rule applies to, or -1 if it applies to all minor versions.
- APPL_MICRO_VERSION
- Optional parameter
- The application micro version this rule applies to, or -1 if it applies to all micro versions.
- BUNDLE_NAME
- Optional parameter
- The name of the bundle that contains the policy that defined this rule.
- BUNDLE_ID
- Optional parameter
- The ID for the bundle that defines this rule, or all blanks if not set in manifest.
- BUNDLE_MAJOR_VER
- Optional parameter
- The major version number of the bundle that defines this rule, or -1 if not set in manifest.
- BUNDLE_MINOR_VER
- Optional parameter
- The minor version number of the bundle that defines this rule, or -1 if not set in manifest.
- BUNDLE_MICRO_VER
- Optional parameter
- The micro version number of the bundle that defines this rule, or -1 if not set in manifest.
- BUNDLE_DIRECTORY
- Optional parameter
- The zFS bundle directory that contains the policy XML.
- CHANGEAGENT
- Optional parameter
- The agent that made the last change to the resource definition.
- The values of this parameter are:
- CREATESPI
- CSDAPI
- CSDBATCH
- DREPAPI
- CHANGEAGREL
- Optional parameter
- The CICS release that was running when the resource definition was last changed.
- CHANGETIME
- Optional parameter
- The ABSTIME value that represents the time stamp when the resource definition was last changed.
- CHANGEUSRID
- Optional parameter
- The user ID that ran the change agent.
- COUNT
- Optional parameter
- The number of times this rules threshold has been exceeded since CICS restart.
- DEFINESOURCE
- Optional parameter
- The source of the resource definition. The DEFINESOURCE value depends on the CHANGEAGENT value.
- DEFINETIME
- Optional parameter
- The ABSTIME value that represents the time stamp when the resource definition was created.
- EPADAPTER_NAME
- Optional parameter
- The name of the EP apdapter if the action is EVENT and the ADAPTER option is selected. Otherwise, this parameter is all blanks.
- EPADAPTERSET_NAME
- Optional parameter
- The name of the EP apdapterset if the action is EVENT and the ADAPTER SET option is selected. Otherwise, this parameter is all blanks.
- INSTALLAGENT
- Optional parameter
- The agent that installed the resource.
- The values of this parameter are:
- BUNDLE
- INSTALLTIME
- Optional parameter
- The ABSTIME value that represents the time stamp when the resource was installed.
- INSTALLUSRID
- Optional parameter
- The user ID that installed the resource.
- ITEM_NAME
- Optional parameter
- The name of the item to which this rule relates.
- LEVEL
- Optional parameter
- The level to which this rule was deployed.
- The values of this parameter are:
- REGION
- PLATFORM
- APPLICATION
- APPLMAJORVER
- APPLMINORVER
- APPLMICROVER
- OPERATION
- MODEL_NAME
- Optional parameter
- The name of the MP model.
- OPERATION_NAME
- Optional parameter
- The name of the application operation this rule applies to.
- OPERATOR
- Optional parameter
- The value of the threshold operator.
- The values of this parameter are:
- GT
- POLICY_NAME
- Optional parameter
- The name of the policy that defines this rule.
- Optional parameter
- PLATFORM_NAME
- Optional parameter
- The name of the platform this rule applies to.
- RULE_TYPE
- Optional parameter
- The category to which this rule applies.
- THRESHOLD
- Optional parameter
- The value of the threshold for this rule, that is: VALUE * UNIT
- TIME
- Optional parameter
- The time, in STCK format; when the rules threshold was last exceeded.
- VALUE
- Optional parameter
- The value as specified before the unit was applied.
- UNIT
- Optional parameter
- The unit that was specified by the user when they defined the threshold.
- The values of this parameter are:
- NO_UNIT
- BYTES
- KILOBYTES
- MEGABYTES
- GIGABYTES
- THOUSANDS
- SECONDS
- MILLISECONDS
- MICROSECONDS
- USERTAG
- Optional parameter.
- The value of the usertag for the policy that defines this rule.
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- BROWSE_END
- BROWSE_END_EARLY
- The following values are returned when RESPONSE is INVALID:
- INVALID_FORMAT
- INVALID_FUNCTION
- The following values are returned when RESPONSE is DISASTER:
- ABEND
- RESPONSE
- Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.