SetBpmSegmentsInfo

Syntax

bool SetBpmSegmentsInfo(BpmProcessId tBpmProcess, SetBpmCubeSegmentsInfoArg tArg)

Parameters

tBpmProcess. Moniker of opened process instance.

tArg. Operation execution parameters.

Description

The SetBpmSegmentsInfo operation changes 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 instance, and in the tArg field specify step and data segment settings to be applied. The moniker can be obtained after executing the OpenBpmProcess operation.

Information about step and segments can be obtained using the GetBpmSegmentsForSteps operation.

The operation results in the logical True if segment settings were changed successfully.

Example

Below is the example of changing segment settings in process step. The request contains moniker of opened process step, data entry step GUID and segment settings. The response contains whether settings were changed 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">
<SetBpmSegmentsInfo xmlns="http://www.fsight.ru/PP.SOM.Som">
<tBpmProcess xmlns="">
  <id>FEMECGGABFLBGOAEJBJKCPGGFAHPPKEEIKOJCGNBAGIOIMIC!M!S!BPPGKHJHGABFLBGOAENCJJPOBAMGBMALIEDKIOMOCIBDCANJEA</id>
  </tBpmProcess>
<tArg xmlns="">
  <stpGuid>{42F4DDBC-DC40-46E3-83F6-202E13E4EF37}</stpGuid>
<segsInfo>
<it>
  <isDynamic>true</isDynamic>
  <linked>true</linked>
  <segKey>343832</segKey>
  <cubeKey>343811</cubeKey>
  </it>
<it>
  <isDynamic>false</isDynamic>
  <linked>true</linked>
  <segKey>343834</segKey>
  <cubeKey>343811</cubeKey>
  </it>
  </segsInfo>
  </tArg>
  </SetBpmSegmentsInfo>
  </s:Body>
  </s:Envelope>

SOAP response:

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

JSON request:

{
"SetBpmSegmentsInfo" :
{
"tBpmProcess" :
{
"id" : "FEMECGGABFLBGOAEJBJKCPGGFAHPPKEEIKOJCGNBAGIOIMIC!M!S!BPPGKHJHGABFLBGOAENCJJPOBAMGBMALIEDKIOMOCIBDCANJEA"
},
"tArg" :
{
"stpGuid" : "{42F4DDBC-DC40-46E3-83F6-202E13E4EF37}",
"segsInfo" :
{
"it" :
[
{
"isDynamic" : "true",
"linked" : "true",
"segKey" : "343832",
"cubeKey" : "343811"
},
{
"isDynamic" : "false",
"linked" : "true",
"segKey" : "343834",
"cubeKey" : "343811"
}
]
}
}
}
}

JSON response:

{
"SetBpmSegmentsInfoResult" : "1"
}
public static bool SetBpmSegmentsInfo(string moniker, string stepGUID, BpmCubeSegmentInfo[] newSegsInfo)
{
var somClient = new SomPortTypeClient(); // Proxy object for operation execution
// Operation execution parameters
var tSet = new SetBpmSegmentsInfo()
{
// Create object moniker
tBpmProcess = new BpmProcessId() { id = moniker },
tArg = new SetBpmCubeSegmentsInfoArg()
{
stpGuid = stepGUID,
segsInfo = newSegsInfo
}
};
// Change data segment settings
var result = somClient.SetBpmSegmentsInfo(tSet);
return result;
}

See also:

Working with Processes