GetBpmSegmentInfo

Syntax

BpmCubeSegmentInfo GetBpmSegmentInfo(BpmProcessId tBpmProcess, GetBpmCubeSegmentInfoArg tArg)

Parameters

tBpmProcess. Moniker of opened process.

tArg. Operation execution parameters.

Description

The GetBpmSegmentInfo operation gets data segment settings for process step.

Comments

The operation is relevant for the Data Entry or Approval steps.

To execute the operation, in the tBpmProcess field specify moniker of opened process, and in the tArg field specify information about step and data segment, for which the operation is executed. The moniker can be obtained after executing the OpenBpmProcess operation. Step information can be obtained using the GetBpmWorkspace operation. Information about available segments is returned by the GetBpmSegmentsForSteps operation.

The operation results in the obtained data segment settings.

Example

Below is the example of getting settings of the data segment used in a step. The request contains moniker of opened process, data entry step GUID, cube and segment keys. The response contains settings determined for a process step segment.

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">
<GetBpmSegmentInfo xmlns="http://www.fsight.ru/PP.SOM.Som">
<tBpmProcess xmlns="">
  <id>MMCCFMODHHDDGOAEJNHEBIDDFKDDHAGEOJJCCJMGOADNDDCJ!M!S!BPFLPMKNODHHDDGOAEAPBGMNOKNLEGJMHEHJPIBDFCLCKGHBEP</id>
  </tBpmProcess>
<tArg xmlns="">
  <stpGuid>{42F4DDBC-DC40-46E3-83F6-202E13E4EF37}</stpGuid>
  <cubeKey>343811</cubeKey>
  <key>343832</key>
  </tArg>
  </GetBpmSegmentInfo>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<GetBpmSegmentInfoResult 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">
  <isDynamic xmlns="">1</isDynamic>
  <linked xmlns="">1</linked>
<segDims xmlns="">
<it>
  <dimKey>343812</dimKey>
  <isEnabled>0</isEnabled>
  <bindType>Unknown</bindType>
  <name>Facts</name>
  </it>
<it>
  <dimKey>343809</dimKey>
  <isEnabled>0</isEnabled>
  <bindType>Unknown</bindType>
  <name>Calendar</name>
  </it>
<it>
  <dimKey>343805</dimKey>
  <isEnabled>0</isEnabled>
  <bindType>Unknown</bindType>
  <name>Sectors dictionary</name>
  </it>
<it>
  <dimKey>343807</dimKey>
  <isEnabled>1</isEnabled>
  <bindType>Unknown</bindType>
  <name>Companies dictionary</name>
  <mnk>MMCCFMODHHDDGOAEJNHEBIDDFKDDHAGEOJJCCJMGOADNDDCJ!M!S!SCDNJCBPDHHDDGOAEIPGBOBIEMGOMOPBECKCBBGOLNDJDGBNF</mnk>
  </it>
  </segDims>
  </GetBpmSegmentInfoResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
"GetBpmSegmentInfo" :
{
"tBpmProcess" :
{
"id" : "MMCCFMODHHDDGOAEJNHEBIDDFKDDHAGEOJJCCJMGOADNDDCJ!M!S!BPFLPMKNODHHDDGOAEAPBGMNOKNLEGJMHEHJPIBDFCLCKGHBEP"
},
"tArg" :
{
"stpGuid" : "{42F4DDBC-DC40-46E3-83F6-202E13E4EF37}",
"cubeKey" : "343811",
"key" : "343832"
}
}
}

JSON response:

{
"GetBpmSegmentInfoResult" :
{
"isDynamic" : "1",
"linked" : "1",
"segDims" :
{
"it" :
[
{
"dimKey" : "343812",
"isEnabled" : "0",
"bindType" : "Unknown",
"name" : "Facts"
},
{
"dimKey" : "343809",
"isEnabled" : "0",
"bindType" : "Unknown",
"name" : "Calendar"
},
{
"dimKey" : "343805",
"isEnabled" : "0",
"bindType" : "Unknown",
"name" : "Sectors dictionary"
},
{
"dimKey" : "343807",
"isEnabled" : "1",
"bindType" : "Unknown",
"name" : "Companies dictionary",
"mnk" : "MMCCFMODHHDDGOAEJNHEBIDDFKDDHAGEOJJCCJMGOADNDDCJ!M!S!SCDNJCBPDHHDDGOAEIPGBOBIEMGOMOPBECKCBBGOLNDJDGBNF"
}
]
}
}
}
public static BpmCubeSegmentInfo GetBpmSegmentInfo(string moniker, string stepGUID, uint cube, uint segment)
{
var somClient = new SomPortTypeClient(); // Proxy object for operation execution
// Operation execution parameters
var tGet = new GetBpmSegmentInfo()
{
// Create object moniker
tBpmProcess = new BpmProcessId() { id = moniker },
tArg = new GetBpmCubeSegmentInfoArg()
{
stpGuid = stepGUID,
cubeKey = cube,
key = segment
}
};
// Get data segment settings
var result = somClient.GetBpmSegmentInfo(tGet);
return result;
}

See also:

Working with Processes