Overview

You can create application plug-ins to extend the capabilities of the Zowe™ Application Framework. An application plug-in is an installable set of files that present resources in a web-based user interface, as a set of RESTful services, or in a web-based user interface and as a set of RESTful services.

Read the following topics to get started with extending the Zowe Application Framework.

How Zowe Application Framework works

Read the following topics to learn how Zowe Application Framework works:

Tutorials

Follow these tutorials to get started working with the sample application plug-in:

  1. Tutorial: Stand up a local version of the Example Zowe Application Server

    The zlux-app-server repository is an example of a server built upon the application framework. Within the repository, you will find a collection of build, deploy, and run scripts and configuration files that will help you to configure a simple Zowe Application Server with a few applications included.

  2. Tutorial: User Browser Workshop App

    This tutorial contains code snippets and descriptions that you can combine to build a complete application.

The following tutorials are available in Github.

Samples

Zowe allows extensions to be written in any UI framework through the use of an Iframe, or Angular and React natively. In this section, code samples of various use-cases will be provided with install instructions.

Troubleshooting Suggestions:

If you are running into issues, try these suggestions:

  • Restart the Zowe Server/ VM.
  • Double check that the name in the plugins folder matches your identifier in pluginsDefinition.json located in the Zowe root.
  • After logging into the Zowe desktop, use the Chrome or Firefox developer tools and navigate to the "network" tab to see what errors you are getting.
  • Check each file with cat <filename> to be sure it wasn't corrupted while uploading. If files were corrupted, try uploading using a different method like SCP or SFTP.

Sample Iframe App

Github Sample Repo:

sample-iframe-app

Sample Angular App

Github Sample Repo:

sample-angular-app

Sample React App

Github Sample Repo:

sample-react-app

User Browser Workshop Starter App

Github Sample Repo:

workshop-starter-app

This sample is included as the first part of a tutorial detailing communication between separate Zowe apps.

It should be installed on your system before starting the User Browser Workshop App Tutorial

The App's scenario is that it has been opened to submit a task report to a set of users who can handle the task. In this case, it is a bug report. We want to find engineers who can fix this bug, but this App does not contain a directory listing for engineers in the company, so we need to communicate with some App that does provide this information. In this tutorial, you must build an App which is called by this App in order to list engineers, is able to be filtered by the office that they work from, and is able to submit a list of engineers which would be able to handle the task.

After installing this app on your system, follow directions in the User Browser Workshop App Tutorial to enable app-to-app communication.