Start Process Link

Function: a!startProcessLink()

Defines a link to start a process. Users are shown the start form or first chained attended node and any subsequent chained forms. When the user submits the last form, the chain completes and the original interface is reloaded. Links can be used in charts, grids, hierarchy browsers, images, link fields, milestones, pickers, and rich text.

See also: Starting Processes From an Interface, Process Model Type, Link

Parameters

Name Keyword Type Description
Label label Text Text associated with this link.
Process Model processModel Process Model The process model to start.
Process Parameters processParameters Dictionary A dictionary containing the parameters for the process model and their values.
Banner Message bannerMessage Text The text shown in the banner when a process starts successfully after completing any initial chained forms. When not provided, no banner is displayed.
Visibility showWhen Boolean Determines whether the link is displayed in the component. When set to false, the link is hidden and is not evaluated. Default: true.

Examples

Since process model constants are specific to each system, this example does not evaluate in your Test Rules interface. Use it only as a reference.

Start process link that passes parameter data to the process model

1
2
3
4
5
6
7
8
9
10
11
12
=a!linkField(
  links: {
    a!startProcessLink(
      label: "Update Customer Details",
      processModel: cons!UPDATE_CUSTOMER_DETAILS_PM,
      processParameters: {
        customerId: ri!customer.id
      },
      bannerMessage: "Updated details for " & ri!customer.name
    )
  }
)
FEEDBACK