Installing the API samples

The Remote Resource Access API includes samples that can serve as a starting point for using the API.

To import the Remote Resource Access API samples into your workspace:

1. Open the Plug-in Development perspective.
   Tip:

   Eclipse plug-in development requires the Plug-in Development perspective. This perspective is not enabled by default in Developer for z/OS®. To enable it:

   1. Open the Preferences window.
   2. Navigate to General > Capabilities.
   3. On the Capabilities page, expand Development and select Plug-in Development.
   4. Click Apply and Close.

   To open the perspective, click Window (on Windows) or IBM® Developer for z/OS (on macOS) > Perspective > Open Perspective > Other, and then select Plug-in Development and click Open.
2. Click File > Import.
3. On the Import window, expand Plug-in Development, click Plug-ins and Fragments, and then click Next.
4. In the Import From area of the Import Plug-ins and Fragments window, select Directory and click Browse.
5. In the Plug-in Directory window, select the com.ibm.ftt.api.samples plug-in and click OK. This plug-in is in the idz\samples\api-samples\eclipse\plugins folder of the Developer for z/OS installation path.
6. In the Import As area of the Import Plug-ins and Fragments window, select the Projects with source folders checkbox and click Next.
7. In the Selection window, select the plug-in name in the left pane and then click Add and Finish.
   The samples plug-in is added to the Package Explorer.

   
8. To see how the samples integrate with Developer for z/OS, define and start a runtime configuration.
   1. Select com.ibm.ftt.api.samples in the Package Explorer and then click Run > Run Configurations.
      The Create, manage, and run configurations wizard opens.
   2. To open the new configuration page, double-click Eclipse Application from the list of configurations.
   3. In the Name field, type a name of your choice and in the Location field, type a location of your choice.
      To create a configuration in the current workspace, for example, you might type Resource API configuration in the Name field and ${workspace_loc}/../Resource API configuration in the Location field.
   4. Click Run a product and then select com.ibm.rational.developer.systemz.product.ide from the list.
   5. To start the runtime configuration, click Run.
   A runtime Developer for z/OS workbench opens with the z/OS Projects perspective. This runtime workbench opens in a new workspace, separate from the originating workspace. The menu bar in the new workspace contains an API Samples menu. Some of the menus contain API Sample Actions. The results of some of these actions are displayed in the Console view of the originating workspace. For more information about these samples, see the descriptions in the Remote Resource Access API topics in Help Contents.