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

The **S-Docs Usage Metrics Lightning Web Component (LWC)** provides a centralized, real-time view of your organization’s S-Docs document generation and e-Signature usage. This component helps admins and stakeholders monitor consumption, track limits, and proactively manage document activity directly within Salesforce Lightning Experience.

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.

***

## What the Usage Metrics LWC Displays

The Usage Metrics LWC shows key insights related to S-Docs usage, including:

* Total documents generated
* Manual документ generation counts
* Automated document generation counts (Flows, Apex, SDK, Jobs)
* Document entitlement usage progress
* e-Signature request usage and limits
* Last refreshed timestamp with an option to manually refresh

This information updates automatically and can also be refreshed on demand.

***

## Where the Usage Metrics LWC Can Be Added

The Usage Metrics LWC is designed to be added to **Lightning Home Pages**.

Note:

* LWCs are **not supported** on Salesforce dashboard layouts
* The component is intended for high-level visibility rather than record-specific usage

***

## Adding the Usage Metrics LWC to a Home Page

{% stepper %}
{% step %}
Navigate to **Lightning App Builder**.
{% endstep %}

{% step %}
Open the **Home Page** you want to customize:

* Click the **Setup gear** → **Edit Page**
  {% endstep %}

{% step %}
In the left sidebar, scroll to **Custom – Managed**.
{% endstep %}

{% step %}
Drag **S-Docs Usage Metrics** onto the page layout.
{% endstep %}
{% endstepper %}

***

## Configuring the Usage Metrics LWC

After placing the component on the page, click on it to access configuration options.

You can customize what data is displayed by enabling or disabling the following settings:

* **Hide Manual Count**\
  Hides the number of documents generated manually through button clicks
* **Hide Automation Count**\
  Hides documents generated through automation such as Flows, Apex, SDK, or S-Docs Jobs
* **Hide Document Limit Progress Bar**\
  Hides the document usage progress bar\
  \&#xNAN;*(Recommended for seat/license based S-Docs plans)*
* **Hide e-Signature Limit Progress Bar**\
  Hides the progress bar showing e-Signature usage vs entitlement
* **Set Component Visibility**\
  Control when the component appears using Salesforce visibility rules

***

## Saving and Activating the Page

{% stepper %}
{% step %}
Click **Save**
{% endstep %}

{% step %}
Click **Activate**
{% endstep %}

{% step %}
Assign the page as needed:

* Org default
* App default
* App and profile specific
  {% endstep %}
  {% endstepper %}

After activation, the Usage Metrics LWC becomes visible on the selected Home Page.

***

## Refreshing Usage Data

The Usage Metrics LWC updates automatically every **24 hours**.

To view the latest data immediately:

* Click **Refresh** at the bottom of the component
* The **last updated timestamp** appears next to the Refresh button

This ensures admins always have access to the most current usage information.

***

## When to Use the Usage Metrics LWC

The Usage Metrics LWC is ideal when:

* Monitoring document and e-Signature consumption
* Ensuring usage stays within entitlement limits
* Identifying high document generation activity
* Providing visibility to admins or operations teams

{% hint style="info" %}
Considerations

* Available only on **Lightning Home Pages**
* Does not support dashboard placement
* Usage data auto-refreshes every 24 hours
* Manual refresh is available for real-time insights
* Visibility can be controlled using Salesforce component rules
  {% endhint %}


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.sdocs.com/sdocs/administration/landing-page-for-admin/install-configure/configure-the-s-docs-usage-metrics-lwc-on-home-page.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.