Class %CSP.UI.Portal.Dialog.Import

class %CSP.UI.Portal.Dialog.Import 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 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!!!

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
7	7	31

Summary

This is a Zen Page class. It belongs to the application %CSP.UI.Portal.Application.

Properties
%condition	%import	%includeFiles	%page
%resource	CHARSET	FILEFLAG	FILETYPE
FirstFailed	IMPORTALL	INPUTTYPE	InvalidParam
IsEMSReadOnly	LOCALFILENAME	NAMESPACE	ValidationErrorMsg
align	aux	backgroundTimerInterval	cellAlign
cellSize	cellStyle	cellVAlign	children
composite	containerStyle	cssLevel	dialogTitle
disabled	disabledStyle	dragAndDrop	dragEnabled
dropEnabled	enclosingClass	enclosingStyle	error
groupClass	groupStyle	height	helpId
hidden	hideApplyButton	hideCancelButton	hint
hintClass	hintStyle	id	index
label	labelClass	labelDisabledClass	labelPosition
labelStyle	layout	name	onafterdrag
onbeforedrag	onclick	ondrag	ondrop
onhide	onrefresh	onshow	onupdate
parent	showLabel	slice	title
tuple	useSVG	useSoftModals	valign
visible	width	window	zenPersistentPopup

Methods
%AddChild	%AddChildAfter	%AddChildBefore	%AddComponent
%AddImportedComponents	%AddToSaveSet	%ApplyURLParms	%Attr
%BindExport	%ClassIsLatestVersion	%ClassName	%ConstructClone
%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty	%DispatchMethod
%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty	%DrawAutoLogout
%DrawClassDefinitions	%DrawComponentHTML	%DrawHTML	%DrawHTMLPage
%DrawJSStrings	%DrawObjectDefinitions	%DrawTitle	%EnclosingDivId
%EndBackgroundMethod	%EndScript	%Eval	%EvalC
%Extends	%ForceClientRender	%GetChildIndex	%GetComponent
%GetComponentById	%GetComponentByName	%GetEventHandlers	%GetLinks
%GetPageName	%GetParameter	%GetValueById	%GetValueByName
%GetXMLName	%IsA	%IsModified	%Link
%LinkCSS	%LinkScript	%MakeId	%New
%NormalizeObject	%ObjectModified	%OnAddToPageAfter	%OnAddToPageBefore
%OnAfterCreatePage	%OnBeforeCreatePage	%OnCreateApplication	%OnCreatePage
%OnDetermineCSSLevel	%OnDrawEnclosingDiv	%OnDrawHTMLBody	%OnDrawHTMLHead
%OnDrawHTMLMeta	%OnDrawObjectProperties	%OnFinishBackgroundTask	%OnGetSubtitle
%OnGetTitle	%OnMonitorBackgroundTask	%OnMutateChildren	%OnObjectSynch
%OnPreHTTP	%OnSubmit	%OnUseSoftModals	%OnZENDeserialize
%OriginalNamespace	%PackageName	%QuoteValue	%QuoteValueL10N
%RemoveChild	%RemoveChildren	%RemoveComponent	%RemoveFromSaveSet
%RunBackgroundMethod	%Self	%SerializeObject	%SetBackgroundMethodStatus
%SetErrorById	%SetErrorByName	%SetModified	%SetValueById
%SetValueByName	%SetValuesByName	%StartScript	%ValidateObject
%ZENVersion	ConvertParameter	Decrypt	DrawContent
DrawPageTitle	Encrypt	EscapeHTML	EscapeURL
EvalResult	GetStatus	HyperEventCall	HyperEventHead
Include	InsertHiddenField	InsertHiddenFields	IsEnabled
IsPrivate	JavaInstalled	Link	OnHTTPHeader
OnPage	OnPageError	OnPostHTTP	OnPostHyperEvent
OnPreHTTP	OnPreHyperEvent	Page	PrepareAction
QuoteJS	RewriteURL	SaveSelection	ShowError
StartTimer	StopTimer	ThrowError	UnescapeHTML
UnescapeURL	ValidateFile	XMLDTD	XMLExport
XMLExportToStream	XMLExportToString	XMLNew	XMLSchema
XMLSchemaNamespace	XMLSchemaType	addChild	addChildAfter
addChildBefore	adjustSize	browseSelect	btnApply
btnOK	canFinish	canGoBack	canGoNext
cancelPopup	changedImportType	childrenMutated	correctIELayering
createComponent	createComponentNS	ctrlKeyDown	deleteComponent
dialogApply	dialogCancel	dialogFinish	dialogTitleGet
disableButtons	doImport	doLocationChange	dragFinishHandler
dragHandler	dragNotifyHandler	dragStartHandler	drawDone
dropHandler	dropStartHandler	endModal	exposeComponent
findElement	fireOnResizeEvent	fireOnUnloadEvent	fireOnUpdateEvent
firePopupAction	formValidationHandler	getChildIndex	getComponent
getComponentById	getDialogValue	getEnclosingDiv	getHidden
getHintElement	getLabelElement	getOpener	getProperty
getSelected	getSettings	getType	gotoPage
hasMultiplePages	invokeSuper	isOfType	launchPopupWindow
makeId	nextPage	onCreate	onDelete
onDisplayHandler	onEndModalHandler	onPopupAction	onRefreshContents
onSerialize	onServerMethodCall	onServerMethodError	onServerMethodReturn
onStartModalHandler	ondialogCancel	ondialogFinish	ondialogStart
ondisabledHandler	onfinishHandler	onhandleAutoLogoutWarn	onkeydownHandler
onkeyupHandler	onlayoutHandler	onloadHandler	onlogoutHandler
onoverlayHandler	onresizeHandler	onstartHandler	onunloadHandler
onupdateHandler	popupActionHandler	previousPage	refreshContents
removeChild	render	renderContents	renderSVG
resetMsg	selectLocalFile	setComponentId	setHidden
setOverlayMode	setProperty	setPropertyAll	setTraceOption
showDocumentation	showHelp	showMsg	startModal
startProgressBar	stopProgressBar	toggleCheckboxes	updateState
validateRequired

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;

If $NAMESPACE is set, auto switch namespace

• parameter CSPURL = "/csp/sys/exp/%CSP.UI.Portal.Dialog.Import.zen";

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 then show content will not be available.

• parameter PAGENAME = "Import";

Displayed name of this page.

• parameter RESOURCE = "%Development:USE";

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 CHARSET as %String;

• property FILEFLAG as %ZEN.Datatype.string;

• property FILETYPE as %ZEN.Datatype.string(ZENURL="FILETYPE");

Type from where we get the selected items from: Class or Routine.

• 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 INPUTTYPE as %ZEN.Datatype.string(ZENURL="INPUTTYPE");

• 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");

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 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.

• method browseSelect(name) [ Language = javascript ]

User clicked the Browse button.

• method canFinish() [ Language = javascript ]

Return true if this template can Finish (i.e., enable the Finish button).

• method 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.

• method canGoNext() [ Language = javascript ]

Return true if this template can go to the next page (i.e., enable the Next button).

• method changedImportType(thisObj) [ Language = javascript ]

• method doImport() [ Language = javascript ]

Start the Import

• method doLocationChange(flag) [ Language = javascript ]

User changed to pick file between Remote and Local

• method drawDone(tab) [ Language = javascript ]

This method is fired up after onDrawContent is finished. Hide progress message and display error if exists.

• method getDialogValue() [ Language = javascript ]

Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.

• method getSelected() [ Language = javascript ]

• method hasMultiplePages() [ Language = javascript ]

Return true if this template has more than one "page". This will display Back and Next buttons. This is implemented by subclasses.

• method nextPage() [ Language = javascript ]

Go to the next page of the template (if there is one).

• method 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".

• method 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.

• method onloadHandler() [ Language = javascript ]

This client event, if present, is fired when the page is loaded.

• method onresizeHandler() [ Language = javascript ]

This client event, if present, is fired when the page is resized.

• method onstartHandler() [ Language = javascript ]

This is called when the template is first displayed; This provides a chance to load the last filetype, etc.

• method previousPage() [ Language = javascript ]

Go to the previous page of the template (if there is one).
This is implemented by subclasses.

• method selectLocalFile() [ Language = javascript ]

• method toggleCheckboxes(cbState) [ Language = javascript ]

• method 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.

Class Reference IRIS for UNIX 2024.1.2
Documentation Search