GetBpmSegmentsForSteps

Syntax

BpmSegmentsForStepsResult GetBpmSegmentsForSteps(BpmProcessId tBpmProcess, BpmSegmentsForStepsArg tArg)

Parameters

tBpmProcess. Moniker of opened process.

tArg. Operation execution parameters.

Description

The GetBpmSegmentsForSteps operation gets information about the segments that can be used in a 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 the step, 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.

The operation results in the list data sources that of the attached data entry form with data segments that can be attached to process step.

Example

Below is the example of getting information about the segments that can be applied for a step. The request contains moniker of opened process, data entry step GUID, and data entry form key, for working with which the step is set up. The response contains information about the cube segments used in the data entry form.

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

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<GetBpmSegmentsForStepsResult 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">
<res xmlns="">
<it>
  <cubesName>Cube</cubesName>
  <type>0</type>
  <cubeKey>343811</cubeKey>
<segs>
<it>
  <key>343832</key>
  <linked>1</linked>
  <name>Access by sectors</name>
  </it>
<it>
  <key>343834</key>
  <linked>1</linked>
  <name>Access by companies</name>
  </it>
  </segs>
  </it>
  </res>
<paramsData xmlns="">
<it>
  <dimKey>343805</dimKey>
  </it>
  </paramsData>
  </GetBpmSegmentsForStepsResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
"GetBpmSegmentsForSteps" :
{
"tBpmProcess" :
{
"id" : "MMCCFMODHHDDGOAEJNHEBIDDFKDDHAGEOJJCCJMGOADNDDCJ!M!S!BPFLPMKNODHHDDGOAEAPBGMNOKNLEGJMHEHJPIBDFCLCKGHBEP"
},
"tArg" :
{
"key" : "343818",
"isFullTree" : "true",
"stpGuid" : "{42F4DDBC-DC40-46E3-83F6-202E13E4EF37}"
}
}
}

JSON response:

{
"GetBpmSegmentsForStepsResult" :
{
"res" :
{
"it" :
{
"cubesName" : "Cube",
"type" : "0",
"cubeKey" : "343811",
"segs" :
{
"it" :
[
{
"key" : "343832",
"linked" : "1",
"name" : "Access by sectors"
},
{
"key" : "343834",
"linked" : "1",
"name" : "Access by companies"
}
]
}
}
},
"paramsData" :
{
"it" :
{
"dimKey" : "343805"
}
}
}
}
public static BpmSegmentsForStepsResult GetBpmSegmentsForSteps(string moniker, string stepGUID, uint frmKey)
{
var somClient = new SomPortTypeClient(); // Proxy object for operation execution
// Operation execution parameters
var tGet = new GetBpmSegmentsForSteps()
{
// Create object moniker
tBpmProcess = new BpmProcessId() { id = moniker },
tArg = new BpmSegmentsForStepsArg()
{
isFullTree = true,
stpGuid = stepGUID,
key = frmKey
}
};
// Get segment settings that can be used in step
var result = somClient.GetBpmSegmentsForSteps(tGet);
return result;
}

See also:

Working with Processes