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.
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.
Generic method examples
The following examples demonstrate the generic method for data access.

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.
    - Generic method examples
      The following examples demonstrate the generic method for data access.
      - Example 1: Read an MVS™ data set sequentially
        In the following example, File Manager Service Provider REST API calls are issued to start a persistent session to read records in an MVS™ data set, using a template to map fields in each record.
      - Example 2: Read a keyed record from a CICS® VSAM data set
        In the following example, File Manager Service Provider REST API calls are issued to access a CICS® VSAM data set using a template, and read one record from a specified key position.
      - Example 3: Read the entire contents of a UNIX System Services file
        In the following example, File Manager Service Provider REST API calls are issued to read all records in a UNIX System Services file without using a template or copybook.
      - Example 4: Read an IMS™ database sequentially
        In the following example, File Manager Service Provider REST API calls are issued to start a persistent IMS™ session to read segments from an IMS database, using a File Manager/IMS view to map fields in each segment.
      - Example 5: Read from a position within an IMS™ database
        In the following example, File Manager Service Provider REST API calls are issued to position within an IMS™ database and then read a segment at that position.
      - Example 6: Read a Db2® database sequentially
        In the following example, File Manager Service Provider REST API calls are issued to start a persistent Db2® session to read rows from a Db2 table, using a File Manager template to map fields in each row.
      - Example 7: Apply a WHERE clause to a Db2® table
        In the following example, File Manager Service Provider REST API calls are issued to limit the result table using a Db2® WHERE clause, then read the first row in the result table.
    - Specific method examples
      The following examples demonstrate the specific method for data access.
- Function and panel reference lists

Generic method examples

The following examples demonstrate the generic method for data access.

z/OS® Connect can map as little or as much of the JSON request payload as required during API creation. In these examples, nothing is mapped, so the API caller passes all relevant parameters.