GetDashboardExpressionField

Syntax

DashboardExpressionField GetDashboardExpressionField(string mon, DashboardExpressionField tArg)

Parameters

mon. Moniker for working with calculated fact of information panel data source.

tArg. Calculated fact settings that should be obtained.

Description

The GetDashboardExpressionField operation gets calculated fact settings of information panel data source.

Comments

To execute the operation, in the mon field specify moniker of opened information panel instance with the !Sources!data source key!Expressions!calculated fact key postfix, and in the tArg field specify empty values or default values for the fields, which values should be obtained. The moniker can be obtained on executing the OpenDashboard operation.

The operation results in the calculated fact settings.

Example

Below is the example of getting calculated fact settings. The request contains calculated fact moniker and the 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">
<GetDashboardExpressionField xmlns="http://www.fsight.ru/PP.SOM.Som">
  <mon xmlns="">LKACHLFPHPFFGOAEFAJMIHOHCKLEPLKEEIENANDBMODOBJMH!M!S!PHOONDMFPHPFFGOAEGILOHDKLDDEDFAAEEJAAJAMKHGKPJBCK!Sources!1!Expressions!1</mon>
<tArg xmlns="">
  <k>1</k>
  <n />
  <valid>false</valid>
<customFormat>
  <format />
  <all>false</all>
  </customFormat>
  <dataType>2147483647</dataType>
  <expressionType>2147483647</expressionType>
  <calendarLevel>None</calendarLevel>
  <includeInSelection>false</includeInSelection>
  <calcMethod>BySelection</calcMethod>
  <expression />
  <parentFieldId />
  </tArg>
  </GetDashboardExpressionField>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<GetDashboardExpressionFieldResult 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">
  <k xmlns="">1</k>
  <id xmlns="">CALCULATED FACT</id>
  <n xmlns="">Calculated value</n>
  <valid xmlns="">1</valid>
<customFormat xmlns="">
  <format />
  <all>0</all>
  </customFormat>
  <dataType xmlns="">8</dataType>
  <expressionType xmlns="">0</expressionType>
  <calendarLevel xmlns="">Year</calendarLevel>
  <includeInSelection xmlns="">0</includeInSelection>
  <calcMethod xmlns="">BySelection</calcMethod>
  <expression xmlns="">@[FIELD 3]/2</expression>
  <parentFieldId xmlns="">FIELD 3</parentFieldId>
  </GetDashboardExpressionFieldResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
"GetDashboardExpressionField" :
{
"mon" : "LKACHLFPHPFFGOAEFAJMIHOHCKLEPLKEEIENANDBMODOBJMH!M!S!PHOONDMFPHPFFGOAEGILOHDKLDDEDFAAEEJAAJAMKHGKPJBCK!Sources!1!Expressions!1",
"tArg" :
{
"k" : "1",
"n" : "",
"valid" : "false",
"customFormat" :
{
"format" : "",
"all" : "false"
},
"dataType" : "2147483647",
"expressionType" : "2147483647",
"calendarLevel" : "None",
"includeInSelection" : "false",
"calcMethod" : "BySelection",
"expression" : "",
"parentFieldId" : ""
}
}
}

JSON response:

{
"GetDashboardExpressionFieldResult" :
{
"k" : "1",
"id" : "CALCULATED FACT",
"n" : "Calculated value",
"valid" : "1",
"customFormat" :
{
"format" : "",
"all" : "0"
},
"dataType" : "8",
"expressionType" : "0",
"calendarLevel" : "Year",
"includeInSelection" : "0",
"calcMethod" : "BySelection",
"expression" : "@[FIELD 3]\/2",
"parentFieldId" : "FIELD 3"
}
}
public static DashboardExpressionField GetDashboardExpressionField(string moniker, uint sourceKey, uint calcFactKey)
{
var somClient = new SomPortTypeClient(); // Proxy object for operation execution
// Operation execution parameters
var tGet = new GetDashboardExpressionField()
{
tArg = new DashboardExpressionField()
{
calcMethod = new CubeCalcMethod(),
calendarLevel = new DimCalendarLvl(),
customFormat = new SemanticLayerCustomFormat()
{
all = new bool(),
format = string.Empty
},
dataType = int.MaxValue,
expression = string.Empty,
expressionType = int.MaxValue,
includeInSelection = new bool(),
k = calcFactKey,
n = string.Empty,
parentFieldId = string.Empty,
valid = new bool()
},
// Moniker for working with calculated fact
mon = moniker + "!Sources!" + sourceKey + "!Expressions!" + calcFactKey
};
// Get calculated fact settings
var result = somClient.GetDashboardExpressionField(tGet);
return result;
}

See also:

Working with Information Panels