PrxMetaReportExport

Syntax

PrxExportData PrxMetaReportExport(string mon, PrxExportDataPattern tArg)

Parameters

mon. Moniker of opened regular report instance.

tArg. Regular report export options.

Description

The PrxMetaReportExport operation exports regular report to external file.

Comments

To execute the operation, in the mon field specify regular report instance moniker, and in the tArg field specify export options.

The moniker can be obtained on executing the OpenPrxMeta operation.

The operation results in the information about obtained file.

Example

Below is the example for regular report export to Microsoft Excel (XLSX) file. The request contains moniker of opened regular report instance and export options. The output file is saved on BI server. The response contains moniker to access the obtained file.

SOAP request:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<PrxMetaReportExport xmlns="http://www.fsight.ru/PP.SOM.Som">
  <mon xmlns="">S1!M!S!P1</mon>
<tArg xmlns="">
  <storeResult>true</storeResult>
  <format>xlsx</format>
  <palette>true</palette>
  <autoHeight>true</autoHeight>
  <objectAsBitmap>false</objectAsBitmap>
  <cellImages>true</cellImages>
  <fixEmfLines>true</fixEmfLines>
  <showWarnings>false</showWarnings>
  <reportTitle>true</reportTitle>
  <sheetTitles>true</sheetTitles>
  <chartsAsImages>false</chartsAsImages>
  <emptyPages>false</emptyPages>
  <breakIntoLayouts>true</breakIntoLayouts>
  <headlines>true</headlines>
  <sheetAccess>false</sheetAccess>
  <flashsAsImages>false</flashsAsImages>
  <hiddenSheets>false</hiddenSheets>
  <formulas>true</formulas>
  </tArg>
  </PrxMetaReportExport>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<PrxMetaReportExportResult xmlns="http://www.fsight.ru/PP.SOM.Som" xmlns:q1="http://www.fsight.ru/PP.SOM.Som" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <format xmlns="">xlsx</format>
<storeId xmlns="">
  <id>S1!M!S!P1!Bin!0</id>
  </storeId>
  </PrxMetaReportExportResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
"PrxMetaReportExport" :
{
"mon" : "S1!M!S!P1",
"tArg" :
{
"storeResult" : "true",
"format" : "xlsx",
"palette" : "true",
"autoHeight" : "true",
"objectAsBitmap" : "false",
"cellImages" : "true",
"fixEmfLines" : "true",
"showWarnings" : "false",
"reportTitle" : "true",
"sheetTitles" : "true",
"chartsAsImages" : "false",
"emptyPages" : "false",
"breakIntoLayouts" : "true",
"headlines" : "true",
"sheetAccess" : "false",
"flashsAsImages" : "false",
"hiddenSheets" : "false",
"formulas" : "true"
}
}
}

JSON response:

{
"PrxMetaReportExportResult" :
{
"format" : "xlsx",
"storeId" :
{
"id" : "S1!M!S!P1!Bin!0"
}
}
}
public static PrxExportData ExportPrxReport(string moniker)
{
var somClient = new SomPortTypeClient(); //Proxy object for operation execution
//Operation execution parameters
var tExp = new PrxMetaReportExport()
{
tArg = new PrxExportDataPattern()
{
format = "xlsx",
reportTitle = true,
sheetTitles = true,
storeResult = true
},
mon = moniker
};
//Export report
var result = somClient.PrxMetaReportExport(tExp);
return result;
}

See also:

Working with Regular Reports