Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [EnsPortal] >  [Dialog] >  [TestTransform]
Private  Storage   

class EnsPortal.Dialog.TestTransform extends EnsPortal.Dialog.standardDialog

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
5 11 28


Summary

This is a Zen Page class. It belongs to the application EnsPortal.Application.

Properties
%condition %import %includeFiles %page
%resource FirstFailed InvalidParam IsEMSReadOnly
ValidationErrorMsg align aux backgroundTimerInterval
canEdit cellAlign cellSize cellStyle
cellVAlign children closeOnEnter closeOnEsc
composite containerStyle cssLevel dialogTitle
disabled disabledStyle dragAndDrop dragEnabled
dropEnabled enclosingClass enclosingStyle error
extraDataSerialized firstLoad groupClass groupStyle
hasButtons height hidden hideApplyButton
hideCancelButton hideOKButton hint hintClass
hintStyle id index keepAliveInterval
label labelClass labelDisabledClass labelPosition
labelStyle lastSavedExtraSerialized layout msgNotPermitted
name onafterdrag onbeforedrag onclick
ondrag ondrop onhide onrefresh
onshow onupdate parent showLabel
slice sourceClass sourceData sourceDocType
sourceLabel studioMode targetClass targetDocType
targetLabel title transform tuple
useSVG useSoftModals valign visible
width window zenPersistentPopup

Methods
%AddCSPShareHyperevents %AddChild %AddChildAfter %AddChildBefore
%AddComponent %AddEnsExceptionHandler %AddImportedComponents %AddToSaveSet
%ApplyURLParms %Attr %BindExport %ClassIsLatestVersion
%ClassName %ConstructClone %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %DrawAutoLogout %DrawClassDefinitions %DrawComponentHTML
%DrawHTML %DrawHTMLPage %DrawJSStrings %DrawObjectDefinitions
%DrawTitle %EnclosingDivId %EndBackgroundMethod %EndScript
%Eval %EvalC %Extends %ForceClientRender
%GetChildIndex %GetComponent %GetComponentById %GetComponentByName
%GetEventHandlers %GetLinks %GetPageName %GetParameter
%GetValueById %GetValueByName %GetXMLName %IsA
%IsModified %Link %LinkCSS %LinkScript
%MakeId %New %NormalizeObject %ObjectModified
%OnAddToPageAfter %OnAddToPageBefore %OnAfterCreatePage %OnBeforeCreatePage
%OnCreateApplication %OnCreatePage %OnDetermineCSSLevel %OnDrawEnclosingDiv
%OnDrawHTMLBody %OnDrawHTMLHead %OnDrawHTMLMeta %OnDrawObjectProperties
%OnFinishBackgroundTask %OnGetSubtitle %OnGetTitle %OnMonitorBackgroundTask
%OnMutateChildren %OnObjectSynch %OnPreHTTP %OnSubmit
%OnUseSoftModals %OnZENDeserialize %OriginalNamespace %PackageName
%QuoteValue %QuoteValueL10N %RemoveChild %RemoveChildren
%RemoveComponent %RemoveFromSaveSet %RunBackgroundMethod %Self
%SerializeObject %SetBackgroundMethodStatus %SetErrorById %SetErrorByName
%SetModified %SetValueById %SetValueByName %SetValuesByName
%StartScript %ValidateObject %ZENVersion ConvertParameter
CreateInputObject CreateOutput Decrypt Encrypt
EscapeHTML EscapeURL EvalResult GetExtraData
GetHyperEventResources GetSourceData HyperEventCall HyperEventHead
Include InsertHiddenField InsertHiddenFields IsPrivate
JavaInstalled Link OnChangeTransform OnHTTPHeader
OnPage OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent Page QuoteJS
RewriteURL SaveExtraSerialized SetSourceData ShowError
SimpleKeepAlive StartTimer StopTimer ThrowError
UnescapeHTML UnescapeURL UpdateSourceData XMLDTD
XMLExport XMLExportToStream XMLExportToString XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType addChild
addChildAfter addChildBefore addPopupSuffix adjustSize
applyDetails btnApply btnOK cancelPopup
changeSourceData checkEdit childrenMutated clientKeepAlive
clipboardDocument correctIELayering createComponent createComponentNS
ctrlKeyDown deleteComponent dialogApply dialogCancel
dialogFinish dialogTitleGet disableButtons dragFinishHandler
dragHandler dragNotifyHandler dragStartHandler drawExtraDataTables
dropHandler dropStartHandler endModal exposeComponent
findElement findOneReservedAndRecord fireOnResizeEvent fireOnUnloadEvent
fireOnUpdateEvent firePopupAction getChildIndex getComponent
getComponentById getDialogValue getEnclosingDiv getHidden
getHintElement getLabelElement getOpener getProperty
getSerializedExtraData getSettings getType gotoPage
hideAuxPropertyColumn inResizeLoop initPopupSuffix invokeSuper
isDisabledAction isOfType launchPopupWindow makeId
onCreate onDelete onDisplayHandler onEndModalHandler
onPopupAction onRefreshContents onSerialize onServerMethodCall
onServerMethodError onServerMethodReturn onStartModalHandler ondialogCancel
ondialogFinish ondialogStart ondisabledHandler onhandleAutoLogoutWarn
onkeydownHandler onkeyupHandler onlayoutHandler onloadHandler
onlogoutHandler onoverlayHandler onresizeHandler onunloadHandler
onupdateHandler popupActionHandler prepareExtraTestDataEntry recordProperties
recordPropsOfReserved refreshContents removeChild removePopupSuffix
render renderContents renderSVG resetMsg
runTest serializeExtraDataFromTables setComponentId setHidden
setOverlayMode setProperty setPropertyAll setTraceOption
showMsg showOtherFormat startKeepAlive startModal
startProgressBar stopKeepAlive stopProgressBar validateRequired


Parameters

• parameter APPLYBUTTON = 0;
If true, then this dialog displays an Apply button.
• parameter CANCELBUTTON = 0;
If true, then this dialog displays a Cancel button.
• parameter OKBUTTON = 0;
• parameter PAGENAME = "Test Transform";
Displayed name of this page.
• parameter RESOURCE = "%Ens_DTLTest:USE";
User needs USE permissions on the %Ens_DTLTest resource to view this page.

Properties

• property extraDataSerialized as %String(MAXLEN="");
JSON serialization of aux, process and context extra data. Example of dynamic object created from serialization is extraDataSerialized.aux.RuleUserData="test"
• property firstLoad as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
• property lastSavedExtraSerialized as %String(MAXLEN="");
Record last extraDataSerialized persisted on server for user and dtl to prevent unnecessary saves
• property sourceClass as %ZEN.Datatype.className;
• property sourceData as %ZEN.Datatype.string(ZENCLIENTONLY=1);
• property sourceDocType as %ZEN.Datatype.string;
• property sourceLabel as %ZEN.Datatype.string [ InitialExpression = $$$TextHTML("Input Message") ];
• property targetClass as %ZEN.Datatype.className;
• property targetDocType as %ZEN.Datatype.string;
• property targetLabel as %ZEN.Datatype.string [ InitialExpression = $$$TextHTML("Output Message") ];
• property transform as %ZEN.Datatype.className(ZENURL="TRANSFORM");

Methods

• method %OnAfterCreatePage() as %Status
Ensure that a transform has been supplied.
• 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 CreateInputObject(pInputClass As %String = "", pData As %String = "", Output pStatus As %Status, ByRef pDocProperties) as %RegisteredObject
Create an input message for testing. Note that pData may be a stream object if the source data is sufficiently large.
• method CreateOutput(pSeed) as %Status
Callback method to create the necessary objects and capture the transformed output. We make context and process public for possible use is in Transform method
• method GetExtraData() as %String [ ZenMethod ]
• method GetSourceData() as %RawString
Get the current source data for this user. If the data is small enough to fit into a string, then a string is returned. The exception is if the source class is an EnsLib.HL7.Message in which case a stream will be returned even if short enough for a string. If multiple nodes in the global are needed, then a stream is returned. This method is not accessible from the client as it can return a stream.
• method OnChangeTransform(pNewTransform As %String) as %Integer [ ZenMethod ]
Method to (re)initialise the page for a transform
• method SaveExtraSerialized() as %String [ ZenMethod ]
• classmethod SetSourceData(pTransform As %Dictionary.Classname, pData As %String) as %String [ ZenMethod ]
Save the source data for the current transform to the server. Note that pData will be automatically converted to a stream object if it exceeds the maximum string length.
• method UpdateSourceData() as %String [ ZenMethod ]
Method to ensure that the current source data is present on the client. The data is written directly to the JS variable zenPage.sourceData on the client because the content may exceed 32k for sample documents, and we want to avoid the overhead of serialising the value along with the page itself.
• method applyDetails() [ Language = javascript ]
• method changeSourceData() [ Language = javascript ]
Event handler to send updates to the source data back to the server.
• method clipboardDocument() [ Language = javascript ]
• method drawExtraDataTables() [ Language = javascript ]
Populate tables based on stored data & properties identifed in dtl
• method findOneReservedAndRecord(value, reserved) [ Language = javascript ]
• method getDialogValue() [ Language = javascript ]
Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.
• method getSerializedExtraData(tableID) [ Language = javascript ]
Read a table of property/value pairs and convert to JSON object
• method hideAuxPropertyColumn() [ Language = javascript ]
Hide property column if detected only aux used without reference to property
• method isDisabledAction(action) [ Language = javascript ]
Walks up action tree to see if action disabled
• method ondialogStart() [ Language = javascript ]
Find use of reserved variables in dtl and generate any input tables
• method onloadHandler() [ Language = javascript ]
Ensure that the source data on the client is synchronised with the server.
• method prepareExtraTestDataEntry() [ Language = javascript ]
Look for use of reserved variables in DTL: aux, process and context store in this._reserved[aux] and process and context arrays.
• method recordProperties(value, reserved) [ Language = javascript ]
• method recordPropsOfReserved(value) [ Language = javascript ]
• method runTest() [ Language = javascript ]
Use the callback on the "targetData" component to trigger the transform and output of the result. read the tables and populate extraDataSerialized.
• method serializeExtraDataFromTables() [ Language = javascript ]
Read the extra data tables and serialize so can be passed to the test call.
• method showOtherFormat() [ Language = javascript ]


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.