Home > Class Reference > ENSLIB namespace > %CSP.UI.Portal.FileMan

%CSP.UI.Portal.FileMan

class %CSP.UI.Portal.FileMan extends %CSP.UI.Portal.FileManTemplate, %CSP.UI.Portal.UtilsNav

Zen page for System Management Portal - FileMan wizard

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter AUTONS = 1;
Switch namespace for this page
parameter CSPURL = /csp/sys/exp/%CSP.UI.Portal.FileMan.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,SQL,FileMan Wizard;
Inherited description: Each SMP page should set this link which points to the documentation anchor name.
parameter PAGENAME = FileMan Wizard;
Displayed name of this page.
parameter PARENTPAGE = /csp/sys/exp/%CSP.UI.Portal.SQL.Home.zen;
Cancel return to this parent page
parameter RESOURCE = %Development;
Security requirement

Properties (Including Private)

property DefaultLogFile as %ZEN.Datatype.string;
Property methods: DefaultLogFileDisplayToLogical(), DefaultLogFileGet(), DefaultLogFileIsValid(), DefaultLogFileLogicalToDisplay(), DefaultLogFileLogicalToOdbc(), DefaultLogFileNormalize(), DefaultLogFileSet()
property LogsPage as %ZEN.Datatype.string [ InitialExpression = ..Link("/csp/sys/exp/UtilFileManLog.csp") ];
Property methods: LogsPageDisplayToLogical(), LogsPageGet(), LogsPageIsValid(), LogsPageLogicalToDisplay(), LogsPageLogicalToOdbc(), LogsPageNormalize(), LogsPageSet()
property TasksPage as %ZEN.Datatype.string [ InitialExpression = ..Link("/csp/sys/%25CSP.UI.Portal.BackgroundTaskList.zen") ];
Property methods: TasksPageDisplayToLogical(), TasksPageGet(), TasksPageIsValid(), TasksPageLogicalToDisplay(), TasksPageLogicalToOdbc(), TasksPageNormalize(), TasksPageSet()
property msgConfirmCancel as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Do you want to keep your file selections in the cart for future use in this session? Click [OK] to keep or [Cancel] to discard selections.") ];
Property methods: msgConfirmCancelDisplayToLogical(), msgConfirmCancelGet(), msgConfirmCancelIsValid(), msgConfirmCancelLogicalToDisplay(), msgConfirmCancelLogicalToOdbc(), msgConfirmCancelNormalize(), msgConfirmCancelSet()
property msgMapAll as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Are you sure you want to map all files shown in the current table to classes?") ];
Property methods: msgMapAllDisplayToLogical(), msgMapAllGet(), msgMapAllIsValid(), msgMapAllLogicalToDisplay(), msgMapAllLogicalToOdbc(), msgMapAllNormalize(), msgMapAllSet()
property msgSelectAll as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("All files shown in table added to cart.") ];
Property methods: msgSelectAllDisplayToLogical(), msgSelectAllGet(), msgSelectAllIsValid(), msgSelectAllLogicalToDisplay(), msgSelectAllLogicalToOdbc(), msgSelectAllNormalize(), msgSelectAllSet()

Methods (Including Private)

Inherited description: Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)
Subclasses with extra layers of locator links or other than "Configuration" please override.
method %OnAfterCreatePage() as %Status
Set Locator bar and determine whether to show change password option.
method %OnGetPageName() as %String
Inherited description: Get the (localized) name of the page. This should be implemented in a subclass.
classmethod ClearCart() as %Boolean [ ZenMethod ]
Clear cart completely.
classmethod CreateClasses(ByRef pParms As %String, ByRef pItems As %String) as %Status
Final call from the background job to create classes.
method DrawResult(seed As %String) as %Status
Actually write out result. When the page is first opened, seed is null. When it's called from Prepare, seed = action^the selected locale.
classmethod GetText(pid) as %String [ ZenMethod ]
classmethod GetTreeInfo(pRoot As %String, Output pTree, ByRef pParms) as %Status
Build tree for cart. If specific numbers are selected show them in sub tree. The first piece of %session.Data("FileMan",t) is NAME of the file
classmethod HasSelection() as %Boolean [ ZenMethod ]
classmethod MapSelected(proxy As %ZEN.proxyObject, isFinish, filename) as