Configuring and Managing Custom Views

Configuring Custom Views

Adding a Custom View

1. Click the profile icon and select Manage Organizations & Teams.

2. Select the Organization for which you wish to configure a Custom View.

3. Click the Custom Views tab.

4. Click Configure Custom Views.

   At this point, you can add a contact email address of the Custom View's developer or maintainer. Refer to Verifying contact email address for more details.

5. Click Add a Custom View.

6. Fill out the form to configure a new Custom View. Specify the same information that you have previously defined in the local Custom View config file.

7. Click Register Custom View.

Now, the configuration is stored in the Merchant Center and a Custom View entity is created. The Custom View is currently in the Draft state.

Before proceeding with the installation step, you need to perform the following actions:

• Verifying contact email address
• Assigning the Custom View ID
• Moving a Custom View to the Ready state

Verifying contact email address

Working on Custom Views requires commercetools to contact the developers or owners of Custom Views from time to time, primarily for updates and support purposes. Hence, we require that every Organization using Custom Views provides a valid and verified contact email address.

To add a new email address, do the following:

1. In the Configure Custom Views screen, click Add new email address.
2. Specify a valid email address.
3. Click Save.

To update an existing email address, do the following:

1. In the Configure Custom Views screen, click the edit icon in the Contact email address for support section.
2. Specify the email address in the Edit contact email address dialog.
3. Click Save.

You will receive an email at the provided address. Click the verification link inside the email.

If you don't receive an email, please verify that you've provided the correct email address. If you've provided an incorrect email address, update the address and click Resend verification email.

Assigning the Custom View ID

Once you add a new Custom View, a unique ID is generated for the Custom View. Copy the Custom View ID and add it to the Custom View Config file, then redeploy your Custom View.

Moving a Custom View to the Ready state

By default, a Custom View is in the Draft state. This state signifies that the owners or developers are finalizing the development and configuration of the Custom View.

To install a Custom View in an Organization, you must first move it to the Ready state.

In the configuration details page of your Custom View:

1. Click the State drop-down menu, choose Ready.
2. Click Confirm in the confirmation dialog. The Custom View is now Ready for installation.

Locating installed Custom Views

After installing the Custom View, users will be able to interact with it in the Merchant Center areas you selected as entry points.

A Custom View selector displays the names of the Custom Views available for the current area. To open the installed Custom View, click the Custom View name in the Custom View selector.

The Custom View selector is displayed at the top of the content area below the page title and description. For tabular pages, the Custom View selector is displayed below the tabs selected as entry points when adding the Custom View.

Moving a Custom View to the Draft state

In the configuration details page of your Custom View:

Click the State drop-down menu, choose Draft. The Custom View is now in the Draft state. While in this state, you can update the configuration or delete the Custom View.

Deleting a Custom View

To delete a Custom View, click the delete icon, then click Confirm in the Delete Custom Views dialog. The Custom View is then removed from the Configured Custom Views: Draft section.

Managing Custom Views

Installing a Custom View

Install a Custom View to make it accessible in the Projects of your Organization.

1. Click the profile icon and select Manage Organizations & Teams.

2. Select the Organization for which you wish to install a Custom View.

3. Click the Custom Views tab.

4. Click Install Custom Views.
   This page shows the Custom Views that have been Installed in the current Organization.
   In addition, you can see the list of Custom Views that are Ready for installation and have not been installed yet in the current Organization. The list might include Custom Views defined in other Organizations where you have administrator rights.

   

5. Choose a Custom View from the Ready for installation section. Refer to Moving a Custom View to the Ready state for more details.

6. Review the permissions listed in the Requested permissions section. A user must have at least View permission to access the Custom View in the Merchant Center.

7. In the Projects access section, grant Projects access by selecting one of the following options:

   • Install for all projects of this organization: grants access to all projects of an Organization.
   • Install for selected projects only: grants access only to selected projects of an Organization. To do so, select the Projects from the Select projects drop-down list.

8. Click Save.

You can now access the Custom View within the respective Merchant Center Projects.

Depending on the setup of your Organization, you can assign Team permissions to your Teams.

Updating Projects access

You can grant or revoke Projects access for a Custom View.

1. Click the profile icon and select Manage Organizations & Teams.

2. Select the Organization.

3. Click the Custom Views tab.

4. Click Install Custom Views.

5. Choose the Custom View.

6. In the Projects access section, select one of the following options:

   • Install for all projects of this organization: grants access to all projects of an Organization.

   • Install for selected projects only: grants access only to selected projects of an Organization. To do so, select the Projects from the Select projects drop-down list.

     To revoke access for selected Projects of the Organization, click the Revoke access button next to the desired Project in the selected projects list.

7. Click Save.

Assigning Team permissions

To grant access to Custom Views to individual Teams, you must configure each Team's permissions. Members of the Team can view and access the Custom View in the Merchant Center, based on the given permissions.

1. Click the profile icon and select Manage Organizations & Teams.

2. Select your Organization.

3. Choose a Team, then click the Permissions tab.

4. Select the desired Project from the Select project drop-down.

   Make sure to select Projects that have been granted access to the Custom View.

5. In the Custom Views section, choose the desired Custom View and configure the permissions for the Team. A Custom View always has a default permission group. At the very minimum, you need to assign View only to allow users to access the Custom View. Additionally, you can use more granular permission groups to cover specific business requirements.

   • View only: view resources in a Custom View.
   • View and edit: view, create, modify, and delete resources in a Custom View.

Uninstalling a Custom View

To remove a Custom View from all the Projects in an Organization:

1. Click the profile icon and select Manage Organizations & Teams.
2. Select the Organization for which you wish to uninstall a Custom View.
3. Click the Custom Views tab.
4. Click Install Custom Views.
5. Choose a Custom View from the Installed section.
6. Click Uninstall.
7. Click Confirm in the Uninstall the Custom View dialog.