Home > Class Reference > ENSLIB namespace > %CSP.UI.Portal.SourceControl
Private  Storage   


class %CSP.UI.Portal.SourceControl extends %CSP.UI.Template.List

System Management Portal - System Administration - Configuration - Source Control


Parameters Properties Methods Queries Indices ForeignKeys Triggers
5 5 16


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

%condition %import %includeFiles %page
%resource BeginDate ClassURL CurrentColumn
CurrentSort DocPage EndDate FILETYPE
Filter FirstFailed GlobalURL HelpAddress
ISREADONLY InvalidParam IsEMSReadOnly IsEditForm
LocatorHeader MaxRows NSSelected NamespaceList
OnclickArray PID ParentURL RoutineURL
ShowGen ShowMap ShowSys StdTitle
TableMaxRows TablePageSize TitleMsg TotalNamespaces
ValidationErrorMsg aboutPage align aux
backgroundTimerInterval captionLastUpdate 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

%AddChild %AddChildAfter %AddChildBefore %AddComponent
%AddImportedComponents %AddLocatorLinks %AddToSaveSet %ApplyURLParms
%Attr %BindExport %ChangeNS %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
%GetNavTableState %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 BuildMeter
CheckAllBlanks CheckContextLinks CheckEnterpriseManager ConvertParameter
Decrypt DoLogout DrawAutoRefresh DrawLocator
DrawMenu DrawRibbon DrawSCContent DrawTableHeader
DrawTitle Encrypt EscapeHTML EscapeURL
EvalResult FindDBDir FindDBName GetCSPURL
GetContextLinks GetDBList GetDocURL GetExpandState
GetHomePage GetNSList GetNewURL GetQuickLinks
GetRecentList HyperEventCall HyperEventHead Include
InsertHiddenField InsertHiddenFields IsPrivate LastUpdateTime
Link OnDrawRibbon OnGetRibbonInfo OnHTTPHeader
OnPage OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent Page PrepareAction
QuoteJS RegisterRecent RewriteURL SaveData
SaveExpandState SaveSelections ShowError StartTimer
StopTimer ThrowError UnescapeHTML UnescapeURL
UpdateAutoRefreshRate UpdateAutoRefreshState UpdateTableNavState UpdateTableState
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
addChild addChildAfter addChildBefore adjustSizes
afterSave afterValidate cancelPopup changePassword
checkURLNamespace childrenMutated columnSort correctIELayering
createComponent createComponentNS deleteComponent disableCommandButton
doCancel doDoc doFilter doModified
doNamespace doSave doSearch dragFinishHandler
dragHandler dragNotifyHandler dragStartHandler dropHandler
dropStartHandler enableCommandButton endModal exposeComponent
findElement findNSMatch fireOnResizeEvent fireOnUnloadEvent
fireOnUpdateEvent firePopupAction getChildIndex getComponent
getComponentById getEnclosingDiv getHidden getHintElement
getLabelElement getOpener getPageTitle getProperty
getSelectedNamespace getSettings getTime getTitleAreaHeight
getType goHome goMenu gotoNamespace
gotoPage hideCommandButton invokeSuper isButtonDisabled
isOfType launchPopupWindow logout makeId
navMaxRowsChanged navPageSizeChanged navigate onCreate
onDelete onDisplayHandler onEndModalHandler onPopupAction
onRefreshContents onSerialize onServerMethodCall onServerMethodError
onServerMethodReturn onStartModalHandler ondisabledHandler onkeydownHandler
onkeyupHandler onlayoutHandler onloadHandler onlogoutHandler
onoverlayHandler onresizeHandler onunloadHandler onupdateHandler
popupActionHandler refreshContents refreshHandler refreshkeyUp
removeChild render renderContents renderSVG
resetMsg scChanged searchBlur searchBoxHandler
searchFocus searchKeyDown searchKeyPress setComponentId
setConnectivityStatusMsg setHidden setModified setOverlayMode
setPageTitle setProperty setPropertyAll setRefreshMode
setRefreshRate setSortMode setSortModeHandler setTraceOption
setViewMode setViewModeHandler showAbout showCommandButton
showContact showDocumentation showExpand showHelp
showMsg startModal startProgressBar stopProgressBar
switchNamespace toggleDetails toggleSearch trimSpace
updateSCContent updateTime updateView validateRequired


• parameter AUTONS = 1;
Allow to change namespaces for this page.
• parameter CSPURL = "/csp/sys/mgr/%CSP.UI.Portal.SourceControl.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 HELPADDRESS = "Home,Configuration,Source Control Settings";
Each SMP page should set this link which points to the documentation anchor name.
• parameter PAGENAME = "Source Control Settings";
Displayed name of this page.
• parameter RESOURCE = "%Admin_Manage";
Security requirement


• property FILETYPE as %String [ InitialExpression = "SourceControl" ];
• 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 NSSelected as %String;
• property TitleMsg as %String [ InitialExpression = $$$Text("The source control for namespace %1 is defined below.") ];
• property TotalNamespaces as %Integer;


• method %OnAfterCreatePage() as %Status
Subclass to override. Always include code in this method.
• method %OnGetPageName() as %String
Get the (localized) name of the page. This should be implemented in a subclass.
• method DrawMenu(pSeed) as %Status
Draw Namespaces list in the search pane. If pSeed is not null, then show only those that match it.
• method DrawSCContent(pNamespace) as %Status
Draw html content for source control for current or selected namespace.
• method DrawTableHeader(pSeed As %String) as %Status
Draw the contents of the Table Header (the region between the diagram and the table).
• method OnDrawRibbon() as %Status
This is called in the middle of rendering the tool ribbon. Subclasses can inject their own content into the ribbon by writing it out in this method. This content is best wrapped within a single td element. It can also consist of multiple td elements.

To achieve a fixed position for elements within the ribbon, for a fixed width page you can use a single enclosing td that contains a table and a single tr, with td elements inside that single tr that contain your content for the ribbon.

To achieve a fixed position for elements within the ribbon, for a page whose width varies depending on its contents (thereby stretching the ribbon) you can use multiple td elements to contain your content and then a final td element that is empty and has width 40% (or so) to push your contents towards the left and keep them in their proper locations.

• classmethod SaveData(namespace, value) as %ZEN.proxyObject [ ZenMethod ]
• method adjustSizes() [ Language = javascript ]
Adjust sizes of components on the page.
• method doFilter() [ Language = javascript ]
User wants to filter namespaces list.
• method doNamespace(menuIndex, namespace) [ Language = javascript ]
User clicked on a new namespace. Check if user has unsaved changes. If yes, then prompt to save.
• method doSave() [ Language = javascript ]
Get user input and send to server to save settings.
• method getPageTitle() as %String [ Language = javascript ]
Get the title string to add to the locator row.
• method onlayoutHandler(load) [ Language = javascript ]
This client event, if present, is fired when the page is first loaded or whenever it is resized.
If this is called at load time, then load will be true.
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method scChanged(scValue) [ Language = javascript ]
• method updateSCContent(namespace) [ Language = javascript ]
Given the newly seleted namespace, update the source control content