IBM FileNet P8, Version 5.2            

Creating a component queue

Use the options on the Add Component Queue Wizard pages to associate a Java™ application or Java Message Service (JMS) queue with a workflow queue.

To create a component queue:

  1. In Process Configuration Console, open the isolated region.
  2. Select the Component Queues folder icon and click New on the toolbar.
  3. Enter a name for the queue in the Queue name box. After a successful commit of the changes, the name will appear in the list of component queues in Process Designer.
  4. In the Description box, you can optionally enter a brief description of the queue.
  5. Click Next to continue.
  6. To configure the adapter, do one of the following actions:
    Option Action
    To configure a new component queue Continue with the following step.
    To modify the configuration of an existing component queue For legacy Java component queues, ensure that the JAR file that contains the classes is available on the local computer, and then make the desired changes.
    To modify CE_Operations Note that you can modify only some of the properties of the CE_Operations, as is reflected in the user interface.

    CE_Operations functionality is part of the Content Platform Java component.

  7. In the Adapter list, choose the appropriate adapter.
    • IBM® FileNet® Web Services and Open Client support only Java applications for components.
    • For Workplace or Workplace XT, you can also choose Legacy JMS component.
  8. Complete the following actions for your component:
    Option Description
    Java component Complete the configuration steps in Configure a Java component adapter.
    JMS component Complete the configuration steps in Java Message Service configuration window (Workplace only).
    Legacy component To configure legacy components, see the documentation for version 5.1 or earlier.
  9. On return from the configuration window, specify the following adapter properties:
    Table 1. Table of field names and description for the Adapter Properties
    Name Description
    Batch Size The amount of step elements to query per batch at runtime. The suggested minimum is 10.
    Polling Rate The amount of time, in milliseconds, between polls of the associated component queue to look for work; 1000 is equivalent to polling once per second. Frequent polling can impact system performance if the queue tends to be empty.
    Exception Submap The submap to be used when this component encounters exceptions. The default is Malfunction. See About system maps for more information on submaps.

    If your component has an error during execution, the work item contains a summary of the exception text. Therefore, it is advantageous to know where to look for the work object. If you retain the Malfunction submap, the work object will go to the Conductor queue. If you define a custom exception handling submap for the component adapter, the work item is sent to that map.

    Processing Timeout The maximum amount of time, in milliseconds, for processing each step in the component method.
    Auto Recovery Timeout The amount of time after which a locked work object in the component queue will be dispatched to the exception submap. This is the recovery behavior to handle work objects that have been locked due to server crashes or adaptor classes that are not working properly.
  10. Specify the JAAS credentials.

    If the component code does not have any external authentication requirements, you do not need to specify the JAAS context.

    If you specify a JAAS context, you should use the administrative tools provided by the application server hosting the Content Platform Engine server to configure the JAAS context with the appropriate login modules, and ensure that the login modules are available to the application server. The login modules can be part of the Code Module for the component.

    If the CELogin was used for the compatibility of the Java API (3.5 Content Engine Java API), you must specify the JAAS credentials. However, it is recommended that you rewrite the component to use the current API.

    By default, the CE Operations credentials are the bootstrap user credentials.

    Table 2. Table of field names and description for the JAAS Credentials
    Name Description
    User name A valid user name. The user name serves as Java Authentication and Authorization Services (JAAS) credentials for identification and permissions for both the workflow system and any external systems that are accessed.

    The user must have Query and Process access to the component queue, as defined in Process Configuration Console. Component Manager reports an error when starting the component if the user does not have sufficient access rights.

    Password The password associated with the user name.
    Configuration context The name of the set of login modules JAAS uses for this component. For further information, see Developing Component Integrator-Based Workflow Applications.
  11. Click Finish when done.
  12. To complete the configuration, define the operations for the component queue.
    Note: On the Component Properties window, you can specify exposed fields, indexes, and security for this component, as well as change the adapter and operation properties.
  13. Click Commit to apply these changes to your isolated region.

    You can commit the changes immediately, or you can wait until you have finished all your changes.



Feedback

Last updated: October 2013
bpfc084.htm

© Copyright IBM Corporation 2014.
This information center is powered by Eclipse technology. (http://www.eclipse.org)