Copyright © Cloud Software Group, Inc. All rights reserved.

Defining an EAI Step

To define an EAI step in your procedure:

3.	In the TIBCO iProcess Modeler, click the EAI Step tool then place it on your procedure definition.

4.	The EAI Step Definition dialog is displayed.

5.	Enter the Name and Description for the step.

6.	In the EAI Type drop-down list, select the appropriate entry for the plug-in you want to use. (For example, for a SQL EAI step, select EAISQL - SQL EAI step plug-in.)

You must select an entry when you first create the step; it cannot be changed later. The list box displays EAI step types that are available as client EAI plug-ins. This name is used as the link between the EAI step and the run-time plug-in registered on the iProcess Engine(s).

If the appropriate EAI step does not appear in the drop-down list, you need to make sure the plug-in is installed using the Options > Install EAI plug-in menu option. (Refer to the appropriate EAI plug-in installation documentation for installation instructions.)

7.	(Optional) Select the Don’t delete work items on withdraw option. If this option is selected, and the deadline on an outstanding step expires or it is withdrawn as an action (release or deadline expire) of another step:

−	the deadline actions are processed.

−	the step remains outstanding (the step remains in the workqueue or the sub-procedure case is not purged).

−

when the step is released (or the sub-procedure case completes) the normal release actions are not processed but the case field data associated with the release step (e.g. the field values set in a normal step whilst in a work queue or the output parameters of a sub-case) is applied to the main case data.

8.	(Optional) Click the Ignore Case Suspend check box if you want the EAI step to still be processed as normal while a case is suspended by a TIBCO iProcess Objects or SAL application.

If Ignore Case Suspend is not checked (the default option), the EAI step is not processed while the case is suspended. This means that:

−	work items generated by the EAI step are marked as unavailable and cannot be opened (until the case is re-activated.)

−

deadlines on work items generated by the EAI step are not processed. The date and time at which deadlines are due are not affected, and deadlines continue to expire. However, no actions are processed when a deadline expires. When the case is re-activated, any expired deadlines are immediately processed.

Cases can only be suspended and re-activated from a TIBCO iProcess Objects or SAL application. Audit trail messages indicate whether a case is active or suspended. Refer to the TIBCO iProcess Objects documentation for more information about suspending cases.

9.

Click:

a.	the Deadlines tab if you want to enter deadline information for this step. (Refer to “Defining Deadlines” in the TIBCO iProcess Modeler - Basic Design guide for an explanation of defining deadlines.)

b.	the Audit Trail tab to define custom audit trail entry expressions.

c.	the Delayed Release tab to define delayed release settings.

10.	On the General tab, click EAI Call-Out Definition.

The name of this button may be different depending on the EAI Type you have selected.

11.	A dialog specific to your chosen EAI step type is displayed. This allows you to enter the specific information required by your chosen EAI step type.

The layout of this dialog and the information you need to supply differ according to the type of EAI step. For more information, either:

−	click the Help button in the step type dialog.

−	choose the appropriate entry for the step type from the Help > Plug-ins menu.

For example, if you want to define a SQL EAI step:

a.	Select EAISQL - SQL EAI step plug-in from the EAI Type drop-down list. The EAI Call-Out Definition button changes to Edit Stored Procedure Call-Out, and is enabled.

b.	Click Edit Stored Procedure Call-Out. The SQL EAI Step dialog is displayed.

Custom Audit Trail Entry Expressions

Click the Audit Trail tab to define custom audit trail entry expressions. This enables you to define text expressions that are evaluated when the step is processed and inserted as the %USER value in the audit trail entries.

You must either enter a value in both of the following fields, or leave them both empty:

•	In the Call-out Initiated field, enter a valid text expression that will replace the %USER value in the audit trail when the call out is initiated.

•	In the Call-out Complete field, enter a valid text expression that will replace the %USER value in the audit trail when the call out is complete.

Delayed Release Settings

Click the Delayed Release tab to define delayed release settings.

Select one of the following options:

•	Never - The step is never set to delayed release so it will be released immediately.

•	Always - The step will be released by the external application.

Conditional - The step will be delayed release if a specific condition expression evaluates to True. If you select this option, you need to enter a valid condition expression following the IF statement. For example, IF DO_DEL_REL= “Yes”.

The run-time plug-in on the server can override these settings if it returns a status of Delayed Release when the step is processed. Refer to the TIBCO iProcess Plug-in SDK User’s Guide for more information about how the plug-in interfaces operate.

Copyright © Cloud Software Group, Inc. All rights reserved.