Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

%CSP.UI.Portal.SourceControl

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

System Management Portal - System Administration - Configuration - Source Control

Property Inventory

Method Inventory

Parameters

parameter AUTONS = 1;
Allow to change namespaces for this page.
parameter CSPURL = /csp/sys/mgr/%CSP.UI.Portal.SourceControl.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 HELPADDRESS = Home,Configuration,Source Control Settings;
Inherited description: 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

Properties

property FILETYPE as %String [ InitialExpression = "SourceControl" ];
Property methods: FILETYPEDisplayToLogical(), FILETYPEGet(), FILETYPEIsValid(), FILETYPELogicalToDisplay(), FILETYPELogicalToOdbc(), FILETYPENormalize(), FILETYPESet()
property IsEditForm as %Boolean [ InitialExpression = 1 ];
Inherited description: If set to 1 then the generic Save and Cancel button will be shown on the ribbon bar.
Property methods: IsEditFormDisplayToLogical(), IsEditFormGet(), IsEditFormIsValid(), IsEditFormLogicalToDisplay(), IsEditFormLogicalToXSD(), IsEditFormNormalize(), IsEditFormSet(), IsEditFormXSDToLogical()
property NSSelected as %String;
Property methods: NSSelectedDisplayToLogical(), NSSelectedGet(), NSSelectedIsValid(), NSSelectedLogicalToDisplay(), NSSelectedLogicalToOdbc(), NSSelectedNormalize(), NSSelectedSet()
property TitleMsg as %String [ InitialExpression = $$$Text("The source control for namespace %1 is defined below.") ];
Property methods: TitleMsgDisplayToLogical(), TitleMsgGet(), TitleMsgIsValid(), TitleMsgLogicalToDisplay(), TitleMsgLogicalToOdbc(), TitleMsgNormalize(), TitleMsgSet()
property TotalNamespaces as %Integer;
Property methods: TotalNamespacesDisplayToLogical(), TotalNamespacesGet(), TotalNamespacesIsValid(), TotalNamespacesLogicalToDisplay(), TotalNamespacesNormalize(), TotalNamespacesSet(), TotalNamespacesXSDToLogical()

Methods

method %OnAfterCreatePage() as %Status
Inherited description: Subclass to override. Always include code in this method.
method %OnGetPageName() as %String
Inherited description: 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
Inherited description: 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 ]
clientmethod adjustSizes() [ Language = javascript ]
Inherited description: Adjust sizes of components on the page.
clientmethod doFilter() [ Language = javascript ]
User wants to filter namespaces list.
clientmethod doNamespace(menuIndex, namespace) [ Language = javascript ]
User clicked on a new namespace. Check if user has unsaved changes. If yes, then prompt to save.
clientmethod doSave() [ Language = javascript ]
Get user input and send to server to save settings.
clientmethod onlayoutHandler(load) [ Language = javascript ]
Inherited description: 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.
clientmethod onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
clientmethod scChanged(scValue) [ Language = javascript ]
clientmethod updateSCContent(namespace) [ Language = javascript ]
Given the newly seleted namespace, update the source control content

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab