GetPivotEvaluatorTotalsMetaData

Syntax

PvtTotals GetPivotEvaluatorTotalsMetaData(string mon, PvtTotals tArg)

Parameters

mon. Moniker for working with totals.

tArg. Parameters for getting information about totals.

Description

The GetPivotEvaluatorTotalsMetaData operation gets total calculation options.

Comments

To execute the operation, in the mon field specify moniker of regular report instance with the !DataArea!DataSources!source key!DataSourceSlices!slice key!Pivot!Totals postfix to work with totals, and in the tArg field specify obtained settings.

The moniker can be obtained on executing the OpenPrxMeta operation.

In the tArg field specify empty values or default values for the fields, which values should be obtained. Specify one element for collections. To get information about a specific element, specify its key in metadata. If -1 is specified as a key value, information about all elements of this type is obtained.

Example

Below is the example of getting totals settings. The request contains moniker for working with totals and a list of settings, which values should be obtained. The response contains the obtained settings values.

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">
<GetPivotEvaluatorTotalsMetaData xmlns="http://www.fsight.ru/PP.SOM.Som">
  <mon xmlns="">HAPIEIKAGHBPFOAEGECNPBJBABIFDABEOKMMJKOHAOBCEPLN!M!S!PLMNJPALAGHBPFOAENFAIOMEDPPLOKFNEKKJAEHOAOHCPFIIC!DataArea!DataSources!1!DataSourceSlices!1!Pivot!Totals</mon>
<tArg xmlns="">
  <treatEmptyAsZero>false</treatEmptyAsZero>
  <includeOwner>false</includeOwner>
<columnTypes>
  <t>None</t>
  </columnTypes>
  <enabled>false</enabled>
<columnSettings>
  <namingMode>Source</namingMode>
  <totalsNameSeparator />
  <hierarchyTotal>false</hierarchyTotal>
  <overallTotal>false</overallTotal>
  <insteadOwnerTotalsType>None</insteadOwnerTotalsType>
  </columnSettings>
  </tArg>
  </GetPivotEvaluatorTotalsMetaData>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<GetPivotEvaluatorTotalsMetaDataResult 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">
  <treatEmptyAsZero xmlns="">1</treatEmptyAsZero>
  <includeOwner xmlns="">1</includeOwner>
<columnTypes xmlns="">
  <t>Sum</t>
  </columnTypes>
  <enabled xmlns="">1</enabled>
<columnSettings xmlns="">
  <namingMode>Combined</namingMode>
  <totalsNameSeparator>-</totalsNameSeparator>
  <hierarchyTotal>1</hierarchyTotal>
  <overallTotal>1</overallTotal>
  <insteadOwnerTotalsType>Sum</insteadOwnerTotalsType>
  </columnSettings>
  </GetPivotEvaluatorTotalsMetaDataResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
"GetPivotEvaluatorTotalsMetaData" :
{
"mon" : "HAPIEIKAGHBPFOAEGECNPBJBABIFDABEOKMMJKOHAOBCEPLN!M!S!PLMNJPALAGHBPFOAENFAIOMEDPPLOKFNEKKJAEHOAOHCPFIIC!DataArea!DataSources!1!DataSourceSlices!1!Pivot!Totals",
"tArg" :
{
"treatEmptyAsZero" : "false",
"includeOwner" : "false",
"columnTypes" :
{
"t" : "None"
},
"enabled" : "false",
"columnSettings" :
{
"namingMode" : "Source",
"totalsNameSeparator" : "",
"hierarchyTotal" : "false",
"overallTotal" : "false",
"insteadOwnerTotalsType" : "None"
}
}
}
}

JSON response:

{
"GetPivotEvaluatorTotalsMetaDataResult" :
{
"treatEmptyAsZero" : "1",
"includeOwner" : "1",
"columnTypes" :
{
"t" : "Sum"
},
"enabled" : "1",
"columnSettings" :
{
"namingMode" : "Combined",
"totalsNameSeparator" : "-",
"hierarchyTotal" : "1",
"overallTotal" : "1",
"insteadOwnerTotalsType" : "Sum"
}
}
}
public static PvtTotals GetPivotEvaluatorTotalsMetaData(string moniker, uint dataSourceKey, uint sliceKey)
{
var somClient = new SomPortTypeClient(); // Proxy object for operation execution
// Operation execution parameters
var tGet = new GetPivotEvaluatorTotalsMetaData()
{
tArg = new PvtTotals()
{
enabled = new bool(),
columnTypes = new PvtEvaluatorElementType[1],
columnSettings = new PvtEvaluatorTotalsSettings()
{
hierarchyTotal = new bool(),
insteadOwnerTotalsType = new PvtEvaluatorElementType(),
namingMode = new PvtTotalParentNamingMode(),
overallTotal = new bool(),
totalsNameSeparator = ""
},
includeOwner = new bool(),
treatEmptyAsZero = new bool()
},
mon = moniker + "!DataArea!DataSources!" + dataSourceKey.ToString() + "!DataSourceSlices!" + sliceKey.ToString() + "!Pivot!Totals"
};
// Get totals calculation settings
var result = somClient.GetPivotEvaluatorTotalsMetaData(tGet);
return result;
}

See also:

Working with Regular Reports