Callable Object Parameters 

Use

In Guided Procedures (GP), you can define input and output parameters for the callable objects that you create.

The availability of parameters depends on the callable object type, and on the implementation of the underlying application or service.

For certain types of callable objects, such as Web Dynpro components, and so on, the implemented input and output parameters are automatically detected and you can only modify the order in which they are displayed. For other callable object types, such as Web pages, or content packages, you can define certain input and output parameters manually, if required.

When you attach callable objects to actions, and include them into blocks and processes, you can consolidate their parameters with those of other actions to define a group of parameters that take the same value.

Parameter Properties

A callable object parameter has the following properties:

Property	Description
Name	This is an arbitrary name that is used for display purposes. The names of the input parameters for the Web page callable object type are used as URL parameters.
Technical Name	The technical name must be unique. You can use the following characters to form the technical name: ●      Upper- and lowercase letters from the Latin alphabet ●      Digits from 0 to 9 ●      Underscore ●      Hyphen ●      Period
Namespace	You can define a namespace for the parameters of your callable object. Parameters of type Structure Template have a predefined namespace.
Original Language	The original language is relevant for translation purposes.
Type	The type of the parameter may be one of the listed below.
Is List	If this option is enabled, the parameter may contain multiple values.
Is Required	If this option is enabled, the parameter is required. The Is List and Is Required options are displayed jointly as a Cardinality property. Cardinality, also known as multiplicity, is expressed in the following way: ■       0..1 – at most one value possible ■       0..n – zero or more values possible ■       1..1 – exactly one value possible ■       1..n – one or more values possible

Parameter Types

You can define parameters of the following standard types:

Decimal	String	Byte and unsigned byte
Double	Date	Integer and unsigned integer
Float	Time	Long integer
Binary	Timestamp	Short and unsigned short integer
Boolean

In addition, GP defines the following specific types:

●      Reference to BO

You can define an object view that you have previously created as a parameter of this type. More information: Creating Object Views

●      Structure

A parameter of this type is a complex structure that may hold other parameters. It does not have its own value that can be assigned at runtime. As a consequence, empty structures make no sense and cannot be consolidated.

●      Structure Template

A structure template is a complex parameter with a predefined structure that you cannot change. Structure template parameters are either forms or files.

Parameter Configuration

You can configure parameters at action, block, and process level once you have included the callable object in the process flow. To be able to do this correctly, you must be aware of the underlying concepts related to parameter contexts.

Each GP activity (action, block, or process) has its own parameter context, also known as the local context. Parameters from the local context are only visible to activities up in the process hierarchy (parent activities) if they are exposed in, or propagated to, the input and output parameter sets of the child activity. All parameters that you create are exposed by default. You can choose to hide them at action, block, or process level.

Using the tools of GP design time at the action, block, or process level, you are able to:

●      Filter and sort parameters using a set of predefined and custom criteria

More information: Searching in the Parameter List

●      Define which parameters need to be exposed in upper contexts

●      Copy and paste already defined parameters from one callable object to another

●      Assign default values to parameters

More information: Configuring Parameters

Parameter Consolidation

Finally, you can consolidate parameters from different actions or blocks to achieve a seamless data flow. The following scenarios are possible:

●      You consolidate parameters of the same type – either input or output. At runtime, you enter a value once, and it is valid for all parameters in the group.

●      You map the input parameters of a callable object to the output parameters of the same object. In this case, you retrieve the values of the output parameters from the relevant input parameters.

●      You map the output parameters of a callable object to the input parameters of another callable object. At runtime, the input for the second object is automatically retrieved from the output for the first object.

Guided Procedures imposes a set of rules and restrictions, which you have to observe when performing parameter consolidation. It also offers various tools to facilitate the process.

More information: Consolidating Parameters

Since parameters are propagated in the order Callable Object  → Action  → Block  → Process, you must first consolidate parameters at block level and then at process level.

Consolidation at action level is optional, but you must start with it if you intend to perform it.