Integrating document plug-ins using a link file

You can use a link file to link to other document plug-ins and integrate them in the CICS Explorer®.

Before you begin

You must know the root directory where the CICS® Explorer is installed and the directory where the plug-ins that you want to integrate are located. The plug-ins must be in a folder called plugins, and the folder can be located on a local or a network drive. The drive must be accessible while the CICS Explorer is running, otherwise, the documentation will not be found.

About this task

This example task shows you how to integrate document plug-ins using a link file.

Procedure

  1. Create a new text file in the CICS_Explorer\links directory. This directory is located in the root directory where the CICS Explorer is installed.
  2. In the text file, add the line path=filepath, where filepath is the path to the directory containing the plugins folder. For example:
    • If you are using a Microsoft Windows operating system, and the plug-ins are located at C:\processes\plugins, the line in the text file is path=C:/processes. Ensure that you use the correct separator in the path. It must be /, otherwise, the plug-ins are not integrated.
    • If you are using a Linux operating system, and the plug-ins are located at /home/user/process/plugins, the line in the text file is /home/user/process.
  3. Save the text file as filename.link, where filename can be any name.
  4. If your plug-ins are located in more than one place, repeat steps 1 to 3 for the other locations.
  5. Start the CICS Explorer.

Results

When the CICS Explorer starts, it checks the identified directory, or directories, for valid plug-ins. The document plug-ins are integrated and displayed in the Help Contents. When you perform a search, any results found in the integrated documentation are displayed as well as results in the CICS Explorer documentation.