> For the complete documentation index, see [llms.txt](https://help.sdocs.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.sdocs.com/sdocs/administration/install-configure/configure-the-s-docs-usage-metrics-lwc-on-home-page.md).

# How To: Configure the S-Docs Usage Metrics LWC on Home Page

The **S-Docs Usage Metrics Lightning Web Component (LWC)** provides a real-time view of your organization's document generation and e-Signature activity. This LWC makes it easier to monitor consumption, stay within entitlements, and proactively manage your document workflows.

By adding the Usage Metrics LWC to a Lightning Home Page, organizations can quickly understand how S-Docs is being used and ensure they remain within their entitled limits.

<figure><img src="https://1548664070-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWKNnJmhJBQwhdk5WBFsi%2Fuploads%2F3Gnk8Sc3J8j4Xi3r0p64%2Fimage.png?alt=media&amp;token=7aa284cc-ad02-4f55-a29a-6107a8482736" alt=""><figcaption></figcaption></figure>

***

## Configure the Usage Metrics LWC

The Usage Metrics LWC can be added to Lightning home page layouts. [**Click here to learn more about setting up Lightning Experience home page layouts**](https://help.salesforce.com/s/articleView?id=xcloud.admin_home_lex_intro.htm\&type=5).

{% hint style="info" icon="bullhorn" %}
**Note:** LWCs are not a supported component type for dashboard layouts.
{% endhint %}

### Navigate to the Lightning Builder for a Home Page

Navigate to the home page you'd like to add the **Usage Metrics** LWC to. Click the **Setup** gear, then click **Edit Page**.

<figure><img src="https://1548664070-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWKNnJmhJBQwhdk5WBFsi%2Fuploads%2FJ9BOGeAJ0t1ho3TQVhao%2Fimage.png?alt=media&amp;token=631da810-335f-4d80-9bc5-99276fc53139" alt=""><figcaption></figcaption></figure>

### **Add the Usage Metrics LWC to your page**

Within the Lightning App Builder, scroll down the list of components in the left sidebar to the *Custom - Managed* section. Drag the **S-Docs Usage Metrics** LWC onto the page.

<figure><img src="https://1548664070-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWKNnJmhJBQwhdk5WBFsi%2Fuploads%2FkCXNPHBrTLmyHa5rmWld%2Fimage.png?alt=media&amp;token=3f61d536-3f82-44bf-ae98-114d0a6ca89b" alt=""><figcaption></figcaption></figure>

### Configure the Usage Metrics LWC

After dragging the **S-Docs Usage Metrics** LWC onto your home page layout, click on the component to open the configuration options.

<figure><img src="https://1548664070-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWKNnJmhJBQwhdk5WBFsi%2Fuploads%2FXSzbFlJ2K1owwiqMqx3X%2Fimage.png?alt=media&amp;token=8a3ff07e-3f88-4f5e-8b26-43455d84441f" alt=""><figcaption></figcaption></figure>

You can customize the data that the Usage Metrics LWC displays here:

1. **Hide Manual Count:** Hide the number of documents that users generate manually (via button clicks).
2. **Hide Automation Count:** Hide the number of documents generated programmatically (through Flows, Apex, etc. via the SDK or S-Docs Jobs).
3. **Hide Document Limit Progress Bar:** Hide the progress bar that displays how generated documents compare to your org's document entitlement limits. *We recommend checking this box if you have a seat-based S-Docs plan.*
4. **Hide e-Signature Limit Progress Bar:** Hide the progress bar that displays how e-Signature requests created with [**S-Docs e-Signature**](https://kb.sdocs.com/knowledge-base/sdocs/sdocs-e-signature/configuring-s-docs-e-signature/) compare to your org's e-Signature entitlement limits.
5. **Set Component Visibility:** You can optionally configure *Component Visibility* to display/hide this LWC based on your own conditions in Salesforce.

### Save your configurations

Click **Save** to save your configurations. If you're customizing a new page or the page hasn't been activated before, you will also need to click **Activate** and assign the page as a [**default home page**](https://help.salesforce.com/s/articleView?id=xcloud.admin_home_lex_set_default.htm\&type=5) for different levels based on your organization's needs (e.g. an org default, an app default, or specific app and profile assignments).

The Usage Metrics LWC will now appear on your home page.

<figure><img src="https://1548664070-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWKNnJmhJBQwhdk5WBFsi%2Fuploads%2FKJJNEmVnp96c9Ydtmu4s%2Fimage.png?alt=media&amp;token=7316952e-b2bd-41c6-9946-80337296929a" alt=""><figcaption></figcaption></figure>

{% hint style="info" icon="bullhorn" %}
**Note:** The **Usage Metrics** LWC automatically updates every 24 hours. However, you can view the latest live data by clicking **Refresh** at the bottom of the LWC. You can also see when the data was last updated next to the **Refresh** button.
{% endhint %}


---

# 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://help.sdocs.com/sdocs/administration/install-configure/configure-the-s-docs-usage-metrics-lwc-on-home-page.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.
