Call instruction parameters

The Call instruction requires an activity name in the Method field, a check box for sharing the parameter page, and optionally a variable number of parameters for the called activity.

Parameter Description

Parameter	Description
Activity (in the Method field)	Identify the activity you are calling. Type `Call` followed by a space and the Activity Name key part of an activity. To locate the activity with rule resolution at runtime, the system uses the class of the step page as the initial Applies To key part, and searches the class hierarchy for an activity of that name. If the Step Page field is blank, the system uses the Applies To key part of this activity as the initial Applies To key part. Optionally, you can identify the Applies To key part of the called activity explicitly, using the format: `Call Data-Admin-Operator-ID.Analyze` `Call MyCo-Finance-Work-Form990.Validate` Note: The explicit class format causes rule resolution to bypass all class hierarchy searches — the activity must be present in the specific class identified before the dot. (Other aspects of rule resolution operate normally.) Because use of explicit class names can introduce inflexibility, complicate debugging, and reduce opportunities for rule reuse, avoid this format whenever possible. When you save an activity, CALL steps that use this format cause a rule warning.
Pass current parameter page	Select to cause the calling activity's parameter page to be passed to (shared with) the called activity, which can alter its contents in any way. Clear to use the array that appears below the check box to pass parameters to the called activity. If you select this box, the parameter page remains available to the calling activity after the return. This capability is sometimes known as call-by-reference. Note: If you select this box, make sure that input parameter values needed by the called activity are present on the parameter page before calling the activity.
Value	If you did not select the Pass current parameter page check box, complete values for parameters of the called activity. Enter literal or property reference values for each parameter that you want to have a value. These icons may appear: — Marks required parameters — Marks output parameters Images do not appear for parameters that are designated as both input and not required. CAUTION: Do not use a local variable to hold an output parameter. Do not enter a constant as the value of an output parameter. The system creates a parameter page for the called activity that is separate from the calling activity's parameter page. The called activity's parameter page is destroyed upon return.

Activity (in the Method field)

Identify the activity you are calling. Type Call followed by a space and the Activity Name key part of an activity.

To locate the activity with rule resolution at runtime, the system uses the class of the step page as the initial Applies To key part, and searches the class hierarchy for an activity of that name. If the Step Page field is blank, the system uses the Applies To key part of this activity as the initial Applies To key part.

Optionally, you can identify the Applies To key part of the called activity explicitly, using the format:

Call Data-Admin-Operator-ID.Analyze

Call MyCo-Finance-Work-Form990.Validate

Note: The explicit class format causes rule resolution to bypass all class hierarchy searches — the activity must be present in the specific class identified before the dot. (Other aspects of rule resolution operate normally.) Because use of explicit class names can introduce inflexibility, complicate debugging, and reduce opportunities for rule reuse, avoid this format whenever possible. When you save an activity, CALL steps that use this format cause a rule warning.

Pass current parameter page

Select to cause the calling activity's parameter page to be passed to (shared with) the called activity, which can alter its contents in any way. Clear to use the array that appears below the check box to pass parameters to the called activity.

If you select this box, the parameter page remains available to the calling activity after the return. This capability is sometimes known as call-by-reference.

Note: If you select this box, make sure that input parameter values needed by the called activity are present on the parameter page before calling the activity.

Value

If you did not select the Pass current parameter page check box, complete values for parameters of the called activity. Enter literal or property reference values for each parameter that you want to have a value. These icons may appear:

— Marks required parameters
— Marks output parameters

Images do not appear for parameters that are designated as both input and not required.

CAUTION:

Do not use a local variable to hold an output parameter. Do not enter a constant as the value of an output parameter.

The system creates a parameter page for the called activity that is separate from the calling activity's parameter page. The called activity's parameter page is destroyed upon return.

You can also pass a reference to a clipboard page as a parameter. The called activity can then use this Page Name parameter as if it were the clipboard page. See Passing Page Name parameters for details. An older, alternative way to pass pages between activities (using the indirect page mechanism) is no longer recommended and has been deprecated.