Function Definition and Targeting


Once the product – sub product definition is done, the definition of functions comes into picture. This involves the following sequence:

  • Defining Function Groups (if required)
  • Defining Functions (if required)
  • Map the function to the Product – Sub Product combination
  • Target the function to the appropriate channels (if required)

Define Function Group


The definition of function group is done through the object OD_FUNCTION_GRP_TBL. A function group can be utilized to group related functions and categorize the functions for the purpose of generic handling in screen based administration.
The definition of this Object in the Canvas schema is provided in the following table:

Column Name

M / O

Type

Purpose

OD_FUNCTION_GRP_CODE

M

String

A unique ID for this group.

OD_FUNCTION_GRP_DESC

M

String

This is a column provided to the developer for storing any meaningful comment for quick identification of this function group.

OD_STATUS

M

String

This is the status of this product / sub product definition. Possible values are as follows:

  • A – Authorized (will be picked up for any profiling)

Define Function


The definition of function is done through the object OD_FUNCTION_MASTER_MB. A function is a representation of the fine grained access level control.
The definition of this Object in the Canvas schema is provided in the following table:

Column Name

M / O

Type

Purpose

OD_FUNCTION_CODE

M

String

A unique ID for this function

OD_FUNCTION_DESC

M

String

This is a column provided to the developer for storing any meaningful comment for quick identification of this function.

OD_STATUS

M

String

This is the status of this product / sub product definition. Possible values are as follows:

  • A – Authorized (will be picked up for any profiling)

OD_FUNCTION_GRP_ID

M

String

The ID of the function group to which this function belongs to.

OD_FUNCTION_LABEL

M

String

This is not used. This column can have a value similar to the one given for OD_FUNCTION_DESC.

OD_RULE_BASED_FLG

M

String

Flag that indicates whether any request associated to this function should be taken through a workflow.

OD_ENTL_MODE

O

String

The value indicates how data level entitlement is to be evaluated for a request associated to this function. If provided as ALL, then it indicates that multiple values provided for a criterion should be evaluated that all of the provided values should be entitled for that user.

Map Function to Product – Sub Product


Canvas does not evaluate a function in isolation. It always evaluates against the combination of Product – Sub Product – Function. Towards that the subsequent step is to map a function to the Product – Sub Product combination.
The definition of this mapping is done through the object OD_FUNCTION_PRODUCT_MAP_MB. The definition of this Object in the Canvas schema is provided in the following table:

Column Name

M / O

Type

Purpose

OD_FUNCTION_CODE

M

String

A unique ID for this function.

OD_PRODUCT_CODE

M

String

The product code

OD_SUBPROD_CODE

M

String

The sub product code

FLG_IS_READONLY

M

String

Provide Y to indicate that this function does not require any data level entitlements.

ENABLE_MULTI_SELECT

M

String

Provide Y to indicate that the administration screen should allow multi selection of data level entitlements for the various criteria against this function.

SERV_CONF_APPLICABLE

O

String

This is no longer used.

Target Function to Channel


One of the key targeting that Canvas provides is the ability to target functionality to channels. The definition of the various channels is present in the object OD_CHANNEL_MASTER_MB.
Canvas uses the following Channel IDs to indicate the following modes of access:

Channel Id

Meaning

1

Indicates that the access is through a browser on a device detected as "Mobile".

2

Indicates that the access is through a packaged App on a device detected as "Mobile".

3

Indicates that the access is through a browser on a device that is not a categorized as "Mobile" or "Desktop".

4

Indicates that the access is through a packaged App on a device detected as "Tablet".

5

Indicates that the access is through a browser on a device detected as "Tablet".


The targeting of a function to a channel is done through the object OD_FUNCTION_CHANNEL_MAP_MB. The definition of this Object in the Canvas schema is provided in the following table:

Column Name

M / O

Type

Purpose

OD_FUNCTION_CODE

M

String

To store the function code

OD_CHANNEL_ID

M

String

To store the Channel ID