Event types, requestors, and handlers shipped with z/OSMF

IBM ships several event types, requestors, and handlers with z/OSMF so that you can quickly start exploiting the application linking capability and easily navigate between multiple z/OSMF tasks.

For more details about these application linking objects, see the following sections:

Event types

An event type is the intermediary that connects an event requestor to an event handler. Event requestors and event handlers do not interact directly; instead, z/OSMF uses the event type to pass information, the event type and parameters, from the requestor to the handler.

Event handlers can process all, none, or a subset of the parameters that are provided with an event type. When creating an event requestor for an event type, ensure that the event requestor supplies the parameters that are required by the event handlers. To obtain a list of the parameters that are required for the IBM-supplied handlers to process an event type, see Event handlers.

For a list of the event types that are shipped with z/OSMF, see Table 1. This table provides the following information for each event type: ID, display name, description, parameters, and the name of the plug-in that registers the event type. By default, these event types are listed in the Application Linking Manager task if the corresponding plug-in is configured in your z/OSMF instance.

Table 1. Event types shipped with z/OSMF
Event Type ID Display Name Description Parameters Provided Registered By
IBM.ZOSMF.WORKFLOWS.CREATE_WORKFLOW Create a workflow Perform a guided set of steps, for example, to configure components or products in your installation.
workflow_definition_file_name
Fully-qualified UNIX file name or PDS name of the workflow definition file.
workflow_name
Name that the user has provided for the workflow.
workflow_owner
z/OS user id of the workflow owner.
workflow_target_system
Name of the system for this workflow.
Workflows plug-in
IBM.ZOSMF.CONFIGURE_NETWORK_POLICIES Configure network policies Configure z/OS Communications Server network policies. No parameters are provided for this event type. Configuration Assistant plug-in
IBM.ZOSMF.VIEW_ACTIVE_WLM_SERVICE _DEFINITION View Active Service Definition View the active service definition.
sysplex
Name of the sysplex for which to display the active service definition.
timestamp
Timestamp in milliseconds when the service definition was active.
Workload Management plug-in
IBM.ZOSMF.VIEW_ACTIVE_WLM_SERVICE _DEFINITION.REPORT_CLASS View Report Class of Active Service Definition View the report classes that are contained in the active service definition.
sysplex
Name of the sysplex for which to display the active service definition.
timestamp
Timestamp in milliseconds when the service definition was active.
reportClass
Name of the report class to be viewed.
Workload Management plug-in
IBM.ZOSMF.VIEW_ACTIVE_WLM_SERVICE _DEFINITION.SERVICE_CLASS View Service Class of Active Service Definition View the service classes that are contained in the active service definition.
sysplex
Name of the sysplex for which to display the active service definition.
timestamp
Timestamp in milliseconds when the service definition was active.
serviceClass
Name of the service class to be viewed.
period
Period in the service class to be viewed.
Workload Management plug-in
IBM.ZOSMF.VIEW_ACTIVE_WLM_SERVICE _DEFINITION.WORKLOAD View Workload of Active Service Definition View the workloads that are contained in the active service definition.
sysplex
Name of the sysplex for which to display the active service definition.
timestamp
Timestamp in milliseconds when the service definition was active.
workload
Name of the workload to be viewed.
Workload Management plug-in
IBM.ZOSMF.VIEW_ACTIVE_WLM_SERVICE _POLICY View Active Service Policy View the active service policy.
sysplex
Name of the sysplex for which to display the active service policy.
timestamp
Timestamp in milliseconds when the service policy was active.
Workload Management plug-in
IBM.ZOSMF.VIEW_DATASET View Data Set View or browse a data set.
dataSetName
Name of the dataset to be viewed.
ISPF plug-in
IBM.ZOSMF.VIEW_JOB_STATUS View Job Status View the status of a job.
jobName
Name of the job for which to display status.
jobId
ID of the job for which to display status.
ISPF plug-in
IBM.ZOSMF.VIEW_SYSPLEX_PERF View Sysplex Performance View the overall performance of a sysplex.
sysplex
Name of the sysplex for which to display the performance.
Resource Monitoring plug-in
IBM.ZOSMF.VIEW_SYSPLEX_PERF_INDEX View Performance Index Details View the performance index of a sysplex.
sysplex
Name of the sysplex for which to display the performance index.
Resource Monitoring plug-in
IBM.ZOSMF.VIEW_WLM_REPORT_CLASS_PERF View Report Class Performance View the execution velocity and response time metrics for the report classes in a sysplex.
sysplex
Name of the sysplex for which to display performance metrics.
reportClass
Name of the report class for which to display metrics.
Resource Monitoring plug-in
IBM.ZOSMF.VIEW_WLM_SERVICE_CLASS_PERF View Service Class Performance View the performance of active service class periods in a sysplex.
sysplex
Name of the sysplex for which to display performance metrics.
serviceClass
Name of the service class for which to display metrics.
period
Period in the service class for which to display metrics.
Resource Monitoring plug-in
IBM.ZOSMF.VIEW_WLM_STATUS View WLM Status Display the status of WLM in the sysplex.
sysplex
Name of the sysplex for which to display the status of WLM.
Workload Management plug-in
IBM.ZOSMF.VIEW_WLM_WORKLOAD_PERF View Workload Performance View the execution velocity and response time metrics for the workloads in a sysplex.
sysplex
Name of the sysplex for which to display performance metrics.
workload
Name of the workload for which to display metrics.
Resource Monitoring plug-in

Event requestors

An event requestor provides a user-interface control that when invoked passes an event type and the required parameters to the Application Linking Manager task so that they can be passed to an appropriate handler. Table 2 lists the name and description of the event requestors that are shipped with z/OSMF, and it provides a list of the event types the requestor can invoke, the user-interface (UI) control you can use to invoke the event type, and the IBM-supplied handlers for the event type.

When creating an event handler for the IBM-supplied event types, you can use the information provided in Table 2 to invoke the event type and verify that your handler is displaying the expected output.

Notes:
  1. The UI controls listed in Table 2 are available only if the corresponding event type is registered in z/OSMF, and one or more handlers are registered for the event type and are available to process the request. Otherwise, the UI control is disabled or is not provided in the user interface.
Table 2. Event requestors shipped with z/OSMF
Event Requestor Description Invoked Event Type UI Controls that Invoke the Event Type Event Handler
Application Linking Manager task Create context-sensitive launch points between z/OSMF tasks or external applications. IBM.ZOSMF.IMPORT_EXTERNAL _APP
  • Import action provided in the Event Types table.
  • Import action provided in the Handlers table.
Import Manager task
Incident Log task Diagnose system problems, and send diagnostic data to IBM or other vendors for further diagnostics. IBM.ZOSMF.VIEW_DATASET
  • View Log button on the Diagnostic Data tab on the View Diagnostic Details page.
  • Link in the Source Name column in the Diagnostic Data table on the Diagnostic Data tab.
ISPF task
Incident Log task Diagnose system problems, and send diagnostic data to IBM or other vendors for further diagnostics. IBM.ZOSMF.VIEW_JOB_STATUS View Job Details action provided in the FTP Job Status table on the FTP Job Status page. By default, no handler is provided for this event type.
Links task Add links to external sites for system management tools and information. IBM.ZOSMF.IMPORT_EXTERNAL _APP New action provided in the Links page. Import Manager task
Resource Monitoring task Monitor the performance of the z/OS®, AIX®, Linux, and Windows systems in your enterprise. IBM.ZOSMF.VIEW_ACTIVE_WLM_SERVICE _DEFINITION.SERVICE_CLASS View WLM Service Class action provided in the bar chart for metrics that are organized or filtered by WLM service class or WLM service class period. Workload Management task
Resource Monitoring task Monitor the performance of the z/OS, AIX, Linux, and Windows systems in your enterprise. IBM.ZOSMF.VIEW_ACTIVE_WLM_SERVICE _DEFINITION.WORKLOAD View WLM Workload action provided in the bar chart for metrics that are organized or filtered by WLM workload. Workload Management task
Resource Monitoring task Monitor the performance of the z/OS, AIX, Linux, and Windows systems in your enterprise. IBM.ZOSMF.VIEW_ACTIVE_WLM_SERVICE _DEFINITION.REPORT_CLASS View WLM Report Class action provided in the bar chart for metrics that are organized or filtered by WLM report class or WLM report class period. Workload Management task
Resource Monitoring task Monitor the performance of the z/OS, AIX, Linux, and Windows systems in your enterprise. IBM.ZOSMF.VIEW_SYSPLEX_PERF System Status link provided in the Select Sysplex window. System Status task
System Status task Quickly assess the workload performance on the systems in your enterprise, and define the systems to be monitored. IBM.ZOSMF.VIEW_SYSPLEX_PERF_INDEX
  • View > Performance Index Details action provided in the Resources table on the System Status page.
  • Link in the Performance Index Status column in the Resources table on the System Status page.
Resource Monitoring task
System Status task Quickly assess the workload performance on the systems in your enterprise, and define the systems to be monitored. IBM.ZOSMF.VIEW_ACTIVE_WLM_SERVICE _DEFINITION
  • View > Active WLM Service Definition action provided in the Resources table on the System Status page.
  • Link in the Related Service Definition column in the Resources table on the System Status page.
Workload Management task
System Status task Quickly assess the workload performance on the systems in your enterprise, and define the systems to be monitored. IBM.ZOSMF.VIEW_ACTIVE_WLM_SERVICE _POLICY
  • View > Active WLM Policy action provided in the Resources table on the System Status page.
  • Link in the Active WLM Policy column in the Resources table on the System Status page.
Workload Management task
System Status task Quickly assess the workload performance on the systems in your enterprise, and define the systems to be monitored. IBM.ZOSMF.VIEW_WLM_STATUS View > WLM Status action provided in the Resources table on the System Status page. Workload Management task
Workload Management task Administer and operate WLM, and manage WLM service definitions and policies. IBM.ZOSMF.VIEW_SYSPLEX_PERF View performance of systems link provided on the WLM Status page. System Status task
Workload Management task Administer and operate WLM, and manage WLM service definitions and policies. IBM.ZOSMF.VIEW_WLM_SERVICE_CLASS _PERF
  • View performance of active policy link provided on the WLM Status page.
  • View Performance of Active Policy action provided in the table on the Service Policies for Sysplex page.
  • View Performance of Active Policy action provided in the Service Policies table in a View or Modify tab.
  • View Performance of Selected and View Performance of All actions provided in the Service Classes and Service Class Overrides tables in a View or Modify tab.
Resource Monitoring task
Workload Management task Administer and operate WLM, and manage WLM service definitions and policies. IBM.ZOSMF.VIEW_WLM_WORKLOAD_PERF View Performance of Selected and View Performance of All actions provided in the Workloads table in a View or Modify tab. Resource Monitoring task
Workload Management task Administer and operate WLM, and manage WLM service definitions and policies. IBM.ZOSMF.VIEW_WLM_REPORT_CLASS_PERF View Performance of Selected and View Performance of All actions provided in the Report Classes table in a View or Modify tab. Resource Monitoring task

Event handlers

An event handler is a z/OSMF task or external application that can handle requests sent by event requestors. Event handlers support specific event types and can support all, none, or a subset of the parameters that are supplied with an event type. For a handler to process a request, it must receive the correct parameters from the event requestor.

For a list of the event types and parameters (optional and required) that are supported by the handlers shipped with z/OSMF, see Table 3. This table also provides a description of each handler and the expected output for each event type and handler combination.

Table 3. Event handlers shipped with z/OSMF
Event Handler Description Supported Event Type Required Parameters Optional Parameters Expected Output
Configuration Assistant task Configure TCP/IP policy-based networking functions. IBM.ZOSMF.CONFIGURE_NETWORK _POLICIES None None Displays the main page in the Configuration Assistant task.
Import Manager task Add installation-specific function to z/OSMF in the form of plug-ins. IBM.ZOSMF.IMPORT_EXTERNAL _APP tab None Opens to the Import Manager task.
ISPF task Access traditional ISPF applications. IBM.ZOSMF.VIEW_DATASET dataSetName None Displays the data set.
Resource Monitoring task Monitor the performance of the z/OS, AIX, Linux, and Windows systems in your enterprise. IBM.ZOSMF.VIEW_SYSPLEX_PERF _INDEX None
sysplex
If unspecified, the default value is the z/OSMF host sysplex.
Opens a dashboard that contains the performance index for the following items:
  • Important service class periods
  • All service class periods
  • Report class periods
Resource Monitoring task Monitor the performance of the z/OS, AIX, Linux, and Windows systems in your enterprise. IBM.ZOSMF.VIEW_WLM_REPORT _CLASS_PERF None
sysplex
If unspecified, the default value is the z/OSMF host sysplex.
reportClass
If unspecified, the metrics for all report classes are displayed.
Opens a dashboard that contains the following metrics for each WLM report class:
  • Execution velocity
  • Response time
Resource Monitoring task Monitor the performance of the z/OS, AIX, Linux, and Windows systems in your enterprise. IBM.ZOSMF.VIEW_WLM_SERVICE _CLASS_PERF None
sysplex
If unspecified, the default value is the z/OSMF host sysplex.
serviceClass
If unspecified, the metrics for all service classes are displayed.
period
If unspecified, the metrics for all periods in the specified service class are displayed. This value is used only if a service class is specified.
Opens a dashboard that contains the following metrics for each WLM service class period:
  • Performance index
  • Execution velocity
  • Execution velocity goal
  • Response time
  • Response time goal
Resource Monitoring task Monitor the performance of the z/OS, AIX, Linux, and Windows systems in your enterprise. IBM.ZOSMF.VIEW_WLM _WORKLOAD_PERF None
sysplex
If unspecified, the default value is the z/OSMF host sysplex.
workload
If unspecified, the metrics for all workloads are displayed.
Opens a dashboard that contains the following metrics for each WLM workload:
  • Execution velocity
  • Response time
System Status task Quickly assess the workload performance on the systems in your enterprise, and define the systems to be monitored. IBM.ZOSMF.VIEW_SYSPLEX_PERF None
sysplex
If unspecified, the default value is the z/OSMF host sysplex.
Displays a list of the sysplexes that are defined in the System Status task.
Workflows task Perform a guided set of steps, for example, to configure components or products in your installation. IBM.ZOSMF.WORKFLOWS. CREATE_WORKFLOW
workflow_definition
_file_name
Fully-qualified UNIX file name or PDS name of the workflow definition file.
workflow_name
Name that the user has provided for the workflow.
workflow _owner
z/OS user id of the workflow owner.
workflow _target_system
Name of the system for this workflow.
workflow _callback
Callback URL to use when the workflow is created. For example, the caller can be notified with the name of workflow, to be used for a subsequent invocation to launch the workflow.
workflow _comments
Comments to be added to the workflow on creation.
Opens to the Workflow Details panel for the newly created workflow in the Workflows task.
Workload Management task Administer and operate WLM, and manage WLM service definitions and policies. IBM.ZOSMF.VIEW_ACTIVE_WLM _SERVICE_DEFINITION None
sysplex
If unspecified, the default value is the z/OSMF host sysplex.
timestamp
If unspecified, the service definition that is currently active is displayed.
Displays the service definition that is active in the sysplex.
Workload Management task Administer and operate WLM, and manage WLM service definitions and policies. IBM.ZOSMF.VIEW_ACTIVE_WLM _SERVICE_DEFINITION.REPORT _CLASS None
sysplex
If unspecified, the default value is the z/OSMF host sysplex.
timestamp
If unspecified, the service definition that is currently active is displayed.
reportClass
If unspecified, all the report classes in the service definition are displayed.
Displays the specified report class or a list of all the report classes defined in the active service definition.
Workload Management task Administer and operate WLM, and manage WLM service definitions and policies. IBM.ZOSMF.VIEW_ACTIVE_WLM _SERVICE_DEFINITION.SERVICE _CLASS None
sysplex
If unspecified, the default value is the z/OSMF host sysplex.
timestamp
If unspecified, the service definition that is currently active is displayed.
serviceClass
If unspecified, all the service classes in the service definition are displayed.
period
If unspecified, all the periods in the service class are displayed. This value is used only if a service class is specified.
Displays the specified service class and period, or a list of all the service classes defined in the active service definition.
Workload Management task Administer and operate WLM, and manage WLM service definitions and policies. IBM.ZOSMF.VIEW_ACTIVE_WLM _SERVICE_DEFINITION.WORKLOAD None
sysplex
If unspecified, the default value is the z/OSMF host sysplex.
timestamp
If unspecified, the service definition that is currently active is displayed.
workload
If unspecified, all the workloads in the service definition are displayed.
Displays the specified workload or a list of all the workloads defined in the active service definition.
Workload Management task Administer and operate WLM, and manage WLM service definitions and policies. IBM.ZOSMF.VIEW_ACTIVE_WLM _SERVICE_POLICY None
sysplex
If unspecified, the default value is the z/OSMF host sysplex.
timestamp
If unspecified, the service policy that is currently active is displayed.
Displays the service policy that is active in the sysplex.
Workload Management task Administer and operate WLM, and manage WLM service definitions and policies. IBM.ZOSMF.VIEW_WLM_STATUS None
sysplex
If unspecified, the default value is the z/OSMF host sysplex.
Opens the WLM Status tab.