The BusinessWorks Step Definition Dialog

1. The BusinessWorks Step Definition dialog is displayed. In the Introspection Mode area, select the introspection method you want to use. See Understanding the Introspection Methods for more information about introspection methods.

Select one of the following options:

— Import Process Definition. Select this if you wish to use the interface file introspection method. If you select this method then, from the BusinessWorks Interface File box, click to browse to the location of your interface file. The interface file contains the connection information and BusinessWorks process definitions that the iProcess Engine needs to communicate with BusinessWorks. It is created using the iProcess Service Agent resource in BusinessWorks. See Creating an iProcess Service Agent Resource for information on how to create a BusinessWorks interface file.

If the interface file contains a JMS queue and/or JMS provider that has not been configured in the iProcess BusinessWorks step, then the BusinessWorks Step Definition wizard displays the Add a new JMS Provider dialog so that you can configure the new JMS queue and/or JMS provider detailed in the interface file. See Adding a New JMS Provider for details of this dialog.

Click the Test button in the BusinessWorks Step Definition dialog. This will test the connection to the JMS provider.

— Live link to BusinessWorks. If you selected this method then from the JMS Destinations box, select the JMS queue you want to send JMS messages to.

Depending on your requirements you can add new JMS queues, or modify, copy and delete existing JMS queues by using the Add, Modify, Copy and Delete buttons from the iProcess Service Agent area of the BusinessWorks

Step Definition dialog. See Administering JMS Providers and Destinations for more information.

You can also add new JMS providers or modify, copy and delete existing JMS providers. See Managing JMS Providers for more information.

If the Destination information in the iProcess Service Agent area has changed, you must now click Refresh to display an updated list of processes in the Process field. Until you do this neither the process list nor the Test button is available.

Click the Test button in the JMS Connection box of the BusinessWorks Step Definition dialog. This will test the connection to the JMS provider. If there is any problem, this will help you determine whether the fault is with the JMS connection or with BusinessWorks.

2. From the Processes drop-down list, select the BusinessWorks process that you want to invoke. See Invoking iProcess Engine from BusinessWorks for more information about defining BusinessWorks processes.
3. Specify the Invocation Style. This determines how the iProcess Engine should handle the BusinessWorks step. It can be one of:
— Immediate Release  The iProcess Engine will wait for a reply before continuing to process other cases. This is the default.
— Delayed Release  The iProcess Engine does not wait for a reply and continues to process other cases. This means the BG process continues to work without being slowed down if the BusinessWorks system is busy. If an error occurs, an error code, error message, and BG action flag will be sent back to iProcess Engine and logged to the audit trace.

If you select Delayed Release, the Manual field is also selected; automatic delayed release is not supported in this version.

Existing BusinessWorks processes, developed with previous versions of the iProcess Connector for ActiveMatrix BusinessWorks, are assumed to be immediate release, since delayed release was not supported in previous versions of the iProcess Connector for ActiveMatrix BusinessWorks. If you want the existing BusinessWorks processes to use delayed release, these processes need to be modified

Note:
— The Delayed Release option is disabled if the schema for the process has no input parameters. In that case, the Delayed Release ID could not be mapped to a suitable field (see Overview of the Invocation Process From BusinessWorks).
— If the schema has both input and output parameters, and you select Delayed Release, the Output tab is disabled. A warning message is displayed suggesting that you carry out the output mapping in BusinessWorks rather than in the iProcess Engine.
— If the step is subject to delayed release, the BusinessWorks process that is to be instantiated by the step must use the iProcess Complete Delayed Release activity to complete the delayed release. See iProcess Complete Delayed Release for details of the activity.
— The Delayed Release tab in the Edit Step Definition dialog is not used. Delayed Release is specified only by selecting the Delayed Release option in this dialog.
— If you try to purge a case that is subject to delayed release but has not yet been released, the purge may fail. Prevent this by setting the CHECK_EAIWITHDRAW_ONPURGE process attribute to 0. See the section "Administering Process Attributes" in TIBCO iProcess Engine Administrator’s Guide for details of this attribute.
4. Click Next to continue. The Define iProcess to BusinessWorks Mappings dialog is displayed.