SetBpmSegmentsInfo: Operation

BpmSetSegmentsInfoResult SetBpmSegmentsInfo(BpmProcessId tBpmProcess, SetBpmCubeSegmentsInfoArg tArg)

Parameters

Description

The SetBpmSegmentsInfo operation changes data segment settings for process step.

Comments

To execute the operation, in the tBpmProcess field specify moniker of opened process, 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 information about successfully changed data segment settings.

Example

Below is the example of changing segment settings in process step. The request contains moniker of opened process, data entry step GUID and segment settings. The response contains whether settings were changed successfully.

SOAP JSON C#

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">

<id>MMCCFMODHHDDGOAEJNHEBIDDFKDDHAGEOJJCCJMGOADNDDCJ!M!S!BPFLPMKNODHHDDGOAEAPBGMNOKNLEGJMHEHJPIBDFCLCKGHBEP</id>

</tBpmProcess>

<it>

<name>Access by sectors</name>

</it>

<it>

<isDynamic>false</isDynamic>

<name>Access by companies</name>

</it>

</segsInfo>

</tArg>

</SetBpmSegmentsInfo>

</s:Body>

</s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">

<soapenv:Body>

</SetBpmSegmentsInfoResult>

</soapenv:Body>

</soapenv:Envelope>

JSON request:

{
 "SetBpmSegmentsInfo" : 
  {
   "tBpmProcess" : 
    {
     "id" : "MMCCFMODHHDDGOAEJNHEBIDDFKDDHAGEOJJCCJMGOADNDDCJ!M!S!BPFLPMKNODHHDDGOAEAPBGMNOKNLEGJMHEHJPIBDFCLCKGHBEP"
    },
   "tArg" : 
    {
     "stpGuid" : "{42F4DDBC-DC40-46E3-83F6-202E13E4EF37}",
     "segsInfo" : 
      {
       "it" : 
        [
          {
           "isDynamic" : "true",
           "linked" : "true",
           "key" : "343832",
           "cubeKey" : "343811",
           "name" : "Access by sectors"
          },
          {
           "isDynamic" : "false",
           "linked" : "true",
           "key" : "343834",
           "cubeKey" : "343811",
           "name" : "Access by companies"
          }
        ]
      }
    }
  }
}

JSON response:

{
 "SetBpmSegmentsInfoResult" : 
  {
   "result" : "1"
  }
}

public static BpmSetSegmentsInfoResult 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;
}

SetBpmSegmentsInfo

Syntax