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

class EnsPortal.ComplexRecordMapper extends EnsPortal.Template.devPage

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
4 12 61


Summary

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

Properties
%condition %controller %import %includeFiles
%page %resource %tempMap HelpAddress
ISREADONLY LocatorHeader ParentURL StdTitle
aboutPage align aux backgroundTimerInterval
canEdit cellAlign cellSize cellStyle
cellVAlign children complexMap complexMapAsName
composite contactPage containerStyle controller
controllerId cssLevel currItem currSortMode
currStep currViewMode currentNamespace currentProject
currentUser disabled dragAndDrop dragEnabled
dropEnabled enableAutoRefresh enclosingClass enclosingStyle
error groupClass groupStyle hasSCOutput
height hidden hint hintClass
hintStyle home homePage id
index keepAliveInterval label labelClass
labelDisabledClass labelPosition labelStyle lastLoc
layout lblTitle limitPopups msgDocReadOnly
msgNotPermitted name needProject onafterdrag
onbeforedrag onclick ondrag ondrop
onhide onnotifyView onrefresh onshow
onupdate pageModified parent readOnly
readOnlyReason renamed searchKey showLabel
slice sourceControlEnabled sourceControlManagerDialog sourceControlNewlineFormat
sourceControlOutputDialog sourceControlVisible studioMode tipCSVWizard
tipCompile tipContractAll tipDelete tipExpandAll
tipExport tipGen tipImport tipImportLegacy
tipNew tipOpen tipSave tipSaveAs
title tuple useSVG useSoftModals
valign visible width window
zenPersistentPopup

Methods
%AddCSPShareHyperevents %AddChild %AddChildAfter %AddChildBefore
%AddComponent %AddEnsExceptionHandler %AddImportedComponents %AddLocatorLinks
%AddToSaveSet %ApplyURLParms %Attr %BindExport
%ClassIsLatestVersion %ClassName %ConstructClone %DispatchClassMethod
%DispatchGetModified %DispatchGetProperty %DispatchMethod %DispatchSetModified
%DispatchSetMultidimProperty %DispatchSetProperty %DrawAutoLogout %DrawClassDefinitions
%DrawComponentHTML %DrawHTML %DrawHTMLPage %DrawJSStrings
%DrawObjectDefinitions %DrawSourceControlCommands %DrawSourceControlHead %DrawSourceControlJS
%DrawSourceControlStyle %EnclosingDivId %EndBackgroundMethod %EndScript
%Eval %EvalC %Extends %ForceClientRender
%GetChildIndex %GetComponent %GetComponentById %GetComponentByName
%GetEventHandlers %GetHomePage %GetHomeParam %GetLinks
%GetLocatorLinks %GetPageName %GetParameter %GetProductName
%GetRootLink %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 %OnGetPageName %OnGetProductName
%OnGetSmallMenu %OnGetTitle %OnMonitorBackgroundTask %OnMutateChildren
%OnObjectSynch %OnPreHTTP %OnSubmit %OnUseSoftModals
%OnZENDeserialize %OriginalNamespace %PackageName %QuoteValue
%QuoteValueL10N %Register %RemoveChild %RemoveChildren
%RemoveComponent %RemoveFromSaveSet %RunBackgroundMethod %Self
%SerializeObject %SetBackgroundMethodStatus %SetErrorById %SetErrorByName
%SetModified %SetValueById %SetValueByName %SetValuesByName
%StartScript %ValidateObject %ZENVersion AfterUserAction
AppendSourceControlOutput BuildMenu CheckAllBlanks CheckContextLinks
CheckEnterpriseManager ClearSourceControlOutput ConvertParameter CreateProject
CreateSourceControl Decrypt DoLogout DocumentLoad
DocumentSave DrawLocator DrawRibbon DrawTitle
Encrypt EscapeHTML EscapeURL EvalResult
GetCSPURL GetContextLinks GetCurrentProject GetDocURL
GetFullProjectName GetHomePage GetHyperEventResources GetInternalName
GetLastMap GetMapObject GetNewURL GetQuickLinks
GetSourceControlClass GetSourceControlCommands GetTimestamp HaveSourceControlOutput
HyperEventCall HyperEventHead Include InsertHiddenField
InsertHiddenFields IsDocReadOnly IsEnabled IsPrivate
IsProjectRequired IsSourceControlReadOnly JavaInstalled Link
LoadProject OnDrawRibbon OnGetRibbonInfo OnHTTPHeader
OnPage OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent Page QuoteJS
RegisterRecent RewriteURL SetCurrentProject SetLastMap
SetProjectRequired ShowError SimpleKeepAlive StartTimer
StopTimer SubmitMapObject ThrowError UnescapeHTML
UnescapeURL UpdateSCMenus UserAction XMLDTD
XMLExport XMLExportToStream XMLExportToString XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType addChild
addChildAfter addChildBefore addItem addPopupSuffix
addToNameIndex addUndoAction appendServerOutput applyChanges
arrowClick buildPropIndex canUndo canUserModify
cancelPopup changeElementName changeElementType changePassword
changeTargetClassname changeURLNamespace checkEdit checkStudioHyperEvents
checkTextControls childrenMutated chooseSCMenu chooseSCProject
clearSCOutput clearUndoBuffer clientKeepAlive cloneObject
correctIELayering createComponent createComponentNS createSCMenuItem
createSCProject createSCSubMenu createTimeWarning deleteComponent
deleteMap disableCommandButton displayCountDown dragFinishHandler
dragHandler dragNotifyHandler dragStartHandler drawElementHTML
drawHeaderTrailerHTML drawTable dropHandler dropStartHandler
enableCommandButton endModal escapeCData exposeComponent
findElement fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent
firePopupAction fixDocumentTitle generateMap getChildIndex
getClientModel getComplexMap getComponent getComponentById
getController getCurrentExtension getCurrentLocation getCurrentName
getElementDetails getElementType getElementUserType getEnclosingDiv
getHidden getHintElement getIsReadOnly getLabelElement
getNextRecordName getOpener getPageTitle getProperty
getReadOnlyReason getSaveAction getSettings getTitleAreaHeight
getType goHome goMenu gotoNamespace
gotoPage grayOutButtons hideCommandButton hideTimeoutWarning
hideWarnContinue inResizeLoop initPopupSuffix initializeSourceControl
initializeTextMonitor invokeAfterUserAction invokeSourceControl invokeSuper
isOfType launchPopupWindow loadDocument loadEditor
logout makeId manualKeepAlive moveItem
navigate newMap onCreate onDelete
onDisplayHandler onDocumentLoad onDocumentLoadComplete onDocumentReload
onDocumentSave onDocumentSaveComplete onEndModalHandler onPopupAction
onRefreshContents onSerialize onServerMethodCall onServerMethodError
onServerMethodReturn onStartModalHandler ondisabledHandler onhandleAutoLogoutWarn
onkeydownHandler onkeyupHandler onlayoutHandler onloadHandler
onlogoutHandler onoverlayHandler onresizeHandler onunloadHandler
onupdateHandler openMap popupActionHandler raiseEvent
refreshContents reloadDocument removeChild removeHeaderTrailer
removeItem removePopupSuffix render renderContents
renderSVG rowMouseOut rowMouseOver saveDocument
saveMap saveMapAs searchBlur searchBoxHandler
searchFocus searchKeyDown searchKeyPress selectItem
sendEventToController setComponentId setConnectivityStatusMsg setControllerId
setDescription setHidden setModified setOverlayMode
setPageTitle setProperty setPropertyAll setReadOnly
setResultsDiv setSCProject setSortMode setSortModeHandler
setTraceOption setViewMode setViewModeHandler setWarnInnerHTML
showAbout showCommandButton showContact showDocumentation
showHelp showSCMenu showSCOutput showTimeoutWarning
startKeepAlive startModal startProgressBar stopKeepAlive
stopProgressBar switchNamespace textControlKeyDown textControlKeyUp
toggleExpandingElement toggleReadOnly toggleRepeating toggleSVGElements
undo updateDocumentState updateJSONSCReadOnly updateSCIndicator
updateUndoButton validateElement validateMap warnclickListener


Parameters

• parameter EDITRESOURCE = "%Ens_Code:WRITE,%Ens_RecordMap:WRITE";
User needs WRITE permissions on either the %Ens_Code or the %Ens_RecordMap resource to make changes on this page.
• parameter JSINCLUDES = "zenCSLM.js";
Include zenCSLM.
• parameter PAGENAME = "Complex Record Mapper";
Displayed name of this page.
• parameter RESOURCE = "%Ens_Code:READ,%Ens_RecordMap:READ";
User needs READ permissions on either the %Ens_Code or the %Ens_RecordMap resource to view this page.

Properties

• property %tempMap as EnsLib.RecordMap.Model.ComplexBatch;
• property complexMap as %ZEN.Datatype.string(ZENURL="COMPLEXMAP");
Name of ComplexMap being viewed.
• property complexMapAsName as %ZEN.Datatype.string;
• property currItem as %ZEN.Datatype.integer [ InitialExpression = -1 ];
ID (index number, 0-based) of current selected item.
• property lastLoc as %ZEN.Datatype.string(ZENURL="LOC");
CSV-string used to remember last location across page redraws, especially involving popups.
• property msgDocReadOnly as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("This complex record map is read only.") ];
• property tipDelete as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Delete the current Complex RecordMap") ];
• property tipGen as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Save this Complex RecordMap and generate classes") ];
• property tipNew as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Create a new Complex RecordMap") ];
• property tipOpen as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Open a saved Complex RecordMap") ];
• property tipSave as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Save this Complex RecordMap") ];
• property tipSaveAs as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Save this Complex RecordMap with a new name") ];

Methods

• method %OnAfterCreatePage() as %Status
Determine whether source control is enabled and ensure we don't write out the session cookie if we are running in Studio mode.
• method %OnDrawHTMLHead() as %Status
Add the EnsException error handling on the client.
• method %OnGetPageName() as %String
Get the (localized) name of the page.
• method %OnGetTitle() as %String
Get the (localized) title string for the page.
• method GetInternalName() as %String
Return the internal name of the current document, including the three letter extension in upper-case. For example, MyPackage.MyClass.CLS would be the internal name for the class MyPackage.MyClass. Subclasses MUST override this method.
• classmethod GetLastMap() as %String
• method GetMapObject(ByRef pParms, Output pObject As %RegisteredObject) as %Status
Get ComplexBatch object for the JSON provider.
• method OnDrawRibbon() as %Status
Use %DrawSourceControlCommands() to render the extra source control options in the tool ribbon.
• method OnGetRibbonInfo(Output pDisplay As %Boolean, Output pViewIcons As %List, Output pSortOptions As %List, Output pSearchBox As %Boolean, Output pRibbonTitle As %String, Output pCommands As %List) as %Status
Get information to display in the ribbon bar.
• classmethod SetLastMap(pMapName As %String = "") [ ZenMethod ]
• method SubmitMapObject(pCommand As %String, pProvider As %ZEN.Auxiliary.jsonProvider, ByRef pObject As %RegisteredObject, Output pResponse As %RegisteredObject) as %Status
Process submitted JSON content based on the object created
• method addItem(parentIndex, evt) [ Language = javascript ]
• method addToNameIndex(element, index) [ Language = javascript ]
• method addUndoAction(setModified) [ Language = javascript ]
Remember the current state in the undo buffer.
• method applyChanges() [ Language = javascript ]
• method buildPropIndex() [ Language = javascript ]
• method canUndo() [ Language = javascript ]
Return true if it is possible to undo an action
• method changeElementName(newName) [ Language = javascript ]
• method changeElementType() [ Language = javascript ]
• method changeTargetClassname(newMapName) [ Language = javascript ]
Check that the Target Classname is changed along with the ComplexMap name
• method chooseSCMenu(menuName, commandName, saveFlags) [ Language = javascript ]
Handle a source control menu selection.
• method clearUndoBuffer() [ Language = javascript ]
Clear the undo buffer.
• method cloneObject(obj, clone) [ Language = javascript ]
Create a clone of the given object.
• method deleteMap() [ Language = javascript ]
• method drawElementHTML(element, parent, parentIndex, parentContracted, html, path, first, last, depth) [ Language = javascript ]
• method drawHeaderTrailerHTML(complexMap, property, html) [ Language = javascript ]
• method drawTable() [ Language = javascript ]
• method generateMap() [ Language = javascript ]
• method getClientModel() [ Language = javascript ]
Get the jsonProvider object on the client. Subclasses MUST override this method to return the jsonProvider.
• method getComplexMap() [ Language = javascript ]
• method getCurrentLocation() [ Language = javascript ]
Returns the index of the currently selected item and the offsets of the main window in a comma separated list. It returns the empty string "" if no item is selected.
• method getCurrentName() [ Language = javascript ]
Return the current name of the class/object being modified
• method getElementDetails(element) [ Language = javascript ]
• method getElementType(element) [ Language = javascript ]
• method getElementUserType(elementType, elementClass) [ Language = javascript ]
• method getNextRecordName() [ Language = javascript ]
• method loadEditor(complexMapName, location, newMap, renamed) [ Language = javascript ]
Load the page for the specified RecordMap.
• method moveItem(index, direction, evt) [ Language = javascript ]
• method newMap() [ Language = javascript ]
Create a new ComplexMap.
• method onDocumentReload(reason) [ Language = javascript ]
Ensure we redraw the diagram if the model was updated.
• method onDocumentSaveComplete(contentUpdated) [ Language = javascript ]
Ensure we redraw the table if the model was updated.
• method onPopupAction(popupName, action, value) [ Language = javascript ]
Returning from popups
• method onlayoutHandler(load) [ Language = javascript ]
This client event, if present, is fired when the page is first loaded or whenever it is resized.
If this is called at load time, then load will be true.
• method openMap() [ Language = javascript ]
Launch the finder dialog to select a ComplexMap.
• method removeHeaderTrailer(which) [ Language = javascript ]
• method removeItem(index, evt) [ Language = javascript ]
• method rowMouseOut(evt, row) [ Language = javascript ]
• method rowMouseOver(evt, row) [ Language = javascript ]
• method saveMap(force, suppressOKMessage) [ Language = javascript ]
Method to save the Complex RecordMap to disk without generating any classes.
• method saveMapAs() [ Language = javascript ]
• method selectItem(index, force) [ Language = javascript ]
• method setDescription(desc) [ Language = javascript ]
Update the description (annotation) of this record map.
• method setReadOnly(readOnly) [ Language = javascript ]
Set readOnly to the value of readOnly. Subclasses MUST implement this method to update the controls on the page so that the page's behaviour actually matches the value of the readOnly flag.
• method showSCMenu() [ Language = javascript ]
Call UpdateSCMenu() first in case the document has been modified elsewhere, then display the source control menu based on the contents of the _sourceControlMenu data created by UpdateSCMenu().
• method toggleExpandingElement(index) [ Language = javascript ]
• method toggleRepeating(index, getFromForm) [ Language = javascript ]
• method undo() [ Language = javascript ]
Undo the most recent change.
• method updateUndoButton() [ Language = javascript ]
• method validateElement(element, rowIndex, errors) [ Language = javascript ]
• method validateMap(reportErrors) [ Language = javascript ]


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