Skip to content

Commit

Permalink
Update index.md
Browse files Browse the repository at this point in the history
  • Loading branch information
huyenntk-mageplaza committed Sep 8, 2023
1 parent de5d77f commit 08ffac1
Showing 1 changed file with 35 additions and 11 deletions.
46 changes: 35 additions & 11 deletions docs/catalog-permissions/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Login to the **Admin Magento**, choose `Stores> Configuration> Catalog Permissio

#### 1.1.1. Restrict Category

![](https://i.imgur.com/eL8KiCi.png)
![](https://i.imgur.com/Jynhn78.png)

- **Enable**: Select `Yes` to enable **Restrict Category** and will display a new field **Customer Group Restriction** under the **Content** tab when accessing the `Catalog> Categories`.

Expand All @@ -56,14 +56,16 @@ Login to the **Admin Magento**, choose `Stores> Configuration> Catalog Permissio

- **Select Specific URL**: Display the **Specific URL** field allow you to choose specific URL to be redirected to when accessing the restricted category
- **Specific URL**: Enter Url for the **Specific URL** field. If left blank or incorrectly entered the URL format, it will redirect to the 404 page by default

- **Show Redirect Message From Category Page**: Display the message to notify redirecting from the Category Page.
- **Hide menu on Frontend**:
- If `Yes` is selected, it will hide the Category outside the Frontend.
- And vice versa, selecting `No` will not hide the Category outside the Frontend


#### 1.1.2. Restrict Product

![](https://i.imgur.com/3jR2hKF.png)
![](https://i.imgur.com/rsOqGs1.png)

- **Enable**: Select `Yes` to enable **Restrict Product** and will display a new field **Customer Group Restriction** under the **Content** tab when accessing the `Catalog> Products`.

Expand All @@ -75,14 +77,15 @@ Login to the **Admin Magento**, choose `Stores> Configuration> Catalog Permissio

- **Select Specific URL**: Display the **Specific URL** field allow you to choose specific URL to be redirected to when accessing the restricted Product
- **Specific URL**: Enter Url for the **Specific URL** field. If left blank or incorrectly entered the URL format, it will redirect to the 404 page by default


- **Show Redirect Message From Product Page**: Display the message to notify redirecting from the Product Page.
- **Hide on Category Page & widget**:
- If `Yes` is selected, it will hide the product on the category page and widget.
- If `No` is selected, it will not hide Product on category page and widget and will display product as usual.

#### 1.1.3. Restrict Static Page

![](https://i.imgur.com/kubEvxv.png)
![](https://i.imgur.com/SdOx5hl.png)

- **Enable**: Select `Yes` to enable **Restrict Static Page** and will display a new field **Customer Group Restriction** under the **Content** tab when accessing the `Catalog> Page`.

Expand All @@ -95,6 +98,7 @@ Login to the **Admin Magento**, choose `Stores> Configuration> Catalog Permissio
- **Select Specific URL**: Display the **Specific URL** field allow you to choose specific URL to be redirected to when accessing the restricted page
- **Specific URL**: Enter Url for the **Specific URL** field. If left blank or incorrectly entered the URL format, it will redirect to the 404 page by default

- **Show Redirect Message From Static Page**: Display the message to notify redirecting from the Static Page.

#### 1.1.4. Restrict Static Block

Expand All @@ -107,10 +111,10 @@ Login to the **Admin Magento**, choose `Stores> Configuration> Catalog Permissio
### 2. Edit Category

- Login to the **Magento Admin**, choose `Catalog> Categories`, select **new/edit** with a restricted category you want
- **This section applies the configuration when choose new/edit for each Category.**
- **This section applies the configuration when choosing new/edit for each Category.**
- **Note**: If the Restrict Category in the Configuration section and for each Category here are different, priorities will be given to each category first.

![](https://i.imgur.com/oez4vp0.png)
![](https://i.imgur.com/Q5CnvjK.png)

- **Enable**:
- Default is `No` if **Enable Restrict Category** is enabled.
Expand All @@ -133,6 +137,8 @@ Login to the **Admin Magento**, choose `Stores> Configuration> Catalog Permissio
- **Specific URL**: Enter Url for the **Specific URL** field. If left blank or incorrectly entered the URL format, it will redirect to the 404 page by default
- You can choose **Use Config Settings** to redirect to the default URL or CMS page that you set in **Configuration Restrict Category**, at **Redirect To** field.

- **Show Redirect Message From Category Page**: Display the message to notify redirecting from the Category Page. If you put a tick on the **Use Config Settings** field, then the system will display the message set in the Module Configuration.

- **Also Hide Menu**:
- Select `Yes` to hide that category in Frontend. Otherwise, selecting `No` will display that category in Frontend.
- You can select `Use Config Settings` to default to use the configured value at **Configuration Restrict Category** with **Hide menu on Frontend** field.
Expand All @@ -153,7 +159,7 @@ Login to the **Admin Magento**, choose `Stores> Configuration> Catalog Permissio
- **This section applies the configuration when choose new/edit for each Product.**
- **Note**: If the Restrict Products in the Configuration section and for each Product here are different, priorities will be given to each Product first.

![](https://i.imgur.com/uDOO7g4.png)
![](https://i.imgur.com/a6Ud3kU.png)

- **Enable**:
- Default is `No` if **Enable Restrict Product** is enabled.
Expand Down Expand Up @@ -187,21 +193,23 @@ Login to the **Admin Magento**, choose `Stores> Configuration> Catalog Permissio
- **End Date**:
- Click the Calendar box to select the end date for Restrict Product.
- If left blank in this field, it will start applying Restrict Product by the date selected in the **Status Date** field and will not end up applying Restrict Product until it is disabled for that Product.

- **Show Redirect Message From Product Page**: Display the message to notify redirecting from the Product page. If you put a tick on the **Use Config Settings** field, then the system will display the message set in the Module Configuration.



### 4. Edit Pages/Block
### 4. Edit Pages/Block

- Login to the **Magento Admin**, choose `Content > Elements > Pages/Blocks`, select **new/edit** with a Restrict Static Page/Restrict Static Block you want.
- **This section applies the configuration when choose new/edit for each Page/Block.**
- **Note**: If the **Restrict Static Page/Restrict Static Block** in the Configuration section and for **each Page/Block** here are different, priorities will be given to each Page/Block first.

*Page*

![](https://i.imgur.com/bLK7hid.png)
![](https://i.imgur.com/51LCiID.png)

*Block*

![](https://i.imgur.com/eN5tQjo.png)
![](https://i.imgur.com/dN6To1H.png)

- **Enable**:
- Default is `No` if **Enable Restrict Product** is enabled.
Expand Down Expand Up @@ -237,6 +245,22 @@ Login to the **Admin Magento**, choose `Stores> Configuration> Catalog Permissio
- **Replace By**: Will be replaced by the **Show/Hide Editor** button. Here, it is possible to configure the block page and when accessing the restricted Block page will be replaced by the block page you have configured.
- If left blank, **Replace By** will default to the Replace By content above.

### 5. Rest API

**Mageplaza Catalog Permission extension** supports Rest API to limit or redirect when accessing the Category page, Product page, Static Page, and Static Block.

For more details, please visit <a href="https://documenter.getpostman.com/view/24281445/2s9Y5R1mB2#1e3230d5-1948-4613-8c02-a28f76f9ffbb" target="_blank" rel="nofollow noopener">here</a>.

Learn how to create Integration tokens <a href="https://devdocs.magento.com/guides/v2.3/get-started/authentication/gs-authentication-token.html" target="_blank" rel="nofollow noopener">here</a>.

### 6. GraphQL

To start working with Catalog Permission GraphQL for Magento, you need to meet the following requirements:

- Utilize Magento 2.3.x or 2.4.x. Return the site to the developer mode.
- Set GraphQL endpoint as http://<magento2-4-server>/graphql in the **URL** field, click **Set endpoint**. (Ex: http://develop.mageplaza.com/graphql)
- The mutations that Mageplaza supports are setting restrictions or redirects when accessing pages, blocks, etc. For more details, please visit <a href="https://documenter.getpostman.com/view/24281445/2s9Y5R1mB4" target="_blank" rel="nofollow noopener">here</a>.


## Notation

Expand Down

0 comments on commit 08ffac1

Please sign in to comment.