SetEaxFormulaDescriptionUsedAttrs: Operation

bool SetEaxFormulaDescriptionUsedAttrs(string mon, EaxFormulaDescriptionDimensionsArg tArg)

Parameters

Description

The SetEaxFormulaDescriptionUsedAttrs operation changes settings of displaying of 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 set the dimension attributes, which values will be used to create term names.

The operation results in the logical True if display settings were changed successfully. The made changes are not stored in report metadata, but are saved in a local browser storage in the element with the FORMULA_DESCRIPTION_DIALOG key. To use the saved settings within the other sessions, load the settings using the SetEaxUsedAttributesIdMap operation.

Example

Below is the example of changing 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 and formula key. The request also contains the list with dimension keys and attribute identifiers, which values will be used to indicate elements in terms. The response contains whether settings were changed successfully.

SOAP JSON C#

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">

<mon xmlns="">NBNHEPFAALBBGOAEABGIFGOOMGCKMALEJKHEEKKJBGLAMNPH!M!S!PEICKDAGAALBBGOAEIBOHAGDMIAKHEAJEPILBICMEKJJOEBAJ</mon>

<its>

<it>

</it>

<it>

<usedAttributeId>START_DATE</usedAttributeId>

</it>

</its>

</formulaDimensions>

</tArg>

</SetEaxFormulaDescriptionUsedAttrs>

</s:Body>

</s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">

<soapenv:Body>

</soapenv:Body>

</soapenv:Envelope>

JSON request:

{
 "SetEaxFormulaDescriptionUsedAttrs" : 
  {
   "mon" : "NBNHEPFAALBBGOAEABGIFGOOMGCKMALEJKHEEKKJBGLAMNPH!M!S!PEICKDAGAALBBGOAEIBOHAGDMIAKHEAJEPILBICMEKJJOEBAJ",
   "tArg" : 
    {
     "formulaDescriptionKey" : "1",
     "formulaDimensions" : 
      {
       "its" : 
        {
         "it" : 
          [
            {
             "k" : "339495",
             "usedAttributeId" : "KEY"
            },
            {
             "k" : "339497",
             "usedAttributeId" : "START_DATE"
            }
          ]
        }
      }
    }
  }
}

JSON response:

{
 "SetEaxFormulaDescriptionUsedAttrsResult" : "1"
}

public static bool SetEaxFormulaDescriptionUsedAttrs(string moniker, uint formulaKey)
{
    var somClient = new SomPortTypeClient(); // Proxy object for operation execution
    // Operation execution parameters
    var tSet = new SetEaxFormulaDescriptionUsedAttrs()
    {
        tArg = new EaxFormulaDescriptionDimensionsArg()
        {
            formulaDescriptionKey = formulaKey,
            formulaDimensions = new EaxFormulaDescriptionDimensions()
            {
                its = new EaxFormulaDescriptionDimension[]
                {
                    new EaxFormulaDescriptionDimension()
                    {
                        k = 339495,
                        usedAttributeId = "KEY"
                    },
                    new EaxFormulaDescriptionDimension()
                    {
                        k = 339497,
                        usedAttributeId = "START_DATE"
                    }
                }
            }
        },
        mon = moniker
    };
    // Change settings of displaying detailed information about formula terms
    var result = somClient.SetEaxFormulaDescriptionUsedAttrs(tSet);
    return result;
}

SetEaxFormulaDescriptionUsedAttrs

Syntax