Skip to main content

%DeepSee.Component.deepseeCSVProvider

class %DeepSee.Component.deepseeCSVProvider extends %ZEN.Component.component

This class is responsible for creating a CSV file from the contents of a DeepSee ResultSet

Method Inventory

Parameters

parameter DOMAIN = %DeepSee;
parameter INCLUDEFILES = zenCSLM.js;
Inherited description: CSV list of additional include files (either .js or .css) that should be included when this component is used on a page.
By default, the file extension (.js or .css) is used to determine whether an item in the list is a script include or a style include. You can override this behavior by adding the terms "script:" or "style:" to the beginning of the file name or names. This prefix is not used as part of the include filename.
parameter NAMESPACE = http://www.intersystems.com/deepsee;
This is the XML namespace used for library components.

Methods

method %DrawHTML()
This class does not project HTML into its containing document
classmethod %EmitKpiResult(pParamsObj={{}}, pFileStream) as %Status
Emit the CSV for the content of a KPI
classmethod %EmitNameValueTable(pFileStream, pNames As %DynamicArray = [], pValues As %DynamicArray = [], pTableTitle="", pParamsObj={{}}) as %Status
Write a set of name-value pairs as stored in two arrays to a pFileStream in CSV format.
classmethod ExportCSV(pMDX="", pFileName As %String = "", pParmsJSON As %String = "", Output pStatus As %Status) as %String [ ZenMethod ]
Export the results of an MDX query to pFileName. Parameters can be passed from the client in a serialized JSON string that will be deserialized into a DynamicObject
classmethod GenerateTempName() as %String [ ZenMethod ]
Return a random and unique name in the temp directory with an 'csv' extention for the creation of temp files during processing
classmethod GetKpiFilterCaption(pKPIName, pSpec) as %String [ ZenMethod ]
Lookup a filter caption for a KPI
classmethod GetSystemTempDir() as %String [ ZenMethod ]
Return the temp directory for this system.
classmethod RemoveFile(pFileName) as %Status [ ZenMethod ]
Remove a temporary file used for this provider within this session from the mgr/Temp directory
classmethod ScopeFileName(rawName As %String) as %String [ ZenMethod ]
Given a user specified file name clip it to ensure that it only refers to files in the mgr/temp space
clientmethod downloadCSV(mdx, exportParams) [ Language = javascript ]
Package the entire generation of the download stream into a single convenient call for client consumption.
clientmethod exportMDXToCSV(mdx, params, fileName) [ Language = javascript ]
Client-facing utility method to send an MDX query to the server to be exported as a CSV.
clientmethod prepareTableParms(table) [ Language = javascript ]
Receive a pivotTable component and use its settings to produce a set of expected export parameters consistent with usage in this provider.

Inherited Members

Inherited Properties

Inherited Methods

Feedback