Home
Working with File Manager
File Manager Service Provider for z/OS® Connect Enterprise Edition
File Manager Service Provider for IBM® z/OS® Connect Enterprise Edition enables client applications to access IBM Z data sources using z/OS Connect.
Swagger documentation
The z/OS® Connect API Editor automatically generates Swagger documentation during API creation. A swagger.json file is created within the API project.

Working with File Manager
- File Manager overview
- Getting started with File Manager
- Viewing and changing data sets
  To view data stored in a supported data set, use the View Utility or the Edit Utility.
- Creating and editing templates
  For many tasks performed with File Manager, you can manipulate your view of a data set by applying a template.
- Working with the Template List
  Display a list of templates and perform actions on them.
- Filtering records with templates
- Managing data sets
- Using File Manager utilities
- Tape Specific Functions
- Disk/VSAM Data Functions
- OAM Functions
- Using UNIX™ System Services and the Hierarchical File System
- Introduction to programming with File Manager functions
- Enhancing File Manager processing
  You can enhance normal processing of a number of File Manager tasks by supplying a procedure that runs in conjunction with the File Manager process.
- Redefines criteria
  Redefines criteria can be specified for a field with a REDEFINES clause, or a field that is the target of a REDEFINES clause.
- Enhanced ISPF: Reference List, Search, Change, and PDSE Workbench
  File Manager provides several enhancements to the basic facilities that are available in an ISPF session: Enhanced Reference List, Enhanced Search, Enhanced Change, and PDSE Workbench.
- File Manager Service Provider for z/OS® Connect Enterprise Edition
  File Manager Service Provider for IBM® z/OS® Connect Enterprise Edition enables client applications to access IBM Z data sources using z/OS Connect.
  - Methods for accessing IBM Z data sources
    File Manager Service Provider supports two methods for accessing data: generic and specific.
  - Single reads versus multiple reads
    Regardless of which method for accessing data is used (generic or specific), the File Manager Service Provider starts a File Manager “view” session to read records from a given data resource.
  - Requests and responses
    The File Manager Service Provider expects JSON payloads from z/OS® Connect-defined APIs representing requests, and passes back JSON payloads as responses to these requests.
  - Creating z/OS® Connect APIs
    Installing the z/OS® Connect EE API Editor into your Eclipse environment adds a perspective that allows you to create a z/OS Connect EE API Project.
  - Using the Build Toolkit plug-in
    z/OS® Connect provides a Build Toolkit (zconbt) for creating service archive (SAR) files. SAR files are used during z/OS Connect API creation to associate APIs with service providers such as File Manager Service Provider.
  - Swagger documentation
    The z/OS® Connect API Editor automatically generates Swagger documentation during API creation. A swagger.json file is created within the API project.
  - Security
    The File Manager Service Provider for z/OS® Connect EE requires an API caller to pass an HTTP Basic Authorization header that identifies the user ID and password of the caller.
  - Troubleshooting
    Use this information to troubleshoot File Manager API request failures.
  - Example scenarios
    The following examples illustrate the sequence of File Manager Service Provider REST API calls used to process some common file types under different scenarios.
- Function and panel reference lists

Swagger documentation

The z/OS® Connect API Editor automatically generates Swagger documentation during API creation. A swagger.json file is created within the API project.

This content is also available via REST API from the z/OS Connect WLP server. For example:

GET        https://your.server:port/<apiBasePath>/api-docs

Where <apiBasePath> is the name of your API as specified in the API Editor.

The swagger.json content can be viewed in a Swagger document editor such as Swagger UI or Swagger Codegen. Alternatively, you can use the z/OS Connect EE Servers view in Eclipse: right-click on the API and select the Open in Swagger UI menu option.