Page Comparison

...

This is a core API which that can be invoked in any event. The usage of canvas.launch() API has been is explained here with the following task as an example:

...

Code Block

language	java

CFLR.registerListener("CT_PAYMENT_FORM", canvas.form.listeners.paymentForm);

CABR.registerHandler('PAY_SUMBIT', 'PAYMENTS_FORM_CONTAINER', function(config)
{
	var fm = config.formObj;
	var refNo = fm.additionalConfig['reference_no'] || '';
	if (canvas.isEmpty(fm.model.getValue('ACC_NO')))
	{
		fm.markInvalid("ACC_NO");
		return;
	} else if (canvas.isEmpty(fm.model.getValue('BENE_ACC_NO'))) 
	{
		fm.markInvalid("BENE_ACC_NO");
		return;
	} else if (canvas.isEmpty(fm.model.getValue('TRANSACTION_AMT'))) 
	{
		fm.markInvalid("TRANSACTION_AMT");
		return;
	} else if (canvas.isEmpty(fm.model.getValue('TRAN_DATE'))) 
	{
		fm.markInvalid("TRAN_DATE");
		return;
	}
	var ajaxParams = 
	{
		"INPUT_ACTION" : "SUBMIT",
		"INPUT_FUNCTION_CODE" : "VSBLTY",
		"INPUT_PRODUCT" : "CUSER",
		"INPUT_SUB_PRODUCT" : "CUSER",
		"PAGE_CODE_TYPE" : "TXN_CODE",
		"PRODUCT_NAME" : "CUSER",
		"REFERENCE_NO" : refNo
	};
	canvas.apply(ajaxParams, fm.getModelData());
	canvas.ajax(
	{
		params : ajaxParams,
		success : function(response) 
		{
			var referenceNo = response.REFERENCE_NO;
			var text = response.STATUS == "SUCCESS" ? CRB.getBundleValue("common", "LBL_TRAN_SUCCESS") : CRB.getBundleValue("common", "LBL_TRAN_FAILURE");
			text = String.format(text, referenceNo);
			var successDialog = new canvas.Dialog(
			{
				dialogType : "MESSAGE",
				title : "Confirmation Window",
				message : text,
				okHandler : function()
				{
					successDialog.close();
					if (window.transactionComplete)
					{
						window.dispatchEvent(window.transactionComplete);
						return true;
					} else
					{
						CBXFORMCONTAINER.exit(config);
						if (fm.additionalConfig['widgetObj'])
						{
							widget = fm.additionalConfig['widgetObj'];
							widget.refreshWidgetData();
						}
					}
					canvas.launch(
					{
						workspaceId : "ACC_SERV_WSPACE"
					});
				}
			});
			successDialog.show();
		}
	});
});

...

Anchor
launch_another_workspace
launch_another_workspace
Launch another workspace

Syntax

Code Block

language	text

canvas.launch(
{ 
	workspaceId : '<WORKSPACE_ID>', 
	callback : <function(){}> (Optional) 
});

Example

Code Block

language	text

canvas.launch(
{
	workspaceId : 'ACC_SERV_WSPACE'
});

Anchor
launch_workspace_layout
launch_workspace_layout
Launch a workspace and layout

Syntax

Code Block

language	text

canvas.launch(
{ 
	workspaceId : '<WORKSPACE_ID>',
	layoutId : '<LAYOUT_ID>', 
	callback : <function(){}> (Optional) 
});

Example

Code Block

language	text

canvas.launch(
{
	workspaceId : 'CHART_WS', 
	layoutId : 'CHART_LYT'
});

Anchor

	launch_workspace_layout_widget
	launch_workspace_layout_widget

Launch a workspace, layout, then a widget

Syntax

Code Block

language	text

canvas.launch(
{ 
	workspaceId : '<WORKSPACE_ID>', 
	layoutId : '<LAYOUT_ID>', 
	widgetId : '<WIDGET_ID>', 
	callback : <function(){}> (Optional) 
});

Example

Code Block

language	text

canvas.launch(
{
	workspaceId : 'LOANS_WS', 
	layoutId : 'LOANS_LYT', 
	widgetId : 'CT_LOAN_SUMMARY_WGT'
});

Anchor

	launch_ws_layout_widget_appshortcut
	launch_ws_layout_widget_appshortcut

Launch a workspace, layout, widget, and trigger a non-contextual app handler

Consider a scenario where you need to launch a non-contextual app (e.g. app shortcut) on an empty widget. The app shortcut when clicked will take the user to the linked app (widget). To achieve this via canvas.launch() API, you can use the customLauncher parameter, which is the handler for app shortcut item.

Note
This variant of canvas.launch() API is enabled in TBS only.

Syntax

Code Block

language	js

canvas.launch(
{
    workspaceId : '<WORKSPACE_ID>',
    layoutId : '<LAYOUT_ID>',
    widgetId : '<WIDGET_ID>',
    customLauncher : <function(){}> (app shortcut handler; Optional)
});

Example

Code Block

language	js

ACHR.registerHandler(<APP_SHORTCUT_ID>, function (config)
{
	// implementation code
});

var config = {};
config.workspaceId = workspaceId;
config.layoutId = LayoutId;
config.widgetId = WidgetId;
var appId = <APP_SHORTCUT_ID>;
if (appId != null && appId != undefined)
{
	config.customLauncher = ACHR.getHandler(appId);
}
canvas.launch(config);

Anchor
launch_widget_modal_window
launch_widget_modal_window
Launch a widget in modal window

Syntax

Code Block

language	text

canvas.launch(
{ 
	renderType : 'WINDOW',
	widgetId : '<WIDGET_ID>',
	width : '<WIDTH_IN_%_OR_PXL>', (Optional) 
	height : '<HEIGHT_IN_%_OR_PXL>', (Optional) 
	fullScreenInd : <TRUE | FALSE>, (Optional) 
	closeOnEsc : <TRUE | FALSE>, (Optional) 
	modalDialog : <TRUE | FALSE>, (Optional) 
	draggable : <TRUE | FALSE>,	(Optional) 
	callback : <function(){}> (Optional) 
});

Example

Code Block

language	text

canvas.launch(
{
	renderType : 'WINDOW', 
	widgetId : 'CT_LOAN_SUMMARY_WGT'
});

Anchor
launch_form_modal_window
launch_form_modal_window
Launch a form with container in Modal window

Syntax

Code Block

language	text

canvas.launch(
{ 
	renderType : 'WINDOW',
	formId : '<FORM_ID>', 
	containerId : '<CONTAINER_ID>', 
	width : '<WIDTH_IN_%_OR_PXL>', (Optional) 
	height : '<HEIGHT_IN_%_OR_PXL>', (Optional) 
	fullScreenInd : <TRUE | FALSE>, (Optional) 
	closeOnEsc : <TRUE | FALSE>, (Optional) 
	modalDialog : <TRUE | FALSE>, (Optional) 
	draggable : <TRUE | FALSE>,	(Optional) 
	callback : <function(){}> (Optional) 
});

Example

Code Block

language	text

canvas.launch(
{
	renderType : 'WINDOW',
	formId : 'CT_PAYMENT_FORM',
	containerId : 'PAYMENTS_FORM_CONTAINER'
});

Anchor

	launch_from_without_modal_window
	launch_from_without_modal_window

Launch a form without container in Modal window
Syntax

Code Block

language	text

canvas.launch(
{ 
	renderType : 'WINDOW',
	formId : '<FORM_ID>', 
	width : '<WIDTH_IN_%_OR_PXL>', (Optional) 
	height : '<HEIGHT_IN_%_OR_PXL>', (Optional) 
	fullScreenInd : <TRUE | FALSE>, (Optional) 
	closeOnEsc : <TRUE | FALSE>, (Optional) 
	modalDialog : <TRUE | FALSE>, (Optional) 
	draggable : <TRUE | FALSE>,	(Optional) 
	callback : <function(){}> (Optional) 
});

Example

Code Block

language	text

canvas.launch(
{
	renderType : 'WINDOW',
	formId : 'CT_PAYMENT_FORM'
});

Anchor
form_rendered_app
form_rendered_app
Form rendered in an app with container

Syntax

Code Block

language	text

canvas.launch(
{ 
	formId : '<FORM_ID>', 
	containerId : '<CONTAINER_ID>', 
	RenderType : 'APP',
	workspaceId : '<WORKSPACE_ID>', 
	layoutId : '<LAYOUT_ID>', 
	widgetId : '<WIDGET_ID>',
	width : '<WIDTH_IN_%_OR_PXL>', (Optional) 
	height : '<HEIGHT_IN_%_OR_PXL>', (Optional) 
	fullScreenInd : <TRUE | FALSE>, (Optional) 
	closeOnEsc : <TRUE | FALSE>, (Optional) 
	modalDialog : <TRUE | FALSE>, (Optional) 
	draggable : <TRUE | FALSE>,	(Optional) 
	callback : <function(){}> (Optional) 
});

Example

Code Block

language	text

canvas.launch(
{
	formId : 'CT_PAYMENT_FORM',
	containerId : 'PAYMENTS_FORM_CONTAINER', 
	renderType : 'APP', 
	workspaceId : 'ACC_SERV_WSPACE', 
	layoutId : 'ACC_SERV_LYT', 
	widgetId : 'EMPTYAPP'
});

Anchor
from_rendered_with_object_container
from_rendered_with_object_container
Form renders with form object and container in Modal Window:

Syntax

Code Block

language	text

canvas.launch(
{ 
	fm : '<fm_Obj>',
	containerId : '<CONTAINER_ID>', 
	width : '<WIDTH_IN_%_OR_PXL>', (Optional) 
	height : '<HEIGHT_IN_%_OR_PXL>', (Optional) 
	fullScreenInd : <TRUE | FALSE>, (Optional) 
	closeOnEsc : <TRUE | FALSE>, (Optional) 
	modalDialog : <TRUE | FALSE>, (Optional) 
	draggable : <TRUE | FALSE>, (Optional) 
	callback : <function(){}> (Optional) 
});

Example

Code Block

language	text

var frmMgr = new canvas.form.FormManager(
{
	formId : 'CT_PAYMENT_FORM'
});

canvas.launch(
{
	fm : frmMgr, 
	containerId : 'PAYMENTS_FORM_CONTAINER'
});

Anchor

	from_without_container
	from_without_container

Form renders with form object and without container in Modal Window:

Syntax

Code Block

language	text

canvas.launch(
{ 
	fm : '<fm_Obj>', 
	width : '<WIDTH_IN_%_OR_PXL>', (Optional) 
	height : '<HEIGHT_IN_%_OR_PXL>', (Optional) 
	fullScreenInd : <TRUE | FALSE>, (Optional) 
	closeOnEsc : <TRUE | FALSE>, (Optional) 
	modalDialog : <TRUE | FALSE>, (Optional) 
	draggable : <TRUE | FALSE>, (Optional) 
	callback : <function(){}> (Optional) 
});

Example

Code Block

language	text

var frmMgr = new canvas.form.FormManager(
{	
	formId : 'CT_PAYMENT_FORM'
});

canvas.launch(
{
	fm : frmMgr
});

Anchor
html_content
html_content
Launch a custom HTML Content in Modal Window

Syntax

Code Block

language	text

canvas.launch(
{ 
	modalContent : '<HTML_DOM>', 
	title : '<TITLE_OF_WINDOW>', (Optional) 
	width : '<WIDTH_IN_%_OR_PXL>', (Optional) 
	height : '<HEIGHT_IN_%_OR_PXL>', (Optional) 
	fullScreenInd : <TRUE | FALSE>, (Optional) 
	closeOnEsc : <TRUE | FALSE>, (Optional) 
	modalDialog : <TRUE | FALSE>, (Optional) 
	draggable : <TRUE | FALSE>,	(Optional) 
	callback : <function(){}> (Optional) 
});

Example

Code Block

language	text

canvas.launch(
{ 
	modalContent : 'Hello'
});

Anchor
predefined_dialog
predefined_dialog
Launch pre-defined dialog messages in the modal window

Syntax

Code Block

language	text

canvas.launch(
{ 
	message : '<MESSAGE_OF_DIALOG>', 
	dialogType : 'CONFIRMATION'|'MESSAGE'|'WARN_EDIT_OK'|'SUCCESS'|'ERROR'|'WARNING' 
	width : '<WIDTH_IN_%_OR_PXL>', (Optional) 
	height : '<HEIGHT_IN_%_OR_PXL>', (Optional) 
	fullScreenInd : <TRUE | FALSE>, (Optional) 
	closeOnEsc : <TRUE | FALSE>, (Optional) 
	modalDialog : <TRUE | FALSE>, (Optional) 
	draggable : <TRUE | FALSE>,	(Optional) 
	callback : <function(){}> (Optional) 
});

Example

Code Block

language	text

canvas.launch(
{
	message : 'The mandatory fields are not filled-in', 
	dialogType : 'ERROR'
});

Version	Old Version 17	New Version 18
Changes made by	Ravikumar Babu CTOO (Unlicensed)	Ravikumar Babu CTOO (Unlicensed)
Saved on	May 23, 2019	May 23, 2019

Versions Compared

Key