Enabling an EP adapter

You enable an EP adapter, contained in a bundle, by installing the resource object for the bundle to make it available to the CICS® region. You can enable EP adapters in a number of ways, including using the CICS Explorer®.

Before you begin

You must have created the required BUNDDEF resource object in the data repository to install the EP adapter bundle in the CICS region.

About this task

An EP adapter is enabled by installing the bundle resource if that resource specifies enabled as its initial state, and the installation action succeeds. The following procedure describes how to enable an event binding by using CICS Explorer.

Procedure

  1. From the main menu on the CICS Explorer workbench, click Definitions > Bundle definitions to view the list of BUNDDEF resource definitions.
  2. Right-click the EP adapter bundle definition name in the Bundle Definitions view and click Install.
  3. In the Perform Operation window, select the target CICS system or system group where you want to install your EP adapter bundle, and click OK.
  4. Use one of the following methods to check that your bundle installs successfully:
    • From the main menu of the CICS Explorer workbench, click Operations > Bundles and check the status of the bundle in the Status field.
    • From the main menu of the CICS Explorer workbench, click Operations > Bundle Parts and check the status of the bundle parts in the Enable Status field.
    If your bundle installs with any resources disabled, see Diagnosing deployment errors in CICS TS 6.1.0 product documentation.

Results

The EP adapter bundle is installed in the specified CICS region. CICS dynamically creates any additional resources that are defined in the bundle manifest. Events specified in the EP adapter are captured and emitted to an event consumer.

What to do next

After the resource definition installs successfully, you can use CICS Explorer to view the status of installed EP adapters or bundles by clicking Operations > Event Processing > EP adapters or Operations > Bundles. You can also disable and discard EP adapters or bundles by right-clicking resources in the EP Adapters or Bundles views.
To replace a deployed bundle after it is installed, you can use one of the following methods:
  • Disable, discard, then install the changed version of a bundle with the same name. No events are emitted from the moment the bundle is disabled until the moment the installation completes successfully.
  • You can replace an EP adapter without disabling it first by creating a bundle that has a different name from the name of the original bundle and that contains an EP adapter of the same name. Events continue to be emitted until the bundle installation completes successfully, at which point the new EP adapter replaces the previous version.