Class EnsPortal.Dialog.Import

class EnsPortal.Dialog.Import extends EnsPortal.Dialog.standardDialog

Import dialog.

This class is used internally by InterSystems IRIS and not intended for application development. There is no guarantee about the behavior or future operation of this class.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
5	8	28

Summary

This is a Zen Page class. It belongs to the application EnsPortal.Application.

Properties
%condition	%import	%includeFiles	%page
%resource	FirstFailed	InvalidParam	IsEMSReadOnly
Type	ValidationErrorMsg	align	aux
backgroundTimerInterval	canEdit	cellAlign	cellSize
cellStyle	cellVAlign	children	closeOnEnter
closeOnEsc	composite	containerStyle	cssLevel
dialogTitle	disabled	disabledStyle	documentSuffix
dragAndDrop	dragEnabled	dropEnabled	enclosingClass
enclosingStyle	error	fileSelectedCount	groupClass
groupStyle	hasButtons	height	hidden
hideApplyButton	hideCancelButton	hideOKButton	hint
hintClass	hintStyle	id	index
keepAliveInterval	label	labelClass	labelDisabledClass
labelPosition	labelStyle	layout	localFileName
localFileTemp	locationType	matchingDocs	msgNotPermitted
name	onafterdrag	onbeforedrag	onclick
ondrag	ondrop	onhide	onrefresh
onshow	onupdate	parent	remoteFileName
showLabel	slice	studioMode	title
tuple	useSVG	useSoftModals	valign
visible	width	window	zenPersistentPopup

Methods
%AddCSPShareHyperevents	%AddChild	%AddChildAfter	%AddChildBefore
%AddComponent	%AddEnsExceptionHandler	%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	DrawFileContents	Encrypt	EscapeHTML
EscapeURL	EvalResult	GetDefaultRemoteFile	GetHyperEventResources
GetLink	HyperEventCall	HyperEventHead	Include
InsertHiddenField	InsertHiddenFields	IsPrivate	JavaInstalled
Link	OnHTTPHeader	OnPage	OnPageError
OnPostHTTP	OnPostHyperEvent	OnPreHTTP	OnPreHyperEvent
Page	QuoteJS	RewriteURL	SaveListOfDocsToSession
SaveLocalInfoToSession	SetDefaultRemoteFile	ShowError	SimpleKeepAlive
StartTimer	StopTimer	ThrowError	UnescapeHTML
UnescapeURL	ValidateFile	XMLDTD	XMLExport
XMLExportToStream	XMLExportToString	XMLNew	XMLSchema
XMLSchemaNamespace	XMLSchemaType	addChild	addChildAfter
addChildBefore	addPopupSuffix	adjustSize	adjustSizes
browseSelect	btnApply	btnImport	btnOK
btnOpen	cancelPopup	checkEdit	childrenMutated
clearGroups	clientKeepAlive	correctIELayering	createComponent
createComponentNS	ctrlKeyDown	deleteComponent	dialogApply
dialogCancel	dialogFinish	dialogTitleGet	disableButtons
doLocationChange	dragFinishHandler	dragHandler	dragNotifyHandler
dragStartHandler	dropHandler	dropStartHandler	endModal
exposeComponent	findElement	fireOnResizeEvent	fireOnUnloadEvent
fireOnUpdateEvent	firePopupAction	getChildIndex	getComponent
getComponentById	getDialogValue	getEnclosingDiv	getHidden
getHintElement	getLabelElement	getOpener	getProperty
getSettings	getType	gotoPage	inResizeLoop
initPopupSuffix	invokeSuper	isOfType	launchPopupWindow
makeId	onCreate	onDelete	onDisplayHandler
onEndModalHandler	onPopupAction	onRefreshContents	onSerialize
onServerMethodCall	onServerMethodError	onServerMethodReturn	onStartModalHandler
ondialogCancel	ondialogFinish	ondialogStart	ondisabledHandler
onhandleAutoLogoutWarn	onkeydownHandler	onkeyupHandler	onlayoutHandler
onloadHandler	onlogoutHandler	onoverlayHandler	onresizeHandler
onunloadHandler	onupdateHandler	popupActionHandler	refreshContents
removeChild	removePopupSuffix	render	renderContents
renderSVG	resetLocalFile	resetMsg	selectCharset
selectLocalFile	selectRemoteFile	setComponentId	setHidden
setOverlayMode	setProperty	setPropertyAll	setTraceOption
showMsg	startKeepAlive	startModal	startProgressBar
stopKeepAlive	stopProgressBar	toggleCheckboxes	toggleOneCheckbox
updateContentsMsg	validateRequired

Parameters

• parameter APPLYBUTTON = 0;

If true, then this dialog displays an Apply button.

• parameter CANCELBUTTON = 0;

If true, then this dialog displays a Cancel button.

• parameter JSINCLUDES = "zenCSLM.js";

Comma-separated list of additional JS include files for the page.

• parameter RESOURCE = "$Case($G(%request.Data(""TYPE"",1)),""Lookup"":""%Ens_LookupTables:WRITE"",""HL7"":""?"",:""%All"")_"",%Ens_ViewFileSystem:USE""";

Security resources required.

• parameter TYPE = "$G(%request.Data(""TYPE"",1))";

Properties

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

Currently we support the following types: "Lookup", "HL7".

• property documentSuffix as %String [ InitialExpression = $Case($G(%request.Data("TYPE",1)),"Lookup":"LUT","HL7":"HL7",:"?") ];

Document suffixes that can be imported.

• property fileSelectedCount as %Integer [ InitialExpression = -99 ];

• property localFileName as %String(ZENURL="LOCALFILENAME");

• property localFileTemp as %String(ZENURL="TEMPFILE");

If locationType="LOCAL", this is the temporary file name that was saved on the remote server upon submit and upload.

• property locationType as %String(ZENURL="LOCATIONTYPE") [ InitialExpression = "REMOTE" ];

Default machine for file browsing is server (or remote). If server is running on another machine we also allow import files that are local to the client machine.

• property matchingDocs as %Integer [ InitialExpression = 0 ];

• property remoteFileName as %String;

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.

• method %OnGetTitle() as %String

Get the (localized) title string for the dialog.

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

• method DrawFileContents(pSeed) as %Status

• classmethod GetDefaultRemoteFile() as %String [ ZenMethod ]

• method GetLink() as %String [ ZenMethod ]

• classmethod SaveListOfDocsToSession(Docs As %ListOfDataTypes) [ ZenMethod ]

• classmethod SaveLocalInfoToSession(LocalFileName As %String, CharSet As %String, Type As %String) [ ZenMethod ]

• classmethod SetDefaultRemoteFile(pFile As %String) [ ZenMethod ]

• classmethod ValidateFile(File As %String) as %Integer [ ZenMethod ]

• method adjustSizes() [ Language = javascript ]

• method browseSelect(name) [ Language = javascript ]

User clicked the Browse button.

• method btnImport() [ Language = javascript ]

Do the actual import of the selected documents from the file.

• method btnOpen() [ Language = javascript ]

Open file on the remote server.

• method clearGroups() [ Language = javascript ]

Remove file contents and import results from screen; show "Open" button for corresponding location type, hide other "Open" button.

• method doLocationChange(location) [ Language = javascript ]

User changed to pick file between remote and local.

• method getDialogValue() [ Language = javascript ]

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

• 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 onloadHandler() [ Language = javascript ]

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

• method onresizeHandler() [ Language = javascript ]

Adjust sizes of components on the page.

• method resetLocalFile() [ Language = javascript ]

Reset local file control appearance

• method selectCharset() [ Language = javascript ]

• method selectLocalFile() [ Language = javascript ]

• method selectRemoteFile() [ Language = javascript ]

• method toggleCheckboxes(cbState) [ Language = javascript ]

• method toggleOneCheckbox(cbState) [ Language = javascript ]

• method updateContentsMsg(count) [ Language = javascript ]

Class Reference IRIS for UNIX 2024.1.2
Documentation Search