SetPivotDimensionMetaData

Syntax

bool SetPivotDimensionMetaData(string mon, PivotDimension tArg)

Parameters

mon. Moniker for working with data slice dimension.

tArg. Dimension parameters that should be applied.

Description

The SetPivotDimensionMetaData operation changes data slice dimension.

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!PivotDims!<dimension key> postfix to work with a dimension, and in the tArg field specify new parameters of the dimension that should be applied.

The moniker can be obtained on executing the OpenPrxMeta operation.

The operation returns True if changes are applied successfully.

Example

Below is the example of changing data slice dimension settings. The request contains moniker for working with dimension and dimension parameters to be changed. The response contains whether changes are applied successfully.

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">
<SetPivotDimensionMetaData xmlns="http://www.fsight.ru/PP.SOM.Som">
  <mon xmlns="">S1!M!S!P1!DataArea!DataSources!1!DataSourceSlices!1!Pivot!PivotDims!116</mon>
<tArg xmlns="">
  <k>0</k>
  <separated>1</separated>
  </tArg>
  </SetPivotDimensionMetaData>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
  <SetPivotDimensionMetaDataResult 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">1</SetPivotDimensionMetaDataResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
 "SetPivotDimensionMetaData" : 
  {
   "mon" : "S1!M!S!P1!DataArea!DataSources!1!DataSourceSlices!1!Pivot!PivotDims!116",
   "tArg" : 
    {
     "k" : "0",
     "separated" : "1"
    }
  }
}

JSON response:

{
 "SetPivotDimensionMetaDataResult" : "1"
}
public static bool SetPivotDimMetadata(string moniker, uint dataSourceKey, uint sliceKey, uint dimKey)
{
    var somClient = new SomPortTypeClient(); //Proxy object for operation execution
    //Operation execution parameters
    var tSet = new SetPivotDimensionMetaData()
    {
        tArg = new PivotDimension()
        {
            separated = 1
        },
        mon = moniker + "!DataArea!DataSources!" + dataSourceKey.ToString() + "!DataSourceSlices!" + sliceKey.ToString() + "!Pivot!PivotDims!" + dimKey.ToString()
    };
    //Change dimension parameters
    var result = somClient.SetPivotDimensionMetaData(tSet);
    return result;
}

See also:

Working With Regular Reports