Canvas Descriptors

Canvas has the following configuration structure to get the necessary information from the descriptors for the application that you are building:

• Default – This is the top level node in the configuration structure. This is more like a Property Bag that supports collection of multiple key value pairs that are needed for Canvas. Refer Configuration of Default Descriptor.
  • Security – This is a first level child to the Default. This provides various configurations towards enabling authentication as well as security aspects, and log in or log out page flow related information etc. Refer Configuration Descriptor: Security.
  • Database – This is a first level child to the Default. This provides the configuration inputs towards identification of the Database, data source, and other related information. Refer Configuration Descriptor: Database.
  • Cache – This is a first level child to the Default. This provides the configuration inputs related to identification of the cache configuration that the end application wishes to enable. Refer Configuration Descriptor: Cache.
  • Export – This is a first level child to the Default. This provides the configuration inputs related to the Export processing support that Canvas provides for its various Apps. Refer Configuration Descriptor: Export.
  • Multilingual – This is a first level child to the Default. This provides the configuration inputs related to the multilingual support that is expected from the end application and details of any override on the default labels or messages that Canvas provides. Refer Configuration Descriptor: Multilingual.
  • Web Utility – This is a first level child to the Default. This provides the configuration inputs related to web utilities. Refer Configuration Descriptor: Web Utilities.
  • Implementation – This is a first level child to the Default. This provides the configuration inputs related to the list of classes that are implemented. Refer Configuration Descriptor: Class Implementation.
  • Component Preferences – This is a first level child to the Default. This provides the configuration inputs related to canvas components (workspace. Sub Workspaces, Apps and Forms) preference settings. Refer Configuration Descriptor: Components Preferences.
  • System Preferences – This is a first level child to the Default. This provides the configuration inputs applicable to the entire system. Refer Configuration Descriptor: System Preferences.
  • Working Folder – This is the node specific folder in the local server or local instance. This folder is the base folder to accommodate all the resources that canvas handles by means of relative paths.
  • Centralized Working Folder – This is a folder on the SAN that is available across all the nodes. This is critical on a clustered setup for any content that is shared across nodes. An example could be the user image file that needs to be accessible across all nodes in a cluster.

The following conventions are followed across the descriptors while capturing the configuration:

• All places where the configuration type is given as Boolean, the value for true or enabled is considered as one of true, yes, y, 1 or on. All other values are equated as false or disabled. The values are also considered case insensitive. So, a TRUE and true will be evaluated as Boolean.TRUE.
• Wherever the configuration type is given as Routing Mode, the value can be one of FORWARD or REDIRECT.
• Whenever any configuration type is provided as an array using the denotation [], it means that the values must be provided as a comma separated listing. Canvas splits the String using comma (,) as the separator and convert to an array of values for processing.
• Whenever any configuration type is given for folder path, it means the values must be the relative path. Canvas finds the actual absolute path using the combination of value for the CT_WORK_FOLDER key and the corresponding relative path.

Refer the following topics: