Click or drag to resize

ReportingServicesRunReport Method

Executes and retrieves a formatted report file for a Report that is contained within the specified DataMiner template.

Namespace:  FactoryLogix.xTend.Analytics
Assembly:  FactoryLogix.xTend.API (in FactoryLogix.xTend.API.dll) Version: 8.242.0.0 (8.242.0.0)
Syntax
public FileContent RunReport(
	Guid sessionId,
	Guid templateId,
	Guid reportId,
	ReportFormat format,
	ParameterValue[] parameters,
	int width,
	int height
)

Parameters

sessionId
Type: SystemGuid
The session identifier that was returned by the Connect(String, String, String, String, String) method.
templateId
Type: SystemGuid
The Id of the DataMiner template.
reportId
Type: SystemGuid
The Id of the Report to be executed.
format
Type: FactoryLogix.xTend.DataObjectsReportFormat
An enumerated value indicating the output format for the report.
parameters
Type: FactoryLogix.xTend.DataObjectsParameterValue
A list of ParameterValue objects representing the data filters and parameters to be used by the query.
width
Type: SystemInt32
For raster image type output formats, the pixel width of the output. Ignored for non-raster based output formats.
height
Type: SystemInt32
For raster image type output formats, the pixel height of the output. Ignored for non-raster based output formats.

Return Value

Type: FileContent
A FileContent object containing the formatted report.
Exceptions
ExceptionCondition
InvalidSessionExceptionThrown if the sessionId parameter is invalid.
NotFoundExceptionThe specified DataTemplate and/or Report was not found in the system.
InvalidParameterExceptionOne or more of the specified ParameterValues was not valid.
See Also