57 Configuring Event Notification

This chapter contains the following sections:

57.1 Overview

Event notification keeps Content Integration Platform administrators informed about the synchronicity of source and target systems. When changes are made to monitored folders (published folders on the source system), CIP administrators receive confirmation that the same changes were either successfully propagated to WebCenter Sites, or propagation failed to occur. Event-driven notices are delivered to administrators in a simple workflow process.

A default workflow is available for each of the following events:

Event in WebCenter Sites Workflow
Asset creation CIPAssetCreated. Invoked when an object is created in a monitored folder and the counterpart asset is created in WebCenter Sites.
Asset deletion CIPAssetDeleted. Invoked when an object is deleted from a monitored folder and the counterpart asset is deleted from WebCenter Sites.
Asset deletion failure CIPAssetDeletionFailed. Invoked when:An object that was deleted from the monitored folder is checked out on the WebCenter Sites system.An object that was deleted from the monitored folder has dependencies that would become unresolved on the WebCenter Sites system if the counterpart asset were to be deleted.
Asset modification CIPAssetModified , invoked when an object in the monitored folder is modified and the counterpart asset is created in WebCenter Sites.
Asset modification failure CIPAssetModificationFailed , invoked when an object in the monitored folder is modified, but its counterpart asset is checked out in WebCenter Sites.

Custom Workflows

Although CIP-related workflows can be created, in most cases it is more convenient to use the sample workflows provided with Content Integration Platform. If you wish to install sample workflows, continue reading this section. If you wish to create custom workflows, see Chapter 10, "Creating and Managing Workflow Processes."

57.2 Sample Workflows

Sample workflows are available to use as the basis for modifying to use for your own particular needs. It can be an easier way to provide for workflows in your organization rather than constructing basic workflows from scratch..

Note:

If you have already published to WebCenter Sites, install and enable only the following workflows for the published content: CIPAssetCreated , CIPAssetModified , and CIPAssetModificationFailed. The remaining workflows (CIPAssetDeleted and CIPAssetDeletionFailed ) must be installed and enabled before an asset is published.

This section contains the following topics:

57.2.1 Installing Sample Workflows

To install sample workflows

  1. Run catalogmover.bat (or catalogmover.sh on Linux) from the WebCenter Sites installation directory.

  2. Go to Catalog, and then Auto Import Catalog(s).

    • Select workflows.zip (in the same directory or level as all cs_*_schema.zip files).

    • In the import dialog, fill in the fields as shown below:

      Catalog Data Directory: Leave the default value

      Catalog ACL List: Browser, SiteGod, xceleditor, xceladmin

  3. Create the sample workflows by invoking the following URL:

    http://<host>:<port>/<context_path>/ContentServer?pagename=OpenMarket/Xcelerate/Installation/CIPCreateWorkflows&username=<username>&<password>=<password>

    where:

    • <host> is the address of the WebCenter Sites installation

    • <port> is the port of the WebCenter Sites installation

    • <context_path> is the context path where the WebCenter Sites web application is deployed

    • <username> is the WebCenter Sites administrator's user name

    • <password> is the WebCenter Sites administrator's password

    For example, the URL of the default configuration is:

    http://localhost:8080/cs/ContentServer?pagename=OpenMarket/Xcelerate/Installation/CIPCreateWorkflows&

    username=fwadmin&password=xceladmin

    When the workflows are installed, the following message will be displayed:

    "Workflows for Content Integration Platform were created successfully "

57.2.2 Verifying Sample Workflows

When the sample workflows are created, associated objects are also created in WebCenter Sites.

To verify the sample workflows and associated objects

  1. Log in to the WebCenter Sites Advanced interface as an administrator.

  2. Verify that the following objects have been created:

    • CIPAdmin role, which will be used as the management role for all CIP workflows. All users with the CIPAdmin role will be notified about all CIP events in the sample workflows.

    • Workflow processes:

      CIP Asset Created, CIP Asset Deleted, CIP Asset Deletion Failed, CIP Asset Modified, and CIP Asset ModificationFailed

    • Workflow states:

      CIP Asset Created, CIP Asset Deleted, CIP Asset Deletion Failed, CIP Asset Modified, and CIP Asset Modification Failed

    • Workflow step action:

      CIP Asset Deleted, which results in an email notice to the CIP administrators.

    • Email object:

      CIP Asset Event

57.2.3 Enabling Sample Workflows

Sample workflows are pre-configured in the default mappings.xml file. Each asset type that is listed in the default mappings.xml file contains a commented workflow configuration section.

To enable a CIP workflow

  1. Uncomment the following section for each asset type that you wish to enable for event notification:

    <descriptor-mapping sourceid="assetCreatedProcess" 
        targetid="CIPAssetCreated" type="static" />
    <descriptor-mapping sourceid="assetModifiedProcess" 
        targetid="CIPAssetModified" type="static" />
    <descriptor-mapping sourceid="assetDeletedProcess" 
        targetid="CIPAssetDeleted" type="static" />
    <descriptor-mapping sourceid="assetDeletionFailedProcess" 
        targetid="CIPAssetDeletionFailed" type="static" />
    
  2. Assign the CIPAdmin role to CIP administrators. Ensure that CIP administrators are able to receive email. For instructions, see Section 5.5.1, "Creating and Editing a User Profile."

  3. If the number of events occurring on the source system is relatively large, it is best to use workflow groups, as they will allow you to resolve tasks in bulk. Workflow groups are not packaged by default. They must be created manually. For instructions on creating workflow groups, see Chapter 10, "Creating and Managing Workflow Processes."

    Note:

    If a workflow group has the name of the invoked workflow process, the workflow process will be automatically added to the group.

    Sample workflows behave in the following way:

    • For creation, deletion failure, modification, and modification failure events, a task is assigned to all WebCenter Sites users with the CIPAdmin role. The task is simply a way of notifying the users of events and their propagation to the target system. The task can be removed; there is no obligation to take a step.

    • When an event occurs, only the first step of the corresponding workflow is taken. If the option Assign from list of participants for the first step is chosen, all members of the selected roles will be assigned the next task. (For simplicity, notification workflows comprise one state and two steps.)

    • For deletion events, all members with the CIPAdmin role receive an email notice. Because the asset no longer exists once the deletion event occurs, no tasks are displayed.