Show TOC Start of Content Area

Procedure documentation Configuring Parameters  Locate the document in its SAP Library structure

Use

For the callable objects that you create, you can define input and output parameters. When the callable object is attached to an action, the parameters are inherited by the action and are then propagated further to the block and process level.

At action, block, and process level, you can define additional parameters, expose existing parameters, configure default values for them, or change their technical names.

At callable object level, you can reuse parameters defined for one callable object in another.

Prerequisites

      You have the appropriate rights to work with Guided Procedures (GP) design time.

More information: Authorizations

      You have created a block or a process containing actions with callable objects that expose input or output parameters.

Procedure

Viewing Parameter Properties

...

       1.      In the gallery, select the required action, block, or process, and choose Open….

The object’s design time opens.

       2.      Open the Parameters tab page.

All root-level parameters in the local context of the object are displayed.

Note

To be able to view all nested parameters, choose Expand All if no selection is made. If you select a particular Structure parameter, choose Expand to view its nested parameters only. To hide nested parameters, use Collapse All and Collapse by analogy.

For each parameter, you can view the following properties:

       Display Name – the parameter name

       Defined For – the callable object, action, or block for which the parameter is defined

       Type – such as String, Structure and so on

       Cardinality – occurrence constraints of the parameter

       Input/Output – specifies if the parameter is defined as input or output

Icon

Description

This graphic is explained in the accompanying text

Input parameter

This graphic is explained in the accompanying text

Output parameter

This graphic is explained in the accompanying text

Parameter that is both input and output.

For example, groups that contain both input and output parameters are represented by this icon.

       Exposed In (Exposed Out) – parameter that is visible in the input or output context and can be propagated to a higher level in the process. The option is enabled by default.

       3.      To display other parameter attributes, choose Show Details. Two additional columns appear:

¡        Technical Name – the unique identifier of the parameter

¡        Namespace – within this space, parameters must be unique

       4.      (Optional) You can sort parameters or search for parameters by specifying a set of criteria.

More information: Searching in the Parameter List

Configuring Parameter Properties

...

Switch to edit mode by choosing This graphic is explained in the accompanying text (Edit) and, where required, configure the following options:

      Assign default values (available for root-level input parameters only)

                            a.      Select a root-level input parameter from the list and choose Default Value.

                            b.      In the Value field, enter a value.

                            c.      Choose Set.

      Change technical names (available for root-level parameters only).

Click in the Technical Name field of a root-level parameter and enter the new technical name.

Note

Since technical names must be unique within a namespace, the system automatically renames duplicate parameters in the format <user-defined technical name>.<sequence_number>. For example, parameters with technical name myParameter appear as myParameter.1, myParameter.2, and so on.

      Disable the Exposed In (Exposed Out) options to hide parameters from activities that are higher in the process hierarchy.

In more complicated scenarios where you have Structure parameters containing numerous child parameters, you can decide to expose only some of them. However, it is not possible to expose a child parameter without exposing the Structure itself.

      At action or block level, define additional parameters if required.

For example, you may need to specify the processor of a step dynamically at runtime. Instead of creating a separate callable object, you can create a parameter that holds the logon ID of the user. You can then configure the relevant process role with the option Filled from Context Parameter.

To define additional parameters:

...

                            a.      Open the design time of an action or a block.

                            b.      Open the Parameters tab page.

                            c.      Choose Additional Parameters.

                            d.      For each parameter that you want to create, choose Insert New and configure the relevant attributes (name, type, cardinality and so on).

                            e.      To save all additional parameters, choose Apply.

Note

Additional parameters at action and block level differ from other parameters only in their fixed namespace, which is by default http://www.sap.com/nw/eup/gp/local/additionalparameters.

Reusing Parameters

Guided Procedures allows you to reuse parameters already defined for a particular callable object in another callable object. You can do this when you want to create identical parameters that need to be consolidated.

There are two basic ways to reuse parameters:

      You can copy and paste parameters within a single session on the same system.

...

                            a.      In the gallery, open the design time of a callable object for which you have already defined parameters and open the Parameters tab page.

                            b.      Select a parameter from the list and choose Copy.

                            c.      Open the design time of the callable object for which you want to define parameters.

                            d.      Switch to edit mode by choosing This graphic is explained in the accompanying text (Edit) and open the Parameters tab page.

                            e.      If you want to paste the parameter at root level, choose Paste. Otherwise, select a parent structure and then choose Paste.

                              f.      (Optional) Use Copy All and Paste All to copy all parameters from the callable object context.

      You can export and import parameters in another session or on a different system.

...

                            a.      Open the design time of the callable object for which you have already defined parameters and open the Parameters tab page.

                            b.      Select a parameter from the list and choose Export. To export all parameters, choose Export All.

Parameters are saved in an XML file which you can download to your local machine using the Download link provided. If you want to use the parameters in a process on a different system, make sure that you transfer the file in advance.

                            c.      Choose Close.

                            d.      Open the design time of the callable object for which you want to define parameters. It may be on a different system, or you may have initiated a new portal session.

                            e.      Switch to edit mode by choosing This graphic is explained in the accompanying text (Edit) and open the Parameters tab page.

                              f.      Choose Import and browse to locate the XML file you exported previously.

                            g.      Choose Import under Import Parameters.

                            h.      Once the file is imported, choose Close.

To avoid duplicate names (if any), the system appends a sequence number to the display and technical names of the parameters that are copied or exported. For example, My Parameter with a technical name myParameter, becomes My Parameter 1 with a technical name myParameter1.

Note

Reusing parameters is also available for the additional parameters defined at action and block level.

Result

Once you have configured parameters, you can consolidate them if necessary.

More information: Consolidating Parameters

End of Content Area