Records section (custom task)

The Records section specifies the record(s) whose ID is passed to the Java method.

The second section of the Custom task properties form is labeled Records.

on the Records section are fields used to identify a target record. The target record is used to determine the record(s) whose ID will be passed to the Java method.

There are radio buttons associated with the fields. The way that target records are used to determine the record(s) whose ID will be passed to the Java method depends on which one of the radio buttons is selected.

Here are descriptions of the fields:

Take the

This is a dropdown list that can have one of three possible values:

Business Object: If Business Object is selected, the record associated with the task specified by the field after this one will be the target record.
Secondary BO: This option is available if the workflow is launched in response to an Associate or De-Associate system event. If the value of this field is Secondary BO, the record at the other end of the association is the target record.
This option is also available if the workflow is launched in response to a SCHEVENTCREATE, SCHEVENTSTART, or SCHEVENTEND system event. If the value of this field is Secondary BO, the Event record that triggered the event is the target record.
Assignee: If Assignee is selected, the My Profile record of the user assigned to the task specified by the field next to it of this one will be the target record.

of Task

The value of this field is the label of the task that the target record will be associated with.

The radio buttons under these fields determine how the target record will be used to determine the record(s) whose ID will be passed to the Java method depends.

When the properties form is first displayed, only the currently selected radio button is visible. Click ↓ to toggle between showing all radio buttons and showing only the selected one.

The following descriptions explain the meaning of the radio buttons. There are fields that appear after some of the radio buttons. These fields contain additional information needed for the choice represented by the radio button.

Here are the descriptions:

Use it

If this is selected, the ID of the target record(s) will be passed to the Java method.

Use its Reference

If this is selected, the ID of record(s) referenced by a smart section or locator field of the target records will be passed to the Java method. When you select this radio button, a window pops up that allows you to choose from the smart sections and locator fields in the target record.

After you have selected this radio button, the name of the selected smart section or locator field is displayed in a read-only field next to the radio button.

Use its Association

If this is selected, the ID of record(s) associated with the target record will be passed to the Java method. When you select this radio button, a window pops up that allows you to specify the type of association to use. It allows you to identify the association by the type of record that must be on the other end of the association and optionally the name of the association.

After you have selected this radio button, if you specified an association name, the association name is displayed in a read-only field next to the radio button. The type of record that was selected appears in this section in the Object Type field.

Use any Associated BO from Module ____ of type ____

This option is useful when you want to specify an associated record without specifying which association to use. This option is also useful when the association defined in the Data Modeler was to the base business object and you do not know which type of business object in a module is selected at runtime.

When you select this radio button, you must specify a module, unless the module whose name appears next to the Module icon is the module that contains the business object used to create the record on the other end of the association. If that is not the correct module, click the Module icon. A list of modules will pop up. Click the correct module.

You may also specify that the record on the other end of the association must have been created by a particular business object in the specified module. If the name of a business object appears in the dropdown list next to the module name, the record on the other end of the association must have been created from the named business object. If -Any- appears in the dropdown list, then the record on the other end of the association may have been created from any business object in the named module.

To specify that a particular association name is required, click the Association icon. A list of the association types defined in the List Manager pops up. Click the association name that you want to appear next to the Association icon. To retrieve association records that are not restricted to a particular association name, click -Any- which appears on the list.

Use its Parent

If the target record is created from a business object that is part of a hierarchy module and this option is selected, then the ID of the target records' parent will be passed to the Java method.

When you select this radio button, a window pops up for you to select the business object that was used to create the parent record. This selection of a business object is not used for filtering. It is used to allow other tasks to access the parent's fields.

One of the choices for the business object that created the parent is -Any-. Choosing this will be the equivalent of selecting the module's base business object (the one with the same name as the module).

The section includes a read-only field labeled Object Type. The value displayed in this field is the type of the record whose ID will be passed to the Java method.