Basic App Configuration - Simple Grid

Owned by Lakshminarayanan1 S CTOO (Unlicensed)
Last updated: Oct 09, 2020
  1. In Canvas Studio, click App Designer on the top right pane.



  2. Click to create a new App.

  3. Provide the basic app configuration details based on the description in the following table:



    #

    Field Name

    Description

    Sample Values

    1

    App Display Name

    Label key of the localized text that appears as App title.

    Transaction Summary

    2

    App ID

    Unique ID for the App.
    This value is automatically configured and can be edited if required.

    TRANSACTION_SUMMARY_WGT

    3

    View ID

    Unique ID for the App View.
    This value is automatically configured and can be edited if required.

    TRANSACTION_SUMMARY_VW

    4

    App Resource Bundle

    Name of the bundle key associated with the property file.
    This file can contain label keys for the App title, and keys for all label text appearing on the app view. The bundle key allows only alphabets, numbers, hyphens and underscores.

    common

    Entitlement Configuration

    5

    Product Code

    Name of the Product that the app stands for. Only the users who are authorized to this product can view the data in this app.
    To add new entitlement details, make an entry of the product code in OD_PRODUCT_MASTER_MB and OD_FUNCTION_PRODUCT_MAP_MB tables in database.

    CUSER

    6

    Sub Product Code

    Name of the Sub Product within the Product for which the app stands for. The users who are authorized only to this sub product can view the data in this app.
    To add new entitlement details, make an entry of the sub product code in OD_PRODUCT_MASTER_MB and OD_FUNCTION_PRODUCT_MAP_MB tables in database.

    CUSER

    7

    Function Code

    Name of the Function within the Sub Product for which the app stands for. The users who are authorized only to this function can view the data in this app.
    To add new entitlement details, make an entry of the function code in OD_FUNCTION_MASTER_MB and OD_FUNCTION_PRODUCT_MAP_MB tables in database.

    VSBLTY

  4. Select the CLASSIC_GRID View Type from the App View types listed.



  5. Select the Data source based on the description provided in the following table:



    Data Source

    1

    Use Existing Data Source

    Checked: Enables to select the datasource for which the connection is already created and available in the list. Click the Data Src ID field and type the name of the Data Source to select it. 

    By connecting to any existing data source, Canvas Studio fetches the table column details to the designer screen and does not require any manual entry of the column names.


    Unchecked: Enables to connect to any data source using SQL Param Map ID. This option will be available only if the 'Use Existing Data Source' is unchecked.
    SQL Param Map ID - iBATIS SQL Map ID that contains the SQL to fetch the data for the view. See section Adding the SQL Map and Instruction Class with App for sample SQL Map file. 

    A manual entry of table column details is required in the designer section, if SQL Param Map ID is used to connect to any data source.


    2

    Use the Default Instruction class?

    Checked: Uses the default instruction class for the chosen view and does not require a customized instruction class.
    Unchecked: The default instruction class will not be used and enables the following option to allow the user to enter the instruction class manually.
    Instruction class - Handles the data displayed on the view. This instruction class must extend the Canvas default instruction class.

    For Example: com.intellectdesign.canvas.viewdefinition.AdvGroupViewDefinitionInstruction


  6. Click Proceed to design the App. Refer the section, Designing an App - Simple Grid for information on designing the app.