Skip to main content


class %Activate.UI.Wizard extends %ZEN.Template.ObjectGatewayWizard.Template

Activate Wizard

Property Inventory

Method Inventory


parameter HELPID = BGAX_using_wizard;
Inherited description: DOCBOOK Topic Id that offers help for this template.
parameter PAGENAME = Activate Wizard;
Inherited description: Optional. This is the display name used for this page. If not provided, the class name is used.
parameter PAGETITLE = Activate Wizard;
Display title of this page
parameter TEMPLATEDESCRIPTION = Activate Wizard;
Inherited description: Short description of the template to show in Studio.
If DOMAIN is defined this will be localized.
parameter TEMPLATENAME = Activate Wizard;
Inherited description: Name of the template to show in Studio.
If DOMAIN is defined this will be localized.
parameter TEMPLATETITLE = Activate Wizard;
Inherited description: Title of the template to show in the template window.


property isExit as %Boolean [ InitialExpression = 0 ];
After user clicks the Finish button, the caption of button Finish becomes Exit,and isExit becomes 1. If btnFinish is clicked when isExit = 1 then we exit out of the wizard.
Property methods: isExitDisplayToLogical(), isExitGet(), isExitIsValid(), isExitLogicalToDisplay(), isExitLogicalToXSD(), isExitNormalize(), isExitSet(), isExitXSDToLogical()
property msgSelectRows as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Please select an object reference before clicking FINISH.") ];
Property methods: msgSelectRowsDisplayToLogical(), msgSelectRowsGet(), msgSelectRowsIsValid(), msgSelectRowsLogicalToDisplay(), msgSelectRowsLogicalToOdbc(), msgSelectRowsNormalize(), msgSelectRowsSet()
property msgTooManyRows as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("You have selected more than 10 objects and this may take a long time to process. Are you sure you want to do this?") ];
Property methods: msgTooManyRowsDisplayToLogical(), msgTooManyRowsGet(), msgTooManyRowsIsValid(), msgTooManyRowsLogicalToDisplay(), msgTooManyRowsLogicalToOdbc(), msgTooManyRowsNormalize(), msgTooManyRowsSet()


method %OnAfterCreatePage() as %Status
This callback is called after the server-side page object and all of its children are created.
Subclasses can override this to add, remove, or modify items within the page object model, or to provide values for controls.
classmethod CheckAllBlanks(string) as %Boolean [ ZenMethod ]
classmethod IsEnabled() as %Boolean
Return false from this method to disable this template (for example based on the server platform)
method SetSelected(selectedRows As %String, package As %String, details As %Boolean) as %Boolean [ ZenMethod ]
Set the selected rows into %session data for the result page Save the package and show details also.
clientmethod canFinish() [ Language = javascript ]
Return true if this template can Finish (i.e., enable the Finish button).
As long as you are on page 2+, Finish is enabled.
clientmethod canGoBack() [ Language = javascript ]
Return true if this template can go to the previous page (i.e., enable the Back button).
This is implemented by subclasses.
clientmethod canGoNext() [ Language = javascript ]
Return true if this template can go to the next page (i.e., enable the Next button).
clientmethod finishTemplate() [ Language = javascript ]
User clicked the Finish button
clientmethod hasMultiplePages() [ Language = javascript ]
Set to true so btnNext and btnBack will show.
clientmethod hasSelected() [ Language = javascript ]
clientmethod nextPage() [ Language = javascript ]
Go to the next page of the template.
clientmethod onstartHandler() [ Language = javascript ]
This is called when the template is first displayed; This provides a chance to set focus etc.
clientmethod previousPage() [ Language = javascript ]
Go to the previous page of the template.
clientmethod rowChecked(table) [ Language = javascript ]
User checked a checkbox in a row in the table. Show the location and update Finish button.
clientmethod rowSelected(table) [ Language = javascript ]
User selected a row in the table. Show the location.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab