CxAEReporter

The CxAEReporter API is a COM-enabled automation interface used to create, edit and run CygNet reports and is encapsulated in CxAEReporter.dll.

See CxAEReporter XML Examples.

CxAEReporter Methods

The CxAEReporter object contains the following methods:

BrowseServerFiles CreateReport DeleteFile DownloadFileToTempDir GetFileList GetFileNameFromFilePath

GetPathType GetReportPath GetReportTempPath OpenFile OpenReport OpenStandardDirDialog

OpenStandardFileDialog ReadFileToString SaveStandardFileDialog ViewReport WriteStringToFile

BrowseServerFiles

Opens a dialog box to browse Group service-based files.

Syntax

BrowseServerFiles(strSiteService As String, strRootNodeFilter As String) As String

Parameters

Parameter	Required	Description
strSiteService	Yes	The Group service to view files from. Can be blank.
strRootNodeFilter	Yes	The filter for the root node to base browsing off. Can be blank.

Remarks

Returns the selected Group node path.

CreateReport

Creates the report as defined in strReportConfig.

Syntax

CreateReport(strReportConfig As String, strModuleConfig As String, bProcessOutput as Boolean)

Parameters

Parameter	Required	Description
strReportConfig	Yes	Options: A file path to report definition file (.rdf), or an XML string defining a report.
strModuleConfig	Yes	Options: File path to module config file, or XML string defining the report module configuration, or HSS name for the service that contains the module config point.
bProcessOutput	Yes	Set to true if report should be delivered as defined in the report config, and false if running the report strictly for local viewing.

Remarks

None.

DeleteFile

Deletes a specified file.

Syntax

DeleteFile(strFilePath As String) As Boolean

Parameters

Parameter	Required	Description
strFilePath	Yes	The path to the file to be deleted.

Remarks

Returns true if the file was deleted; returns false otherwise.

DownloadFileToTempDir

Downloads a report to the temporary directory.

Syntax

DownloadFileToTempDir(strFilePath As String) As String

Parameters

Parameter	Required	Description
strFilePath	Yes	The path to the report definition to be downloaded to the temporary directory.

Remarks

If successful, returns the path for the saved report file.

GetFileList

Returns list of files in a given path.

Syntax

GetFileList(strFilePath As String) As Array

Parameters

Parameter	Required	Description
strFilePath	Yes	The path to the directory to get the list of files from.

Remarks

None.

GetFileNameFromFilePath

Returns the file name portion of a supplied file path.

Syntax

GetFileNameFromFilePath(strFilePath As String) As String

Parameters

Parameter	Required	Description
strFilePath	Yes	The path to extract the file name from.

Remarks

None.

GetPathType

Returns whether a given file path is a BSS path ("BSS"), GRP path ("GRP"), or local file system path ("FileSys").

Syntax

GetPathType(strPath As String) As String

Parameters

Parameter	Required	Description
strPath	Yes	The file path to have its type determined.

Remarks

None.

GetReportPath

Prompts users for the path to a report file.

Syntax

GetReportPath() As String

Parameters

None.

Remarks

Returns the selected report path.

GetReportTempPath

Gets the temporary directory used by the reporting module.

Syntax

GetReportTempPath() As String

Parameters

None.

Remarks

None.

OpenFile

Opens a specified file with the associated application.

Syntax

OpenFile(strFilePath As String) As Boolean

Parameters

Parameter	Required	Description
strFilePath	Yes	The path to the file to be opened with the default program.

Remarks

If successful, returns true; returns false otherwise.

OpenReport

Prompts the user for a report to be opened.

Syntax

OpenReport() As String

Parameters

None.

Remarks

Returns the opened report path.

OpenStandardDirDialog

Opens the standard Open Folder… dialog box.

Syntax

OpenStandardDirDialog() As String

Parameters

None.

Remarks

Returns the selected path.

OpenStandardFileDialog

Opens the standard Open File… dialog box.

Syntax

OpenStandardFileDialog(strFilter As String) As String

Parameters

Parameter	Required	Description
strFilter	Yes	The filter for the Open File… dialog box to use.

Remarks

Returns the selected path.

Example

strPath = OpenStandardFileDialog("XML|*.xml|All Files|*.*")

ReadFileToString

Returns text contents of a file read from the local file system, GRP, or BSS.

Syntax

ReadFileToString(strFilePath As String) As String

Parameters

Parameter	Required	Description
strFilePath	Yes	The path to the file to be read.

Remarks

None.

SaveStandardFileDialog

Opens the standard Save File… dialog box.

Syntax

SaveStandardFileDialog() As String

Parameters

None.

Remarks

Returns the path for the file to be saved.

ViewReport

Opens a given report file with the associated application for its file type.

Syntax

ViewReport(strReportPath As String) As String

Parameters

Parameter	Required	Description
strReportPath	Yes	The path to the report file to be opened with the default program.

Remarks

Returns the opened report path.

WriteStringToFile

Writes text to a file in a local file system, GRP, or BSS.

Syntax

WriteStringToFile(strFilePath As String, strContents As String) As Boolean

Parameters

Parameter	Required	Description
strFilePath	Yes	The path to the file to be written to.
strContents	Yes	The text to be written to the given file.

Remarks

Returns true if the file is successfully written to; returns false otherwise.

---

More:

CxAEReporter XML Examples