GetEaxFormulaDescriptionUsedAttrs

Syntax

GetEaxFormulaDescriptionDimensionsResult GetEaxFormulaDescriptionUsedAttrs(string mon, EaxFormulaDescriptionDimensionsArg tArg)

Parameters

mon. Moniker of opened regular report instance.

tArg. Operation execution parameters.

Description

The GetEaxFormulaDescriptionUsedAttrs operation gets settings of displaying detailed information about formula terms.

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.formulaDimensions field specify empty values or default values for the fields, which values should be obtained.

The operation results in the obtained information about the dimension attributes, which values are used for term creation.

Example

Below is the example of getting settings of displaying detailed information about formula terms. It is assumed that the cell with formulas is already selected on a report sheet. The request contains regular report moniker, formula key, and the list of obtained fields. The response contains the obtained information about dimension attributes.

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">
<GetEaxFormulaDescriptionUsedAttrs xmlns="http://www.fsight.ru/PP.SOM.Som">
  <mon xmlns="">NBNHEPFAALBBGOAEABGIFGOOMGCKMALEJKHEEKKJBGLAMNPH!M!S!PEICKDAGAALBBGOAEIBOHAGDMIAKHEAJEPILBICMEKJJOEBAJ</mon>
<tArg xmlns="">
  <formulaDescriptionKey>1</formulaDescriptionKey>
<formulaDimensions>
<its>
<it>
  <k>-1</k>
  <id />
  <n />
  <usedAttributeId />
  <attributes />
  </it>
  </its>
  </formulaDimensions>
  </tArg>
  </GetEaxFormulaDescriptionUsedAttrs>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<GetEaxFormulaDescriptionUsedAttrsResult 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">
<formulaDimensions xmlns="">
<its>
<it>
  <k>339497</k>
  <n>Calendar</n>
  <usedAttributeId>NAME</usedAttributeId>
  <attributes />
  </it>
<it>
  <k>339495</k>
  <n>Dictionary 1</n>
  <usedAttributeId>NAME</usedAttributeId>
  <attributes />
  </it>
  </its>
  </formulaDimensions>
  </GetEaxFormulaDescriptionUsedAttrsResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
"GetEaxFormulaDescriptionUsedAttrs" :
{
"mon" : "NBNHEPFAALBBGOAEABGIFGOOMGCKMALEJKHEEKKJBGLAMNPH!M!S!PEICKDAGAALBBGOAEIBOHAGDMIAKHEAJEPILBICMEKJJOEBAJ",
"tArg" :
{
"formulaDescriptionKey" : "1",
"formulaDimensions" :
{
"its" :
{
"it" :
[
{
"k" : "-1",
"id" : "",
"n" : "",
"usedAttributeId" : "",
"attributes" : ""
}
]
}
}
}
}
}

JSON response:

{
"GetEaxFormulaDescriptionUsedAttrsResult" :
{
"formulaDimensions" :
{
"its" :
{
"it" :
[
{
"k" : "339497",
"n" : "Calendar",
"usedAttributeId" : "NAME",
"attributes" : ""
},
{
"k" : "339495",
"n" : "Dictionary 1",
"usedAttributeId" : "NAME",
"attributes" : ""
}
]
}
}
}
}
public static GetEaxFormulaDescriptionDimensionsResult GetEaxFormulaDescriptionUsedAttrs(string moniker, uint formulaKey)
{
var somClient = new SomPortTypeClient(); // Proxy object for operation execution
// Operation execution parameters
var tGet = new GetEaxFormulaDescriptionUsedAttrs()
{
tArg = new EaxFormulaDescriptionDimensionsArg()
{
formulaDescriptionKey = formulaKey,
formulaDimensions = new EaxFormulaDescriptionDimensions()
{
its = new EaxFormulaDescriptionDimension[]
{
new EaxFormulaDescriptionDimension()
{
id = string.Empty,
k = uint.MaxValue,
n = string.Empty,
attributes = new EaxFormulaDescriptionDimensionAttrs(),
usedAttributeId = string.Empty
}
}
}
},
mon = moniker
};
// Get settings of displaying detailed information about formula terms
var result = somClient.GetEaxFormulaDescriptionUsedAttrs(tGet);
return result;
}

See also:

Working with Regular Reports