Start Process Link Share Share via LinkedIn Reddit Email Copy Link Print On This Page 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: Starting Processes From an Interface Process Model Type Link, Buttons and link design guidance Parameters Name Keyword Types Description Label label Text Text associated with this link. Process Model processModel Process Model The process model to start. You must provide a constant referencing the process model or a process model UUID. 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 Using start process links offline Start process links will not function on the mobile application on a form that is configured to be available offline. Starting autoscaled processes You can select a process model with autoscale enabled, but any process started with the link will run without autoscaling regardless of its configuration. To monitor any processes started with the link, use the Process Activity tab in the Monitor view. 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 ) } ) Feature compatibility The table below lists this component's compatibility with various features in Appian. Feature Compatibility Note Portals Incompatible Offline Mobile Incompatible Sync-Time Custom Record Fields Incompatible Real-Time Custom Record Fields Incompatible Custom record fields that evaluate in real time must be configured using one or more Custom Field functions. Process Reports Incompatible Cannot be used to configure a process report. Process Events Incompatible Cannot be used to configure a process event node, such as a start event or timer event. Process Autoscaling Compatible Feedback Was this page helpful? SHARE FEEDBACK Loading...