Work-Relay Components Settings

  • This article is related to Version 8.7 and later.
  • Starting from v. 8.7 different lightning components settings are moved from page editor to this page.
  • Settings for components are managed there and their default values are defined there too.
  • Settings can be saved as configs having own names.
  • These configs can be selected in component properties in the page builder.
  • This allows to create and store necessary sets of component properties and then simply apply them to components as many times as user needs.
Expand or collapse content Form Panel

Work-Relay Form Panel component allows to incorporate Work-Relay form into Lightning page. These settings define some properties that will be applied to any form.

  • Form - select a form to be displayed
  • Entire Height - displays a form with it's full height, otherwise it will be shown in a scrollable container
  • Parameters - a custom form parameters (if any) in JSON key:value format.
  • Custom Record ID - the record ID to use for the form. If not provided, the form will be rendered in the context of the current record.
  • Form Mode - displays a form in "edit" or "view" mode
  • Context Fields - allow to pass parameters to the form from the Context object.

Context fields:

The 'key' is the parameter name, the 'value' is the field API name.
Example: The form source object is Contact (FirstName='Jim', LastName='Lee'). Context Fields in this case may look like:
{"fnameParam":"FirstName", "lnameParam":"LastName"}
In the form the merge field {$FormParameters.fnameParam} will be replaced with "Jim".
Note: Context field settings will work only if Record Id is passed.

Note that there are no fields for form ID and record ID. These settings are like templates suitable for any form, but the form itself and the Data Source Object record should be specified in a WR Form Panel component settings in the page builder. Please read the proper article.

Expand or collapse content Process Statistics

Process Statistics component allows to build Statistics dashboard into a page as a component. It has only one property - list of allowed processes. Once inserted, this component will display a statistics for this process in the same way as on particular page. See proper article to know more about statistics.

Allowed processes are set in the proper field. The search in the component will only include the allowed processes. To search across all processes leave this field blank.

Expand or collapse content Progress Dashboard

A Progress Dashboard component can be used to incorporate a particular Progress Dashboard to the lightning page.

From the version 8.7 these settings define some properties that will be applied to any Progress Dashboard.

  • Height and Width - dimensions of Progress Dashboard. Select "Fixed" to specify them in %, px, rem or vw/vh. Select "Calc" to enter CSS calc() expression.
  • Show Header - allows to turn on a progress dashboard header with all it's elements except "Filters" menu item.
  • Progress Dashboard - select a dashboard to display.

For previous versions: these settings are like templates suitable for any dashboard, but the dashboard itself and other parameters specific for it should be specified in a Progress Dashboard component settings in the page builder (please read the proper article). These properties are:

  • Dashboard ID - an ID of the Progress Dashboard to be displayed/
  • Process ID - optional, allows to show this progress dashboard for a process or process version that is different from what this dashboard has been created for.
Expand or collapse content Task Manager

Work-Relay Task Manager component can be used to incorporate Work-Relay Tasks Dashboard to the lightning page.

In this page tab Task Manager Settings stores not only Component settings, but settings for the Task manager itself. The "Default" View can be changed and saved (unlike as other component settings) and will be applied to both Component and Task Manager Page.

Note: Default settings will not affect Task Manager page if the current user has already saved custom settings for the Task Manager. There is a way to remove these settings:

  • Open Developer Console
  • Switch to Query Editor
  • Execute the following query:
SELECT id, name FROM WR_BPM__Work_Relay_Config_Custom__c WHERE Id != null AND Name = 'TasksManagerSettings' AND WR_BPM__Type__c = 'TasksManagerSettings' AND OwnerId = '%user_id%' AND WR_BPM__Assignee__c = '%user_id%' order by Name desc

(where %user_id% is an ID of user which you want to delete Task Manager Settings for)

  • You should receive one row in query results.
  • Select this row and click "Delete Row" button.

There are several sections here:

Component Settings (from the version 8.7):

  • Width and Height - they allows to specify built-in dashboard size in pixels, percents, rem and wv/vh units or use calc() expressions.
  • Fit to the Container's Size - turn on this setting if this component is added to the lightning page.
  • Compact Mode - displays dashboard as a vertical grid with tasks.
  • Mobile mode - displays tasks in mobile view.
Lightning Experience | Salesforce - Google Chrome

Before v. 8.7 - please read the proper article about component settings for Task Manager.

General Settings

These are settings that are suitable for Task Manager in spite on which view is selected:

  • Default View - Select either Kanban or Table as the default view of the Task Manager Dashboard.
  • Keep applied filters in cache - Select how long unsaved filters will be applied to the dashboard. This allows the user to apply and work with filters without overriding existing or saving a new filter.
  • How to handle update task events - Select the frequency with which the Dashboard refreshes to display new/updated work items (available starting Work-Relay 4.1 Release).
  • Consider Role Hierarchy for All Tasks view - When turned on, work items will be displayed in accordance with the Role Hierarchy defined in the Salesforce org.
  • Show filter panel on start - When turned on, the Filter panel will be displayed by default when loading the Task Manager.
  • Proceed tasks asynchronously - When turned on, the Proceed actions on a work item will run in a separate thread of execution.
  • Visible Work Item Types - Select the work item types to be displayed in the dashboard.
  • Auto-load next task - When turned on, upon Proceeding a work item, the next work item in the same Kanban column will automatically be displayed.

Kanban View

  • Show "Completed Tasks" column - When it is turned on, completed work items will be displayed on the dashboard in a column named "Completed." Specify the number days within which the work items to be displayed have been completed in the field below.
  • Default Order - Select the desired work item property that will be used for default sorting, as well as the direction (ascending or descending).

Table View

  • Show completed Task/Issues - When checked, completed work items will be displayed in the table (available starting WorkRelay 4.1 Release).
  • Default Order - Select the desired work item property that will be used for default sorting, as well as the direction (ascending or descending).
  • Columns configuration - Select the columns that will be displayed in the table. Column heading labels may be overwritten for the table, if desired.

General, Kanban and Table Settings are the same as those that are set on Task Manager Settings.

Note: These Task Manager Settings will be used as default for all users. Settings that are set on Task Manager page will override these for each user that have set them.

Expand or collapse content Workflow Line

Workflow Line component displays progress bar of the process started on the record along with all related data such as active step general information, form (if it was set as a step(s) layout), assignee(s) etc.

It can be added to record lightning page only. If added to any other page (such as Home, etc.) or to the lightning page of a record with no started process(es) it will display "Nothing to show" message on a gray inactive progress bar.

From the version 8.7 these settings define some properties that will be applied to any Workflow Line:

General

  • Component Type - select component view mode. This extends the process setting for component type (click to read). Default option is "Inherit", but it can be implicitly set/overridden for a particular instance of Work-Relay Workflow Line component.
  • Let Workflows Component control Workflow Line - when turned on, Workflow Line will be controlled by the Workflows Component ignoring provided process settings.
  • Refresh After Proceed - refreshes whole page after successful proceed. This means that if active process step(s) has after step action(s) updating context record or Save Form on Proceed Step form setting is turned on (in case process step layout type is Form) updated data will be displayed on record details once process step is completed.
  • Refresh After Form Submission - refreshes page after form save action executed successfully (either standard Save form button or custom button triggering Save form API action).
  • Entire height for Form - displays form(s) tied to process step(s) without vertical scrollbar (100% height).
  • Tabs Visibility - specifies which tabs should be displayed. These settings can be overridden by Smart Step Settings, if they are set on Process Diagram.

Process Instance Search Settings

There is a property named Search type - it specifies how to get ID of process instance to display workflow line for. It has the following values:

  • Context Record Id - a process instance ID is taken from current record which page with workflow line component is displayed for:
  • Context Object Field Value - the value of specified context object field will be used to search for the process instance. The first record found will be used if there will be more than one record found. An Object should be selected in "Object Type" field, and a field in the "Object Field" picklist.
  • Advanced Query Builder - queries any Object's field to find the ID of the Record the Process is running on. Use Context Record's fields to search for it. If the Process is not specified, the first active Instance found will be shown. Use Conditions to limit search.

Let's explain how this works.

There are:

  • Context Object Type - an object, which record page component is inserted to. On the picture above it is "Account".
  • Search Object Type - an object that will be queried from the database (an "Opportunity" in the picture above).
  • Search Object Field Name - a field that should contain an ID of some record that is a record of Context Object Type (e.g., "Account ID")
  • Query Conditions Settings contain conditions which queried object ("Search Object Type") must match.
  • Process Name and Process Version allow to specify specific process and it's version to be displayed.

The first layer of query is the following:

  • System searches for records of Opportunity ("Search Object Type"), that match Query Conditions and selects top 1 of them.
  • System takes a value from Account ID ("Search Object Field Name") field of this record and considers it contains an ID.
  • System searches for a processes that are started on a record which has this ID.

The second layer of query is the following:

  • System adds a process set in "Process Name" to the query; if "Process Version" is specified, system adds it.

After query has been executed, system should display a Workflow Line for the specified Process/Version instance, started on the record which ID has been queried.

Notes:

  • if queried field contains no ID of suitable record, or there is no suitable process that is started on the record with queried ID, a Workflow Line will show no progress.
  • if queried field can contain not only ID, there is a chance that system will query non-ID value, and will show no process instance. To avoid this query fields that can contain IDs only (e.g., lookups) or use precise conditions to query fields with ID-containing values only.

System executes a database query and takes first one record found. If the proper field in this record contains no suitable ID (and user is sure that ID is contained there), this means user need to specify more strict query conditions.

Before the version 8.7 only basic parameters are available. See proper article to know more.

Expand or collapse content Workflows

Work-Relay Workflows component displays processes that are currently started on the record (Started Processes tab) and processes that are not started on the record (Startable Processes tab).

From the version 8.7 these settings define some properties that will be applied to this component.

  • Display Tabs - choose which tabs should be shown (Started processes, Startable processes or both).
  • Default Tab - choose tab (Started processes or Startable processes) that will be active by default. This option is shown only if both tabs are selected in  Display Tabs field.

Started Processes section:

  • Tab label is used to rename tab.
  • Conditions - enter conditions expressions to limit displayed processes to those that match that conditions. Conditions can have these modes:
    • Conditions - select a property of Flow Instance object ans set it's operator and value
    • SOQL - specify the WHERE conditions for the SOQL query returning the list of started processes. The query is to WR_BPM__Flow_Instance__c Object.
    • Formula - specify the formula expression for conditions and their logic.
    • Call Apex - specify Apex Class returning query result, and it's parameters.

Startable Processes section:

  • Filter by Process Folder - use this settings to display startable processes from specified folder only. Use '\' delimiter to provide full process path.
  • Filter by Process Name - you can enter your process name here and component will display only specified process in the list. Wildcard symbols are allowed. Example: %test% - will display all processes that have the text “test”.
  • Tab label is used to rename tab.
  • Conditions - enter conditions expressions to limit displayed processes to those that match that conditions. Specify the WHERE conditions for the SOQL query returning the list of started processes. The query is to WR_BPM__Flow_Instance__c Object. Conditions modes are the same as for Started Processes.

Before the version 8.7 these settings slightly differ. See proper article to know about and see examples.

0 Comments

Add your comment

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.