Skip to main content

%CSP.UI.Portal.SQL.ImportStatement

class %CSP.UI.Portal.SQL.ImportStatement extends %CSP.UI.Portal.Dialog.WizardTemplate

This class is used internally by InterSystems IRIS. 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 SQL Statement dialog for Management Portal SQL.

Please do not modify any part of this dialog without COMPLETELY testing all cases!!!
This dialog is used by SQL for importing single SQL statement or all statements per namespace.

Property Inventory

Method Inventory

Parameters

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.SQL.ImportStatement.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 PAGENAME = ImportSQLStatement;
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:
Resource[:Permission]
Permission is optional, and defaults to USE if not supplied. If it is supplied, it should be one of USE, READ or WRITE.

Properties

property FILETYPE as %ZEN.Datatype.string [ InitialExpression = "SQLSTATEMENT" ];
Property methods: FILETYPEDisplayToLogical(), FILETYPEGet(), FILETYPEIsValid(), FILETYPELogicalToDisplay(), FILETYPELogicalToOdbc(), FILETYPENormalize(), FILETYPESet()
property INPUTTYPE as %ZEN.Datatype.string (ZENURL = "INPUTTYPE");
Property methods: INPUTTYPEDisplayToLogical(), INPUTTYPEGet(), INPUTTYPEIsValid(), INPUTTYPELogicalToDisplay(), INPUTTYPELogicalToOdbc(), INPUTTYPENormalize(), INPUTTYPESet()
property LOCALFILENAME as %ZEN.Datatype.string (ZENURL = "LOCALFILENAME");
This is the temporary file name we saved on remote server, only saved when Input Type is LOCAL.
Property methods: LOCALFILENAMEDisplayToLogical(), LOCALFILENAMEGet(), LOCALFILENAMEIsValid(), LOCALFILENAMELogicalToDisplay(), LOCALFILENAMELogicalToOdbc(), LOCALFILENAMENormalize(), LOCALFILENAMESet()
property NAMESPACE as %ZEN.Datatype.string (ZENURL = "$NAMESPACE");
Property methods: NAMESPACEDisplayToLogical(), NAMESPACEGet(), NAMESPACEIsValid(), NAMESPACELogicalToDisplay(), NAMESPACELogicalToOdbc(), NAMESPACENormalize(), NAMESPACESet()

Methods

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 DrawPageTitle(pSeed As %String) as %Status
classmethod FileExists(filename) as %Integer [ ZenMethod ]
Check to see if file exists
method GetTempFileName(pDocName) as %String [ ZenMethod ]
classmethod SaveLastFile(pFileName, pFileType) [ ZenMethod ]
clientmethod browseSelect(name, wildcard) [ Language = javascript ]
User clicked the Browse button.
clientmethod completeImport(filename, inputtype) [ Language = javascript ]
this method completes both remote import and local import
clientmethod doImport() [ Language = javascript ]
User clicked the Import.
clientmethod doLocationChange(flag) [ Language = javascript ]
User changed to pick file between Remote and Local
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 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 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 selectLocalFile() [ Language = javascript ]
clientmethod submitHandler() [ Language = javascript ]
check if input type is LOCAL, and handles import from local files if it is.
clientmethod validateFile(filename) [ Language = javascript ]
Check if file is empty.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab