Class Reference
EnsPortal.Template.prodConfigSCPage
Server:appadmin-00044-deployment-6bf4cbc86d-9f4xc
Instance:IRIS
User:SuperUser
 
-
  [USER] >  [EnsPortal] >  [Template] >  [prodConfigSCPage]
Private  Storage

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 4 25


Summary

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

Properties
%condition %import %includeFiles %page
%resource HelpAddress ISREADONLY LocatorHeader
ParentURL StdTitle aboutPage align
aux backgroundTimerInterval canEdit cellAlign
cellSize cellStyle cellVAlign children
composite contactPage containerStyle cssLevel
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
layout lblTitle limitPopups msgNotPermitted
msgProductionReadOnly msgSCReadOnly name needProject
onafterdrag onbeforedrag onclick ondrag
ondrop onhide onrefresh onshow
onupdate pageModified parent readOnly
readOnlyReason renamed searchKey showLabel
slice sourceControlEnabled sourceControlManagerDialog sourceControlNewlineFormat
sourceControlOutputDialog sourceControlVisible 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
GetNewURL GetQuickLinks GetSourceControlClass GetSourceControlCommands
GetTimestamp HaveSourceControlOutput HyperEventCall HyperEventHead
Include InsertHiddenField InsertHiddenFields IsDocReadOnly
IsEnabled IsPrivate IsProductionSCReadOnly IsProjectRequired
IsRuntimeDifferentFromClass IsSourceControlReadOnly JavaInstalled Link
LoadProject OnDrawRibbon OnGetRibbonInfo OnHTTPHeader
OnPage OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent Page QuoteJS
RegisterRecent RewriteURL SCSubmitProduction SetCurrentProject
SetProjectRequired ShowError SimpleKeepAlive StartTimer
StopTimer ThrowError UnescapeHTML UnescapeURL
UpdateSCMenus UserAction XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType addChild addChildAfter
addChildBefore addPopupSuffix appendServerOutput arrowClick
canUserModify cancelPopup changePassword changeURLNamespace
checkEdit checkRuntimeAndClassInSync checkTextControls childrenMutated
chooseSCMenu chooseSCProject clearSCOutput clientKeepAlive
correctIELayering createComponent createComponentNS createSCMenuItem
createSCProject createSCSubMenu createTimeWarning deleteComponent
disableCommandButton displayCountDown dragFinishHandler dragHandler
dragNotifyHandler dragStartHandler dropHandler dropStartHandler
enableCommandButton endModal exposeComponent findElement
fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent firePopupAction
getChildIndex getClientModel getComponent getComponentById
getCurrentExtension getCurrentName getEnclosingDiv getHidden
getHintElement getIsReadOnly getLabelElement getOpener
getPageTitle getProperty getReadOnlyReason getSaveAction
getSettings getTitleAreaHeight getType goHome
goMenu gotoNamespace gotoPage hideCommandButton
hideTimeoutWarning hideWarnContinue inResizeLoop initPopupSuffix
initializeSourceControl initializeTextMonitor invokeAfterUserAction invokeSourceControl
invokeSuper isOfType launchPopupWindow loadDocument
logout makeId manualKeepAlive navigate
onCreate onDelete onDisplayHandler onDocumentLoad
onDocumentLoadComplete onDocumentSave onDocumentSaveComplete onEndModalHandler
onPopupAction onRefreshContents onSerialize onServerMethodCall
onServerMethodError onServerMethodReturn onStartModalHandler ondisabledHandler
onhandleAutoLogoutWarn onkeydownHandler onkeyupHandler onlayoutHandler
onloadHandler onlogoutHandler onoverlayHandler onresizeHandler
onunloadHandler onupdateHandler popupActionHandler refreshContents
reloadDocument removeChild removePopupSuffix render
renderContents renderSVG saveDocument scSetReadWriteState
searchBlur searchBoxHandler searchFocus searchKeyDown
searchKeyPress setComponentId setConnectivityStatusMsg setHidden
setModified setOverlayMode setPageTitle setProperty
setPropertyAll setReadOnly setSCProject setSortMode
setSortModeHandler setTraceOption setViewMode setViewModeHandler
setWarnInnerHTML showAbout showCommandButton showContact
showDocumentation showHelp showSCMenu showSCOutput
showTimeoutWarning startKeepAlive startModal startProgressBar
stopKeepAlive stopProgressBar switchNamespace textControlKeyDown
textControlKeyUp toggleReadOnly updateDocumentState updateSCIndicator
warnclickListener

Subclasses
EnsPortal.ProductionConfig

Parameters

• parameter MANAGERDIALOG = "EnsPortal.Dialog.SourceControlManager.zen";
Page to use for managing popups requested by the source control framework.
• parameter OUTPUTDIALOG = "EnsPortal.Dialog.SourceControlOutput.zen";
Page to use for displaying output from the server.

Properties

• property msgProductionReadOnly as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("This production is set to read only") ];
• property msgSCReadOnly as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Your source control framework has marked this production as read only, so you will not be able to modify this production.") ];

Methods

• method GetInternalName() as %String
Return the internal name of the current Production class.
• method IsDocReadOnly() as %Boolean [ ZenMethod ]
• method IsProductionSCReadOnly() as %Boolean [ ZenMethod ]
• classmethod IsRuntimeDifferentFromClass(pClassName) as %String [ ZenMethod ]
Wrapper to check if class is different from runtime
• method SCSubmitProduction(pCommand As %String, pProvider As %ZEN.Auxiliary.jsonProvider, pSubmitObject As Ens.Config.Production, Output pResponseObject As %RegisteredObject) as %Status
Source Control stub Not used for saving production class changes
• method canUserModify(saveAs) [ Language = javascript ]
Test if the user has write privilege.
• method checkEdit() [ Language = javascript ]
• method checkRuntimeAndClassInSync(caller) [ Language = javascript ]
Used to check if class and code in sync
• method chooseSCMenu(menuName, commandName, saveFlags) [ Language = javascript ]
Handle a source control menu selection.
• method getClientModel() [ Language = javascript ]
Get the jsonProvider object on the client. Subclasses MUST override this method to return the jsonProvider.
• method getCurrentName() [ Language = javascript ]
Return the current name of the production being modified
• method getIsReadOnly() as %Boolean [ Language = javascript ]
• method getReadOnlyReason() [ Language = javascript ]
Callback to get the text of the reason for the current document being loaded as readonly.
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method reloadDocument() [ Language = javascript ]
Override SC method since not doing a full page reload so that invokeSourceControl still calls UpdateSCMenus()
• method saveDocument(force) [ Language = javascript ]
Overwrite SC method since we do not do the Save and SaveToClass In Studio the class will be saved but SaveToClass not called.
• method scSetReadWriteState(readOnly) [ Language = javascript ]
• method setReadOnly(readOnly) [ Language = javascript ]
Set readOnly to the value of readOnly.
• method showSCMenu() [ Language = javascript ]
Display the source control menu based on the contents of the _sourceControlMenu data created by UpdateSCMenu().
• method toggleReadOnly(caller) [ Language = javascript ]
Called after each Source Control action. Add caller parameter to be able to identify if called from this class.


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