This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?

%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

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

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 %String [ ZenMethod ]
Start background job to map one of the following: 1) user has specific file selections (isFinish=1); or 2) user clicked "Map All" to map all files in a particular (search) table (isFinish=0 and filename is not null).
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.
classmethod RemoveCart(pid) as %String [ ZenMethod ]
Remove a selection from cart.
classmethod SaveToCart(pid, pSelected) [ ZenMethod ]
If pSelected is null, then map all fields. pSelected is a string with fields delimited by "^" with the first piece to be the NAME of the file.
classmethod SelectAll(filename As %String) as %String [ ZenMethod ]
Select all files based on partial filename match.
classmethod UpdateDetails(pid) as %Boolean [ ZenMethod ]
Load fields into Available/Selected list boxes.
clientmethod arrowClick(from, to) [ Language = javascript ]
Moving a list item from one box to the next, then remove it from the original box
clientmethod arrowClickAll(from, to) [ Language = javascript ]
Moving the entire list from one box to the next, then remove it from the original box
clientmethod arrowClicked(id) [ Language = javascript ]
clientmethod arrowMoved(thisObj) [ Language = javascript ]
User double clicked one of the listboxes. Update imply message.
clientmethod displayResult(ok) [ Language = javascript ]
After running action, display error message or refresh page.
clientmethod doAddCart() [ Language = javascript ]
Add selected FileNumber to cart. Check to see if User unselected any to not to map. If yes, then save the selected fields.
clientmethod doCancel() [ Language = javascript ]
User clicked Cancel. Check if user has selected any files. If yes, prompt user whether they want to keep the selection.
clientmethod doDelete() [ Language = javascript ]
Delete one selection from tree. If no selections left then go back to previous page.
clientmethod doDeleteAll() [ Language = javascript ]
User clicked "Clear Cart". Clear all items in the cart and return to previous page.
clientmethod doFinish(isFinish) [ Language = javascript ]
User clicked "Finish". Map selected items in the cart - call server method to job off in the background.
clientmethod doMapAll() [ Language = javascript ]
User clicked "Map All". Map All that are shown in the current table.
clientmethod doNext(page) [ Language = javascript ]
User clicked "Next" or "Back". page number pass in is the target page number.
clientmethod doSearch() [ Language = javascript ]
User clicked "Search". Get user file name (partial is okay) and refresh table.
clientmethod doSelAll() [ Language = javascript ]
User clicked "Select All". Add all that are shown in the current table to the cart.
clientmethod doSelect(id) [ Language = javascript ]
User clicked "Select". Show Fields for the selected File Number.
clientmethod doView(option) [ Language = javascript ]
clientmethod expandNode(node) [ Language = javascript ]
Show or hide tree.
clientmethod onkeydownHandler(evt) [ Language = javascript ]
Examine if user hit the Return key. If yes, start the search. This method handles all keydown events on the window. Works for both IE and NS.
clientmethod showResult(text) [ Language = javascript ]
Update action result. If text is passed in, show it. Otherwise set it to nothing.
clientmethod toggleDelete(flag) [ Language = javascript ]
show or hide image and link Delete for presentation context
clientmethod toggleMapAll(flag) [ Language = javascript ]
disable or enable buttons for MapAll and SelectAll
clientmethod treeCount() [ Language = javascript ]
check total Abstract Syntax tree count for presentation context. this method is triggled from onupdate from the tree control.
clientmethod treeLoad() [ Language = javascript ]
load tree

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Feedback