# Magento 2 Admin Message Manager

### <span style="color: #3b82f6;">Installation and User Guide for Magento 2 Admin Message Manager</span>

**Table of Contents**

1. [*Installation* ](#bkmrk-installation)
    - *Installation via app/code*
    - *Installation via Composer*
2. [*Configuration Settings for Admin Message Manager*](#bkmrk-configuration-settin)
    - *General Settings*
3. [*Admin Message Manager Workflow*](#bkmrk-admin-message-manage)
    - *Step 1: Access the Admin Message Grid*
    - *Step 2: Create a New Message*
    - *Step 3: Edit or Delete Messages*
4. [*Display logic for Admin Messages*](#bkmrk-display-logic-for-ad)
    - *Why do messages appear?*
    - *How do messages appear?*
    - *HTML Support*
5. [*View Messages in Admin Panel*](#bkmrk-view-messages-in-adm)
    - *Notice Message*
    - *Warning Message*
    - *Success Message*
    - *Error Message*

### <span style="color: #3b82f6;">Installation</span> [](#bkmrk-)

- <span style="color: #f97316;">**Installation via app/code:**</span> Upload the content of the module to your root folder. This will not overwrite the existing Magento folder or files, only the new contents will be added. After the successful upload of the package, run below commands on Magento 2 root directory.
    
    ```php
    php bin/magento setup:upgrade
    php bin/magento setup:di:compile
    php bin/magento setup:static-content:deploy
    ```
- <span style="color: #f97316;">**Installation via Composer:**</span> Please follow the guide provided in the below link to complete the installation via composer.

<p class="callout success">[https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer](https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer)</p>

### <span style="color: #3b82f6;">Configuration Settings for Admin Message Manager</span> [](#bkmrk--1)

Go to **Admin &gt; Stores &gt; Configuration &gt; Scommerce Configuration &gt; Admin Message Manager**

#### <span style="color: #f97316;">General Settings</span> [](#bkmrk--2)

- **Enabled -** Select "Yes" or "No" to enable or disable the module.
- **License Key -** Please add the license for the extension which is provided in the order confirmation email. Please note license keys are site URL specific. Please go to *Admin &gt; Stores &gt; Configuration &gt; Scommerce Configuration &gt; Core* and click on "Verify" to verify the license key.

[![image (62) (1).png](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/scaled-1680-/image-62-1.png)](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-62-1.png)

### <span style="color: #3b82f6;">Admin Message Manager Workflow</span> [](#bkmrk--3)

Using this extension an admin create custom messages for the other admins and pass on critical updates based on user roles.

The admin can only use this functionality if the have the "Scommerce Admin Message Manager Section" selected under role resources for their user role.

#### <span style="color: #f97316;">**Step 1: Access the Admin Message Grid**</span>

- Navigate to **Admin&gt;System&gt;Admin Message Manager**
- Only users with **"Scommerce Admin Message Manager Section"** permission can access this grid.

[![image (63) (1).png](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/scaled-1680-/image-63-1.png)](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-63-1.png)

#### <span style="color: #f97316;">**Step 2: Create a New Message**</span>

- Go to **Admin&gt;System&gt;Admin Message Manager**
- Click **"Add New Message"**.

[![image (64) (1).png](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/scaled-1680-/image-64-1.png)](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-64-1.png)

- Fill in the form: 
    - **Enabled :-** Turn it on to enable the message (Active/Inactive toggle)
    - **Message Label** (Optional identifier)
    - **Severity Type** (Notice, Warning, Success, Error)
    - **User Roles** (Multi-select roles that should see the message)
    - **Message Text** (Supports HTML links, bold, italics via WYSIWYG editor)
- Click **"Save"**.

[![image (65) (1).png](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/scaled-1680-/image-65-1.png)](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-65-1.png)

**Note:**

- Required fields: **Enabled, Message Label, Severity, at least one User Role,** **Message Text.**
- HTML is sanitized for security (only `<a>`, `<strong>`, `<em>` allowed).

#### <span style="color: #f97316;">**Step 3: Edit or Delete Messages**</span>

**Edit A Message**

1. In the grid, click **"Edit"** on the desired message.
2. Modify any field (Label, Text, Severity, User Roles, Enabled).
3. Click **"Save"** or **"Delete"** (if removing the message).

[![image (66) (1).png](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/scaled-1680-/image-66-1.png)](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-66-1.png)

**Delete A Message**

**Option 1: Single Deletion (From Grid)**

- Click **"Delete"** on the Edit row then confirm deletion

[![image (67) (1).png](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/scaled-1680-/image-67-1.png)](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-67-1.png)

**Option 2: Single Deletion (From Edit Form)**

- Open the message&gt;Click **"Delete Message"**&gt;Confirm.

[![image (68) (1).png](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/scaled-1680-/image-68-1.png)](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-68-1.png)

**Option 3: Mass Delete (Bulk Action)**

1. Select checkboxes next to messages.
2. From the **Actions** dropdown, choose **"Delete"**.
3. Confirm by clicking **"OK"** in the popup.

[![image (69) (1).png](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/scaled-1680-/image-69-1.png)](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-69-1.png)

### <span style="color: #3b82f6;">**Display Logic for Admin Messages**</span>

#### <span style="color: #f97316;">**When Do Messages Appear?**</span>

A message is displayed in the admin panel if:

- **Status = Active**
- **Admin user's role matches at least one selected role** in the message.

<span style="color: #f97316;">**How Do Messages Appear?**</span>

- **Sticky banner** at the top of the admin panel.
- **Severity-based styling** (colors match Magento's standard alerts): 
    - **Success** (Green)
    - **Notice** (Blue)
    - **Warning** (Yellow)
    - **Error** (Red)

#### <span style="color: #f97316;">**HTML Support**</span>

- Allowed tags: `<a>`, `<strong>`, `<em>`.
- Links are clickable.

### <span style="color: #3b82f6;">**View Messages in Admin Panel**</span>

- Messages appear as **sticky banners** at the top of the admin panel.
- Only **active** messages matching the user's role are displayed.

#### <span style="color: #f97316;">Notice Message</span>

<span style="color: #f97316;">[![image (70) (1).png](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/scaled-1680-/image-70-1.png)](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-70-1.png)</span>

#### <span style="color: #f97316;">Warning Message</span>

<span style="color: #f97316;">[![image (71) (1).png](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/scaled-1680-/image-71-1.png)](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-71-1.png)</span>

#### <span style="color: #f97316;">Success Message</span>

<span style="color: #f97316;">[![image (72) (1).png](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/scaled-1680-/image-72-1.png)](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-72-1.png)</span>

#### <span style="color: #f97316;">Error Message</span>

<span style="color: #f97316;">[![image (73) (1).png](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/scaled-1680-/image-73-1.png)](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-73-1.png)</span>

If you have a question related to this extension please check out our [<span style="text-decoration: underline;">**FAQ Section**</span>](https://www.scommerce-mage.com/magento-2-admin-message-manager.html#customfaq) first. If you can't find the answer you are looking for then please contact [**support@scommerce-mage.com**](mailto:core@scommerce-mage.com)**.**