Menus

Menus

Field's Description

• Menu ID Internal, Identity field.

• Module ID If Module ID value is null in app.menus table, the page is not displayed in menus. These are generic pages and may be shared by other menus. Such pages are displayed on-demand and is used as "related_menu_id" in app.menu_related_pages.

• Base Menu If set, this menu will use the contentUrl from the baseMenu, as well as the (parameters, relatedPages, etc, and then add any additional parameters and relatedPages defined on this menu item.

• Menu Name Name of the menu and that should not be empty.

• Menu Text This content will be HTML and will be used to display HTML formatted menu.

• Sub Module ID If set, menu will be shown under the Sub Module Name in UI.

• Relative URL Provide the HTML file path in project. when you click that menu in UI, given html file will be rendered.

• Parent Menu ID If set, this menu item will show as a child of the ParentMenuId in hierarchical lists of the menu items.

• Menu Sequence The value is used for sequencing the menus on the UI.

• Menus Staff Responsible Need to select the user who is responsible for that menu.

• Is Excluded? When true, the menu will not show in UI.

• Is Module Start Up?

  If It’s true, Menu will be opened automatically when the Module is loaded. NOT YET IMPLEMENTED.

• Is Completed? It’s Used to set whether that Menu is fully completed or not.

• Title Template Provide the title template.

• Condition

  Menu condition provides list of conditions on which the menu will be displayed.  The list of conditions is specified in a JSON text as in sample below.   Each item in the list is a OR condition. If the condition matches to anyone item in the list, the menu will be displayed.  All items in the list of "ParameterConditions" is a AND condition, and they must match for the menu to be displayed.   

  [

    {

      "ParameterConditions": [

        {

          "ParameterName": "CdrType",

          "ParameterValue": 1

        },

        {

          "ParameterName": "IncomingCdrType",

          "ParameterValue": 1

        }

      ]

    },

    {

      "ParameterConditions": [

        {

          "ParameterName": "CdrType",

          "ParameterValue": 1

        },

        {

          "ParameterName": "IncomingCdrType",

          "ParameterValue": 2

        }

      ]

    }

  ].

• Menu Description A short explanation of what that Menu is created for, what it will do.

MenusParameters

Field's Description

• Menu ID Internal, Identity field.

• Parameter Name Need to provide the Parameter Name that cannot be contains spaces/Special characters and that should be unique for that menu. this can be used as Environment Variables as well.

• Field Name

  Need to Provide the Field Name, that will be used in two different cases,

  • Related Page Parameters  : If grid has command button, when we click that you want to redirect to another page and want to pass some parameters(from selected row) then you can be set the FieldName(from grid response table) to the ParameterName.
  • Menus Parameters : Field_name is used from second child. let us consider 3 menus with hierarchical as below,
  • Parent
    • Child 1
      • Child 2

  Parent page has grid with command button when click that we have passed selected row values to Child 1.

  Example : Parent page grid response table has Field “ParentAccountNo”,so we have created Related page parameter “ParentAccountNo” with FieldName “ParentAccountNo” and value got passed from Parent page to Child 1.Now, we want to pass “ParentAccountNo” Field value as “AccountNo” Parameter from Child 1  to Child 2, For this case Menu Parameters will be used.we can be added ParameterName “AccountNo” with FieldName “ParentAccountNo”.

• Parameter Default Value

  If set, this value will be passed as parameter value when parameter value is null.

  Note : Also check Is Default Value Null field Description.

• Is Default Value Null

  If Is Default Value Null=1, Parameter value will be passed as Null, when parameter return no values.

  Note: If parameter_default_value is not null then parameter_is_default_value_null should be 0 and if parameter_default_value is null then parameter_is_default_value_null should be 0/1.

• Usage

  This a Enum. It’s determines whether a parameter is passed as /used for

  • No Action = 0
  • Menu = 1
  • Page = 2
  • Menu  + Page = 3

• Parameter Default Value Method Not yet Implemented.

Related Pages

Field's Description

• Menu Related Page ID Internal, Identity field.

• Parent Menu Related pages are created under that menu.

• Related Menu ID Need to pick the Related menu which you want to redirect.

• Parent Menu Related Page Id If provided, this makes the related page conditionally called when it’s parent related page record is called.

• Title Template

  Need to provide the Title Template, In that we can set the dynamic field value which will be shown as title ,when we redirect the page using related pages.

  Example: we have Command button(Details button) in Account page, when click that Command button from Account No = 2,It’s Redirected to the Customer Support page. on that page we can see the Dynamic Title with selected AccountNo and CustomerCompany.Title used in Related page is #=AccountNo #: #=CustomerCompany#.

• Entity Table Name For implementing command button in Grid controls we need to provide the response table name which was used for binding the grid.

• Control Name Provide the control name of related pages.

• Command Name Need to provide the command name, This should not be empty when you create Related pages for Command buttons in grid controls.If you need Details command button then simply provide the name as “details”.

• Before Method Name If provided, runs this method from the grid’s options, instead of opening a container.

• Field Name FieldName is the name of a field to bind a hyperlink to for navigation.

• On Navigation When true, the page is opened on navigation of the record. When true, it is mutually exclusive with CommandName, FieldName.

• Auto Select If set, the action (link/detail) will select that record as well as fire the action. Navigation always autoSelects.

• Container Level

  • -1 - A new tab at the application root
  •  0  - At the bottom of current page
  •  1  - As a sibling tab to the current tab
  •  2  As a Popup

• Single Instance If true and a previous instance exist, it will be destroyed and recreated.

• Comments A short explanation of what that Related menu is created for, what it will do.

• Command Icon Text Need to provide the Command Icon Text, Text will be shown with command buttons in grid’s row.

• Command Icon Css Class

  Need to provide the Command Icon CSS class. If set , Command button will be shown as Icon button in grid’s row. we can be used “Kendo” and “Font Awesome” Icons.

  Example: “k-icon k-i-pencil”, “fas fa-exclamation-circle text-danger”

• Hover Text The tooltip, also known as info tip or hint, is a common graphical user interface element in which, when hovering over a command buttons, it’s displays information about that Command buttons.

• Command Field Number The value is used for sequencing the command buttons on a row.

• Is Related Page Parameters Implicit If RelatedPageParameters is specified (not null), this flag specifies if the parameters are used in implicit manner or not. If used in an implicit manner, the user will not be able to modify the value.

• Condition

  Related page condition provides list of conditions on which the related page will be displayed.  The list of conditions is specified in a JSON text as in sample below.   Each item in the list is a OR condition. If the condition matches to anyone item in the list, the menu will be displayed.  All items in the list of "ParameterConditions" is a AND condition, and they must match for the menu to be displayed.

  [

    {

      "ParameterConditions": [

        {

          "ParameterName": "CdrType",

          "ParameterValue": 1

        },

        {

          "ParameterName": "IncomingCdrType",

          "ParameterValue": 1

        }

      ]

    },

    {

      "ParameterConditions": [

        {

          "ParameterName": "CdrType",

          "ParameterValue": 1

        },

        {

          "ParameterName": "IncomingCdrType",

          "ParameterValue": 2

        }

      ]

    }

  ].

• Menu Sequence The value is used for sequencing the menus on the UI.

Related Page Parameters

Field's Description

• Menu Related Page ID Internal, Identity field.

• Menu Parameter Name Need to provide the Parameter Name that cannot be contains spaces/Special characters and that should be unique for that menu. this can be used as Environment Variables as well.

• Field Name

  Need to Provide the Field Name, that will be used in two different cases,

  • Related Page Parameters  : If grid has command button, when we click that you want to redirect to another page and want to pass some parameters(from selected row) then you can be set the FieldName(from grid response table) to the ParameterName.
  • Menus Parameters : Field_name is used from second child. let us consider 3 menus with hierarchical as below,
  • Parent
    • Child 1
      • Child 2

  Parent page has grid with command button when click that we have passed selected row values to Child 1.

  Example : Parent page grid response table has Field “ParentAccountNo”,so we have created Related page parameter “ParentAccountNo” with FieldName “ParentAccountNo” and value got passed from Parent page to Child 1.Now, we want to pass “ParentAccountNo” Field value as “AccountNo” Parameter from Child 1  to Child 2, For this case Menu Parameters will be used.we can be added ParameterName “AccountNo” with FieldName “ParentAccountNo”.

• Parameter Default Value

  If set, this value will be passed as parameter value when parameter value is null.

  Note : Also check Is Default Value Null field Description.

• Is Default Value Null

  If Is Default Value Null=1, Parameter value will be passed as Null, when parameter return no values.

  Note: If parameter_default_value is not null then parameter_is_default_value_null should be 0 and if parameter_default_value is null then parameter_is_default_value_null should be 0/1.

• Parameter Default Value Method Not yet Implemented.

• Usage Menu Parameter - The value is passed as parentMenuParameters to be used by a menu control on the page you are calling to filter out menu items
  Page Parameter - The value is added to the container of the page you are calling
  Both Menu and Page Parameters - Combination of Menu and Page above