Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [EnsPortal] >  [DefaultSetting]
Private  Storage   

class EnsPortal.DefaultSetting extends EnsPortal.Template.standardPage

Zen based System Default Settings page for add or edit

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
4 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
PID ParentURL StdTitle aboutPage
align aux backgroundTimerInterval canEdit
cellAlign cellSize cellStyle cellVAlign
children composite contactPage containerStyle
cssLevel currSortMode currStep currViewMode
disabled dragAndDrop dragEnabled dropEnabled
enableAutoRefresh enclosingClass enclosingStyle error
groupClass groupStyle height hidden
hint hintClass hintStyle home
homePage id index isNew
keepAliveInterval label labelClass labelDisabledClass
labelPosition labelStyle layout lblTitle
limitPopups msgNotPermitted msgTable name
onafterdrag onbeforedrag onclick ondrag
ondrop onhide onrefresh onshow
onupdate pageModified parent searchKey
settingsExpanded showLabel slice 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 %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 BuildMenu
CheckAllBlanks CheckContextLinks CheckEnterpriseManager ConvertParameter
Decrypt DoLogout DrawLocator DrawRibbon
DrawTitle Encrypt EscapeHTML EscapeURL
EvalResult GetAffectedCount GetCSPURL GetContextLinks
GetDocPage GetHomePage GetHyperEventResources GetNewURL
GetQuickLinks GetTempGlobal GetTreeGlobal GetTreeInfo
HyperEventCall HyperEventHead Include InsertHiddenField
InsertHiddenFields IsPrivate Link OnDrawRibbon
OnGetRibbonInfo OnHTTPHeader OnPage OnPageError
OnPostHTTP OnPostHyperEvent OnPreHTTP OnPreHyperEvent
Page QuoteJS RegisterRecent RewriteURL
SaveData ShowError SimpleKeepAlive StartTimer
StopTimer ThrowError UnescapeHTML UnescapeURL
UpdateDetails XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType addChild addChildAfter addChildBefore
addPopupSuffix adjustSettingName adjustSizes arrowClick
cancelPopup cancelSetting changePassword changeURLNamespace
checkEdit childrenMutated clientKeepAlive correctIELayering
createComponent createComponentNS deleteComponent disableCommandButton
dragFinishHandler dragHandler dragNotifyHandler dragStartHandler
dropHandler dropStartHandler enableCommandButton endModal
exposeComponent findElement fireOnResizeEvent fireOnUnloadEvent
fireOnUpdateEvent firePopupAction getChildIndex getComponent
getComponentById getEnclosingDiv getHidden getHintElement
getLabelElement getOpener getPageTitle getProperty
getSettings getTitleAreaHeight getType goHome
goMenu gotoNamespace gotoPage hideCommandButton
inResizeLoop initPopupSuffix invokeSuper isOfType
launchPopupWindow logout makeId navigate
onCreate onDelete onDisplayHandler onEndModalHandler
onPopupAction onRefreshContents onSerialize onServerMethodCall
onServerMethodError onServerMethodReturn onStartModalHandler ondisabledHandler
onkeydownHandler onkeyupHandler onlayoutHandler onloadHandler
onlogoutHandler onoverlayHandler onresizeHandler onunloadHandler
onupdateHandler popupActionHandler refreshContents removeChild
removePopupSuffix render renderContents renderSVG
resetSetting saveSetting searchBlur searchBoxHandler
searchFocus searchKeyDown searchKeyPress setComponentId
setConnectivityStatusMsg setHidden setModified setOverlayMode
setPageTitle setProperty setPropertyAll setSortMode
setSortModeHandler setTraceOption setViewMode setViewModeHandler
showAbout showCommandButton showContact showDocumentation
showExpand showHelp startKeepAlive startModal
startProgressBar stopKeepAlive stopProgressBar switchNamespace
toggleSettings treeClick treeContractAll treeExpandAll


Parameters

• parameter EDITRESOURCE = "%Ens_SystemDefaultConfig:WRITE";
User needs WRITE permissions on the %Ens_SystemDefaultConfig resource to make changes on this page.
• parameter JSINCLUDES = "zenCSLM.js";
Comma-separated list of additional JS include files for the page.
• parameter PAGENAME = "Default Setting";
Displayed name of this page.
• parameter RESOURCE = "%Ens_SystemDefaultConfig:READ";
User needs READ permissions on the %Ens_SystemDefaultConfig resource to view this page.

Properties

• property PID as %ZEN.Datatype.string(ZENURL="PID");
The last selected PID
• property isNew as %String(ZENURL="isNew") [ InitialExpression = "0" ];
• property msgTable as %ZEN.Datatype.caption;
Message that is built with the namespace in it.
• property settingsExpanded as %Boolean [ InitialExpression = 1 ];

Methods

• method %GetLocatorLinks(Output pLink) as %Status
Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)
• method %OnAfterCreatePage() as %Status
This callback is called after the server-side page object and all of its children are created.
Subclasses can override this to add, remove, or modify items within the page object model, or to provide values for controls.
• method %OnDrawHTMLHead() as %Status
Add the EnsException error handling on the client.
• method %OnGetPageName() as %String
Get the (localized) name of the page. This should be implemented in a subclass.
• method %OnGetTitle() as %String
Get the (localized) title string for the page.
• classmethod CheckAllBlanks(string) as %Boolean [ ZenMethod ]
• classmethod GetAffectedCount() as %String
Get the total count of configuration items affected by the definition currently shown.
• classmethod GetHyperEventResources(pMethod As %String = "") as %String
Callback to return a list of resources required for a specific HyperEvent. The user must have sufficient privileges on one of the resource/permission pairs to be permitted to execute the hyperevent. An empty string implies the user already has sufficient privileges for the ZenMethod specified in pMethod.
• classmethod GetTempGlobal() as %String
Return the temporary global name.
• classmethod GetTreeGlobal() as %String
Return the temporary global name of the dynaTree.
• classmethod GetTreeInfo(pRoot As %String, Output pTree, ByRef pParms) as %Status
Provide contents of the data source tree and temp globals.
• 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 SaveData(pid, production, itemname, hostclassname, settingname, settingvalue, description, deployable) as %ZEN.proxyObject [ ZenMethod ]
Save general association data to server
• method UpdateDetails(pid) as %Boolean [ ZenMethod ]
Update contents of setting. This method is called when user clicked a row to "Edit". Load data into the fields.
• method adjustSettingName(selector) [ Language = javascript ]
Get only the first piece of white space from the Setting Name value.
• method adjustSizes() [ Language = javascript ]
Adjust sizes of components on the page.
• method cancelSetting() [ Language = javascript ]
Cancel out of Add/Edit and return to the previous page.
• method resetSetting() [ Language = javascript ]
Reset out of Add/Edit, reinitializing all fields and information on the page (the trees are rebuilt too).
• method saveSetting() [ Language = javascript ]
Get user selection and send to server to save settings.
• method showExpand() [ Language = javascript ]
• method toggleSettings() [ Language = javascript ]
Toggle display of settings pane.
• method treeClick(tree) [ Language = javascript ]
Click on a tree's item.
• method treeContractAll(tree) [ Language = javascript ]
Contract the tree.
• method treeExpandAll(tree) [ Language = javascript ]
Expand the tree.


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