View Config - Static Template

Owned by Lakshminarayanan1 S CTOO (Unlicensed)
Last updated: Oct 13, 2020

The View Config tab holds the configurations that are applicable to the Tree App View. Configure the View Configurations based on the description provided in the following table:

  1. Caching:




    #

    Field Name

    Description

    Sample Value

    Caching

    1

    Enable Data Cache

    Enable this option for scenarios where the underlying data source cannot support dynamic filter, sort, and group requests and can only return complete data set. This pulls the data from data source into an in-memory cache and performs all operations on the in-memory cache. Care must be taken when enabling this option to ensure that sizing based on usage needs are considered / factored before this is enabled.

    Toggle on: Cache data from data source prior to processing.

    Toggle off: Gets data from data source.

    When using Web Service data sources, ensure to toggle on Enable Data Cache option and select the App Instance option to enable sorting, filtering and pagination on the app (widget).

    Toggle on

    2

    Caching Scope

    When Cache Data Indicator is 'Yes' enables the Caching Scope option.

    App Instance: Indicate that caching from data source must be done for every instance of the App. This means that there will be more requests to the data source for every time the user navigates to the App across workspaces.

    User Session: Indicates that the caching from data source is done at the Session level. This reduces the number of hits to the data source. This option must not be used for cases where within a session; the user does some activity and expects the cached data to change.

    App Instance

  2. Grid Configuration:




    #

    Field Name

    Description

    Sample Value

    Grid Configuration 

    1

    Detail Action Indicator

    Selected: Enables the double-click action on the view.
    De-Selected: Disables the double-click action on the view.
    The developer must use CWEC.CELL_DBLCLICK handler to write their double-click action logic.


    2

    Group Header Indicator

    Selected: Indicates the custom summary text that must appear as header text.
    De-Selected: Indicates the value of the grouped data will appear as per the Group Configuration settings in Create View Item screen.
    If this configuration is Selected, use groupgridTextTpl attribute to give the summary text.
    For example:

    this.mv = new iportal.view.MultiView
({ 
	groupgridTextTpl : '{[values.rs[0].data["GROUPED_COL"]]} 
	({[values.rs.length]})',//Grouped View Item 
	id:'WIDGET_ID' //App Id 
});


    3

    Total Records Indicator

    Selected: Displays the total number of results for the filters applied.
    De-Selected: Does not display the total number of results for the filters applied.


    4

    Context Column Indicator

    Selected: Displays the dedicated Context Action column as the last column for the context menus. The context types of the menus appearing in the context column must be 'ICON'.
    De-Selected: Context column will not be displayed.


    5

    Column Ordering

    Selected: Allows reordering the column from one position to another position in the grid.
    De-Selected: Disables the column re-ordering option.


    6

    Dynamic Filter

    Selected: Allows filtering of data dynamically on page load.
    De-Selected: Disables the dynamic filtering.


    7

    Initial Records to Display

    Allows displaying the indicated number of records while rendering on the loading page.


    8

    Number of records to display

    Allows displaying the indicated number of records on a page.

    The maximum allowed limit is 45 records per page.


  3. Context Menu:

    Context menus are the pop-up menus that appear when right-clicking the apps. Usually the context menus are created for the record manipulation activities.

    The context actions triggered using the context menu will enforce entitlement enabling a direct context to the logged-in user against the data they are viewing and the actions they can perform on the data.






    #

    Field Name

    Description

    Sample Value

    Context Menu

    1

    Enable Context Menu

    Toggle on: Switch on the toggle to enable context menu. 
    Toggle off: Switch off the toggle if you do not want to enable context menu.

    Toggle on

    2Enable Swipe Context Menu

    Toggle on: Switch on the toggle to enable swipe context menu.
    Toggle off: Switch off the toggle if you do not want to enable swipe context menu.

    Note

    Swipe Context Menu is applicable only for mobiles and tablets. 

    		Toggle on
    3

    Add New

    Click Add New to add new context menu or swipe context menu.

    -

    On clicking the Add New button, the configurations for the context menus appears as shown in the following screen shot. Provide the configuration for the new context menu based on the information available in the following table:



    #

    Field Name

    Description

    Sample Values

    1

    Menu Id

    This is a mandatory field. Menu ID serves as a unique ID for the context menu. 

    INITIATE_PAYMENT

    2

    Menu Display Name Key

    This is a mandatory field. Menu Display Name Key can be termed as label key of the localized text, which will appear as Menu Name.

    INITIATE PAYMENT

    3Position

    This is an optional field. It denotes the position of the context menu.

    		1
    4

    Event Id

    This is an optional field. It denotes a unique Event ID, which will be initiated on click of the menu.

    -

    5

    Context Type

    This is a mandatory field. It denotes the type of Context menu, which must appear on the screen. The available options are:

    • MENU
    • ICON
    • APP
    • BUTTON

    MENU

    6Dialog size

    This is a mandatory field. It indicates the dialog size of the form or form container that appears on the screen, based on the selection of Launch Type. The available options are: 

    • Small 
    • Medium 
    • Large 
    • Extra Large
    		Medium 
    7

    App Widget Id

    This is an optional field. Indicates the Context App to be shown automatically when the current menu is clicked. This option is applicable only when the Context Type is 'APP'.

    -

    8Launch Type

    This is an optional field. On clicking the context menu, a form with or without containers gets launched in modal window. The option ‘PUBLISH’ enables to submit or publish the relevant information. The available options are:

    • Launch form without Container in Modal Window - This launch type enables the form to be launched without a container.
    • Launch form with Container in Modal Window - This launch type allows the form to be launched along with a container.
    • Publish -This launch type paves the way for publishing the information of relevant fields.
    		LAUNCH FORM WITHOUT CONTAINER IN MODAL WINDOW
    9Config

    Config serves as an action button. If Launch Type is involved, then Config certainly becomes mandatory. 

    Note

    You will be able to select form containers only if you choose the option of Launch Form with Container in Modal Window in Launch Type drop-down list. If the Launch Type is Launch Form without Container in Modal Window, then you will be able to select only forms.


    1. Click Config to select forms and form containers.

    2. From the list of forms, select a form of your choice.

      Info

      The form, which you select, must be relevant to the data of the template. 


    10Req Model IDThis is an optional field. It indicates the Request Model ID of the Form.-
    11Mode

    This is an optional field. It indicates the type of mode.

    Note

    If you don’t choose any mode type, then depending on the launch type, a form with or without container gets created. In case, if the launch type involves Publish, then the information associated with the relevant fields will get published.

    The available options are: 

    • EDIT - Enables the user to modify or edit the form.
    • VIEW - The user can only view the form and there is no scope for performing any actions.
    		EDIT
    12Applicable for

    This is a mandatory field. Indicates the channels, for which the menu is applicable. The available options are:

    • Desktop
    • Mobile
    • Tablet

    13Block Position

    This is a mandatory field. Indicates the Swipe Position in Mobiles and Tablets. This option appears only if Enable Swipe Context Menu is selected. The available options are:

    • Left
    • Right
    		LEFT
    14Label

    Indicates the label key of the localized text, which is assigned as the name of the context menu. 

    Selected: The label key will appear.

    De-Selected: The label key will not appear. 

    		Selected
    15Icon

    This option allows you to choose an icon for the context menu. 

    Selected: The icon will appear. 

    De-Selected: The icon will not appear. 

    To select an icon for context menu, perform the following steps: 

    1. Click the iconon the left side of the newly created context menu, e.g. INITIATE PAYMENT. 


    A screen, comprising of various icons appears. 

    2. Default, Active and Disabled are the three available options, categorized under the field, Choose icons for different state. To find an icon, type the name of the icon in the Search box to find it. You can assign separate icons for the three different states of Default, Active and Disabled. Default indicates the default icon of the context menu, whereas Active and Disabled depict the active and disabled states of the context menu respectively. 


    3. For customized icons, click Custom tab.  


    4. Click Browse Files button to select an image from your local drive. You can even drag and drop the customized image file directly.

    5. After selecting the image, provide unique names for Class Tag and Search Tag. The Image Name gets assigned automatically. In case, if you wish to change the Image Name, then you can modify it. The name, which you provide in Search Tag, will be detrimental, when you perform a search. Use the name, provided in the Search Tag to find the customized icon.  Click Ok to upload the customized icon. 

    If you upload a customized icon for the context menu, ensure that you restart the app server, after saving the app (widget). Make sure to log out from Canvas Studio and close the Studio application, before restarting the app server. If you do not restart the app server, the uploaded custom icon will not appear as the assigned icon for the selected context menu.




    6. To edit the configurations of the context menu, click icon, whereas to delete the context menu, click icon. Clickicon to create a new context menu, which will be categorized under the recently created one. 

    		Selected
    16

    Create

    Click Create to create the context menu.