GetEaxTermDescriptions

Syntax

GetEaxTermDescriptionsResult GetEaxTermDescriptions(string mon, GetEaxTermDescriptionsArg tArg)

Parameters

mon. Moniker of opened regular report instance.

tArg. Operation execution parameters.

Description

The GetEaxTermDescriptions operation gets information about terms used in a formula for calculation of table cell value.

Comments

The operation is relevant if calculation algorithms are used in report for calculation. The cell calculated by formulas should be previously selected using the SetTabSheetData operation.

To execute the operation, in the mon field specify moniker of regular report instance. The moniker can be obtained on executing the OpenPrxMeta operation. The report should be calculated. In the tArg.formulaDescriptionKey field specify formula key. The key can be obtained on executing the GetEaxFormulaDescriptions operation. In the tArg.termDescriptions field specify empty values or default values for the fields, which values should be obtained.

The operation results in the obtained information about formula terms.

Example

Below is the example of getting information about terms used in a formula for calculation of table cell value. It is assumed that the cell with formulas is already selected on a report sheet. The request contains regular report moniker and the list of obtained fields. The response contains the obtained information about terms.

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">
<GetEaxTermDescriptions xmlns="http://www.fsight.ru/PP.SOM.Som">
  <mon xmlns="">NBNHEPFAALBBGOAEABGIFGOOMGCKMALEJKHEEKKJBGLAMNPH!M!S!PEICKDAGAALBBGOAEIBOHAGDMIAKHEAJEPILBICMEKJJOEBAJ</mon>
<tArg xmlns="">
  <formulaDescriptionKey>1</formulaDescriptionKey>
<termDescriptions>
<its>
<it>
  <k>-1</k>
  <id />
  <n />
  <shortName />
  <fullName />
<value>
  <v />
  </value>
  </it>
  </its>
  </termDescriptions>
  </tArg>
  </GetEaxTermDescriptions>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<GetEaxTermDescriptionsResult 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">
<termDescriptions xmlns="">
<its>
<it>
  <k>0</k>
  <n>Cube ! 3</n>
  <shortName>Cube ! 3</shortName>
  <fullName>Cube ! Element 0 | 2010 | 3</fullName>
<value>
  <v>2</v>
  </value>
  </it>
<it>
  <k>1</k>
  <n>Cube ! 1</n>
  <shortName>Cube ! 1</shortName>
  <fullName>Cube ! Element 0 | 2010 | 1</fullName>
<value>
  <v>1</v>
  </value>
  </it>
<it>
  <k>2</k>
  <n>Cube ! 2</n>
  <shortName>Cube ! 2</shortName>
  <fullName>Cube ! Element 0 | 2010 | 2</fullName>
<value>
  <v>2</v>
  </value>
  </it>
  </its>
  </termDescriptions>
  </GetEaxTermDescriptionsResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
"GetEaxTermDescriptions" :
{
"mon" : "NBNHEPFAALBBGOAEABGIFGOOMGCKMALEJKHEEKKJBGLAMNPH!M!S!PEICKDAGAALBBGOAEIBOHAGDMIAKHEAJEPILBICMEKJJOEBAJ",
"tArg" :
{
"formulaDescriptionKey" : "1",
"termDescriptions" :
{
"its" :
{
"it" :
[
{
"k" : "-1",
"id" : "",
"n" : "",
"shortName" : "",
"fullName" : "",
"value" :
{
"v" : ""
}
}
]
}
}
}
}
}

JSON response:

{
"GetEaxTermDescriptionsResult" :
{
"termDescriptions" :
{
"its" :
{
"it" :
[
{
"k" : "0",
"n" : "Cube ! 3",
"shortName" : "Cube ! 3",
"fullName" : "Cube ! Element 0 | 2010 | 3",
"value" :
{
"v" : "2"
}
},
{
"k" : "1",
"n" : "Cube ! 1",
"shortName" : "Cube ! 1",
"fullName" : "Cube ! Element 0 | 2010 | 1",
"value" :
{
"v" : "1"
}
},
{
"k" : "2",
"n" : "Cube ! 2",
"shortName" : "Cube ! 2",
"fullName" : "Cube ! Element 0 | 2010 | 2",
"value" :
{
"v" : "2"
}
}
]
}
}
}
}
public static GetEaxTermDescriptionsResult GetEaxTermDescriptions(string moniker, uint formulaKey)
{
var somClient = new SomPortTypeClient(); // Proxy object for operation execution
// Operation execution parameters
var tGet = new GetEaxTermDescriptions()
{
tArg = new GetEaxTermDescriptionsArg()
{
formulaDescriptionKey = formulaKey,
termDescriptions = new EaxTermDescriptions()
{
its = new EaxTermDescription[]
{
new EaxTermDescription()
{
id = string.Empty,
k = uint.MaxValue,
n = string.Empty,
fullName = string.Empty,
shortName = string.Empty,
value = new TypedValue()
{
v = string.Empty
}
}
}
}
},
mon = moniker
};
// Get information about terms used in formulas
var result = somClient.GetEaxTermDescriptions(tGet);
return result;
}

See also:

Working with Regular Reports