Skip to main content

%CSP.UI.Portal.Archives

class %CSP.UI.Portal.Archives extends %CSP.UI.Portal.Utils

Property Inventory

Method Inventory

Parameters

parameter AUTONS = 0;
Do not switch namespace for this page: it needs to stay in %SYS
parameter CSPURL = /csp/sys/mgr/%CSP.UI.Portal.Archives.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 EMSSERVICE = Namespace;
parameter HELPADDRESS = System Administration, Configuration, System Configuration, Archive Targets;
Inherited description: Each SMP page should set this link which points to the documentation anchor name.
parameter PAGENAME = Archive Targets;
Displayed name of this page.
parameter RESOURCE = %Admin_Manage;
Security requirement

Properties

property colDelete as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Delete") ];
Store translated targetCol linkCaption for
Property methods: colDeleteDisplayToLogical(), colDeleteGet(), colDeleteIsValid(), colDeleteLogicalToDisplay(), colDeleteLogicalToOdbc(), colDeleteNormalize(), colDeleteSet()

Methods

method %OnAfterCreatePage() as %Status
Subclass can override.
method %OnGetPageName() as %String
Get the (localized) name of the page. This should be implemented in a subclass.
classmethod DeleteData(Name As %String) as %String [ ZenMethod ]
Call server delete method.
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.

method OnGetRibbonInfo(Output pDisplay As %Boolean, Output pViewIcons As %List, Output pSortOptions As %List, Output pSearchBox As %Boolean, Output pRibbonTitle As %String, Output pCommands As %List) as %Status
Get information to display in the ribbon bar.
clientmethod deleteItem(archiveName, tableID) [ Language = javascript ]
Delete existing item.
clientmethod doEdit(archiveName) [ Language = javascript ]
clientmethod doNew() [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab