> For the complete documentation index, see [llms.txt](https://docs.gridmate.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.gridmate.io/package-reference/components-library/gm-bulk-action-monitor.md).

# GM - Bulk Action Monitor

(gmpkg:bulkActionMonitorLWC)

## **Documentation**

**GM - Bulk Action Monitor** component is a utility bar item that lists the bulk action jobs started by the current user from a grid (bulk mass update, bulk mass assign and bulk quick action). For each job, the monitor shows the grid, the action, the progress and the state. The user can cancel a job in progress, download the errors of a job completed with failures as a CSV file, and remove a finished job from the list. A toast is displayed when a job completes.

{% hint style="info" %}
The job list is stored in the browser local storage. It is specific to the user and to the browser.
{% endhint %}

**Use case:** Add the monitor to the utility bar of a Lightning app to follow the progress of mass updates launched on large volumes of records. See [Grid Bulk Action](/advanced-guides/grid-actions/grid-bulk-action.md).

## **Specification**

<table data-full-width="true"><thead><tr><th width="244">Property</th><th width="131.33333333333331">Type</th><th>Description</th></tr></thead><tbody><tr><td>Cleanup Delay</td><td>Integer</td><td><p>Delay in seconds before a successfully completed job is automatically removed from the list. Only jobs without failures are removed. Set to -1 to keep the jobs until the user removes them.</p><p>The default value is -1.</p></td></tr></tbody></table>

## **API Reference**

{% tabs fullWidth="true" %}
{% tab title="bulkActionMonitorLWC.js-meta.xml" %}

```xml
<?xml version="1.0" encoding="UTF-8"?>
<LightningComponentBundle xmlns="http://soap.sforce.com/2006/04/metadata">
    <apiVersion>65.0</apiVersion>
    <isExposed>true</isExposed>
    <masterLabel>GM - Bulk Action Monitor</masterLabel>
    <description>Bulk Action Monitor</description>
    <targets>
        <target>lightning__UtilityBar</target>
    </targets>

    <targetConfigs>
        <targetConfig targets="lightning__UtilityBar">
            <property
                name="cleanupDelay"
                type="Integer"
                label="Cleanup Delay"
                description="Cleanup delay before removing a successfully completed job. Set to -1 for no cleanup"
            />
        </targetConfig>
    </targetConfigs>
</LightningComponentBundle>
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.gridmate.io/package-reference/components-library/gm-bulk-action-monitor.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
