Creating a project instance file

Project instance files define the set of projects to be downloaded when a user connects to the remote system.

About this task

Each user who works with host-based projects must have a folder on the remote system that contains a set of project instance files. These folders must be direct subfolders of the path that is defined in the <containerPath> tag for com.ibm.ftt.projects.configurations.HostBasedConfigurationFile in the key mapping file. Each folder name must match the user ID of the particular user for whom the projects are defined. For more information about the key mapping file, see the related topics.

The user folders contain one project instance file for each project to be downloaded. The instance files must be encoded in UTF-8 and have an extension of *.hbpin.

Note: To activate host-based projects for a particular user, at least one project instance file must exist in the user's folder.

The project instance file is an XML file that contains the following tags. For the project instance schema, see the related links.

<PROJECT-INSTANCE>
 <WSED-VERSION>7.0.0.0</WSED-VERSION>
 <PROJECT>
    <PROJECT-NAME>overrideName</PROJECT-NAME>
    <PROJECT-DEF-PATH>pathName</PROJECT-DEF-PATH>
 </PROJECT>
</PROJECT-INSTANCE>
<WSED-VERSION>
The version of the schema syntax. This tag must contain 7.0.0.0, as shown.
<PROJECT-NAME>
Is optional and specifies an override to the project name.
<PROJECT-DEF-PATH>
Refers to a project definition file with a path relative to the PROJECT-HOME folder, not the folder that contains the instance file that is being parsed.

Example

The following figure illustrates how to set up a project instance file:
  • The editor shows a project instance file called mvsproject1.hbpin. In this file, the <PROJECT-NAME> tag overrides the project name, and the <PROJECT-DEF-PATH> tag refers to the project definition file PROJDEFFOLDER/mvsproject1def.
  • To the right of the editor, the Remote Systems view shows a folder that is called PROJDEFFOLDER containing the project definition file mvsproject1def.hbppd. Notice that the <PROJ-FULL-PATH> tag does not include the file extension .hbppd when it refers to this file.
  • To the left of the editor, the z/OS Projects view shows the host-based project corresponding to the instance file mvsproject1.hbpin. Notice that the <PROJECT-NAME> tag is used to give the project a new name that contains German characters. The German UTF-8 characters are not displayed correctly in the text editor but are correct in the z/OS Projects view. Had the <PROJECT-NAME> tag not been used to override the project name, it would be called mvsproject1def.
Project instance file points to project definition file

What to do next