# Subscriptions

{% hint style="info" %}
User permissions:

* To subscribe to favorites and alerts, you need **Favorites** > **Subscribe**.&#x20;
* To subscribe to dashboards, you need **Dashboards** > **Subscribe**.
* For favorites and alerts, the available file types depend on your **Query** > **Export** permissions.
  {% endhint %}

{% hint style="info" %}
For organization-wide subscription management, including bulk subscription management and subscription settings, see the **Note for administrators** section below.
{% endhint %}

Phocas sends subscription emails to the address in your [account settings](/basics/getting-started/account-settings.md#enter-or-update-your-email-address).

You can subscribe yourself to items. Sharing an item does not subscribe anyone automatically.

Favorites (Flex favorites) created in the [Flex Modes](/flex-modes/save-and-share-favorites.md) module use a different subscription experience from Analytics and Financial Statements favorites. As a result, some subscription options and instructions on this page apply only to Flex favorites.

## Access the Subscribe option

There are several ways to start a subscription.

### From your homepage

On your [homepage](/basics/getting-started/homepage.md), locate the dashboard, favorite, Flex favorite or alert, click its menu button, then click **Subscribe**.

<figure><img src="/files/555VOVRGfVuKQD1QgtdJ" alt=""><figcaption></figcaption></figure>

### From a dashboard, favorite, or alert

You can subscribe to dashboards, favorites and alerts associated with the Analytics and Financial Statements modules.

* Open the dashboard, favorite, or alert, click the blue arrow next to its name, then click **Subscribe**.
* When creating an alert, click **Create & Subscribe** in the **Create Alert** window. See [Use alerts](/basics/favorites/use-alerts.md) for more information.

<div align="left"><figure><img src="/files/W2csf8zoyh74xy4lr2Gq" alt="" width="563"><figcaption><p>Subscribe to a dashboard</p></figcaption></figure></div>

<div align="left"><figure><img src="/files/QNzACYX4NYhUQgZiZpbG" alt="" width="563"><figcaption><p>Subscribe to a favorite</p></figcaption></figure></div>

<div align="left"><figure><img src="/files/cYmFu0Xkqt1dnb6xtRwM" alt="" width="375"><figcaption><p>Subscribe to an alert</p></figcaption></figure></div>

### From a Flex favorite

1. Open the Flex favorite.
2. Do one of the following:
   * Click the blue arrow next to the favorite name, then click **Subscribe**.
   * Click the **Favorite options** button on the toolbar, then click **Create subscription**.

<figure><img src="/files/dNmQiVODhYxCgTnwD9K5" alt=""><figcaption></figcaption></figure>

## Configure the subscription

In the **Subscribe** window, select how and when you want to receive the subscription emails, then click **Save**.

{% hint style="success" %}
Click **Test Now** to send a test email to your email address and preview how the subscription email looks.
{% endhint %}

The available options depend on the item type:

<table><thead><tr><th width="149">Option</th><th width="127">Available for</th><th>Details</th></tr></thead><tbody><tr><td><strong>Type</strong></td><td>Favorites and alerts</td><td>The format of the file attached to the email. Available formats include <strong>PDF</strong>, <strong>CSV</strong>, <strong>XLSX</strong>, and <strong>HTML</strong>.</td></tr><tr><td><strong>Delivery format</strong></td><td>Flex favorites</td><td><p>The email always includes a <strong>link</strong> that opens the favorite in Phocas. Keep the email as link-only or add a <strong>CSV</strong> or <strong>XLSX</strong> attachment.</p><p>If multiple Flex favorites use the same schedule, they are grouped into one email. Attached files are grouped into a ZIP file.</p></td></tr><tr><td><p><strong>Frequency:</strong></p><p><strong>On scheduled database build</strong></p></td><td>Favorites and alerts</td><td>Sends an email every time the underlying database builds.</td></tr><tr><td><strong>Frequency: Daily, Weekly, or Monthly</strong></td><td>Dashboards, favorites, alerts, and Flex favorites</td><td><p>Sends the email on the days and time you select.</p><ul><li>Weekly subscriptions are sent every Monday by default.</li><li>Monthly subscriptions are sent on the 1st of each calendar month at the selected time, even if the database has not updated in that month.</li><li>If you select a monthly day that does not exist, such as 31 in February, the subscription is sent on the last day of the month.</li><li>For monthly Flex favorite subscriptions, you can select a calendar day, such as Day 2, or a relative option, such as the first, second, third, fourth, or last specific day in the month.</li></ul></td></tr><tr><td><strong>Time</strong></td><td>All</td><td><p>When you want to receive the email.</p><ul><li>The default time is 9 am.</li><li>For Flex favorites, the default delivery window is between 9 am and 10 am.</li><li>This setting uses the timezone in your <a href="/spaces/7pj8v25BOyqZTdG5mdD1/pages/tnROZfjtnOZfwBsa3oON">account settings</a> page.</li><li>Emails can arrive up to an hour later than the selected time.</li></ul></td></tr><tr><td><strong>Don’t send if there are no results</strong></td><td>Favorites and alerts</td><td>Select this checkbox if you only want emails when results exist.</td></tr><tr><td><strong>Only deliver when there are results</strong></td><td>Flex favorites</td><td>Select this checkbox if you only want emails when results exist.</td></tr><tr><td><strong>Only send on</strong></td><td>Alerts</td><td>The alert status that triggers the email.<br>Select one or more status checkboxes: <strong>Red alert</strong>, <strong>Yellow alert</strong>, or <strong>Green alert</strong>.<br>These statuses relate to the color coding in the alert's settings and the icon that appears next to the alert on the homepage. <br>If you don't select a status, the email is sent at your selected time, regardless of status.</td></tr></tbody></table>

{% columns %}
{% column %}

<figure><img src="/files/2FoJWdtF1rp9AGkFIUxD" alt=""><figcaption><p>Dashboard subscription options<br>(Analytics or Financial Statements)</p></figcaption></figure>

<figure><img src="/files/iUmm80cVQ4n5J4uOG0sC" alt=""><figcaption><p>Alert subscription options<br>(Analytics or Financial Statements)</p></figcaption></figure>
{% endcolumn %}

{% column %}

<figure><img src="/files/7apM4lK0uCA7lxRKOIme" alt=""><figcaption><p>Favorite subscription options<br>(Analytics or Financial Statements)</p></figcaption></figure>

<figure><img src="/files/lDsdejEDqC4V8iXDwXId" alt=""><figcaption><p>Flex Modes favorite subscription options</p></figcaption></figure>
{% endcolumn %}
{% endcolumns %}

## Update or stop subscriptions

You can update your subscription settings or unsubscribe from subscriptions within Phocas or directly from the subscription email.

Administrators can manage subscriptions for all users.&#x20;

For details about each subscription option, see the [Configure the subscription](#configure-the-subscription) above.

### From your homepage

The **Subscriptions** tab on your homepage lets you view and manage all your subscriptions in one place.

<figure><img src="/files/x3cWlFJNyu8IgK5nokHR" alt=""><figcaption></figcaption></figure>

1. Locate the item you want to manage.
2. Click its menu button, then click **Manage subscription**.

   <div align="left"><figure><img src="/spaces/7pj8v25BOyqZTdG5mdD1/files/9QOWLU2zAQctceeEtVgc" alt="image-20240409-032555.png" width="132"><figcaption></figcaption></figure></div>
3. Update the subscription settings and click **Save**, or click **Unsubscribe** as required.

{% columns %}
{% column %}

<figure><img src="/files/I2jLzj2JauBnD3IYMrp0" alt=""><figcaption><p>Update a dashboard subscription</p></figcaption></figure>

<figure><img src="/files/JNhGx9iMYW7k2w1QGAYc" alt=""><figcaption><p>Update an alert subscription</p></figcaption></figure>
{% endcolumn %}

{% column %}

<figure><img src="/files/E4UPCFUiQXHxsuBcVWzm" alt=""><figcaption><p>Update a favorite subscription</p></figcaption></figure>

<figure><img src="/files/SDmdlquXqCZZhlVXs62X" alt=""><figcaption><p>Update a Flex favorite subscription</p></figcaption></figure>
{% endcolumn %}
{% endcolumns %}

### From a dashboard, favorite or alert

1. Open the dashboard, favorite, or alert.
2. Click the blue arrow next to its name, then click **Subscribe**.

   <div align="left"><figure><img src="/files/IcxYx9I9OAKaWdFb2GiO" alt="" width="279"><figcaption></figcaption></figure></div>
3. Update the subscription settings and click **Save**, or click **Remove** to unsubscribe, as required.

   <div align="left"><figure><img src="/files/ZszegFDEDvQ9A8jYymrr" alt="" width="281"><figcaption></figcaption></figure></div>

### From a Flex favorite

1. Open the Flex favorite.
2. Do one of the following:
   * Click the blue arrow next to the favorite name.
   * Click the **Favorite options** button on the toolbar.
3. Click **Update subscription**.

   <div align="left"><figure><img src="/files/kO4XNxFVb21klMkdZ3a5" alt="" width="141"><figcaption></figcaption></figure></div>
4. Update the subscription settings and click **Update**, or click **Unsubscribe**, as required.\
   ![](/files/HGGlNOQvAldBFVqEKFz2)

### From the subscription email

Dashboard, favorite, and alert subscription emails include an **Unsubscribe** link.

<div align="left"><figure><img src="/files/AEus2hMCxXruBQVLgaU3" alt="" width="563"><figcaption></figcaption></figure></div>

Flex favorite subscription emails include a **Manage subscriptions** button, which opens the **Subscriptions** tab on your homepage, and an **Unsubscribe** button.

<div align="left"><figure><img src="/files/5gR0YAxCUd5NkWzg7xkl" alt="" width="563"><figcaption></figcaption></figure></div>

***

## Note for administrators

Before users can subscribe to items, you must [configure the SMTP settings](/administration/configuration.md#smtp).

You can control which file types are available to individual users via the **Query** > **Export** [user permissions](/administration/users/add-update-user/user-permissions.md#query-permissions).

You can also [manage subscriptions](/administration/subscriptions-administration.md) for items across your organization:

* Subscribe or unsubscribe users on their behalf.
* Edit users’ subscription settings.
* View which users are subscribed to an item.
* Control the available subscription file types.


---

# 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://docs.phocassoftware.com/basics/getting-started/subscriptions.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.
