Skip to main content


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

Page to define SQL Table/View column privileges.

Property Inventory

Method Inventory


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;
Inherited description: If true, auto-switch namespace to whatever $NAMESPACE is passed in.
parameter CSPURL = /csp/sys/sec/%CSP.UI.Portal.Dialog.ColumnPriv.zen;
Inherited description: 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 = Column Privileges;
Displayed name of this page.
parameter RESOURCE = %Admin_Secure:USE;
Inherited description: 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:
Permission is optional, and defaults to USE if not supplied. If it is supplied, it should be one of USE, READ or WRITE.


property Column as %String;
Table column name if user is editing or revoking
Property methods: ColumnDisplayToLogical(), ColumnGet(), ColumnIsValid(), ColumnLogicalToDisplay(), ColumnLogicalToOdbc(), ColumnNormalize(), ColumnSet()
property IncludeSystem as %Integer (ZENURL = "IncludeSystem") [ InitialExpression = 0 ];
Flag indicating whether user checked the "Include System Items" checkbox.
Property methods: IncludeSystemDisplayToLogical(), IncludeSystemGet(), IncludeSystemIsValid(), IncludeSystemLogicalToDisplay(), IncludeSystemNormalize(), IncludeSystemSet(), IncludeSystemXSDToLogical()
property Namespace as %String (ZENURL = "$NAMESPACE");
Namespace indicating where the schemas/tables/views are coming from.
Property methods: NamespaceDisplayToLogical(), NamespaceGet(), NamespaceIsValid(), NamespaceLogicalToDisplay(), NamespaceLogicalToOdbc(), NamespaceNormalize(), NamespaceSet()
property ObjName as %String (ZENURL = "ObjName");
ObjName = null for Add, or Table name or View name for Edit
Property methods: ObjNameDisplayToLogical(), ObjNameGet(), ObjNameIsValid(), ObjNameLogicalToDisplay(), ObjNameLogicalToOdbc(), ObjNameNormalize(), ObjNameSet()
property ObjectType as %String (ZENURL = "Type");
"TABLE" or "VIEW".
Property methods: ObjectTypeDisplayToLogical(), ObjectTypeGet(), ObjectTypeIsValid(), ObjectTypeLogicalToDisplay(), ObjectTypeLogicalToOdbc(), ObjectTypeNormalize(), ObjectTypeSet()
property PID as %String (ZENURL = "PID");
User or Role whose privileges are being granted
Property methods: PIDDisplayToLogical(), PIDGet(), PIDIsValid(), PIDLogicalToDisplay(), PIDLogicalToOdbc(), PIDNormalize(), PIDSet()
property Schema as %String;
User selected schema name
Property methods: SchemaDisplayToLogical(), SchemaGet(), SchemaIsValid(), SchemaLogicalToDisplay(), SchemaLogicalToOdbc(), SchemaNormalize(), SchemaSet()
property Table as %String;
User selected table name
Property methods: TableDisplayToLogical(), TableGet(), TableIsValid(), TableLogicalToDisplay(), TableLogicalToOdbc(), TableNormalize(), TableSet()
property TotalColumns as %Integer [ InitialExpression = 0 ];
Total number of existing columns for edit
Property methods: TotalColumnsDisplayToLogical(), TotalColumnsGet(), TotalColumnsIsValid(), TotalColumnsLogicalToDisplay(), TotalColumnsNormalize(), TotalColumnsSet(), TotalColumnsXSDToLogical()


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.
classmethod ColumnEdit(pSchema, pTable, pColumn) as %ZEN.proxyObject [ ZenMethod ]
When editing existing column priv, this method loads existing column priv into check boxes
method DrawSelectBoxes(seed As %String) as %Status
method DrawTable(seed As %String) as %Status
Draws table for existing table column priv allowing user to edit or revoke.
classmethod GetColumns(PID As %String, Schema As %String, Table As %String, IncludeSystem As %Integer, Output Columns As %String) as %Status
Return existing columns
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.
classmethod UpdateDetails(Schema As %String, Table As %String, PID As %String, IncludeSystem As %Integer) as %ZEN.proxyObject [ ZenMethod ]
Load fields into Available/Selected list boxes.
clientmethod changeSchema(newVal) [ Language = javascript ]
User changed or selected a schema. Load Table list based on the schema selected.
clientmethod changeTable(newVal) [ Language = javascript ]
User selected a table. Load Available/Selected list boxes.
clientmethod 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.
clientmethod checkboxModified(id, g) [ Language = javascript ]
User changed a checkbox.
clientmethod 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())
clientmethod doAddColumn(newVal) [ Language = javascript ]
User clicked "Add Columns" to add more columns to existing schema.table
clientmethod doEditColumn(column) [ Language = javascript ]
User clicked "Edit" to edit existing column priv
clientmethod doModified() [ Language = javascript ]
clientmethod doRevokeColumn(column) [ Language = javascript ]
User clicked "Revoke" to revoke existing column priv
clientmethod getDialogValue() [ Language = javascript ]
Inherited description: Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.
clientmethod isSomethingChecked() [ Language = javascript ]
clientmethod onSelectBoxMove(flag, isPage) [ Language = javascript ]
clientmethod 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.
clientmethod onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
clientmethod toggleChecks(g, newVal) [ Language = javascript ]
User clicked the Privilege/Grant Admin checkbox.
clientmethod toggleSave(enable) [ Language = javascript ]
clientmethod uncheckAllBoxes() [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab