This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > ENSLIB namespace > EnsPortal.Dialog.DataTransformWizard

EnsPortal.Dialog.DataTransformWizard

class EnsPortal.Dialog.DataTransformWizard extends EnsPortal.Dialog.standardDialog

This dialog lets the user create a new Data Transformation.

Property Inventory

Method Inventory

Parameters

parameter APPLYBUTTON = 0;
Inherited description: If true, then this dialog displays an Apply button.
parameter RESOURCE = %Ens_Code:WRITE,%Ens_DTL:WRITE;
User needs WRITE permissions on either the %Ens_Code or the %Ens_DTL resource to view this page.

Properties

property package as %ZEN.Datatype.string (ZENURL = "PACKAGE");
Default package name.
Property methods: packageDisplayToLogical(), packageGet(), packageIsValid(), packageLogicalToDisplay(), packageLogicalToOdbc(), packageNormalize(), packageSet()
property retValue as %ZEN.Datatype.string;
Holder for return value.
Property methods: retValueDisplayToLogical(), retValueGet(), retValueIsValid(), retValueLogicalToDisplay(), retValueLogicalToOdbc(), retValueNormalize(), retValueSet()

Methods

method %OnAfterCreatePage() as %Status
Inherited description: Avoid writing out the session cookie if we are in a Studio session.
method %OnGetSubtitle() as %String
Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.
method %OnGetTitle() as %String
Get the (localized) title string for the dialog. This should be implemented in a subclass.
classmethod CreateDTClass(pClassName As %String, pDesc As %String, pSourceClass As %String, pSourceDocType As %String, pTargetClass As %String, pTargetDocType As %String) as %String [ ZenMethod ]
Create a new DT class. Return "" if ok otherwise and error message.
classmethod IsNameValid(pName As %String) as %String [ ZenMethod ]
Test if the given name is valid. Returns a colon-separated string. The first position is a 1 or 0 indicating whether this is (1) or is not (0) a valid class name. The second position is a 1 or 0 indicating whether the name is free and clear to use (1) or is the name of an existing data transformation (0).
classmethod IsVDoc(pClass As %String = "") as %Boolean [ ZenMethod ]
clientmethod changeType(which, value) [ Language = javascript ]
User has changed the message type radio button.
clientmethod changeValue(componentId, newValue) [ Language = javascript ]
Handle updates based on a new value for one of the fields.
clientmethod getDialogValue() [ Language = javascript ]
Inherited description: Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
This client event is fired when the a popup page launched from this page fires an action.
clientmethod ondialogFinish(action) as %Boolean [ Language = javascript ]
This callback, if defined, is called when the user presses the OK or Apply action buttons. If this returns false, then the action is cancelled.
clientmethod ondialogStart() [ Language = javascript ]
This callback, if defined, is called when the dialog page is loaded.
clientmethod selectType(which) [ Language = javascript ]
Launch the select type dialog.

Inherited Members

Inherited Properties

Inherited Methods