> For the complete documentation index, see [llms.txt](https://docs.work-relay.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.work-relay.com/processes/process-settings/progress-component-settings.md).

# Progress component settings

In the process builder, click "Open Process Settings" in the "Actions" menu to open the "Edit Process Settings" window.

![](/files/96bb651429bdf4e906eca0a8e2783202f17b4a04)

Open the "Progress Component Settings" tab.

![](/files/3c31efa39cb3cd1cd1b765744f1cd008dc81ccab)

### Component type

The Progress Bar component can be set to the following types:

* **Standard** - Displays branches separately with an option to switch between them:

  ![](/files/7d223db921ce8d49dd5a67a5a731b086a7365480)
* **Summarized** (Default) - Displays steps from all branches in the process in one line, allowing the user to switch between the steps. Completed steps are shown first, then active, and then future:

  ![](/files/17939ce5c32858b4ebe407cf06ff337bcb49d832)

{% hint style="info" %}
For Processes that can have more than one Step in progress at any given time, the Step currently selected to view or interact with is outlined.
{% endhint %}

* **Sequential** - Displays steps from all branches in the Process in one line, in the order [defined in the steps grid](/processes/building-a-process/steps-order.md) in the Process Designer.<br>

  ![](/files/b375417710dfe22fefafa536562b765352cbc873)

### Enable actual dates

Allows the user to define the Start Date and End Date when proceeding the Step.

![](/files/b85c9a67ce19e731f83f184ec2ee5b74a0fa8c70)

### Enable comments

Allows the user to add a Comment when proceeding the Step. The Comment will be visible in the Process Instance History.

![](/files/d2c80c7eaf433e70aec828cef6f5062f292d9d7c)

### Keep history on restart

When turned on, the History of step status changes will be retained and available after a Process Instance is restarted.

![](/files/6a16ef91ffc95361195ee6b9e2d30b2dd6696257)

### Keep timelogs on restart

Turn this on to make process instance have already added [timelogs](/functional/dashboards/time-logs-dashboard/time-logs-dashboard-overview.md) stored for time calculation needs. Uncheck it if you have no need in timelogs [reported](/functional/dashboards/time-logs-dashboard/reporting-time.md) for previous iterations.

This option works when "Change step" and "Restart branch" features are used too.

![](/files/7d88deb0fac7f1acc29555dc6148ece3a4582220)

### Show Issues

If turned on, tasks and issues added for a step are displayed in the workflow line like other steps—active or completed. This can be useful for process managers or assignees and behaves like additional steps.

When this toggler is turned on, a picklist with options to filter displayed issues is available:

![](/files/93697df6105ac81c9dec77f7569332e17d567163)

{% hint style="info" %}
These issues do not affect steps and process durations.

These issues shift [dates](/processes/working-with-processes/forecasted-dates-and-durations.md) of subsequent steps properly depending on their End dates.

This is correctly shown in Gantt if it has "Show Issues" turned on too. See the [proper article](/processes/process-settings/gantt-settings.md).
{% endhint %}

### Load connected instances

Defines whether progress bars of [sub-processes](/processes/working-with-processes/start-and-plan-the-process.md#triggered-by-another-flow) and [connected instances](/processes/process-steps/process-step-settings/connection-points.md) should be manually or automatically opened under the parent process progress bar.

![](/files/1401334557f21b9c9c6d3a33f446906757ec8310)

### Default chatter feed

Defines a feed that will be shown by default in the "Feed" subtab on Instance details:

![](/files/e0e238f418ce04c57693dc2d21e7c6565464da83)

![](/files/3daac88e0c881ac5af79c158f63aaa3fd24d6984)

### Step filters

"Past Step Filters" and "Future Step Filters" define which Steps will be hidden in the progress bar. Move necessary filters to "Selected" sections to have them applied.

![](/files/ec30ed8efc9d700b53a172efc15015bc3e579db9)

### Layout for completed process

This feature allows you to select a separate layout for the process to display when the whole instance is completed. This layout can only be a Form, and it is specified like a step layout of the proper type.

{% stepper %}
{% step %}

#### Open layout settings

Click the "Settings" button (gear icon) to display the Layout Settings popup.

![](/files/c27a7dbd783eb23ab49184618122a227d0dc5367)

![](/files/42c2a7ba1b60a09323b0f61b5985e9eceaa9988c)
{% endstep %}

{% step %}

#### Configure the form

Select a form, set form mode, and specify parameters if necessary. The ID of the record which instance has been started at will be passed to the form automatically.

![](/files/1bed2795efd816fe03eeab082ff4123bfe4f8d58)
{% endstep %}

{% step %}

#### Apply the settings

Click "Apply" to apply layout settings.
{% endstep %}
{% endstepper %}

### Standard Buttons Settings

![](/files/f84e949eb39b1bb957272444835851cd433a3115)

The color of the Proceed, Approve, and Reject standard buttons may be overridden here by selecting the proper value in the picklist in the "Color" column.

Button behavior may be overridden by selecting a Before Handler in the proper column. The following Handler types are available:

* Form
* Action
* Action Group

{% hint style="info" %}
By default, the following parameters are passed to button handlers: Cursor ID, Flow Instance ID, Process ID.
{% endhint %}

![](/files/8d66edf701372f9d27b3884e882b512037a1c6d4)

Custom Parameters may also be defined and passed to the button handler:

![](/files/f0b2596d5b5d503778a68228e516fc537476d601)

### Custom Buttons

![](/files/f8646eb11c7ecba3711eb9e5bb3f9fdf51c11404)

Custom buttons may be added to the Workflow Progress Component menu (arrow button at the right side, Process Instance Menu in [this article](/functional/process-progress-component/progress-component-overview.md#menus-and-buttons)). These buttons must have click handlers. Handlers can have the following **types**:

* **Form** - Opens a Work-Relay form, which can be for any Data Source Object. If selected, the Form Layout Mode must also be defined.
* **Action** - Executes a Global Action.
* **Action Group** - Executes a Global Action Group.
* **Visualforce Page** - Redirects to a Visualforce page.
* **Lightning Component** - Opens a Lightning Component.
* **URL** - Redirects to the specified URL.

By default, the following parameters are passed to custom button handlers: Process Instance Cursor ID, Process Instance ID, Object ID.

For "Form" handler types, both default and custom parameters can be accessed via the Form's $FormParameters context object, for example `{$FormParameters.myParameter1}`.

For "Action" and "Action Group" handlers, parameters can be accessed via the $Variables context object, for example `{$Variables.cursor}`.

Custom parameters are set in the proper popup. Click the "Settings" button (gear icon) to open it:

![](/files/b825767b9a2b4afa3c36e033f82fd4b04e8058e9)

The "Access" picklist defines which users will be able to view the custom button.

The following options are available:

![](/files/1ab982f17db9d893b059dd2e5a630abc2909b229)

* "Managers" are Work-Relay Process Managers.
* "Admins" are Work-Relay Process Admins.
* "Assignee" is the cursor assignee.

The "Visibility" picklist contains different options for custom button visibility:

![](/files/ee621dc16049305ca22e27e17d4e88303bf2a2ed)

### Additional Access

In this table, access to perform additional actions can be provided to users, roles, or profiles, whether they are step assignees or not, by selecting them in the proper field. Access can be granted to Process Manager(s) and Instance Manager(s) separately with the appropriate checkboxes:

![](/files/bbe89387bc808373e23445e164273e4b376c674a)

Entities for additional access can be selected together:

![](/files/aded6622a056d8c301b455716fba936b34cb89ce)

These settings are active by default for Process and Instance Managers:

* Create Issue/Task
* Create Work Logs

Click "Save" to apply changes or "Cancel" to discard them.

<details>

<summary>Releases prior to 8.7</summary>

Open the "Progress Component Settings" tab.

![](/files/23c88adeec421c07c34e1868bba0ba3f0a24324a)

### Component Type

The Progress Bar component can be set to the following types:

* **Summarized** (Default) - Displays steps from all branches in the process in one line, allowing the user to switch between the steps. Completed steps are shown first, then active, and then future:

  ![](/files/9b863b0e20084eb5413b44a373001c73170fe45d)

{% hint style="info" %}
For Processes that can have more than one Step in progress at any given time, the Step currently selected to view or interact with is outlined (2).
{% endhint %}

* **Standard** - Displays branches separately with an option to switch between them.

  ![](/files/4958338f103a906f820662df3b0fbd12cb228029)
* **Sequential** - Displays steps from all branches in the Process in one line, in the order [defined in the steps grid](/processes/building-a-process/steps-order.md) in the Process Designer.

  ![](/files/e9af6a1e3d76831d869928a18a08fe3883e86957)

![](/files/5429153491f185bdf3f8e0c3a087be575957388f)

### Keep history on restart

When checked, the History of step status changes will be retained and available after a Process Instance is restarted.

![](/files/de49ecca5c6ea7d32ee29fbf6c9c84d7bdf3999a)

### Keep timelogs on restart

Starting release 8.4, the "Keep Timelogs on Restart" feature is available. Select this checkbox to retain existing [timelogs](/functional/dashboards/time-logs-dashboard/time-logs-dashboard-overview.md) for time calculations. Clear it when previous-iteration [timelogs](/functional/dashboards/time-logs-dashboard/reporting-time.md) are not needed.

This option works when "Change step" and "Restart branch" features are used too.

![](/files/97e9e0c59c2b4d3f5aa26c27f4d2a9c7e13766ea)

### Show Issues

Starting release 8.4, the "Show Issues" checkbox is available. If checked, tasks and issues added for a step are displayed in the workflow line like other steps—in progress or completed. This can be useful for process managers or assignees and behaves like additional steps.

When this checkbox is shown, a picklist with options to filter displayed issues is available:

![](/files/f18b5ff2c07aa593593f2e7c07947a0728605f66)

{% hint style="info" %}
These issues do not affect steps and process durations.

These issues shift [dates](/processes/working-with-processes/forecasted-dates-and-durations.md) of subsequent steps properly depending on their End dates.

This is correctly shown in Gantt if it has "Show Issues" turned on too. See the [proper article](/processes/process-settings/gantt-settings.md).
{% endhint %}

### Load connected instances

Defines whether progress bars of [sub-processes](/processes/working-with-processes/start-and-plan-the-process.md#triggered-by-another-flow) and [connected instances](/processes/process-steps/process-step-settings/connection-points.md) should be manually or automatically opened under the parent process progress bar.

![](/files/a924bcf997adc3e5463f3b4605410a54d32dce1c)

### Step filters

"Past Step Filters" and "Future Step Filters" define which Steps will be hidden in the progress bar.

![](/files/4ae2a7d52bad47f1909760c5d8a38490edad8365)

### Enable actual dates

Allows the user to define the Start Date and End Date when proceeding the Step.

![](/files/a5c45a96c758be83b081c171ca2b1e47873f9d1d)

### Enable comments

Allows the user to add a Comment when proceeding the Step. The Comment will be visible in the Process Instance History.

![](/files/bc761638db2a92d310f3c68692b12174b5ee362d)

### Standard buttons settings

![](/files/e7c6339965ddecbff74fc6311002e374885995f4)

The color of the Proceed, Approve, and Reject standard buttons may be overridden here by selecting the proper value in the picklist in the "Color" column.

Button behavior may be overridden by selecting a Before Handler in the proper column. The following Handler types are available:

* Form
* Action
* Action Group

Also, you can pass custom parameters too. Click the ">>" button to see the parameters list.

{% hint style="info" %}
By default, the following parameters are passed to custom button handlers: Cursor ID, Flow Instance ID, Process ID.
{% endhint %}

Custom Parameters may be defined and passed to the button handler.

![](/files/a5bfb1991db194417f15baada63f587a6fd2bdc0)

Click the ">>" button to open the formula builder:

![](/files/9d1f9f2f468c338d3591a381b55684c6b79204a9)

![](/files/847d9a22e7d2b120ff881f21d939d8398b4d8888)

### Custom Buttons

![](/files/05958997332fda3a534df23bd9ab218b48b5c348)

Custom buttons may be added to the Workflow Progress Component menu (arrow button at the right side, Process Instance Menu in [this article](/functional/process-progress-component/progress-component-overview.md#menus-and-buttons)). These buttons must have click handlers. Handlers can have the following types:

* **Form** - Opens a Work-Relay form (the form can be for any Data Source Object). If selected, the Form Layout Mode must also be defined.
* **Action** - Executes a Global Action.
* **Action Group** - Executes a Global Action Group.
* **Visualfoce Page** - Redirects to a Visualforce page.
* **Lightning Component** - Opens a Lightning Component.
* **URL** - Redirects to the specified URL.

By default, the following Parameters are passed to custom button handlers: Process Instance Cursor ID, Process Instance ID, Object ID.

For "Form" handler types, both default and custom parameters can be accessed via the Form's $FormParameters context object, for example `{$FormParameters.myParameter1}`.

For "Action" and "Action Group" handlers, the parameters can be accessed via the $Variables context object, for example `{$Variables.cursor}`.

The "Access" picklist defines which users will be able to view the custom button. The following options are available. "Managers" are Work-Relay Process Managers. "Admins" are Work-Relay Process Admins. "Assignee" is the cursor assignee.

![](/files/fa65e21ce0fcef15171d38c92d52d97ed856cb26)

The "Visibility" picklist contains different options for custom button visibility:

![](/files/c769f422a9193998043b67711fb5a95bd6567db0)

### Additional access

In this table, access to perform additional actions can be provided to users, roles, or profiles, whether they are step assignees or not, by entering the Salesforce Record IDs for the desired entity. Access can be granted to Process Manager(s) and Instance Manager(s) separately with the appropriate checkboxes:

![](/files/0d5c2be9de80b8fc357f476b4bdda4b471ae3495)

{% hint style="warning" %}
Multiple IDs should be separated with a comma.
{% endhint %}

Starting release 8.2, the following Additional Access settings are available:

* Create Issue/Task
* Create Work Logs

These settings are active by default for Process and Instance Managers.

Click "Save" to apply changes or "Cancel" to discard them.

</details>
