Class %CSP.UI.Portal.LDAP

class %CSP.UI.Portal.LDAP extends %CSP.UI.Portal.Template

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
8	4	24

Summary

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

Properties
%condition	%import	%includeFiles	%page
%resource	FirstFailed	HelpAddress	ISREADONLY
InvalidParam	IsEMSReadOnly	IsEditForm	IsTest
LDAPUserString1	LDAPUserString2	LocatorHeader	OnclickArray
PID	ParentURL	StdTitle	ValidationErrorMsg
aboutPage	align	aux	backgroundTimerInterval
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	label
labelClass	labelDisabledClass	labelPosition	labelStyle
layout	lblTitle	limitPopups	name
onafterdrag	onbeforedrag	onclick	ondrag
ondrop	onhide	onrefresh	onshow
onupdate	pageModified	parent	searchKey
showLabel	slice	title	tuple
useSVG	useSoftModals	valign	visible
width	window	zenPersistentPopup

Methods
%AddChild	%AddChildAfter	%AddChildBefore	%AddComponent
%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	%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	CopyLDAPConfig	Decrypt	DoLogout
DrawLocator	DrawRibbon	DrawTitle	Encrypt
EscapeHTML	EscapeURL	EvalResult	GetCSPURL
GetContextLinks	GetDocURL	GetHomePage	GetNewURL
GetQuickLinks	HyperEventCall	HyperEventHead	Include
InsertHiddenField	InsertHiddenFields	IsPrivate	IsWindows
JavaInstalled	Link	OnDrawRibbon	OnGetRibbonInfo
OnHTTPHeader	OnPage	OnPageError	OnPostHTTP
OnPostHyperEvent	OnPreHTTP	OnPreHyperEvent	Page
PopulateFields	QuoteJS	RegisterRecent	RewriteURL
SaveData	ShowError	StartTimer	StopTimer
ThrowError	UnescapeHTML	UnescapeURL	XMLDTD
XMLExport	XMLExportToStream	XMLExportToString	XMLNew
XMLSchema	XMLSchemaNamespace	XMLSchemaType	addChild
addChildAfter	addChildBefore	afterSave	afterValidate
cancelPopup	changePassword	changedGroup	changedGroupSetting
childrenMutated	clearClosureTest	correctIELayering	createComponent
createComponentNS	deleteComponent	disableCommandButton	doBaseDN
doBaseDN1	doBrowse	doCancel	doCopyLDAPConfig
doModified	doSave	dochangedGroup1	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	invokeSuper
isButtonDisabled	isOfType	launchPopupWindow	logout
makeId	navigate	onCreate	onDelete
onDisplayHandler	onEndModalHandler	onPopupAction	onRefreshContents
onSerialize	onServerMethodCall	onServerMethodError	onServerMethodReturn
onStartModalHandler	ondisabledHandler	onhandleAutoLogoutWarn	onkeydownHandler
onkeyupHandler	onlayoutHandler	onloadHandler	onlogoutHandler
onoverlayHandler	onresizeHandler	onunloadHandler	onupdateHandler
popupActionHandler	refreshContents	removeChild	render
renderContents	renderSVG	resetMsg	searchBlur
searchBoxHandler	searchFocus	searchKeyDown	searchKeyPress
setComponentId	setConnectivityStatusMsg	setHidden	setModified
setOverlayMode	setPageTitle	setProperty	setPropertyAll
setSortMode	setSortModeHandler	setTraceOption	setViewMode
setViewModeHandler	showAbout	showCommandButton	showContact
showDocumentation	showDomain	showHelp	showLDAP
showMsg	startModal	startProgressBar	stopProgressBar
switchNamespace	toggle	togglePW	trimSpace
validate	validateRequired

Parameters

• parameter AUTONS = 0;

Do not switch namespace for this page: it needs to stay in %SYS

• parameter CSPURL = "/csp/sys/sec/%CSP.UI.Portal.LDAP.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 EMSSERVICE = "Users";

• parameter HELPADDRESS = "Home,Security Management,Security LDAP configurations,Edit LDAP configuration";

Each SMP page should set this link which points to the documentation anchor name.

• parameter PAGENAME = "Edit LDAP configuration";

Displayed name of this page.

• parameter PARENTPAGE = "/csp/sys/sec/%CSP.UI.Portal.LDAPs.zen";

This parameter defines the parent page for this page.
If the name ends in .csp, then the parent is assumed to be an autopage-enabled CSP page.
If the name ends in .cls, then the parent is assumed to be a Zen page.
This is used to automate the construction of the locator bar for this page and to build the index between portal pages and documentation.
The %GetLocatorInfo method is used to get this information.

• parameter RECENT = 0;

If true, register visits to this page in the recent list.

• parameter RESOURCE = "%Admin_Secure";

Security requirement

Properties

• property IsEditForm as %Boolean [ InitialExpression = 1 ];

If set to 1 then the generic Save and Cancel button will be shown on the ribbon bar.

• property IsTest as %Boolean [ InitialExpression = 0 ];

• property LDAPUserString1 as %String [ InitialExpression = $$$TextHTML("LDAP username to use for searches") ];

• property LDAPUserString2 as %String [ InitialExpression = $$$TextHTML("LDAP search username DN") ];

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

Be sure to do ##super() when overriding.

• method %OnGetPageName() as %String

Get the (localized) name of the page. This should be implemented in a subclass.

• method CopyLDAPConfig(LDAPConfigName As %String) as %Status [ ZenMethod ]

• classmethod IsWindows() as %ZEN.proxyObject [ ZenMethod ]

• method PopulateFields(ByRef Properties As %String) as %Status

• classmethod SaveData(pProxy As %ZEN.proxyObject) as %ZEN.proxyObject [ ZenMethod ]

Call server save method.

• method changedGroup() [ Language = javascript ]

Update group examples.

• method changedGroupSetting(newValue) [ Language = javascript ]

• method clearClosureTest() [ Language = javascript ]

• method doBaseDN() [ Language = javascript ]

get BaseDN based on name.

• classmethod doBaseDN1(pProxy As %ZEN.proxyObject) as %ZEN.proxyObject [ ZenMethod ]

get BaseDN based on name..

• method doBrowse(fieldID) [ Language = javascript ]

Launching a file selector window.

• method doCopyLDAPConfig(newLDAPConfig) [ Language = javascript ]

• method doSave() [ Language = javascript ]

Save current item.

• classmethod dochangedGroup1(pProxy As %ZEN.proxyObject) as %ZEN.proxyObject [ ZenMethod ]

get BaseDN based on name..

• method getPageTitle() as %String [ Language = javascript ]

Get the title string to add to the locator row.

• method onPopupAction(popupName, action, value) [ Language = javascript ]

Returning from file select OR qualifers dialog and setting the value into the appropriate field. The id of the field that needs to be updated is saved in "dialogClicked".

• method onloadHandler() [ Language = javascript ]

Disable save button for EMS-managed pages. Be sure to use this.invokeSuper('onloadHandler',arguments); when overriding.

• method showDomain(newvalue) [ Language = javascript ]

• method showLDAP(newvalue) [ Language = javascript ]

• method toggle(groupID) [ Language = javascript ]

• method togglePW(PWOptions) [ Language = javascript ]

User changed PWOptions option. If they want to enter new password, show password fields. Otherwise hide them.

• method validate() as %Boolean [ Language = javascript ]

Class Reference IRIS for UNIX 2024.1.2
Documentation Search