Web Form

An AgileWork that uses a web page as the user interface for a manual activity.

The web page's URL is configurable and can include URL parameters. Therefore, one common use of this AgileShape is to associate several different activities with the same web page. Each AgileShape instance can pass different input to the web page via URL parameters in order to make the web page initialize appropriately for each individual activity. 

As an alternative to URL parameters, you can also set up variables using user defined properties.



Prerequisites

  • Generic process template.

Good to Know

  • If a SharePoint list is customized using the Customize Form (InfoPath) option in the SharePoint ribbon, the WebForm AgileShape must be used instead of ListForm shape in the process. In addition, the URL in WebPageUrl property must be specified.

Navigation

  1. In AgilePoint Envision, open a process template.
  2. Navigate to the Premier Extension stencil.
  3. On the Premier Extension stencil, drag the WebForm AgileShape, and drop it on the process template.
  4. To view the entire list of properties, in the Design Tasks pane, click Show Properties.

Properties for This AgileShape

Field Name Definition

UserDefinedProperties

Opens the Following Window:
User Defined Properties Window
Purpose of this Window:
Specifies ClientData values that are associated with the AgileShape's associated tasks at runtime. This is a way for you to specify a set of variable-like name/value pairs that are passed to your web page via a WorkItem object. This is an alternative to passing data via URL parameters. On your web page you can retrieve this data via the ClientData property of the WorkItem and use it however you want.

WebFormControls

Opens the Following Window:
Web Form Controls Window
Purpose of this Window:
Sets up the display of custom web form.

WebPageUrl

Opens the Following Window:
Web Form URL Window
Purpose of this Window:
Specifies the URL for the web form for the activity.

Work to Perform

Definition:
Specifies the name of the task that appears in a participant's Task List.

In most cases, for processes that use ASP.NET forms, this value also determines the file names for the .aspx form pages.

For the Web Form AgileShape, this property does not determine the file names for the web form. Instead, use the Web Form URL Window.

Allowed Values:
The values for this property vary, depending on the type of process model you are using:
  • Generic - Does the following:
    • Specifies the name that appears in the participant's Task List for this activity.
    • If you create an ASP.NET project for this process in AgilePoint Developer, a new .aspx page is created for each manual activity with the file name equivalent to the value of the Work to Perform property.
  • SPList and SPDoc - Specifies the name that appears in the participant's Task List for this activity.
  • InfoPath - Does the following:
    • Specifies the name that appears in the participant's Task List for this activity.
    • Specifies the view from the InfoPath form that is associated with the process model. These values are loaded from the InfoPath form.

      It is possible to add a new work performer name. However, this is not recommended. A new name would indicate a different type of form, such as an ASP.NET form. This functionality is technically supported, but you would need to write code to implement it.

  • AgileForms - Specifies the name that appears in the participant's Task List for this activity.

    The default value for this field is FormRender. It is recommended to change this value.

Default Value:
None, except for AgileForms process models.
Property Group:
Basic

EnabledExchangeServer

Definition:
Integrates the AgileShape with Microsoft Exchange Server. The AgileShape's associated tasks are visible in the Microsoft Outlook's task list to the assigned participants.
Allowed Values:
  • False - The AgileShape in not integrated with Microsoft Exchange Server.
  • True - The AgileShape is integrated with Microsoft Exchange Server that enables the participants to view the assigned tasks in Microsoft Outlook.
Default Value:
False

ExchangeServer

Opens the Following Window:
Exchange Server Configuration Window
Purpose of this Window:
Integrates an AgileShape with Microsoft Exchange Server. When this connection is properly configured, the AgileShape will then insert, update, and remove tasks for the assigned participants, so that the tasks can be viewed directly from Microsoft Outlook.

BPMN Properties

Each AgileShape includes a set of BPMN properties. For more information, see Adding or Modifying BPMN Properties for an AgileShape.