Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 5

Introduction :

With the help of a related list, the user can show the related data of objects and the user can show the data up to 3 the level hierarchy.

PWR Related List.png

Steps to create related list config:

  1. Go to the Designer tab

    RL Designer.png

  2. Select any component from the list of components

    RL Select Component.png

  3. Users can use existing Config, or users can create a new Config

    RL Select Config.png

  4. If the user creates a new config

    RL Create Config.png

  • Label: Here user can set the title for the config of the component

  • Name: The API name of the label is shown here

  • Page Type: Here user can select page type as record page or non-record page; depending on which page the user wants to show the component

  • Non-Record Page: By choosing the non-record page user can use this config on the home page and app page.

  • Record Page: By choosing the record page user can use this config on a related record object

  • Object Name: Here user can choose any object on which that created config will be shown

Here are the details around different attributes, and which valid information can be input for the same.

Attributes:

  • Record Object: The object name is auto-populated here as you select the object at the time of config creation.

  • Record To Preview: This feature helps you preview and evaluate the related list’s appearance according to the selected record.

RL Record to Preview.png

  • Child relationship: The ”Child relationship” field allows you to choose the child object you want to display in the related list.

RL Child Realtionship Config.png

  • Object Name: Selected child relationship object name will be auto-populated here in read-only format. If no child relationship object is selected, then by default, the record object is auto-populated in this field, or else here you have to choose an object.

RL Object Config.png

  • Display Fields: Display Fields allow you to choose the fields from the display fields that you want to display in the related list. The fields that you selected here are displayed in the selected fields.

RL display Fields.png

  • Show Search: The ”Show Search” checkbox allows you to enable or disable the search functionality within the related list. Search Bar will be displayed at the top of the related list.

  • Search Fields: ”Search Fields” allows you to customize the search experience by choosing which fields you want to be included in the search results for this related list.

RL Search Fields.png

  • Filter Criteria: The ”Filter Criteria” section allows you to customize the display of the related list based on specific criteria.

RL Filter Criteria.png

  • Show Checkbox: The ”Show Checkbox” option allows you to display or hide check boxes next to each item in the related list.

  • Max Selected Record Count: The ”Max Selected Record Count” field allows you to set a maximum limit for the number of records that can be selected in this related list.

  • Page Size: The ”Page Size” option allows you to specify the number of records displayed per page in the related list.

RL Page Size.png

  • Order By: ”Order By” allows the user to specify the way they want the related list items to be displayed; ”Order ” allows the user to organize the items in this related list either in ascending or descending, by default ascending is selected.

RL Order By.pngRL Order By Value.png

  • Table Action: The user can create multiple table actions on the related list. By default, only new actions are displayed, which are visible in the top right corner.

RL Table Action Config.pngRL Table Action Config2.png

  1. Label: The Label provides a name or description for a specific table action

  2. Name: The API name of the label is shown here.

  3. Left Icon: This feature enables you to display an icon on the left side of an action, adding visual context and clarity to the action it represents.

  4. Right Icon: This feature enables you to display an icon on the right side of an action, adding visual context and clarity to the action it represents.

  5. Variant: Allows to show Buttons in different color formats.

    1. Neutral: Neutral is the default variant of the Button which is displayed in white color

    2. Brand: Brand is a blue Button, used to draw attention to the primary action on a page

    3. Outline-brand: Outline-brand is similar to the brand variant, but the color is used for the label and border only, not the Button color

    4. Destructive: Destructive is a red Button used to warn that the action has a negative effect

    5. Success: Success is a green Button used to indicate a successful action

    6. Text Destructive: This button is used to indicate a destructive action to the user

  • Min Selected Count: The ”Min Selected Count” option allows the user to specify the minimum number of items that must be selected in the related list.

  • Hide Action: The Hide Action feature allows the user to control the visibility of specific items within a related list.

  • Action: The user can create the actions here. For example, creating new records, navigating to any URL, editing any record, etc.

    • Type: Here user can select any specific type for that particular action

      • Custom Component

      • Edit

      • Global Action

      • List View

      • New

      • Object Page

      • Quick Action

      • Redirect

      • Tab

      • View

      • Delete

  • Row Actions: The user can create the row actions here, Actions are to be performed at the record level for the respective record by default three actions are created view, edit, delete.

RL Row Action Config.pngRL Row Action Config2.png

  1. Label: The Label provides a name or description for a specific table action.

  2. Name: The API name of the label is shown here.

  3. Hide Action: The Hide Action feature allows you to control the visibility of specific items within a related list.

  4. Action: You can create the actions here. For example, creating new records, navigating to any URL, editing any record, etc.

    1. Type: Here user can select any specific type for that particular action

  • Padding Location: Defines the position of the padding for a component. The padding creates extra space within a component.

RL Padding Location Config.png

  1. Around: Creates padding around the component

  2. Top: Creates padding at the top of the component

  3. Left: Creates padding at the left side of the component

  4. Bottom: Creates padding at the bottom of the component

  5. Right: Creates padding at the right side of the component

  6. Horizontal: Creates padding horizontally

  7. Vertical: Creates padding vertically

  • Padding Size: The padding size of the component can be set to:

RL Padding Size Config.png

  1. None

  2. xxx-small

  3. xx-small

  4. x-small

  5. Small

  6. Medium

  7. Large

  8. x-large

  • Margin Location: Defines the position of the margin for a component. margin creates extra space around a component.

RL Margin Location Config.png

  1. Around: Margin gets added around the component

  2. Top: Margin gets added at the top of the component

  3. Left: Margin gets added at the left side of the component

  4. Bottom: Margin gets added at the bottom of the component

  5. Right: Margin gets added at the right side of the component

  6. Horizontal: Margin gets added horizontally

  7. Vertical: Margin gets added vertically

  • Margin Size: The margin size of the view can be set to:

RL Margin Size Config.png

  1. None

  2. xxx-small

  3. xx-small

  4. x-small

  5. Small

  6. Medium

  7. Large

  8. x-large

After clicking on the Save button the config will get saved on the component config object and the user can view this button on the Record page, App page, Home Page, Flows, and Community.

  • Preview Section: After the user has selected and filled the fields according to their requirements, they can preview the components in the Preview section before saving them on the Record Page, App Page, Flows, and Community Page.

RL Preview Section.png

  • PWR Rating screenshots:

    • PWR Related List on Record Page:

      RL On Record Page.png

    • PWR Related List on Home Page:

      RL On Home Page.png

  • No labels

If you have any concerns or queries, then please contact us on support@orektic.com