Exposing Composite Forms as Callable Objects

Use

To use composite forms in Guided Procedures (GP) processes, you must integrate the composite form objects that you have created in callable objects.

Callable objects are the most fine-grained components in a GP process, which add an abstraction layer to applications and services enabling their seamless integration in workflows.

Prerequisites

You must have created and activated the composite form object that you want to use in the callable object.

More information: Creating Form Objects in the GP Design Time

Procedure

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

From the Type list, select Form → Composite Form and enter the required basic data as follows:

Parameter	Description
Name	Enter an arbitrary name for the callable object.
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. Note You can either use an existing folder, or create a new one.

Choose Next to open the Define Object screen.
1. To select a form object, use Choose.
  Browse the gallery to select the form you need, and confirm your choice using Select.
  
  You can add an activated form object only.
2. Choose the e-mail address where the form is to be sent.
  - You can choose to send it to the step processor's e-mail. It is retrieved from the underlying user management system.
  - You can also configure the callable object to send an e-mail to a custom e-mail address that is specified as an input parameter for the composite form object at runtime.
3. Optionally, you can select a custom e-mail template for the form mail message.
  To do this, enable the option Choose E-Mail Template, and use Choose E-Mail Template to select the appropriate template.
4. Optionally, when submitting forms through mail, you can select a communication setting (different from the default one) for mail connection.
  To do this, enable the option Choose communication setting name for sending mailand select the setting you want to use for this composite form.
  
  You are not required to make a communication setting on both the Composite form object and the callable object in which it is integrated. However, in case you set different communication settings on the two objects, the GP framework will use the communication setting of the callable object.
  
  For more information about configuring communication settings and setting a default one, see Configuring Adapters .
5. For Step Completion, choose one of the following options:
  - To enable the callable object to send the form only without completing the process step, choose Send Form. The processor completes the step by submitting the filled-in form.
  - To enable the callable object to send the form and complete the step, choose Complete Step.
Choose Next to open the Define Input screen.
The form object's input parameters are displayed in read-only mode.
Choose Next to open the Define Output screen.
The form object's output parameters are displayed in read-only mode.
Choose Next, and then Finish and Open.
The design time for the callable object opens. You can edit its definition, if required.

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

Result

Once you have exposed the composite form as a callable object, you can use it in an action together with a display callable object. It allows you to monitor the composite form step by generating a task for it. This task is visible in the GP worklist and UWL at runtime.

More information: Using a Display Callable Object for Forms

Example

You can expose a composite form as a callable object and then include it in a process.

More information: Developing Your First Composite Form Process .