Learning
Documentation
Community
Open Exchange
Global Masters
Home > Class Reference > ENSLIB namespace > EnsPortal.Template.prodConfigSCPage
Private  Storage   

EnsPortal.Template.prodConfigSCPage


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
%ComponentClasses %ComponentNames %Components %CompositeList
%DeletedIds %NotifyList %RenderList %UserPackageList
%condition %import %includeFiles %page
%partial %resource %xmlOutputMode HelpAddress
ISREADONLY LocatorHeader ParentURL SVGClassList
StdTitle UserSVGPackageList aboutPage align
aux backgroundTimerInterval canEdit cellAlign
cellSize cellStyle cellVAlign children
composite contactPage containerStyle cssLevel
currSortMode currStep currViewMode currentNamespace
currentProject currentUser designMode disabled
dragAndDrop dragEnabled dropEnabled dynamic
enableAutoRefresh enclosingClass enclosingStyle error
groupClass groupStyle hasSCOutput height
hidden hint hintClass hintStyle
home homePage id index
inlineSVG isNew isPopup isSoftModal
keepAliveInterval label labelClass labelDisabledClass
labelPosition labelStyle lastModalIndex layout
lblTitle limitPopups msgNotPermitted msgProductionReadOnly
msgSCReadOnly name needProject nextIndex
onafterdrag onbeforedrag onclick ondrag
ondrop onhide onoverlay onrefresh
onshow onupdate overlayMode pageModified
parent popupParent readOnly readOnlyReason
renamed renderFlag scReadOnly searchKey
showLabel slice sourceControlEnabled sourceControlManagerDialog
sourceControlNewlineFormat sourceControlOutputDialog sourceControlVisible title
tuple useSVG useSoftModals valign
visible wasReadOnly width window
zenPersistentPopup

Methods
%%OIDGet %AddCSPShareHyperevents %AddChild
%AddChildAfter %AddChildBefore %AddComponent
%AddEnsExceptionHandler %AddImportedComponents %AddLocatorLinks
%AddToSaveSet %ApplyURLParms %Attr
%BindExport %BuildObjectGraph %ClassIsLatestVersion
%ClassName %Close %ConstructClone
%CreateApplication %CreatePage %DetermineCSSLevel
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty
%DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %DrawAutoLogout %DrawClassDefinition
%DrawClassDefinitions %DrawComponentHTML %DrawHTML
%DrawHTMLPage %DrawJSGetSettings %DrawJSSerialize
%DrawJSStrings %DrawObjectDefinitions %DrawObjectProperties
%DrawSVGDef %DrawSourceControlCommands %DrawSourceControlHead
%DrawSourceControlJS %DrawSourceControlStyle %DrawStyleDefinitions
%DrawStyleHTML %DrawStyleSVG %EnclosingDivId
%EndBackgroundMethod %EndScript %Eval
%EvalC %Extends %ForceClientRender
%GenerateCode %GetAllNamespaces %GetChildIndex
%GetClassCRC %GetClassDepth %GetComponent
%GetComponentById %GetComponentByName %GetComponentPropertyById
%GetDependentComponents %GetEventHandlers %GetHomePage
%GetHomeParam %GetIncludeFiles %GetIncludeInfo
%GetLinks %GetLocatorInfo %GetLocatorLinks
%GetPageName %GetPaneContents %GetParameter
%GetProductName %GetRootLink %GetSuperClassList
%GetValueById %GetValueByName %GetXMLName
%IncrementCount %IsA %IsEmbedded
%IsModified %Link %LinkCSS
%LinkScript %MakeId %New
%NormalizeObject %ObjectModified %ObjectSynch
%OnAddToPage %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 %ReallyAddChild
%Register %RemoveChild %RemoveChildren
%RemoveComponent %RemoveFromSaveSet %RunBackgroundMethod
%Self %SerializeObject %SetBackgroundMethodStatus
%SetErrorById %SetErrorByName %SetModified
%SetValueById %SetValueByName %SetValuesByName
%StartScript %ValidateObject %XMLGenerate
%ZENDeserialize %ZENVersion AfterUserAction
AppendSourceControlOutput BuildMenu CallProductionUpdateAndSaveToClass
CheckAllBlanks CheckContextLinks CheckEnterpriseManager
ClearSourceControlOutput ConvertParameter CreateProject
CreateSourceControl Decrypt DoLogout
DocumentLoad DocumentSave DrawLocator
DrawRibbon DrawTitle Encrypt
EncryptBroker EscapeHTML EscapeURL
EvalResult GetCSPURL GetContextLinks
GetCurrentProject GetDocURL GetFullProjectName
GetHomePage GetHyperEventResources GetInternalName
GetNewURL GetQuickLinks GetSourceControlClass
GetSourceControlCommands GetTimestamp HaveSourceControlOutput
HyperEventBody HyperEventCall HyperEventFrame
HyperEventHead Include InsertHiddenField
InsertHiddenFields InvokeClassMethod InvokeInstanceMethod
IsDocReadOnly IsEnabled IsPrivate
IsProductionSCReadOnly IsProjectRequired IsRuntimeDifferentFromClass
IsSourceControlReadOnly Link LoadProject
LoadZenComponent MonitorBackgroundTask OnDrawRibbon
OnGetRibbonInfo OnHTTPHeader OnPage
OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent OnProductionUpdate
Page QuoteJS ReallyRefreshContents
RegisterRecent RewriteURL SCLoadProduction
SCSubmitProduction SetCurrentProject SetProjectRequired
ShowError SimpleKeepAlive StartTimer
StopTimer ThrowError UnescapeHTML
UnescapeURL UpdateSCMenus UserAction
XMLAfterExport XMLBeforeExport XMLDTD
XMLExport XMLExportInternal XMLExportToStream
XMLExportToString XMLGetSchemaImports XMLImport
XMLImportInternal XMLIsObjectEmpty XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType
addChild addChildAfter addChildBefore
addPopupSuffix appendServerOutput arrowClick
backgroundTimerHandler canUserModify cancelPopup
changePassword changeURLNamespace checkEdit
checkRuntimeAndClassInSync checkTextControls childrenMutated
chooseSCMenu chooseSCProject clearBackgroundTask
clearSCOutput clientKeepAlive correctIELayering
createComponent createComponentNS createSCMenuItem
createSCProject createSCSubMenu deleteComponent
disableCommandButton dragFinishHandler dragHandler
dragNotifyHandler dragStartHandler dropHandler
dropStartHandler enableCommandButton endModal
exposeComponent findElement fireOnLoadEvent
fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent
firePopupAction getChildIndex getClientModel
getComponent getComponentById getCurrentExtension
getCurrentName getEnclosingDiv getHidden
getHintElement getIsReadOnly getLabelElement
getOpener getPageTitle getProperty
getReadOnlyReason getSaveAction getSettings
getTargetPage getTitleAreaHeight getType
goHome goMenu gotoNamespace
gotoPage hideCommandButton inResizeLoop
initPopupSuffix initializeSourceControl initializeTextMonitor
invokeAfterUserAction invokeSourceControl invokeSuper
isOfType launchPopupWindow loadDocument
logout makeId navigate
onCreate onDelete onDisplayHandler
onDocumentLoad onDocumentLoadComplete onDocumentSave
onDocumentSaveComplete onEndModalHandler onPopupAction
onRefreshContents onSerialize onServerMethodCall
onServerMethodError onServerMethodReturn onStartModalHandler
ondisabledHandler onkeydownHandler onkeyupHandler
onlayoutHandler onloadHandler onlogoutHandler
onoverlayHandler onresizeHandler onunloadHandler
onupdateHandler overridingSourceControl popupActionHandler
progressBarHandler refreshContents reloadDocument
removeChild removePopupSuffix render
renderContents renderSVG saveDocument
scSetReadWriteState searchBlur searchBoxHandler
searchFocus searchKeyDown searchKeyPress
setBackgroundTask setComponentId setConnectivityStatusMsg
setHidden setModified setOverlayMode
setPageTitle setProperty setPropertyAll
setReadOnly setSCProject setSortMode
setSortModeHandler setSourceControlFlags setTraceOption
setViewMode setViewModeHandler showAbout
showCommandButton showContact showDocumentation
showHelp showSCMenu showSCOutput
startKeepAlive startModal startProgressBar
stopKeepAlive stopProgressBar switchNamespace
testConnectivity textControlKeyDown textControlKeyUp
toggleReadOnly updateControlsInGroup updateDocumentState
updateSCIndicator

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.") ];
• property scReadOnly as %Boolean [ InitialExpression = 0 ];
Flag to keep record of whether the document is read only due to source control
• property wasReadOnly as %Boolean [ InitialExpression = 0 ];
Flag to keep record of whether the document was readOnly before a source control action was invoked

Methods


• classmethod CallProductionUpdateAndSaveToClass(production As Ens.Config.Production, item As Ens.Config.Item = $$$NULLOREF, updateType As %String = "") as %Status
• 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
• classmethod OnProductionUpdate(pWhen As %String = "before", Output pOutput As %DynamicObject, Output pStatus As %Status, pInternalName As %String, pSourceControlNewlineFormat As %String) as %String
• method SCLoadProduction(ByRef pParms, Output pObject As %ZEN.proxyObject) as %Status
Needed for Source Control getClientModel - timestamp Not used for loading production class for editing
• 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.
• classmethod overridingSourceControl() as %Boolean
• 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 setSourceControlFlags()
Called in %OnAfterCreatePage
• 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.