Creating your own z/OSMF plug-ins

z/OSMF provides a modular framework that you can use to bring together all of your z/OS® system management applications. z/OSMF supports different levels of integration that range from adding a resource link to adding an application link to create your own z/OSMF plug-ins.

To help you decide which integration method is best for you, consider the following recommendations:
  • If you already have a web application that does not and is not expected to have natural integration points with existing z/OSMF tasks or applications, use the Links task to add your web application as a link in z/OSMF.
    • With the link integration, you do not need to create a new application. Minimal or no code change is needed, and you can consolidate your application to the z/OSMF ecosystem.
  • If you are about to create a new web application and want to use the z/OSMF security controls, persistence capabilities, and REST services, it is recommended to create your own web-based application and import it as a third-party plug-in on z/OSMF.
    • If your web application can use the z/OSMF REST services to complete business logic, only the web-based application a needed.
    • If your web application requires a function that is not provided in z/OSMF or you would like to reuse your existing TSO program, it is recommended to create a backend module. You can also enhance your existing module to interact with the web application through z/OSMF TSO/E REST services.
  • The benefits of using a plug-in integration are as follows:
    • You do not need to have an application server and associated configuration.
    • You can leverage the existing z/OSMF security controls and high availability architecture.
    • You can use the REST services that include functions like data persistence, multi-system communication, handling of data sets, Unix files, and Jobs.
    • You can use the z/OSMF JavaScript interfaces that improve user experience. This includes data set and file selector, the modern VS-code based editor that can view data sets and files, file comparison, and so on.
    • You can use z/OSMF application linking to interact with other z/OSMF tasks or websites.
    • With your own backend TSO module, you can use existing native modules to provide data for the web application without reconstructing it with Java or C methods.
  • No matter which approach you take to integrate with z/OSMF, you can use z/OSMF Application Linking Manager to launch other z/OSMF tasks from your application for richer functions and a better user experience. This includes when your web application is a stand-alone and does not run in a z/OSMF window,
Table 1. Summary of benefits for each integration type
Integration type Best fit Benefits How
Link You already have a web application that does not and is not expected to have natural integration points with existing z/OSMF tasks or applications.

You don’t need to create a new application.

Minimum code change is needed.

You can consolidate your application to the z/OSMF ecosystem.

 Use the Links task to add the resource as a link in z/OSMF.
A third-party plug-in You are about to create a new web application and want to leverage the z/OSMF security controls, high availability, persistence capabilities, and the variety of REST services.

You do not need to have an application server and associated configuration.

You can leverage z/OSMF security controls and high availability architecture.

You can use REST services such as data persistence, multi-system communication, handling of data sets, Unix files, and Jobs.

You can use the z/OSMF JavaScript interfaces that improve user experience. This includes data set and file selector, modern VS-code based editor that is used to view data sets and files, file comparison, and so on.

You can use z/OSMF application linking to interact with z/OSMF tasks or other websites.

With your own backend TSO module, you can have existing native modules provide data for the web application without reconstructing it to Java or C methods.

Create your own web application.

Create a property file that represents the plug-in.

(Optional) Create a backend module.

Use z/OSMF Import Manager task to add the application to z/OSMF.
Application Linking You have a web application that can launch or be launched by other z/OSMF tasks or web-based applications and display specific context. Interact with other z/OSMF tasks to provide rich functions and user experience.

Send the event to use existing z/OSMF event handlers, such as "view job status".

Or use the z/OSMF application linking task to define an event handler and provide a context-based function for other tasks to launch.