> For the complete documentation index, see [llms.txt](https://docs.navigaglobal.com/engage/-MGi9-KKLwnWfoD36Ot6/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.navigaglobal.com/engage/-MGi9-KKLwnWfoD36Ot6/fundamentals/configurations.md).

# Configurations

Publish all your Engage settings to your website

Configurations are the ultimate level of Engage where you can finalize all the preferences that you set up on the preceding levels and publish them to your website.

To create a new configuration, navigate to the **Configurations** tab in your Engage dashboard and click on the **+New** button in the top right corner. Enter the name of your configuration, then click **Submit** (or hit **Enter**).

Alternatively, you can select an existing configuration from the drop-down menu where all your previously created configurations are listed.\
You can also delete your configurations, as well as create multiple configurations (however, only one of them can be active at a time).

Below you will find all the settings in the configurations panel supplied by brief comments on how you can use them to set up your configuration.

### **Campaign**

In the **Campaign** menu, you can select the [campaign](/engage/-MGi9-KKLwnWfoD36Ot6/fundamentals/campaigns.md) that your configuration will apply to from the drop-down menu (deactivated campaigns are shown as grayed out text). \
Click on the **Go to Campaign** button if you want to be redirected to the relevant campaign and check its setting&#x73;**:**

![Selecting a campaign for your configuration](https://2189759649-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MGi2iapIi_G2XvKxDCc%2F-MI3LKdR-y5mpoUfdaxk%2F-MI3PxJybPwTUiqkLeBF%2Fengage_configs_select_campaign.png?alt=media\&token=e25743c2-d5f7-42d8-9b8a-f8b39bcd3151)

### Meter Rules

Select the relevant [set of meter rules](/engage/-MGi9-KKLwnWfoD36Ot6/fundamentals/meter-rules.md) for your configuration from the drop-down menu (deactivated meter sets are shown as grayed out text). Click on the **Go to Meter** button to be redirected to the selected meter set and check its settings:\ <br>

![Selecting a meter set for your configuration](https://2189759649-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MGi2iapIi_G2XvKxDCc%2F-MI3LKdR-y5mpoUfdaxk%2F-MI3SWhEJpsqPK3s2c67%2Fengage_configurations_meter_rule.png?alt=media\&token=b504dfab-531c-44eb-be59-8cbdfd0e0cb8)

### **Code**

In the field **Code**, enter the code for your configuration. Engage will use this code to apply your configuration settings to your website.&#x20;

{% hint style="info" %}
Be sure to come up with a short and descriptive configuration code. The allowed characters are letters, numbers, and underscores. Do not use spaces or any special characters in your configuration code.&#x20;
{% endhint %}

In the example below, we are using *C2* for the campaign named *campaign 2:*

![](https://2189759649-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MGi2iapIi_G2XvKxDCc%2F-MI3VSR_XmK8VHg0s0QG%2F-MI3WkNuc0rmIgfGQMM8%2Fengage_configurations_code.png?alt=media\&token=b9c5deee-a84d-4ad7-8c6d-c305b16838f4)

### **Default Meter Level**&#x20;

From the drop-down menu under **Default Meter Level**, select the meter level (free, metered, or premium) for Engage to use in case a visitor cannot be sorted into any of the levels based on your settings (for instance, when none of the meter rules you've set up apply to this visitor).

### **Edit URL Params**&#x20;

Engage allows you to add custom [URL parameters](/engage/-MGi9-KKLwnWfoD36Ot6/fundamentals/glossary.md#url-parameters) to all the links in your configuration.

Clicking on the **Edit URL button** in the top right corner of the configurations panel will allow you to append one or several [URL parameters](/engage/-MGi9-KKLwnWfoD36Ot6/fundamentals/glossary.md#url-parameters) to all the links on all the [templates](/engage/-MGi9-KKLwnWfoD36Ot6/fundamentals/templates.md) used in your configuration. To do this, in the window that opens, click **Add Query Param**, then type your URL parameter's key (the part following the **?**, or an **&** – in case there are multiple parameters – and preceding the **=**) in the first field, and its value (the part following the **=**) in the second one. \
If you would like to add multiple parameters, click the **Add Query Param** button once again to reveal additional input fields:

In the example below, we added two parameters to the configuration, `topic=sports` and `sort=newest`:<br>

![Adding multiple URL parameters to all the links in your configuration](https://2189759649-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MGi2iapIi_G2XvKxDCc%2F-MI3uS23CdPq8UPn-Vsb%2F-MI3vFnLEQ4mgRvpV-FM%2Fengage_configurations_url_params.png?alt=media\&token=09be3761-5bbf-456b-b33a-534e69179dbd)

If you need to delete one or several parameters, just click on the trash can icon next to the relevant parameter.\
Once you have added all the parameters to your configuration, be sure to click **Save Params** for the changes to apply.

### Configuration Level Templates

Additionally, you can select templates for all the step-based processes that your visitors are expected to go through when registering, logging in, resetting their password, etc. \
The **Configurations** tab is also the place where you can customize the notice about your website's use of cookie files.

#### Registration Template

Select a template that will be used to guide your visitors through a registration process (triggered every time your visitors click on an element with the [attribute](broken://pages/-MGqrebdI_26mS5qJlX3#editing-attributes) `data-mg2-action="register"`). \
Click the **Edit HTML** button to open the [WYSIWYG Editor ](broken://pages/-MGqrebdI_26mS5qJlX3)and modify the selected registration template.&#x20;

#### Start Registration on Step

Under **Start** **Registration on Step**, select whether your visitors will see **Login** or **Registration** option first (select the desired option from the drop-down menu).

#### Login Template

Select a template that will be used to guide your visitors through a login process (triggered every time your visitors click on an element with the [attribute](broken://pages/-MGqrebdI_26mS5qJlX3#editing-attributes) `data-mg2-action="login"`). \
Click the **Edit HTML** button to open the [WYSIWYG Editor ](broken://pages/-MGqrebdI_26mS5qJlX3)and modify the selected login template.&#x20;

{% hint style="info" %}
Selecting a **Login Template** is mandatory for your configuration to work properly.&#x20;
{% endhint %}

#### Activation Template

Select a template to be used to guide your visitors through the activation process (triggered every time your visitors click on an element with the [attribute](broken://pages/-MGqrebdI_26mS5qJlX3#editing-attributes) `data-mg2-action="activation"`). \
Click the **Edit HTML** button to open the [WYSIWYG Editor ](broken://pages/-MGqrebdI_26mS5qJlX3)and modify the selected activation template. \
You can also click **Show Template** to preview the selected template.&#x20;

#### Start Activation on Step

Under **Start** **Activation on Step**, select whether your visitors will be required to go through the activation process during **Login** or **Registration** (select the desired option from the drop-down menu).

#### Cookies Privacy Template

Select a template that will be used to inform your visitors about your website's cookie files use. All of these templates have a [banner](/engage/-MGi9-KKLwnWfoD36Ot6/fundamentals/templates.md#banner) layout that you can customize according to your preference by clicking on the [**Edit HTML**](broken://pages/-MGqrebdI_26mS5qJlX3) button.\
You can also click **Show Template** to preview the cookies notice template.&#x20;

#### Reset Password Template

{% hint style="info" %}
You can use this template option if you purchased Engage without the rest of the Subscribe suite. In combination with your website's services, these settings enable your visitors to reset their passwords.&#x20;
{% endhint %}

Here you can select and customize a template for the password reset form. \
Click the **Edit HTML** button to open the [WYSIWYG Editor](broken://pages/-MGqrebdI_26mS5qJlX3) and modify the reset password template.&#x20;

### **Show Password Rules**

Clicking on the button **Show Password Rules** below will reveal additional settings that will allow you to specify the rules for your visitor's password (entered at registration and used to log in to your website):

![Setting up password rules for visitors](https://2189759649-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MGi2iapIi_G2XvKxDCc%2F-MIJ5tbWFQtmSImdYRtE%2F-MIJ6Ro9Qt7GSlFkbpbB%2Fengage_show_password_rules.png?alt=media\&token=e2f8713e-8a6f-4168-8324-4f43db33ff5d)

**Require capital:** check this box to indicate mandatory uppercase letters.\
**Require lower:** check this box to indicate mandatory lowercase letters.\
**Require number:** check this box to indicate mandatory numbers.\
**Require special characters:** check this box to indicate mandatory special characters.\
**Min length:** specify the minimum password length.\
**Max length:** specify the maximum password length. &#x20;

{% hint style="info" %}
These password rules will also apply in case you are using the [Reset Password Template](/engage/-MGi9-KKLwnWfoD36Ot6/fundamentals/configurations.md#reset-password-template).
{% endhint %}

### Cross-Subdomain Article Count

Activating the **Cross-Subdomain Article Count** switcher will allow you to sum all your visitors' article views across different subdomains within your website's domain (e.g. the article views on `sports.example.com` will be added to the views on `business.example.com`). \
When the **Cross-Subdomain Article Count** switcher is turned off, your visitor's views in different subdomains will be counted separately.

### Set A/B Test Cookie

Activate the **Set A/B Test Cookie** switcher for Engage to create a cookie with the randomized [A/B test ](/engage/-MGi9-KKLwnWfoD36Ot6/fundamentals/glossary.md#a-b-testing)data.&#x20;The cookie will be stored for 30 days.

### Allow Debug Panel

Engage allows you to use the **Debug Panel** as a tool to monitor and test your configuration in real time. Activate the **Allow Debug Panel** switcher to enable displaying the debug panel on your website.

Below you'll find the list of information and options available when using the debug panel on your website.

| Debug Panel Property                                                                  | Description and Use                                                                                                                                                                                                                                                                         |
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <p><strong>Clear Paywall's Storage</strong> <br><strong>(Clear All Data)</strong></p> | Resets all the visitors' views in this configuration in the test mode (without publishing these changes to the website).                                                                                                                                                                    |
| **Meter Level:**                                                                      | Shows the current meter level (free, metered, or premium)                                                                                                                                                                                                                                   |
| **Meter Set:**                                                                        | Shows the name of the current meter set                                                                                                                                                                                                                                                     |
| **Campaign:**                                                                         | Shows the name of the current campaign                                                                                                                                                                                                                                                      |
| **Conversation:**                                                                     | Shows the name of the current conversation                                                                                                                                                                                                                                                  |
| **Conversation Views:**                                                               | Shows the current number of [conversation views](/engage/-MGi9-KKLwnWfoD36Ot6/fundamentals/campaigns/conversations/expiration-types.md#reset-article-views)                                                                                                                                 |
| **Meter Views:**                                                                      | Shows the current number of [meter views](/engage/-MGi9-KKLwnWfoD36Ot6/fundamentals/campaigns/conversations/expiration-types.md#reset-article-views)                                                                                                                                        |
| **ArticleLeft:**                                                                      | Shows how many page views remain before a paywall action is triggered                                                                                                                                                                                                                       |
| **PaywallLimit:**                                                                     | Shows the maximum number of page views (as specified in the actions' settings) before a paywall action is triggered                                                                                                                                                                         |
| **Current ZIP:**                                                                      | Identifies the visitor's ZIP code                                                                                                                                                                                                                                                           |
| **Use Custom ZIP:**                                                                   | Check this box to enter a custom ZIP code; enter the code and click **Set** to apply it to your configuration                                                                                                                                                                               |
| **IP Access:**                                                                        | Shows whether the visitors with the current IP address are included into your [Allowed Access List ](/engage/-MGi9-KKLwnWfoD36Ot6/fundamentals/allowed-access-list.md)(**Allowed** or **Denied**, respectively)                                                                             |
| **Use custom configuration:**                                                         | <p>Check this box for the current configuration to be applied to this website;<br>Enter your <strong>Site Code</strong> and <a href="/engage/-MGi9-KKLwnWfoD36Ot6/fundamentals/configurations.md#code"><strong>Config Code</strong></a>, then click <strong>Set Configuration</strong>.</p> |
| **Unique Articles Count:**                                                            | Check this box to ensure that Engage only registers viewing different pages as the visitors' article views.                                                                                                                                                                                 |
| **Configuration is active:**                                                          | Check or uncheck this box to activate or deactivate your current configuration.                                                                                                                                                                                                             |
| **Custom Time:**                                                                      | Check this box to set a custom time (for instance, to test an action that will occur in the future).                                                                                                                                                                                        |
| **Engagement Rate:**                                                                  | Set the desired engagement rate for your content in the range between 0.01 and 1.                                                                                                                                                                                                           |
| **Debug Panel Open State:**                                                           | Check this box for the debug panel to always remain in an expanded view. Uncheck it if you prefer a collapsed view.                                                                                                                                                                         |
| **Log Level:**                                                                        | Starting with version 2.7, the Debug Panel allows you to control how detailed your console logs are. You can select one of the three options from the drop-down menu: **Low** (only essential logs), Medium (moderately detailed logs), and **High** (verbose logs).                        |
| **Version:**                                                                          | Shows the current version and build of Engage.                                                                                                                                                                                                                                              |

### Active

The **Active** switcher allows you to activate or deactivate your configuration.

### Allowed Access List

The **Allowed Access List** field enables you to assign any whitelisted IP addresses added earlier in the [**IP/User Agent**](/engage/-MGi9-KKLwnWfoD36Ot6/fundamentals/allowed-access-list.md) List tab.&#x20;

To do this, click anywhere in the **Allowed Access List** field, then select the relevant list(s) from the drop-down menu:

![Adding IP lists to your configuration](https://2189759649-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MGi2iapIi_G2XvKxDCc%2F-MISrlQjZMpVLni3qyvX%2F-MIStVfyLmnBtSntqUrW%2Fengage_configurations_allowed_access_list.png?alt=media\&token=345e6eaf-35d8-4805-a68d-8a8c38bcf55b)

### Gift Article

The Gift Article feature allows subscribers to share a link (as a gift) to any premium article from their subscription with individuals who do not have access to that content.

To enable the Gift article feature on your .com site, toggle ON the 'Gift article settings'. For more info on this feature, check [here](https://app.gitbook.com/o/-LXJkK7tFJY9DjO_rmf3/s/-MGi2iapIi_G2XvKxDCc/~/changes/498/how-to-guides/enabling-gift-articles-on-your-site).

1. ‘Shareable Count’ - Specifies how many times an end user can share a gift article. This is an optional field where the user can enter any positive integer. By default, the field is left blank, indicating no limit on the number of shares.
2. ‘Validity Until’ - Defines the number of days the gift article link remains valid. This is a mandatory field, with a default value of 30 days, which is also the maximum allowed. After this period, the gift article link will expire and become invalid.&#x20;

<figure><img src="https://2189759649-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MGi2iapIi_G2XvKxDCc%2Fuploads%2FfaMgY527s5Vu5fcwqhUB%2FGift%20Article%20section.png?alt=media&amp;token=e1a5288f-fc75-4c70-98f8-41f7db701c07" alt=""><figcaption><p>Gift Article Settings</p></figcaption></figure>

{% hint style="info" %}
The Gift Article feature is available only from Engage version 2025.1.
{% endhint %}

### Automatic Article Reset

Check the box **Turn on automatic article reset?** if you would like to set up an automatic reset of the visitor's views to occur on a regular basis.

In the first drop-down menu, select the day of the month on that you would like the views to be reset. \
In the second menu, select the interval at which the reset is to occur (between 1 and 12 months). \
Based on the data you've entered, Engage will calculate all the upcoming article reset dates for the current configuration.\
\
In the example below, the views will be reset every month on the first day of each month:

![](https://2189759649-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MGi2iapIi_G2XvKxDCc%2F-MIJeaw0NH7CkM8U6bFW%2F-MIJhZ_Ct-_B4GKmcx0-%2Fengage_auto_article_reset.png?alt=media\&token=2dd8d27e-8189-452b-96a4-09436786d05b)

### Submit

Once you have completed setting up your configuration, click **Submit** in the bottom left of the Configurations panel to save all your preferences. You can submit your configuration every time you'd like to save the changes you've made but are not ready to publish them to the website yet.

### Publish&#x20;

Once your configuration is ready to be applied to your website, click on **Publish.**\
You will see a new window where you can check the box **Clear All Data.** Checking this box will reset all the visitor's views, as well as the relevant configuration settings.&#x20;

If you'd like to clear only specific data before publishing your configuration, click **show more options,** then select the relevant checkboxes:

![Reset Options](https://2189759649-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MGi2iapIi_G2XvKxDCc%2F-MIJMkatg1kHZ36MBq5H%2F-MIJNRaEBeCSxkPfbACe%2Fengage_publish_configuration.png?alt=media\&token=0be4661a-af20-4772-b0e3-2c43c9593697)

{% hint style="warning" %}
From version 2.8.3 onwards, it is possible to reset Publish configuration options in the console window using Connext.Storage.GetLocalConfiguration() command.&#x20;

"PublishSettings" property has been added to Configuration public object (returned by Connext.Storage.GetLocalConfiguration()).

<img src="https://2189759649-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MGi2iapIi_G2XvKxDCc%2Fuploads%2FpSGHfExKx1f763IrcLOI%2Fimage.png?alt=media&amp;token=53945cbe-2961-4f1c-8e28-2f96741938e1" alt="" data-size="original">\
The reset options checked during Publish will return the value 'true' and the unchecked options would return the value 'false' in the console window.
{% endhint %}

{% hint style="info" %}
For all the configuration settings (as well as any subsequent changes you might want to add) to be applied to your website, be sure to first **Submit** and then **Publish** your configuration. It usually takes up to 1 minute for all the settings to be applied to your website.
{% endhint %}
