Class EnsPortal.Dialog.ExportFromItem

class EnsPortal.Dialog.ExportFromItem extends EnsPortal.Dialog.standardDialog

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
4	21	27

Summary

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

Properties
%GblRef	%condition	%import	%includeFiles
%page	%resource	BrowserOid	DefaultFilename
Description	Filename	FirstFailed	InvalidParam
IsEMSReadOnly	ItemID	ProjectName	SaveOnServer
TimeUTC	ValidationErrorMsg	align	aux
backgroundTimerInterval	canEdit	canExportViaBrowser	canViewFileSystem
cellAlign	cellSize	cellStyle	cellVAlign
children	closeOnEnter	closeOnEsc	composite
containerStyle	cssLevel	dialogTitle	disabled
disabledStyle	dragAndDrop	dragEnabled	dropEnabled
enclosingClass	enclosingStyle	error	externalFile
externalFileDifferent	externalFileIncludesRemove	groupClass	groupStyle
hasButtons	height	hidden	hideApplyButton
hideCancelButton	hideOKButton	hint	hintClass
hintStyle	hostId	hostName	id
index	keepAliveInterval	label	labelClass
labelDisabledClass	labelPosition	labelStyle	layout
msgExportToFile	msgNotPermitted	msgUnsupportedCharacters	name
onafterdrag	onbeforedrag	onclick	ondrag
ondrop	onhide	onrefresh	onshow
onupdate	parent	productionId	productionSettings
retValue	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	CleanupTemporaryServerStream
ConvertParameter	Decrypt	DownloadStream	Encrypt
EscapeHTML	EscapeURL	EvalResult	Export
FileExists	GetDefaultDir	GetHyperEventResources	GetItemArray
GetPRJItems	HyperEventCall	HyperEventHead	Include
InsertHiddenField	InsertHiddenFields	IsPrivate	JavaInstalled
Link	OnHTTPHeader	OnPage	OnPageError
OnPostHTTP	OnPostHyperEvent	OnPreHTTP	OnPreHyperEvent
Page	QuoteJS	RefreshProject	RewriteURL
SetDefaultDir	SetSourceLabels	ShowError	SimpleKeepAlive
StartTimer	StopTimer	ThrowError	UnescapeHTML
UnescapeURL	XMLDTD	XMLExport	XMLExportToStream
XMLExportToString	XMLNew	XMLSchema	XMLSchemaNamespace
XMLSchemaType	addChild	addChildAfter	addChildBefore
addPopupSuffix	addProductionSettings	adjustSize	btnApply
btnOK	cancelPopup	checkEdit	childrenMutated
clientKeepAlive	convertRULs	correctIELayering	createComponent
createComponentNS	ctrlKeyDown	deleteComponent	dialogApply
dialogCancel	dialogFinish	dialogTitleGet	disableButtons
dragFinishHandler	dragHandler	dragNotifyHandler	dragStartHandler
dropHandler	dropStartHandler	endModal	exportArray
exposeComponent	findElement	fireOnResizeEvent	fireOnUnloadEvent
fireOnUpdateEvent	firePopupAction	getChildIndex	getComponent
getComponentById	getDialogValue	getEnclosingDiv	getHidden
getHintElement	getLabelElement	getOpener	getProperty
getSettings	getType	gotoPage	identifyItem
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	renderGrid	renderSVG	resetMsg
selectAll	selectFilepath	setComponentId	setHidden
setOverlayMode	setProperty	setPropertyAll	setTraceOption
showFinder	showMsg	startKeepAlive	startModal
startProgressBar	stopKeepAlive	stopProgressBar	validateRequired

Parameters

• parameter APPLYBUTTON = 0;

If true, then this dialog displays an Apply button.

• parameter CSSINCLUDES = "ensemble/Ensemble_Wizards.css";

Comma-separated list of additional CSS include files for the page. If this page is using CSS3 then the CSS3INCLUDES parameter is used (if defined).

• parameter PAGENAME = "Export From Item";

Displayed name of this page.

• parameter RESOURCE = "%Ens_DeploymentPkg:USE";

User needs USE privileges on the %Ens_DeploymentPkg resource to view this page.

Properties

• property %GblRef as %String;

reference to temp global location for list storage

• property BrowserOid as %ZEN.Datatype.string;

• property DefaultFilename as %ZEN.Datatype.string;

• property Description as %ZEN.Datatype.string;

• property Filename as %ZEN.Datatype.string;

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

• property ProjectName as %ZEN.Datatype.string;

• property SaveOnServer as %ZEN.Datatype.boolean [ InitialExpression = 1 ];

• property TimeUTC as %ZEN.Datatype.string;

• property canExportViaBrowser as %Boolean [ InitialExpression = $system.Security.Check("%Ens_DeploymentPkgClient","WRITE") ];

Is the user permitted to export the code via browser. WRITE not USE.

• property canViewFileSystem as %Boolean [ InitialExpression = $system.Security.Check("%Ens_ViewFileSystem","USE") ];

Is the user permitted to access the fileSelect popup.

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

Used for name of existing deployment file

• property externalFileDifferent as %ZEN.Datatype.boolean [ InitialExpression = 0 ];

Used to signify if the loaded deployment file not from the same instance, machine, namespace

• property externalFileIncludesRemove as %ZEN.Datatype.boolean [ InitialExpression = 0 ];

Used to signify if the loaded deployment file includes a Remove project text document

• property hostId as %ZEN.Datatype.integer(ZENURL="HOSTID");

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

• property msgExportToFile as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Select filename and Export") ];

• property msgUnsupportedCharacters as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Item name contains one or more of these characters that are not supported for export: less and more than, forward and back slash, ampersand and double quote.") ];

• property productionId as %ZEN.Datatype.className(ZENURL="PRODUCTION");

• property productionSettings as %ZEN.Datatype.boolean(ZENURL="PRODSETTINGS");

Used to signify exporting production settings

• property retValue as %ZEN.Datatype.string;

Holder for return value.

Methods

• method %OnAfterCreatePage() as %Status

This callback is called after the server-side page object and all of its children are created.

• 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 CleanupTemporaryServerStream(pBrowserOid As %String) as %Integer [ ZenMethod ]

Cleanup temporary server side stream

• classmethod DownloadStream(pEncryptedOid As %String = "") as %String [ ZenMethod ]

• method Export(pCommand As %String, pProvider As %ZEN.Auxiliary.jsonProvider, pSubmitObject As %RegisteredObject, Output pResponseObject As %RegisteredObject) as %Status

• classmethod FileExists(filename As %String) as %String [ ZenMethod ]

• classmethod GetDefaultDir() as %String [ ZenMethod ]

• method GetItemArray(ByRef pParameters, Output pMetaData, Output pData) as %Status

• method GetPRJItems(pPRJName) as %String [ ZenMethod ]

• classmethod RefreshProject(value As %String) as %Status [ ZenMethod ]

• classmethod SetDefaultDir(pPathname As %String) [ ZenMethod ]

• method SetSourceLabels(ByRef pSourceInfo)

• method addProductionSettings() [ Language = javascript ]

• method convertRULs()

• method exportArray() [ Language = javascript ]

• method identifyItem(pItemName As %String, pType As %String) as %String [ ZenMethod ]

• method onPopupAction(popupName, action, value) [ Language = javascript ]

This client event, if present, is fired when a popup page launched from this page fires an action.

• method ondialogCancel() [ Language = javascript ]

Cleanup temporary server side stream returns true otherwise the dialog is not cancelled.

• method ondialogFinish(action) as %Boolean [ Language = javascript ]

This callback is called when the user presses the OK button. If this returns false, then the action is canceled.

• method onloadHandler() [ Language = javascript ]

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

• method renderGrid() [ Language = javascript ]

• method selectAll(onoff) [ Language = javascript ]

• method selectFilepath() [ Language = javascript ]

select either server or browser side

• method showFinder(mode) [ Language = javascript ]

Class Reference IRIS for UNIX 2024.1.2
Documentation Search