Start Process Link

Function

a!startProcessLink( label, processModel, processParameters, bannerMessage, showWhen )

Defines a link to start a process and navigates the user through any initial chained forms. 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:

Parameters

Name Keyword Types 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.

Usage considerations

  • Start process links will not function on the mobile application on a form that is configured to be available offline.

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.

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
    )
  }
)
Open in Github Built: Mon, Oct 18, 2021 (02:58:47 PM)

On This Page

FEEDBACK