Key mapping file

The key mapping file is generated when you export configuration files. It stores the names, locations, and character encodings of configuration files that are used in a push-to-client configuration environment.

The key mapping file is a UTF-8 encoded XML file that is named keymapping.xml. Its default location on the z/OS® system is /var/zexpl/pushtoclient/keymapping.xml. This location is defined in the pushtoclient.folder property of the /etc/zexpl/pushtoclient.properties file. For more information about the pushtoclient.properties file, see the IBM Explorer for z/OS Host Configuration Guide (SC27-8437).

The key mapping file contains the following tags for each configuration file¹:

<fileId>

Identifies the configuration file. This tag can contain the following values, described here by using the label that is displayed on the Export window for each file:

com.ibm.ftt.resources.zos.install.configuration Install Configuration Files - Version Configuration
com.ibm.ftt.resources.zos.install.response Install Configuration Files - Response Files
com.ibm.ftt.configurations.RSEConnections Remote System Connections
com.ibm.ftt.configurations.EclipsePreferences Eclipse Preferences
com.ibm.ftt.resources.zos.mapping.specificmapping z/OS File System Mapping Configuration Files - MVS™ Files - Resource Mapping
com.ibm.ftt.resources.zos.mapping.genericmapping z/OS File System Mapping Configuration Files - MVS Files - System Mapping

Note: Installation, Remote System Connections, and Eclipse Preferences configuration files are stored only on the primary system.

<containerPath>

Specifies the location of the configuration file on the z/OS system. The default container path for each configuration file is either the folder that contains the key mapping file or a subfolder. Subfolders are used to reduce the number of files in the parent folder and to group similar sets of files, such as Eclipse preference files.

<fileMask>

Specifies the name of the configuration file. Some export operations, such as Eclipse Preferences and RSE Connections, generate multiple files. For these operations, the value for the file mask uses wildcard characters such as *.xml and *.zip.

<encoding>

Specifies the character encoding of the configuration file.

Sample key mapping file

The following sample key mapping file points to configuration files stored in the /var/zexpl/pushtoclient path of the z/OS system.


<?xml version="1.0" encoding="UTF-8"?>
 <configuration-system>
   <location-list>
     <location>
       <fileId>com.ibm.ftt.resources.zos.install.configuration</fileId>
       <containerPath>/var/zexpl/pushtoclient/install</containerPath>
       <fileMask>installconfig.xml</fileMask>
       <encoding>UTF-8</encoding>
     </location>
     <location>
       <fileId>com.ibm.ftt.resources.zos.install.response</fileId>
       <containerPath>/var/zexpl/pushtoclient/install/responsefiles</containerPath>
       <fileMask>*.xml</fileMask>
       <encoding>UTF-8</encoding>
     </location>
     <location>
       <fileId>com.ibm.ftt.configurations.EclipsePreferences</fileId>
       <containerPath>/var/zexpl/pushtoclient/preferences</containerPath>
       <fileMask>*.pref</fileMask>
       <encoding>IBM-1047</encoding>
     </location>
     <location>
       <fileId>com.ibm.ftt.configurations.RSEConnections</fileId>
       <containerPath>/var/zexpl/pushtoclient/connections</containerPath>
       <fileMask>*.zip</fileMask>
       <encoding>UTF-8</encoding>
     </location>
     <location>
       <fileId>com.ibm.ftt.resources.zos.mapping.genericmapping</fileId>
       <containerPath>/var/zexpl/pushtoclient/mappings</containerPath>
       <fileMask>zossys.xml</fileMask>
       <encoding>UTF-8</encoding>
     </location>
     <location>
       <fileId>com.ibm.ftt.resources.zos.mapping.specificmapping</fileId>
       <containerPath>/var/zexpl/pushtoclient/mappings</containerPath>
       <fileMask>zoshlq_*.xml</fileMask>
       <encoding>UTF-8</encoding>
     </location>
     <location>
       <fileId>com.ibm.ftt.resources.zos.mapping.bct</fileId>
       <containerPath>/var/zexpl/pushtoclient/mappings</containerPath>
       <fileMask>*.bct</fileMask>
       <encoding>UTF-8</encoding>
     </location>
        </location-list>
 </configuration-system>

¹ For IDz users, search for Key mapping file in IDz KC.