Configuration Descriptor: Components Preferences

Owned by kiran.kumari@intellectdesign.com (Unlicensed)
Last updated: Oct 15, 2019 by Ravikumar Babu CTOO (Unlicensed)

This key contains the bundle name that contains the configuration of preferences that are input to the Canvas models used in the application.

Config Key

Mandatory/ Optional

Type

Purpose

Category: Upload Component Preferences

UPLOAD_TEMP_FOLDER

Mandatory

String

This key is used to provide the path to maintain the uploaded files. For example, /FileUpload

MAX_FILE_SIZE_MB

Mandatory

String

This key is used to provide the maximum file size in MB. You need not include "MB" along with the value. You can include decimal values too. For example, 10

Category: Common Preferences

ENABLE_LAYOUT_RESIZE

Mandatory

String

This key is used to indicate whether the container layout can be resized or not. Possible values are Y or N. Note: This configuration is applicable only for the n-column layout and not for STACK layout

ENABLE_APP_DRAG

Mandatory

Boolean

This key is used to indicate whether the app can be dragged or not. Possible values are Y or N.

RESPONSIVE_GRID_IND

Mandatory

Boolean

This key is used to indicate whether to enable responsive grid or not. Possible values are Y or N.

INIT_RESPONSIVE_GRID_WIDTH

Mandatory

Number

This key is used to provide the minimum width of the grid to convert the grid as responsive grid while resizing. For example, 350

DATE_COLUMN_ALIGNMENT

Mandatory

Lov

This key is used to provide the alignment for the date columns in the grid views. Possible values are LEFT or RIGHT.

AMOUNT_COLUMN_ALIGNMENT

Mandatory

Lov

This key is used to provide the alignment for the Amount columns in the grid views. Possible values are LEFT or RIGHT.

DATE_TIME_COLUMN_ALIGNMENT

Mandatory

Lov

This key is used to provide the alignment for the Date and Time columns in the grid views. Possible values are LEFT or RIGHT.

COPYRIGHT_MSG

Mandatory

String

This key defines the copyright message that must appear in the application. If this property is not configured, the following default value is taken: "Copyright \u00A9 CT MODELHOUSE 2014".

LOAD_COMPILED_TEMPLATE

Optional

String

This key indicates whether to compile the CTTPL template files at the server-side or client-side. Possible values are Y or N, where 'Y' indicates that templates will be compiled at the server-side and 'N' indicates templates will be compiled at the client-side.

Canvas enables the templates to be loaded at client-side either as JavaScript files after precompiling the CTTPL files OR as CTTPL files from a folder in the server.
If the property is set to Y, post build, the framework and implementation teams' templates are precompiled and loaded as JavaScript at the client-side. After which, the data is sent to the JavaScript for binding and the HTML content is generated.

If the property is set to N, the templates do not undergo precompilation and are directly loaded as CTTPL files at the client-side from a folder in the server. The CTTPL files are then compiled at the client-side and data is sent to the JavaScript for binding.

ENABLE_AUDIT_EVENT_DATA

Optional

Boolean

This key is only available in the componentspreferences.properties file for Canvas Studio.

This key is used to enable or disable auditing of user actions performed in various screens on Studio such as Create New View, Create New App, and so on. Possible values are Y or N.

ENABLE_QUERY_GENERATOR

Optional

Boolean

This key is only available in the componentspreferences.properties file for Canvas Studio. This key is used to indicate whether to generate query or not. Possible values are Y or N.

ENABLE_KEYBOARD_NAVIGATION

Optional

Boolean

This key is only available in the componentspreferences.properties file for Canvas Studio.

It is used to indicate whether navigation in grids using keyboard arrow keys is enabled or disabled. For example, rows can be selected using the up and down arrow keys. Also, row-click event get triggered. Possible values are Y or N.

ENABLE_BRIDGE_ENTITLEMENT

Optional

Boolean

This key is only available in the componentspreferences.properties file for Canvas Studio.

It is used to indicate whether the bridge for entitlements is enabled or disabled. Possible values are Y or N. Bridging is the concept of connecting to the Modelhouse application by sending a request to a service or an agent in Modelhouse instead of directly querying the Modelhouse DB from Studio. In this process, if you want to fetch a user's entitlement details from Modelhouse, this property is respected to see if the entitlement details can be fetched directly from the Modelhouse DB or if the details must be fetched after placing a request to the Modelhouse application.

Category: User Images related preferences

USER_IMAGES_FOLDER

Mandatory

Relative Path

This key is used to provide the path of the user uploaded images.

USER_IMAGES_MAXSIZE

Mandatory

Number

This key is used to restrict the user uploaded image file size.

USER_IMAGE_FORMATS

Mandatory

Relative Path

This key is used to define the image formats for images uploaded by the user. For example, JPG, PNG, etc. Multiple values must be comma ',' separated.

Category: Google Map view related preferences

GOOGLE_MAP_URI

Mandatory

URI

This key is used to define the Google Maps URI for the Map views.

GOOGLE_MAP_ZOOM

Mandatory

Number

This key is used to provide the maximum percentage of zoom on the Google Maps.

Category: Grid View preferences

LIST_VIEW_PAGESIZE

Mandatory

Number

This key is used to provide the page size of the grid. This will be used for the grid data pagination.

DEFAULT_RECORDS_PER_PAGE

Optional

Number

This key is used to provide the number of records per page for classic or live grid views. This will be used for the grid data pagination.

DEFAULT_PAGES_DISPLAY

Optional

Number

This key is used to provide the default pages for displaying on the classic or simple live grid. This will be used for the grid data pagination.

SEARCH_RESULT_EXPORT_REQD

Optional

Boolean

This key is used to provide the values that specify whether export content have the search result value or not. Possible values are true or false.

Category: Mobility related preferences

ACTION_BTN_ORDER

Optional

Lov

This key is used to provide the values to specify the order of action buttons in the form container for mobile. The possible values are:

  • PN – Positive button first and then Negative
  • NP – Negative button first and then Positive

Category: App Height related preferences

WIDGETDEFAULTMINHEIGHT

Optional

Number

This key is used to provide the values that specify the default minimum height for the app.The default value is 150.

WIDGETDEFAULTMAXHEIGHT

Optional

Number

This key is used to provide the values that specify the default maximum height for the app.The default value is 450.

CONTEXT_MSG_ENABLE

Optional

Boolean

This key is used to provide the values that enables or disables context messages. Possible values are Y or N. Default value is N.

The following is a sample component configuration file componentspreferences.properties (as per the name given in the default descriptor):

# Path to maintain the uploaded files. This should be a relative path with respect to
# the root path that is configured as CT_WORK_CENTRALIZED_PATH in the implementation 
# property file.
UPLOAD_TEMP_FOLDER = /FileUpload

# Provide the max file size in MB (do not include MB). It can be in decimals also.
MAX_FILE_SIZE_MB = 10

# Flag that indicates whether the container layout should be sizable. 
# It is applicable only for the 'n'- column layout and not for the STACK layout.
ENABLE_LAYOUT_RESIZE = Y

# Flag that indicates whether the app is draggable or not. 
# Possible Values are Y or N.
ENABLE_APP_DRAG = Y

# Flag that enables responsive grid on the grid views for all the apps that are 
# available in the application. Possible Values are Y or N.
RESPONSIVE_GRID_IND = Y

# This property is used to define the minimum width of the grid to convert the grid 
# as responsive grid while resizing.
INIT_RESPONSIVE_GRID_WIDTH = 350
 
# This property is used to define the DATE column alignment on the grid column. 
# Possible values are "LEFT" or "RIGHT".
DATE_COLUMN_ALIGNMENT = LEFT

# This property is used to define the AMOUNT column alignment on the grid column. 
# Possible values are "LEFT" or "RIGHT".
AMOUNT_COLUMN_ALIGNMENT = RIGHT

# This property is used to define the DATE and TIME column alignment on the grid 
# column. Possible values are "LEFT" or "RIGHT".
DATE_TIME_COLUMN_ALIGNMENT = LEFT

# This property is used to define the path of the user uploaded images. This should 
# be a relative path with respect to the root path that is configured as 
# CT_WORK_CENTRALIZED_PATH in the implementation property file.
USER_IMAGES_FOLDER = /PictureUpload

# This property is used to restrict the user uploaded image file size.
USER_IMAGES_MAXSIZE = 10485760

# This property is used to define the image formats that can be uploaded by the user.
USER_IMAGE_FORMATS = jpg,png,gif

# This property defines the google maps URL.
GOOGLE_MAP_URI = https://www.google.com/jsapi
 
# This property is used to define the maximum percentage of zoom on the Google maps.
GOOGLE_MAP_ZOOM = 10

# This property defines the page size of the grid. This will be used for the grid 
# data pagination.
LIST_VIEW_PAGESIZE = 45

# This property defines the default records for the page of the classic or simple 
# live grid. This will be used for the grid data pagination. 
DEFAULT_RECORDS_PER_PAGE = 10

# This property defines the default pages displaying on the classic or simple live 
# grid. This will be used for the grid data pagination. 
DEFAULT_PAGES_DISPLAY = 5

# Flag that indicates whether the export content has the search result value or not.
# Possible values are true or false.
SEARCH_RESULT_EXPORT_REQD = true

# This property is used to specify the order of action buttons in the form Container.
# Applicable only for mobile and will be extended to desktop in the near future.
ACTION_BTN_ORDER = PN

# This property defines the default min height for the widget.
# This is not a mandatory property. The default height is 150.
WIDGETDEFAULTMINHEIGHT = 200

# This property defines the default max height for the widget.
# This is not a mandatory property. The default height is 450.
WIDGETDEFAULTMAXHEIGHT = 450
 
# This property indicates whether to enable or disable context messages.
# This is not a mandatory property. The default value is "N".
CONTEXT_MSG_ENABLE = Y

# This property defines the copy right message.
# This is not a mandatory property. If the property is not configured, it will take 
# the default value as Copyright \u00A9 CT MODELHOUSE 2014
COPYRIGHT_MSG = Copyright \u00A9 CT MODELHOUSE 2014
 
# This property indicates whether to use precompiled template or uncompiled template.
LOAD_COMPILED_TEMPLATE = Y

# This property indicates whether to audit event data or not.
ENABLE_AUDIT_EVENT_DATA = N

# This property indicates whether to generate query or not.
ENABLE_QUERY_GENERATOR = N

# This flag indicates whether the keyboard nevigation is enabled for grids. 
# Possible values are Y or N.
ENABLE_KEYBOARD_NAVIGATION = N

# Flag that indicates whether bridge for entitlement is enabled or disabled. 
# Possible values are Y or N.
ENABLE_BRIDGE_ENTITLEMENT = Y