Process Step Layouts
The Process Step Layout functionality provides the ability to customize the Layout tab's user interface on a step-by-step basis. To configure:
- Open the Process Designer for the desired Process and click on a Process Step (1).
- Expand the "User Interface" section (2) of Step Settings.
- Choose the desired Layout Type (3).
- Save the Process.
The following Layout Types are available:
- Standard (default)
- Work-Relay Form
- Visualforce Page
- Lightning Component
The Standard layout displays the Process's Data Source object record details, using the page layout configured in Salesforce Setup.
Two Layout Modes are available:
- Edit - The page layout will be rendered in Edit mode. Note: This mode is available from version 5.0+
- View - The page layout will be rendered in View mode.
The Work-Relay Form layout will display a custom Work-Relay Form. Select the desired Work-Relay Form (4).
As an advanced option, from version 8.0 the Layout Value Type (5) can be specified, in order to define how the proper Work-Relay Form to display is determined. The options are:
- Static - The selected Work-Relay Form (as in the above screenshot) will be displayed for all users.
- Formula - The Form displayed will be determined dynamically, based on the Work-Relay Form Formula (6). The formula entered must return a Form ID. This allows for a different Form to be displayed for different situations.
For example: Assume an Admin would like to display a different Form depending upon a Case record's Case Type value: Electrical, Mechanical, and and all others. The formula could look like this: FORMULA[CASE({Case.Type}, 'Electrical', 'FormId1', 'Mechanical', 'FormId2','FormId3')]
(where FormId1, FormId2, and FormId3 are Salesforce record IDs for the desired Forms). The Step Layouts for different records will be different Forms:
Layout Modes (7):
- Edit - The Form will allow data to be edited.
- View - The Form will be displayed in read-only mode.
- Dynamic - Displays the Form in either 'View' or 'Edit' mode, depending on user permissions granted. The Step Assignee and Process Admins will see the Form in 'Edit' mode, while 'View' mode will be used for all other users. Note: This mode is available starting from version 5.0.
- Formula - Displays the Form in the mode which is returned by a the defined Layout Mode Formula (8). The formula must return one of the three Layout Modes defined above: View, Edit, or Dynamic. Note: This mode is available starting from version 8.0.
Layout Parameters (9):
Click the "edit" link to open the configuration screen (10). Set the Parameter Name and Value for each parameter you wish to pass to the Form.
Parameters can be accessed on the Form using the {$FormParameters} context object (e.g., the Parameter from the screenshot above will be available as the {$FormParameters.startDate} merge field).
Starting with version 4.1, process variables can be accessed in the form builder using the {$Variables} context object. For example, a process variable named 'endDate' will be available on the form as the {$Variables.endDate} merge field.
Note: By default, the following parameters are available on a Form:
- {$FormParameters.taskId} - The record ID of the current cursor.
- {$FormParameters.formId} - The record ID of the form.
- {$FormParameters.id} - The record ID of the context record.
Allows a Visualforce page, specified in the VF Page field (11), to be displayed as the Step Layout.
If desired, click the "edit" (12) link to specify Layout Parameters (13). Set the Parameter Name and Value for each parameter you wish to pass to the Visualforce Page.
For example, the Parameter in the screenshot above passes the Process Instance Start Date value to the Visualforce Page.
Note: By default, the context record ID is passed to the Visualforce Page as a Parameter named 'id'. E.g., if the process context record is an Account, the Account record Id will be available on the Visualforce Page as the {!$CurrentPage.parameters.id} merge field by default.
Available from version 4.0 .
Allows a Lightning Component (14) to be displayed as the Step Layout and pass parameters (15), if desired.
For example, the Parameter in the screenshot below sets the value of the showPopUp component global attribute.
Note:
- To use a Lightning Component as the Step Layout, its access type should be set to "Global." All required component attributes should be also global.
- Currently, only String parameters can be passed as Lightning Component Parameters.
0 Comments
Add your comment