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 > ENSLIB namespace > EnsPortal.CSVRecordWizard


class EnsPortal.CSVRecordWizard extends EnsPortal.Template.standardPage

Wizard to create a RecordMap definition based on a sample file which contains delimited data, possibly with a header row.

Property Inventory

Method Inventory


parameter EDITRESOURCE = %Ens_Code:WRITE,%Ens_RecordMap:WRITE;
User needs WRITE permissions on either the %Ens_Code or the %Ens_RecordMap resource to make changes on this page.
parameter PAGENAME = CSV Record Wizard;
Inherited description: Displayed name of this page.
parameter RESOURCE = %Ens_Code:READ,%Ens_RecordMap:READ;
User needs READ permissions on either the %Ens_Code or the %Ens_RecordMap resource to view this page.


property canViewFileSystem as %Boolean [ InitialExpression = $system.Security.Check("%Ens_ViewFileSystem","USE") ];
Is the user permitted to access the fileSelect popup.
Property methods: canViewFileSystemDisplayToLogical(), canViewFileSystemGet(), canViewFileSystemIsValid(), canViewFileSystemLogicalToDisplay(), canViewFileSystemLogicalToXSD(), canViewFileSystemNormalize(), canViewFileSystemSet(), canViewFileSystemXSDToLogical()
property msgClassExists as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Class '%1' already exists. Overwrite?") ];
Property methods: msgClassExistsDisplayToLogical(), msgClassExistsGet(), msgClassExistsIsValid(), msgClassExistsLogicalToDisplay(), msgClassExistsLogicalToOdbc(), msgClassExistsNormalize(), msgClassExistsSet()
property msgErrCreating as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Error creating RecordMap:") ];
Property methods: msgErrCreatingDisplayToLogical(), msgErrCreatingGet(), msgErrCreatingIsValid(), msgErrCreatingLogicalToDisplay(), msgErrCreatingLogicalToOdbc(), msgErrCreatingNormalize(), msgErrCreatingSet()
property msgReqRecTerm as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Record Terminator is required") ];
Property methods: msgReqRecTermDisplayToLogical(), msgReqRecTermGet(), msgReqRecTermIsValid(), msgReqRecTermLogicalToDisplay(), msgReqRecTermLogicalToOdbc(), msgReqRecTermNormalize(), msgReqRecTermSet()
property msgReqRecordMap as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("RecordMap name is required") ];
Property methods: msgReqRecordMapDisplayToLogical(), msgReqRecordMapGet(), msgReqRecordMapIsValid(), msgReqRecordMapLogicalToDisplay(), msgReqRecordMapLogicalToOdbc(), msgReqRecordMapNormalize(), msgReqRecordMapSet()
property msgReqSample as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Sample file is required") ];
Property methods: msgReqSampleDisplayToLogical(), msgReqSampleGet(), msgReqSampleIsValid(), msgReqSampleLogicalToDisplay(), msgReqSampleLogicalToOdbc(), msgReqSampleNormalize(), msgReqSampleSet()
property msgReqSeparator as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Separator is required") ];
Property methods: msgReqSeparatorDisplayToLogical(), msgReqSeparatorGet(), msgReqSeparatorIsValid(), msgReqSeparatorLogicalToDisplay(), msgReqSeparatorLogicalToOdbc(), msgReqSeparatorNormalize(), msgReqSeparatorSet()
property sampleFile as %ZEN.Datatype.string (ZENURL = "SAMPLEFILE");
Property methods: sampleFileDisplayToLogical(), sampleFileGet(), sampleFileIsValid(), sampleFileLogicalToDisplay(), sampleFileLogicalToOdbc(), sampleFileNormalize(), sampleFileSet()


method %OnGetPageName() as %String
Get the (localized) name of the page.
method %OnGetTitle() as %String
Get the (localized) title string for the page.
classmethod ClassExists(classname As %String) as %Boolean [ ZenMethod ]
classmethod GetDefaultDir() as %String [ ZenMethod ]
classmethod GetHyperEventResources(pMethod As %String = "") as %String
Callback to return a list of resources required for a specific HyperEvent. The user must have sufficient privileges on one of the resource/permission pairs to be permitted to execute the hyperevent. An empty string implies the user already has sufficient privileges for the ZenMethod specified in pMethod.
method OnGetRibbonInfo(Output pDisplay As %Boolean, Output pViewIcons As %List, Output pSortOptions As %List, Output pSearchBox As %Boolean, Output pRibbonTitle As %String, Output pCommands As %List) as %Status
Get information to display in the ribbon bar.
classmethod SaveSampleFilename(recordMap="", filename) as %String [ ZenMethod ]
classmethod SetDefaultDir(pPathname As %String) [ ZenMethod ]
clientmethod createRecordMap() [ Language = javascript ]
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
Inherited description: Returning from dialogs
clientmethod onRecTermChange(newValue, isRadio) [ Language = javascript ]
clientmethod selectFile() [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods