This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > %CSP.UI.Portal.Dialog.Import


class %CSP.UI.Portal.Dialog.Import extends %CSP.UI.Portal.Dialog.WizardTemplate

This class is used internally by Caché. You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class.

Import dialog for Management Portal

Please do not modify any part of this dialog without COMPLETELY testing all cases!!!
This dialog is used by Classes/Routines/Globals for Namespaces and Classes/Routines for Databases.
Please be extremely careful!!!

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter APPLICATION = %CSP.UI.Portal.Application;
Class name of application this page belongs to.
parameter APPLYBUTTON = 0;
If true, then this dialog displays an Apply button.
parameter AUTONS = 1;
Inherited description: If $NAMESPACE is set, auto switch namespace
parameter CSPURL = /csp/sys/exp/%CSP.UI.Portal.Dialog.Import.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 CheckMaxSize = 10000000;
If greater than this size and user is importing Sequential file (%GO) then show content will not be available.
parameter PAGENAME = Import;
Displayed name of this page.
parameter RESOURCE = %Development:USE;
Inherited description: This is a comma-delimited list of system Resources and associated permissions. A user must hold the specified permissions on at least one of the specified resources in order to view this page or invoke any of its server-side methods from the client.
The format of each item in the list should be as follows:
Permission is optional, and defaults to USE if not supplied. If it is supplied, it should be one of USE, READ or WRITE.

Properties (Including Private)

property CHARSET as %String;
Property methods: CHARSETDisplayToLogical(), CHARSETGet(), CHARSETIsValid(), CHARSETLogicalToDisplay(), CHARSETLogicalToOdbc(), CHARSETNormalize(), CHARSETSet()
property FILEFLAG as %ZEN.Datatype.string;
Property methods: FILEFLAGDisplayToLogical(), FILEFLAGGet(), FILEFLAGIsValid(), FILEFLAGLogicalToDisplay(), FILEFLAGLogicalToOdbc(), FILEFLAGNormalize(), FILEFLAGSet()
property FILETYPE as %ZEN.Datatype.string (ZENURL = "FILETYPE");
Type from where we get the selected items from: Class or Routine.
Property methods: FILETYPEDisplayToLogical(), FILETYPEGet(), FILETYPEIsValid(), FILETYPELogicalToDisplay(), FILETYPELogicalToOdbc(), FILETYPENormalize(), FILETYPESet()
property IMPORTALL as %Boolean [ InitialExpression = "0" ];
If this is 1 then file content will not be shown and entire file will be imported in the background.
Property methods: IMPORTALLDisplayToLogical(), IMPORTALLGet(), IMPORTALLIsValid(), IMPORTALLLogicalToDisplay(), IMPORTALLLogicalToXSD(), IMPORTALLNormalize(), IMPORTALLSet(), IMPORTALLXSDToLogical()
property INPUTTYPE as %ZEN.Datatype.string (ZENURL = "INPUTTYPE");
Property methods: INPUTTYPEDisplayToLogical(), INPUTTYPEGet(), INPUTTYPEIsValid(), INPUTTYPELogicalToDisplay(), INPUTTYPELogicalToOdbc(), INPUTTYPENormalize(), INPUTTYPESet()
property LOCALFILENAME as %ZEN.Datatype.string;
This is the temporary file name we saved on remote server, only saved when Input Type is LOCAL.
property NAMESPACE as %ZEN.Datatype.string (ZENURL = "$NAMESPACE");
Property methods: NAMESPACEDisplayToLogical(), NAMESPACEGet(), NAMESPACEIsValid(), NAMESPACELogicalToDisplay(), NAMESPACELogicalToOdbc(), NAMESPACENormalize(), NAMESPACESet()

Methods (Including Private)

method %OnAfterCreatePage() as %Status
This callback is called after the server-side page object and all of its children are created.
Subclasses can override this to add, remove, or modify items within the page object model, or to provide values for controls.
method %OnGetSubtitle() as %String
Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.
method %OnGetTitle() as %String
Get the (localized) title string for the dialog. This should be implemented in a subclass.
classmethod %OnSubmit(pSubmit As %ZEN.Submit) as %Status
This method is invoked only when user selects to import from Local Machine.
The necessary parameters are passed in URL. The temp file name is saved in %session and to be used in loading content.
classmethod DrawContent(pSeed) as %Status
Draw content of the import file for user to select from. For Global, check size and type. Do not show file content for Sequential file larger than 10MB.
classmethod DrawPageTitle(pSeed As %String) as %Status
classmethod GetStatus(tab, FILETYPE) as %ZEN.proxyObject [ ZenMethod ]
tab = 2: Content - when DrawContent is finished, Status is "Done".
classmethod PrepareAction(filetype, selectedRows) as %String [ ZenMethod ]
classmethod SaveSelection(FILETYPE, ImportType, FileName) [ ZenMethod ]
FILTTYPE=Class/Routine/Global, ImportType=FILE/DIR
classmethod ValidateFile(FILETYPE, ImportType, FILE) as %Integer [ ZenMethod ]
Validate file name. If ImportType is DIR then check if directory exists.
clientmethod browseSelect(name) [ Language = javascript ]
User clicked the Browse button.
clientmethod canFinish() [ Language = javascript ]
Return true if this template can Finish (i.e., enable the Finish button).
clientmethod canGoBack() [ Language = javascript ]
Return true if this template can go to the previous page (i.e., enable the Back button).
This is implemented by subclasses.
clientmethod canGoNext() [ Language = javascript ]
Return true if this template can go to the next page (i.e., enable the Next button).
clientmethod changedImportType(thisObj) [ Language = javascript ]
clientmethod doImport() [ Language = javascript ]
Start the Import
clientmethod doLocationChange(flag) [ Language = javascript ]
User changed to pick file between Remote and Local
clientmethod drawDone(tab) [ Language = javascript ]
This method is fired up after onDrawContent is finished. Hide progress message and display error if exists.
clientmethod getDialogValue() [ Language = javascript ]
Inherited description: Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.
clientmethod getSelected() [ Language = javascript ]
clientmethod hasMultiplePages() [ Language = javascript ]
Inherited description: Return true if this template has more than one "page". This will display Back and Next buttons. This is implemented by subclasses.
clientmethod nextPage() [ Language = javascript ]
Go to the next page of the template (if there is one).
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
Returning from file select OR qualifers dialog and setting the value into the appropriate field. The id of the field that needs to be updated is saved in "dialogClicked".
clientmethod ondialogFinish(action) as %Boolean [ Language = javascript ]
This callback, if defined, is called when the user presses the OK or Apply action buttons. If this returns false, then the action is cancelled.
clientmethod onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
clientmethod onresizeHandler() [ Language = javascript ]
This client event, if present, is fired when the page is resized.
clientmethod onstartHandler() [ Language = javascript ]
This is called when the template is first displayed; This provides a chance to load the last filetype, etc.
clientmethod previousPage() [ Language = javascript ]
Go to the previous page of the template (if there is one).
This is implemented by subclasses.
clientmethod selectLocalFile() [ Language = javascript ]
clientmethod toggleCheckboxes(cbState) [ Language = javascript ]
clientmethod updateState() [ Language = javascript ]
Update the state of the template buttons. Subclasses should call this method when they need to update the state of the footer buttons.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)