Exposing Web Dynpros as Callable Objects (SAP Library - Creating Callable Objects in the GP Design Time)

Exposing Web Dynpros as Callable Objects

Use

The Guided Procedures (GP) framework enables you to expose Web Dynpro components and applications as callable objects. This allows you to integrate existing applications in the processes you have created with GP.

You can expose:

· Web Dynpro components – these are components that implement the GP interface for Web Dynpro callable objects. For more information, see Implementing a Web Dynpro Callable Object.

· Web Dynpro applications – any application that has been deployed on the Application Server (AS) Java

· ABAP Web Dynpro applications – any ABAP application that has been deployed on the AS ABAP

Note

If ABAP is not explicitly mentioned in Web Dynpro applications, assume that the application is Java-based.

Prerequisites

The Web Dynpro component or application must be deployed on the AS Java.

Procedure

Exposing a Java Web Dynpro Component

...

1. Open the gallery and choose Create Callable Object from the contextual panel.

2. From the Type list, select User Interface → Web Dynpro Component (GP Interface) and enter the required basic data as follows:

Parameter	Description
Name	Enter a name that is used to distinguish the callable object in the gallery.
Description	Describe the callable object by entering a brief description of its functions, for example.
Original Language	Choose the language in which the translatable texts of the callable object definition are being created.
Folder	Select a folder in the gallery where the callable object definition is stored. You can either use an existing folder, or create a new one.

3. Choose Next.

Select the required Web Dynpro component from the list.

4. Choose Next.

If input parameters have been implemented for the component, they are displayed in the Define Input step. Otherwise, the step is skipped.

If output parameters have been implemented, they are displayed in the Define Output step.

Note

You can only change the order in which the parameters are displayed.

If configuration parameters have been implemented, they are displayed in the Set Configuration step. Maintain the parameters as required.

Note

The configuration parameters depend on implementation and may vary for each Web Dynpro component.

5. Choose Next, and then Finish and Open.

The design time of the callable object opens. You can edit the object definition here.

Optionally, you can grant permissions to other users to view or modify the object. To do that, open the Permissions tab page.

6. To activate the object, choose This graphic is explained in the accompanying text (Activate).

Exposing a Java Web Dynpro Application

...

1. Open the gallery and choose Create Callable Object from the contextual panel.

2. Enter the required basic data as follows:

Parameter	Description
Type	Select Web Dynpro Application.
Name	See above
Description	See above
Original Language	See above
Folder	See above

3. Choose Next.

Select the required Web Dynpro application from the list.

4. Choose Next.

Define the input parameters of the callable object. For a Web Dynpro application, these are the required and optional parameters that you want to add to the URL string.

a. Choose Insert New.

b. Fill in the required data as follows:

■ Technical name – enter the name of the parameter as it is required for the URL

■ Name – enter an arbitrary name for the parameter. It is used for display purposes only.

■ Original Language – from the dropdown menu list select the language in which you are creating the parameter. It is considered when the callable object data is translated.

■ Type – choose the type of the parameter. Typically, it is a string.

c. Optionally, choose whether the parameter requires a list of values (option List), and whether it is a required parameter (option Value required).

5. Choose Next.

Choose whether a button Complete is to be displayed when the callable object is executed to enable the user to send an explicit completion event to the framework.

6. Choose Next, and then Finish and Open.

The design time of the callable object opens. You can edit the object definition here.

Optionally, you can grant permissions to other users to view or modify the object. To do that, open the Permissions tab page.

7. To activate the object, choose This graphic is explained in the accompanying text (Activate).

Exposing an ABAP Web Dynpro Application

...

1. Open the gallery and choose Create Callable Object from the contextual navigation panel.

2. Enter the required basic data as follows:

Parameter	Description
Type	Choose ABAP Web Dynpro Application.
Name	See above
Description	See above
Original Language	See above
Folder	See above

3. Choose Next.

a. Choose the RFC destination, which defines the parameters for connection to an external service provider. To do that, use Choose…

Once chosen, the name and the type of destination appear. To see more details, choose Definition.

Note

To be able to choose a destination, you should have created one.

See: Maintaining RFC Destinations

b. Enter the ABAP Web Dynpro application’s name and choose Search.

Once found, the name and the description of the application appear.

4. Choose Next.

The input parameters that have been implemented for the component are displayed.

Note

Currently only input parameters of type String are supported and it is not possible to add input parameters. You can only change the order in which the parameters are displayed.

5. Choose Next, and then Finish and Open.

The design time of the callable object opens. You can edit the object definition here.

Optionally, you can grant permissions to other users to view or modify the object. To do that, open the Permissions tab page.

6. To activate the object, choose This graphic is explained in the accompanying text (Activate).

Example

For an example of how you expose a Java Web Dynpro component as a callable object, see Creating an Instance of the Callable Object.