Configuring Business Process Weaver

App Class ID

Unique ID that the application developer assigns to the application class. It is used to reference the application class.

App Class Type

Identifies the type of the application class being registered. Values are:

• Event Handler - The application class is used as event handler. It must be a subclass of BUSINESS_PROCESS_WEAVER:API:EventHandler.

• Task Handler - The application class is used as task handler. It must be a subclass of BUSINESS_PROCESS_WEAVER:API:TaskHandler.

Root Package ID, Qualified Package/Class Path, and Application Class ID

These required fields provide the full path to the application class. When the data is saved, the fields are edited to ensure that the application class is a proper subclass of either Event Handler or Task Handler. To prevent users from removing an App Class ID that is still being used by Business Process Weaver, App Class ID and App Class Type are display-only, and the row cannot be deleted if the App Class ID is currently being used. App Class IDs are used in the:

• Task Registry, either as Event Handler or Task Handler.

• Business Process Definition.

• Business Process Run Control.

• Business Process Instance that has not been finished.

Entry Point and Entry Point Description

Select from all defined entry point IDs by entry point and description.

The entry point allows the user to initiate the process as defined on the Business Process Definition page. See Defining Business Processes for more information about the Business Process Weaver definition referenced by the entry point.

Business Process Type

Select from these values:

• SYS: A system-defined business process.

• USER: A user-defined business process.

Process Weaver ID and Process Weaver Description

Select from all defined Business Process Weaver processes.

Dynamic Run Control

Select from these values: Y (yes) or N (no).

Yes indicates that all BPW step run controls are configured at runtime in PeopleCode. There is no need to go to the Business Process Run Control page to configure step run control parameters. The Business Process Weaver step run controls must set up properly before the Business Process Weaver process is started.

Active

Indicates that an entry point is active or available to be used.

Task ID

Unique ID that is assigned to the task. It is used to reference the task in BPW.

Task Type

Indicates the type of task. Values are:

• App Class - The following search fields appear: Task Handler ID, Description, and Event Handler ID. This option indicates that the task is associated with an App Class (Task Handler that is set up in the Application Class Registry page), which is responsible for executing the step. When this value is selected, you must enter the Task Handler ID, and optionally the Description and Event Handler ID.

• Job - Indicates that the task is a Process Scheduler job. When this value is selected, you must enter a Process Job Name.

• Process - Indicates that the task is a Process Scheduler process. When this value is selected, you must enter values for both Process Type and Process Name.

  Note: Processes that cannot be run individually should not be registered. For example, AR_POST1 through AR_POST8.

Description

Description of the task. If you do not enter a description, the field adopts the description of the App Class, Job, or Process.

Process Type and Process Name

Fields are required when the Task Type is Process to specify the Process Type (for example, Application Engine) and the Process Name (for example, Application Engine program name).

Job Name

Required when the Task Type is Job to specify the Job to execute.

Task Handler ID, Task Handler Parameter

When the Task Type is App Class, the Task Handler ID must be entered to indicate the application class that is responsible for executing the task. Task Handler Parameter is optional and can be used to pass information to the Task Handler application class.

Event Handler ID, Event Handler Parameter

If an event handler is associated with the task, enter its App Class ID as Event Handler ID. Optionally populate the Event Handler Parameter to provide any parameter value to the event handler.

Run Control Prompt Record

Enter the record name of the run control record used by the task. This usually is keyed by user ID and run control ID. If it is provided, BPW can check the existing run controls and display the run control status on the Business Process Run Control and Review pages.

Run Control Required

If the Run Control Prompt Record is provided, you can indicate whether the run control is required before the task can be executed. If this is selected and if no run control is found, the step (task) cannot be started or executed. You will need to set up the run control and then manually start the step or choose to skip the step.

Menu Name, Menu Bar Name, Item Name, Panel Name, Menu Action

These fields enable you to set up the menu/component/page to the run control setup page for the task. If these are set up, you can open the run control setup page directly on the Business Process Run Control or Review pages. For batch processes or jobs, the menu action is always “Add”; therefore, Menu Action is not available when Task Type is Process or Job.

Output Type, Output Format

Select the output type and format for the task.