SDK ガイド › Portal Integration › Web Services › Methods for Web Services › Report Methods › GetReportDataAndExport

GetReportDataAndExport

Description

This method returns report data XML and exports the report.

Syntax

A typical syntax for this method is shown. Note that the exact syntax to use depends on the type of protocol used to communicate with the web service.

XmlNode
 GetReportDataAndExport (

string
 sessionID, 

int
 favoriteID, string parametersXML, 

string
 exportXML, 

string
 criteriaXML)

Parameter

Return Value

This XML also contains information about exported results (file paths) according to following format:

<RESULT …>
	:
	:
<EXPORT_RESULTS>
<FILE_PATH>sessiondata/673994876/FF_1_Param_6.pdf</FILE_PATH>
</EXPORT_RESULTS>
</RESULT>
parametersXML - should be defined in “brief” format of parameters FreeForm official XML. Values supplied by this XML are merged to FreeForm definition. Any irrelevant section or parameter might be omitted.
<connection>
	<params>
		<param name='@UID'><value>user id</value></param>
		<param name='@PWD' ><value>password</value></param>
	</params>
</connection>
<query>
	<params>
		<param name='@PRM1'><value>value 1</value></param>
		<param name='@PRM2'><value>value 2</value></param>
	</params>
</query>

exportXML

The parameter exportXML should be defined as follows. Note that upper case is mandatory.

<REPORT_EXPORT>
	<EXPORT_TYPE>{PDF(default)|CHART|HTML|MHT|CSV|CSVDO}</EXPORT_TYPE>
		<INCLUDED>
<REPORT>
{CHART(default)| DATA | FILTERS | RAW_DATA |BRC | CORRECTIONS | EXCEPTIONS | PENALTY_ADJ | PENALTY_ERR}
</REPORT>
<REPORT></REPORT>
		</INCLUDED>
</REPORT_EXPORT>

• The EXPORT_TYPE tag should be defined only once.
• The REPORT tag in the INCLUDED section represents the part of the report that will be exported. Multiple report parts can be exported by time.

criteriaXML

The parameter criteriaXML should be defined as follows. Note that tag names are case sensitive.

<Criteria>
<UseCache>{1(default) | 0}</UseCache>
<GenerateIfNoCached>{1(default) | 0}</GenerateIfNoCached>
<Width>400</Width>
<Height>200</Height>
</Criteria>

• A UseCache value of “1” means that previously cached report will be returned, even if current format does not correspond to the previously cached format.
• A GenerateIfNoCached value of “1” means to perform an export routine if the cached export results are not present and UseCache=1 or is omitted.

  Note: Caching generated (exported) report should be performed by API consumer. Files included in EXPORT_RESULTS in returned XML should be copied to the cache directory (registry key Insight\paths\ReportsXMLcache ). Also, the result XML should be stored in the same location as follows: [repID].xml (for example, 1000.xml).

Errors

If any errors occur, the web service will log and throw the InsightWebServiceException error.

Remark

The parameters parametersXML and criteriaXML are optional. A free-form report that contains parameters but parametersXML is empty, results in a report error according to the default FreeForm parameters section.

All parameters are passed as type string, to ensure flexibility in calling the method.

Sample Scenarios

Possible scenarios to generate request report data: