Introduction
The browse component can be used to browse through a set of job applications (or other objects). From the workflow list, the end user can select multiple job applications and hit the Browse button. A new page is opened and the browse component is shown.
Browse component has two main panels, a left and a right panel. The left panel contains a tab set with different sub components. In the workflow browse component, the tab set contains the document preview component and record detail components for job application, candidate, previous steps and job.
The right panel can also contain multiple components, which will be listed below each other. Coming from the workflow page, the right panel shows the Rating component which allows you to add a rating to the job application. It also shows the component that allows you to initiate a workflow step.
Browse component is often used to review a set of job applications. Users will use the left panel to read the CV and use the right panel to add a rating or initiate a workflow step.
Where can this component be used?
Workflow tab
List component
The admin also has the ability to allow the user to open browse mode from any List component.
How to configure the component?
Browse mode in workflow
The browse component for the workflow cannot be configured. It is always shown with the following setup:
Left panel:
- Document preview component
- Record detail component for job application
- Record detail component for candidate
- Previous steps of this job application
- Record detail component for job
Right panel:
- Rating component
- Workflow step selection component
Browse mode from List component
The admin can configure the browse component for a list via the right panel in the Lightning App Builder. The screenshot below shows the relevant settings:
Explanation of the settings:
1) Show browse button
This settings allows you to show/hide the browse button in the list view.
2) Configuration for left panel of browse view
This setting allows you to configure the tabs/components shown in the left panel.
How to add each of the types of components
Type of component | Way to specify | Example |
Document preview |
With a custom label for the tab name: |
With a custom label for the tab name: |
Fieldset |
With a custom label for the tab name: With a static text for the tab name: |
With a custom label for the tab name: With a static text for the tab name: |
RecordDetail |
With a custom label for the tab name: With a static text for the tab name: |
With a custom label for the tab name: With a static text for the tab name: This one is only available for left panel. |
Custom component |
With a custom label for the tab name: With a static text for the tab name: |
With a custom label for the tab name: With a static text for the tab name: |
WorkflowStepActions |
CustomLabelName->Component(WorkflowStepActions) |
This one is only available for browse mode of job applications. It shows the step actions component. |
TableCellRating |
CustomLabelName->Component(TableCellRating) |
This one is only available for browse mode of job applications. It shows the rating component. |
Custom components that will be developed can get the relevant context by using the following attributes:
recordId --> Id of the current sObject
sObjectName --> API name of the current sObject
selectedRecords --> List of all selected sObject records
The browse component will set values to the above attributes. The developer can use this data to make the custom component work as expected.
3) Configuration for right panel of browse view
This setting allows you to configure the components shown in the right panel.
Components can be defined the same way as for the left panel.
4) Navigator fields
On the top menu of the browse component there is a pulldown with the records the user has opened in the browse mode. You can specify the fields that are shown in the pulldown.
You can specify multiple fields comma separated. Use the API name of the fields you want to show.