schema - views - overview

  • Updated

Overview:

Custom Views in Neostella provides a configurable framework for creating reusable layouts that define how information is presented within the platform. 

Users can organize related data and components into centralized workspaces associated with a context. This ensures consistent information display.

Custom Views are configured based on a selected context among Global, Project, Person, Organization or Lead. The  Global option allows users to display information from different entities.
 

Key Components:

Design tab:

*Reference image of the Design Workspace.

Users can see a space with three main sections: Component panel, Canvas, and Configuration panel.

  1. Component panel: Allows users to select and drop components in the grid. There are three types:
  • Layout: Used for configuring the view structure. 
    (Tabs, Columns, Rows, and Containers)
  • Static: Elements that remain visible in the view, regardless of the context.
    (Text, Images, Link)
  • Dynamic: Elements that change their content based on the selected context. 
    (Button, Form, Chart, Field, and Card)
  1. Canvas: Gives users a space to drop and adjust components as well as configure the structure and contents of the view.
     
  2. Configuration panel: Used for the configuration of the selected component.
     

Preview Tab: 

This section allows users to see the customized view according to their permissions. In order to display the information, users must choose a record related to the selected context. 
 

 

Display tab: 

This section allows users to configure the General Display of the view, and choose the project Types, Roles, Permissions that will be displayed on their projects views. 

 

There is an option to define the status of the view: Active, Inactive or Draft.

The Menu display icon, label and order can be configured in this section.
 

 

Technical Considerations:

Display: Custom Views are responsible only for layout composition; neither component behavior nor configuration.

Dynamic components:

These components are independent, declarative, and reusable. Each one of them is linked with a specific object which supports multiple records within the same context This dynamic component automatically determines the record to use based on the selected context.

Component characteristics:

  • Self-contained
  • Context-aware
  • Reusable across multiple views

 

Requirements:

Element Description Type
Name Identifies the Custom View. Required
Menu Selector Defines where the Custom View appears in the platform menu. Required
Context Specifies the object or record type associated with the Custom View. Required
Status Defines whether the Custom View is Draft, Active, or Inactive. Required
Label Defines the name displayed to users. Required
Order Determines the position of the Custom View within the interface. Required
Icon Defines the icon displayed for the Custom View. Required
Context Type Narrows the Custom View to a specific context type when needed. Optional
Roles and Permissions Determines which users can access or manage the Custom View. Optional

 

How to use:

24 STEPS

1. To configure a Custom View, you must have a configured Component or create a new one.

Go to the Control Center navigation and select Schema.

2. Select Views.

3. This will open the Views Managing section.

Open the Components tab.

4. For this example we will create one by selecting the New Component button.

5. Add a Name and a API Name.

6. Select the Component Type.

7. For this tutorial, We will use a Chart.

8. To configure the chart, you must give the component a Context.

9. In this case we will use a Project.

10. Now we must select an Object, this will be the specific source of data that will be displayed in the view.

11. For this example we will be using Transactions.

But remember you can select any Object depending on the information that will be displayed.

12. Finish the configuration of the Chart.

In this case, you must select a Chart Type and add a Chart Title.

And set the filters.

13. Once every field is configured, scroll down and click SAVE.

14. This will allow you can see the Component displayed in the list.

Now go to the Views section.

15. Select the Project that will display the Custom View.

16. This is the Canvas used for the configuration of the View.

In the DESIGN Section, go to Dynamic Components.

Now select, drag and drop the Chart option into the Canvas.

16b. Drop

17. This will add the Chart component to the View.

18. Now go to the Configuration Section

19. and select the created Component.

20. This will configure the Component in the view.

Now you can go to the Preview section.

21. Look for the Record section

22. and search for the related Project.

23. Your Custom View is now configured and displaying information through the selected Component.

24. Now you know how to configure a Custom View and use Components to display record information.

https://www.iorad.com/player/2750549/Neostella---How-to-configure-a-Custom-View?tutorialIdKey=



Next step