Class Reference
%CSP.UI.Portal.Dialog.SchemaPriv
Server:appadmin-00044-deployment-6bf4cbc86d-9f4xc
Instance:IRIS
User:SuperUser
 
-
  [USER] >  [%CSP] >  [UI] >  [Portal] >  [Dialog] >  [SchemaPriv]
Private  Storage

class %CSP.UI.Portal.Dialog.SchemaPriv extends %CSP.Portal.standardDialog, %CSP.UI.Component.SelectBoxUtils

Page to define SQL Table/View column privileges.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
7 16 20


Summary

This is a Zen Page class. It belongs to the application %CSP.UI.Portal.Application.

Properties
%condition %import %includeFiles %page
%resource FirstFailed IncludeSystem InvalidParam
IsEMSReadOnly IsMLConfiguration IsNotMLConfiguration IsNotProcedure
IsNotRelation IsProcedure IsRelation Namespace
ObjName ObjPriv ObjectType PID
PrivCount Schema Tables TotalTables
ValidationErrorMsg align aux avaList
backgroundTimerInterval cellAlign cellSize cellStyle
cellVAlign children composite containerStyle
cssLevel dialogTitle disabled disabledStyle
dragAndDrop dragEnabled dropEnabled enclosingClass
enclosingStyle error groupClass groupStyle
height hidden hideApplyButton hideCancelButton
hint hintClass hintStyle id
index label labelClass labelDisabledClass
labelPosition labelStyle layout name
onafterdrag onbeforedrag onclick ondrag
ondrop onhide onrefresh onshow
onupdate parent selList showLabel
slice title tuple useSVG
useSoftModals valign visible width
window zenPersistentPopup

Methods
%AddChild %AddChildAfter %AddChildBefore %AddComponent
%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 Decrypt DrawArrows
DrawArrowsOld DrawAvailableList DrawSelectBoxes DrawSelectList
DrawUpArrowsOld Encrypt EscapeHTML EscapeURL
EvalResult HyperEventCall HyperEventHead Include
InsertHiddenField InsertHiddenFields IsPrivate JavaInstalled
Link ListTables MatchSchema OnHTTPHeader
OnPage OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent Page PopulateSchemas
QuoteJS RewriteURL SaveData ShowError
StartTimer StopTimer ThrowError UnescapeHTML
UnescapeURL XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType addChild addChildAfter addChildBefore
adjustSize btnApply btnOK cancelPopup
changeSchema checkAll checkboxModified childrenMutated
clearList correctIELayering createComponent createComponentNS
ctrlKeyDown deleteComponent dialogApply dialogCancel
dialogFinish dialogTitleGet disableButtons doModified
doSelectBoxMove doSelectBoxMoveAll doSelectBoxMoveItem doSelectBoxMoveList
dragFinishHandler dragHandler dragNotifyHandler dragStartHandler
dropHandler dropStartHandler endModal exposeComponent
findElement fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent
firePopupAction getChildIndex getComponent getComponentById
getDialogValue getEnclosingDiv getHidden getHintElement
getLabelElement getOpener getProperty getSelList
getSettings getType gotoPage invokeSuper
isOfType isSomethingChecked launchPopupWindow makeId
onCreate onDelete onDisplayHandler onEndModalHandler
onPopupAction onRefreshContents onSelectBoxMove onSerialize
onServerMethodCall onServerMethodError onServerMethodReturn onStartModalHandler
ondialogCancel ondialogFinish ondialogStart ondisabledHandler
onhandleAutoLogoutWarn onkeydownHandler onkeyupHandler onlayoutHandler
onloadHandler onlogoutHandler onoverlayHandler onresizeHandler
onunloadHandler onupdateHandler popupActionHandler refreshContents
removeChild render renderContents renderSVG
resetMsg setComponentId setHidden setOverlayMode
setProperty setPropertyAll setTraceOption showMsg
startModal startProgressBar stopProgressBar toggleChecks
toggleSave validateRequired


Parameters

• parameter APPLICATION = "%CSP.UI.Portal.Application";
Class name of application this page belongs to.
• parameter APPLYBUTTON = 1;
If true, then this dialog displays an Apply button.
• parameter AUTONS = 1;
If true, auto-switch namespace to whatever $NAMESPACE is passed in.
• parameter CSPURL = "/csp/sys/sec/%CSP.UI.Portal.Dialog.SchemaPriv.zen";
This parameter is used to make sure that if multiple CSP applications are mapped to the same namespace that the CSP engine can correctly identify which class corresponds with which URL. If 'LockCSPName' is true (the default, defined in the CSP application) then you can only access this page if the url exactly matches this 'CSPURL'. You can set this parameter to "" if you wish to disable this check for this class. This check is applied for all CSP urls (cls/csp/zen).
If this page was compiled from a .csp file, then this parameter is automatically set to contain the url of this file used for compilation.
• parameter DOMAIN = "%Utility";
Domain used for localization.
• parameter PAGENAME = "Schema Privileges";
Displayed name of this page.
• parameter RESOURCE = "%Admin_Secure:USE";
This is a comma-delimited list of system Resources and associated permissions. A user must hold the specified permissions on at least one of the specified resources in order to view this page or invoke any of its server-side methods from the client.
The format of each item in the list should be as follows:
Resource[:Permission]
Permission is optional, and defaults to USE if not supplied. If it is supplied, it should be one of USE, READ or WRITE.

Properties

• property IncludeSystem as %Integer(ZENURL="IncludeSystem") [ InitialExpression = 0 ];
Flag indicating whether user checked the "Include System Items" checkbox.
• property IsMLConfiguration as %Boolean;
• property IsNotMLConfiguration as %Boolean;
• property IsNotProcedure as %Boolean;
• property IsNotRelation as %Boolean;
• property IsProcedure as %Boolean;
• property IsRelation as %Boolean;
• property Namespace as %String(ZENURL="$NAMESPACE");
Namespace indicating where the schemas/tables/views are coming from.
• property ObjName as %String(ZENURL="ObjName");
ObjName = null for Add, or Table name or View name for Edit
• property ObjPriv as %String(ZENURL="ObjPriv");
ObjName = null for Add, or Table name or View name for Edit
• property ObjectType as %String(ZENURL="Type");
"TABLE" or "VIEW".
• property PID as %String(ZENURL="PID");
User or Role whose privileges are being granted
• property PrivCount as %Integer;
• property Schema as %String;
• property Tables as %String;
• property TotalTables as %Integer [ InitialExpression = 0 ];
Total number of existing columns for edit

Methods

• method %OnAfterCreatePage() as %Status
Set Locator bar and determine whether to show change password option.
• 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.
• method DrawSelectBoxes(seed As %String) as %Status
• classmethod ListTables(PID As %String, objtype As %String, schema As %String, Output tSC As %Status) as %Integer
tables based on object type and schema name
• classmethod MatchSchema(PID As %String, Schema As %String, Output Defined As %String) as %Status
• method PopulateSchemas() as %Status
• classmethod SaveData(pProxy As %ZEN.proxyObject) as %ZEN.proxyObject [ ZenMethod ]
Save column priv data to server If this is to revoke column priv, then pRevoke = 1, pPrivs and pGrant will be null.
• method changeSchema(newVal) [ Language = javascript ]
User changed or selected a schema. Load Table list based on the schema selected.
• method checkAll(ID) [ Language = javascript ]
Check if Priv or Grant are all checked. check chkPriv/chkGrant if all its checkboxes are checked; uncheck if at least one is unchecked.
• method checkboxModified(id, g) [ Language = javascript ]
User changed a checkbox.
• method disableButtons(flag) [ Language = javascript ]
Disable or enable the apply,cancel, and ok buttons for this dialog. Overriding %ZEN.Dialog.standardDialog (called by dialogFinish() and dialogCancel())
• method doModified() [ 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 isSomethingChecked() [ Language = javascript ]
• method onSelectBoxMove(flag, isPage) [ Language = javascript ]
• method ondialogFinish(action) as %Boolean [ Language = javascript ]
This callback, if defined, is called when the user presses the OK or Apply action buttons. If this returns false, then the action is cancelled.
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method toggleChecks(g, newVal) [ Language = javascript ]
User clicked the Privilege/Grant Admin checkbox.
• method toggleSave(enable) [ Language = javascript ]


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