Configuring an APA connection

Before any APA information can be viewed, a connection must be established between APA on CICS Explorer and the APA Listener started task on z/OS. Details about the system connection must be provided to z/OS, including its location, and authentication requirements.

Note: APA must be exited and re-started for SSL connection changes to take effect.

Before Starting

At least one connection credential must be defined before a system connection can be configured. See the topic Defining connection credentials for further information.

If an APA Connection has not been configured, or an additional connection is to be setup, perform these steps:

Procedure

  1. Click Window > Preferences from the workbench menu bar, and expand CICS Explorer in the Preferences view. Click Connections. The Connections Preferences view is displayed. If the connections are pre-configured, the connection details would be displayed as in the example below. If not, the fields are blank.



    Configure APA Connection


  2. Click New, complete the preferences below and select the connection credential to use.

    Preference Description
    Type The type of the connection.
    Select "APA Connection".

    Name The local name is used to identify the connection.

    Host Name z/OS server address where the APA server communications reside.

    Port Number Port where the z/OS APA server is listening.

    Credentials The credential to use for the connection. Includes user ID and password (optional).
    Click the menu twistie to see all defined credentials.

    SSL Connection Use SSL (secure) connection
    Default: unchecked

    Keystore File Keystore file used for SSL connection, should point to the directory and file that has the keystore.

    Keystore Pass phrase Pass phrase for keystore - should have the password used to access the keystore file.



  3. Click Apply to save the configuration or Cancel to cancel the process and close the Preferences view without saving the new connection.

  4. Click Connect.

Next Steps

When Connect is clicked CICS Explorer attempts to connect to the configured system. The Signon dialog is displayed and you must enter your password before the CICS Explorer will connect to APA. If the connection is successful, the connection name appears in the connection status bar in the lower right corner of the workbench window next to a green icon to indicate a non-SSL connection, or a padlock to indicate a SSL connection.

If the connection is not successful, a red icon is displayed in the connection status bar in the lower right corner of the workbench window next to the connection name. An error message is displayed at the top of the Connections Preferences view providing a reason for the failure. Check the values in the fields, correct any errors, and click Connect to test the corrections.

When the connection is successful, click OK or Cancel to close the Preferences view.

Parent topic: Tasks