Action Configuration

During app configuration, Canvas enables the user to configure the events for the app and launch the Workspace/Sub Workspace/Apps/Form using those events. See Canvas Launch API section for more details.





Field

Description

Event Type

Select the event for the app. Multiple events can be set for the app by clicking the icon on the top right corner of the dialog box.

Launch Type

Select the action that needs to happen when the chosen event occurs. For example, if user sets 'cell click' in Event Type field and 'Launch Widget in Modal Window' in Launch Type field, the widget will open as a pop-up once the 'cell click' event is triggered.

Launch Type

Description

Launch Widget in Modal Window

Enables the user to launch a Widget in modal window on any event.

Launch Workspace

Enables the user to launch a Workspace on any event.

Launch Workspace and Layout

Enables the user to launch a Workspace and Sub Workspace on any event.

Launch Workspace, Layout, Widget

Enables the user to launch a Workspace, Sub Workspace, and Widget on any event.

Launch Form with Container in Modal Window

Enables the user to launch a Form along with its container in a modal window on any event.

Launch Form without Container in Modal Window

Enables the user to launch a Form without its container in a modal window on any event.

Configuration Icon  ()

Click this icon to search and select the Workspace/Subworkspace/App/Form.

Delete Icon ()

Click this icon to delete the specific launch configuration.

Additional Configuration Icon ( )

Click this icon to set additional configuration for the modal window. See Additional Configuration Screen section in this table.

JSON Preview

Click this button to preview the event and launch type configuration in JSON format.

PUBLISH This option enables you to publish the actions, associated with the launch of components like apps, workspaces, layouts and forms. Refer Example - Widget Action Configuration and Switching Apps using Widget Action Configuration for more information. 
SUBSCRIBEThis option enables you to fetch data in a streamlined manner. On selecting the relevant source widget, the Subscribe Field List allows you to choose the type of data that is to be fetched. Refer Example - Widget Action Configuration for more information. 

Additional Configuration Screen

Event

The value for this field is automatically fetched from the Event Type field of the Action Configuration section. It is a non-editable field. 

Launch Type

The value for this field is automatically fetched from the Launch Type field of the Action Configuration section. It is a non-editable field. 

Draggable

On: Enables the user to drag the modal window.
Off: Does not enable the user to drag the modal window.

Modal Dialog ID

On: Does not enable the user to edit the form/app/workspace/subworkspace in the background screen.
Off: Enables the user to edit the form/app/workspace/subworkspace in the background screen.

Close

On: Enables the user to close the modal window using Esc key on the keyboard.
Off: Does not enable the user to close the modal window using Esc key on the keyboard.

Full Screen

On: Displays the Full Screen Indicator on the modal window.
Off: Does not display the Full Screen Indicator on the modal window.

Width In Pixel

Enables the user to specify the width of the modal window in pixels. For example, 600.

Height in Pixel

Enables the user to specify the height of the modal window in pixels. For example, 500.

Save

Click Save to save the additional configuration.


The following matrix provides the list of events available and their applicability for TBS and jQM with respect to the action configuration:

Event

Applicability

TBS

jQM

CELL_CLICK

ROW_CLICK

CTAPPBEFOREINITIALIZE

AFTER_TEMPLATE_LOAD

BEFORE_LOAD

BBAR_BUTTON_CLICK

CONTEXT_CLICK

WIDGET_EXPAND

WIDGET_COLLAPSE

FLOW_CLICK

SELECTION_CHANGE (SINGLE)

SELECTION_CHANGE (MULTIPLE)

NODE_CLICK

NODE_CONTEXT_CLICK

DRILL_DOWN

EXTRAPARAMSHDLR

CELL_DBL_CLICK

-

ROW_DBL_CLICK

-

DESTROY_APP

-

HIGHLIGHT

-

MENUCLICK

-

ROW_KEY_UP

-

VERIFY_DATE

-

BEFORE_DATA_LOAD

-

-

AFTER_DATA_LOAD

-

-

BEFORE_TAB_CHANGE

-

-

CELL_DATA_CHANGE

-

-

SWITCH_VIEW_CHANGE

-

-

INIT_APP

-

-

FORM_BEFORE_INITIALIZE

-

-

FORM_INITIALIZE

-

-

ORG_TEMPLATE_INITIALIZER

-

-

PREF_CHNG

-

-

CBX_CHANGE

-

-

CBX_CLICK

-

-

Canvas might provide support for some of the events that are classified as not applicable based on the future requirements.