Content Type Visualizer Dashboard Widget

Content Type Visualizer Dashboard Widget offers a graphical representation of all content types, along with their fields, in a particular stack. This is similar to an ER diagram which is most commonly used in database management.

When you add the Content Type Visualizer widget to your dashboard, Contentstack users can easily get a diagrammatic view of all content types in a particular stack along with relationships between the content types, for example, one to one or one to many, and so on.

This step-by-step guide explains how to add the Content Type Visualizer Dashboard Widget for your Stack Dashboard.

Steps for Execution

Using this extension is a two-step process:

  1. Add Content Type Visualizer Widget extension to your Stack Dashboard
  2. Use the extension

Let's discuss these steps in detail.

  1. Add Content Type Visualizer Widget to Your Stack Dashboard

    To add the Content Type Visualizer widget, log in to your Contentstack account and perform the following steps:

    1. Go to your stack and hover over the Settings icon and click on Extensions.
    2. Click on the + Add Extension button on the top-right corner and select Create new.

      image1.png

    3. On the Select Extension Type page, select Dashboard Widget. You will be directed to the Create New Dashboard page where you need to enter details in the fields as given below:

      1. Title: Provide a suitable title, for example, Content Type Visualization.  
      2. Default width: Select Full Width.
      3. Hosting method: Select Hosted by Contentstack. As soon as you do this, you will see the Extension source code field below.
      4. Copy and paste the code from index.html, which is inside the root directory, in the extension .
      5. External source code: In this field, you need to enter the extension code. Contact our support team to get the updated source code for this extension.  
      6. Config parameters: Enter the configuration details for the extension.

        You need to provide the app host (region where your app is hosted, that is North America or European region, for example, app.contentstack.com)

        {
            "appHost": "app.contentstack.com"
        }
        For the European region, please use "eu-app.contentstack.com".

      7. Enable dashboard widget: Select this option to ensure all stack users are able to view the Content Type Visualizer widget on their respective screens. 

    4. Click on Save to create your custom widget. 
  2. Use the Extension

    Once you have added your Dashboard Widget, navigate to the Dashboard by clicking on the Dashboard link at the top. 

    You should be able to see the Content Type Visualizer widget added to your Dashboard as shown below:

    image1.png


    You can click on the refresh button to refresh the widget if new content types have been added and you want to reflect them in the widget. Moreover, you can zoom in or zoom out by clicking on the + and - icons respectively.

    You can see the name of the content type, and clicking on a small icon to the right of the content type name helps you get the JSON preview as shown below:

    image4.png


    You can simply copy the JSON and use it as required. Field count: 5 in the following screenshot represents the number of fields in the selected content type. Also, below it, there is an entry count that represents the total number of published entries in that content type:

    image3.png


    The Select Environment drop-down lists all the environments in your stack. Through this dropdown, you can select the environment and it gives you the published entry count for that particular environment.

    image6.png


    If you click on the pencil icon (as shown in the screenshot below) next to the content type name, you'll be directed to the Content Type Builder page where you can edit the content type as required.

    image2.png

Was this article helpful?

Thanks for your feedbackSmile-icon

More articles in "Dashboard Widget Guide for External Apps"

On This Page

top-arrow