Creating and configuring event subscriptions

In Process Designer, you can create and configure an event subscription for a process application, which is used to obtain information about document and folder events that occur on an Enterprise Content Management (ECM) server.

1. Create a new event subscription by completing the following steps:
   1. Open your process application in Process Designer.
   2. In the library area of the Designer page, click the plus (+) icon beside Implementation and then select Event Subscription. The New Event Subscription wizard opens.
   3. In the Name field, specify a name for the new event subscription.
   4. Click Finish. The new event subscription is displayed in the Implementation library list (under Event Subscription) and the event subscription opens in the Event Subscription editor.
2. Configure the new event subscription by completing the following steps in the Event Subscription editor:
   1. In the ECM Server drop-down list, select one of the following server types to associate with the event subscription:
      • IBM BPM document store
      • The name of an ECM server

      Information about the IBM BPM document store is found in the topic "Working with IBM BPM documents."

      If you want to select the name of an ECM server but no ECM servers are available for selection, you can add a server in the Process App Settings editor by selecting the Use the Process Application Settings editor to add a server link and then clicking the Servers tab. After adding the server, click Save and then switch to the event subscription editor again and select the server from the ECM Server drop-down list. Information about adding an ECM server is found in the topic "Adding an Enterprise Content Management server."

   2. If you selected the name of an ECM server in the ECM Server drop-down list, select either the default Document event class or the Folder event class in the Event Class drop-down list.
   3. If you selected the name of an ECM server in the ECM Server drop-down list, select either the top-level default Document object type or select a different object type in the Object Type drop-down list. (If the drop-down list is disabled, the server is probably unavailable.)
   4. If you selected the name of an ECM server in the ECM Server drop-down list and you want to include all of the subtypes of the selected object type, ensure that the Include Subtypes check box is selected.
   5. In the Event type drop-down list, accept the Created default event type for your ECM server or select a different event type. (If the drop-down list is disabled, the server is probably unavailable.) Information about the available event types is found in the topic Content event types.
   6. If you want to select an existing service for your event subscription that will run and respond to incoming ECM events, click Select in the Attached service area and then select the name of a service, such as General System Service or Integration Service.
   7. If you want to create a new service for your event subscription that will run and respond to incoming ECM events, complete the following steps:
      1. In the Attached Service area, click New. The New Service for Event Subscriptions wizard opens.
      2. In the Name field, accept the default name (which is the same as the event subscription name) or type a different name for your new service.
      3. If you want to create a general system service that will directly invoke the content UCA without first querying the ECM server for additional information, select Create a service that directly invokes a UCA. However, if you want to create an integration service that will first query the ECM server for additional information before determining whether a UCA should be invoked, select Create a service that queries the ECM server before invoking a Content UCA.
      4. Click Finish. The new service and a new content UCA of the same name are created. The new service opens in the service editor.

         If you chose to create a general system service, it is already fully implemented and consists of a Start event, an End event, and an Invoke UCA step that will invoke the new content UCA. However, if you chose to create an integration service, it is partially implemented and it consists of several components, such as an Integration step, a decision gateway step, and an Invoke UCA step to invoke the content UCA.

   8. If you want to test your event subscription and ensure that the attached service, content UCA, and Start and Intermediate events are all operating correctly, complete the following steps:
      1. Click Test Subscription. Test Event Subscription opens, which contains fields that are populated with the selections that you made in the Event Subscription editor. The selections represent the data that will be returned from the ECM server.
      2. In the Object field, accept the default object or select a different object on the ECM server.
      3. Click Test. If the event subscription is defined correctly, a simulated incoming ECM event is triggered and the following message is displayed:

         An inbound ECM event has been successfully simulated for the event subscription.

         The attached service, content UCA, and Start or Intermediate event are subsequently invoked, which leads to either a response from an existing BPD instance or the creation of a new BPD instance. You can view BPD instances in the Inspector view of Process Designer.

   9. By default, event subscriptions are exposed to all users. This means that when any user performs an action that corresponds to the event type that is specified in the Event Type drop-down list (such as creating a document), a document event or a folder event will be fired. If you selected the IBM BPM document store in the ECM Servers drop-down list, you cannot change the default behavior of event subscriptions being exposed to all users. However, if you selected the name of an ECM server in the ECM Servers drop-down list, you can specify that you only want events to be fired for designated users who are named in an existing team. This is accomplished by clicking Select in the Exposing area and then choosing the name of the team. Alternatively, you can create a new team for designated users by completing the following steps:
      1. In the Exposing area, click New. The New Team wizard opens.
      2. In the Name field, type a name for the new team.
      3. Click Finish. The Team page opens.
      4. In the Team page, define the team by following the instructions in the topic Creating a team.
   10. Click Save.