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.
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.
Build Toolkit plug-in properties
This topic describes the properties expected by the File Manager Build Toolkit plug-in.
Build Toolkit plug-in properties for Db2® resources
This topic describes the properties expected by the File Manager Build Toolkit plug-in for Db2® data resources.

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.
    - zconbt command line utility
      The zconbt utility expects as input a properties file and generates as output a SAR file.
    - Build Toolkit plug-in properties
      This topic describes the properties expected by the File Manager Build Toolkit plug-in.
      - Build Toolkit plug-in properties for File Manager base resources
        This topic describes the properties expected by the File Manager Build Toolkit plug-in for File Manager base resources.
      - Build Toolkit plug-in properties for IMS™ resources
        This topic describes the properties expected by the File Manager Build Toolkit plug-in for IMS™ data resources.
      - Build Toolkit plug-in properties for Db2® resources
        This topic describes the properties expected by the File Manager Build Toolkit plug-in for Db2® data resources.
    - Deploying SAR files
      Service archives (SAR files) created using the zconbt command-line utility must be deployed to your z/OS® Connect WLP environment.
    - Configuring File Manager SAR files
      Each SAR file that was built using the zconbt command and the File Manager Build Toolkit plug-in identifies a connection ID (connid).
    - Modifying templates
      If you create a SAR file based on a template and later change the template, the response schema of your SAR file might be out of sync with the data returned by 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

Build Toolkit plug-in properties for Db2® resources

This topic describes the properties expected by the File Manager Build Toolkit plug-in for Db2® data resources.


Property	Importance	Description
name	Required	The name of the service. Must be unique across SAR files.
description	Optional	The description of the service. Recommended to help manage SAR files.
version	Required	The version of the service.
provider	Required	Must be `filemanager`.
ssid	Required	The Db2® subsystem identifier.
owner	Required	The name of the Db2® data resource owner.
tableName	Required	The name of the Db2® data resource.
dataCcsid	Optional	CCSID of resource alphanumeric data. Default is 037.
dbcsCcsid	Optional	CCSID of graphic or double-byte data. Default is 930.
templateName	Optional	Name of a File Manager/Db2 template that maps the Db2® data resource. Example: MVS.DATASET(DB2TMPL).
tmplCcsid	Optional	CCSID of the template. Default is 037.
timeout	Optional	Time in seconds for which the FM/Db2 session can be inactive before it is terminated. Can be any value from 0 to 28800 (eight hours). The default is 300 (5 minutes). If the value is greater than the max_timeout in the server.xml configuration, the timeout value is ignored and the max_timeout value is used instead.
connid	Optional	Connection ID. Associates the generated SAR file with a configuration element in the server.xml of the z/OS® Connect WLP server. Default is default.
host	Required	The hostname or IP address of the ADFzCC server (IPVSRV) where the FM/Db2 template resides. The host property is only relevant during SAR creation.
port	Required	The hostname or IP address of the ADFzCC server (IPVSRV) where the FM/Db2 template resides. The host property is only relevant during SAR creation.
userid	Required	A user ID that has read access to the FM/Db2 template on the z/OS system running the IPVSRV server. The userid property is only relevant during SAR creation.
passwd	Required	A password of the user ID that has read access to the FM/Db2 template on the z/OS® system running the IPVSRV server. The passwd property is only relevant during SAR creation.

Rate this topic

5 stars 4 stars 3 stars 2 stars 1 star

Comment on this topic.

By clicking this box, you acknowledge that you are NOT a U.S. Federal Government employee or agency, nor are you submitting information with respect to or on behalf of one. HCL provides software and services to U.S. Federal Government customers through its partners immixGroup, Inc. Contact this team at https://hcltechsw.com/resources/us-government-contact. Do not include any personal data in this Comment box. Note: To report a problem or question about the product software, do not use this form. Instead, go to the IBM Software Support site.