GetBpmMonitoringWorkspace

Syntax

GetBpmMonitoringWorkspaceResult GetBpmMonitoringWorkspace(BpmProcessId tBpmProcess, GetBpmMonitoringWorkspaceArg tArg)

Parameters

tBpmProcess. Moniker of opened process.

tArg. Operation execution parameters.

Description

The GetBpmMonitoringWorkspace operation gets information about process instance structure during its execution.

Comments

To execute the operation, in the tBpmProcess field specify moniker of opened process. The moniker can be obtained after executing the OpenBpmProcess operation. In the tArg.id field specify unique key of the started process instance. The key can be obtained in the list collection that is available after executing executing the GetProcessInstances operation.

The operation results in the process structure with information about status of execution of specific stages and steps.

Example

Below is the example of getting information about structure of executed process instance. The request contains process moniker and unique key of executed process instance. The response contains the obtained information about process structure.

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">
<GetBpmMonitoringWorkspace xmlns="http://www.fsight.ru/PP.SOM.Som">
<tBpmProcess xmlns="">
  <id>MGJFJPPOBBDDGOAECMABJPKINDGPEBIEBLJDEKDGIANBKOGK!M!S!BPIMOEODAPBBDDGOAEDHLCADLCMDDIJDCEGJPKIJEBEEOLAHIL</id>
  </tBpmProcess>
<tArg xmlns="">
  <id>98037</id>
  </tArg>
  </GetBpmMonitoringWorkspace>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<GetBpmMonitoringWorkspaceResult 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">
<proc xmlns="">
  <name>master_ cpoy</name>
<stages>
<it>
<stage>
  <name>Stage 1</name>
  <index>0</index>
  <guid>{5DFF5AF4-6A61-438A-A75A-79DDC20F1948}</guid>
  <id>168714*0</id>
<states>
  <it>2</it>
  </states>
  </stage>
  <gtwType>No_gateway</gtwType>
  <isCondActive>0</isCondActive>
<stGroups>
<it>
<stGroup>
  <index>0</index>
  <guid>{9B9B1C11-C408-45BA-B33B-2966DE9F6717}</guid>
  </stGroup>
<steps>
<it>
  <isEnabled>1</isEnabled>
  <name>Subprocess call 1</name>
  <type>SubStart</type>
  <index>0</index>
  <guid>{17AE01A0-8BDA-4B2C-8BF3-B48A6A411EE1}</guid>
  <descr />
  <roleId>PS-1-1</roleId>
  <roleName>ADMIN</roleName>
  <deadline>2024-06-22T08:27:15.000</deadline>
<maxDur>
  <periodType>Day</periodType>
  <amount>1</amount>
  </maxDur>
  <bindObjKey>168054</bindObjKey>
  <autoExec>0</autoExec>
  <id>168714*0@0^0</id>
<states>
  <it>2</it>
  </states>
<subproc>
  <procVer>2024-05-23T17:14:04.188</procVer>
  <rollbackType>FirstStep</rollbackType>
  </subproc>
  </it>
<it>
  <isEnabled>1</isEnabled>
  <name>Manual action 2</name>
  <type>ManualTask</type>
  <index>1</index>
  <guid>{9EE92EA8-E209-45D5-B662-7063A93FA887}</guid>
  <descr />
  <roleId>PS-1-1</roleId>
  <roleName>ADMIN</roleName>
<maxDur>
  <periodType>Day</periodType>
  <amount>1</amount>
  </maxDur>
  <id>168714*0@0^1</id>
<states>
  <it>1</it>
  </states>
  </it>
  </steps>
  <isDefaultFlow>0</isDefaultFlow>
  </it>
  </stGroups>
  </it>
  </stages>
  </proc>
  <instId xmlns="">{99654793-F719-4107-AD36-F1060FCD62F5}</instId>
  </GetBpmMonitoringWorkspaceResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
"GetBpmMonitoringWorkspace" :
{
"tBpmProcess" :
{
"id" : "MGJFJPPOBBDDGOAECMABJPKINDGPEBIEBLJDEKDGIANBKOGK!M!S!BPIMOEODAPBBDDGOAEDHLCADLCMDDIJDCEGJPKIJEBEEOLAHIL"
},
"tArg" :
{
"id" : "98037"
}
}
}

JSON response:

{
"GetBpmMonitoringWorkspaceResult" :
{
"proc" :
{
"name" : "master_ cpoy",
"stages" :
{
"it" :
{
"stage" :
{
"name" : "Stage 1",
"index" : "0",
"guid" : "{5DFF5AF4-6A61-438A-A75A-79DDC20F1948}",
"id" : "168714*0",
"states" :
{
"it" : "2"
}
},
"gtwType" : "No_gateway",
"isCondActive" : "0",
"stGroups" :
{
"it" :
{
"stGroup" :
{
"index" : "0",
"guid" : "{9B9B1C11-C408-45BA-B33B-2966DE9F6717}"
},
"steps" :
{
"it" :
[
{
"isEnabled" : "1",
"name" : "Subprocess 1 call",
"type" : "SubStart",
"index" : "0",
"guid" : "{17AE01A0-8BDA-4B2C-8BF3-B48A6A411EE1}",
"descr" : "",
"roleId" : "PS-1-1",
"roleName" : "ADMIN",
"deadline" : "2024-06-22T08:27:15.000",
"maxDur" :
{
"periodType" : "Day",
"amount" : "1"
},
"bindObjKey" : "168054",
"autoExec" : "0",
"id" : "168714*0@0^0",
"states" :
{
"it" : "2"
},
"subproc" :
{
"procVer" : "2024-05-23T17:14:04.188",
"rollbackType" : "FirstStep"
}
},
{
"isEnabled" : "1",
"name" : "Manual action 2",
"type" : "ManualTask",
"index" : "1",
"guid" : "{9EE92EA8-E209-45D5-B662-7063A93FA887}",
"descr" : "",
"roleId" : "PS-1-1",
"roleName" : "ADMIN",
"maxDur" :
{
"periodType" : "Day",
"amount" : "1"
},
"id" : "168714*0@0^1",
"states" :
{
"it" : "1"
}
}
]
},
"isDefaultFlow" : "0"
}
}
}
}
},
"instId" : "{99654793-F719-4107-AD36-F1060FCD62F5}"
}
}
public static GetBpmMonitoringWorkspaceResult GetBpmMonitoringWorkspace(string moniker, uint instanceKey)
{
var somClient = new SomPortTypeClient(); // Proxy object for operation execution
// Operation execution parameters
var tGet = new GetBpmMonitoringWorkspace()
{
tBpmProcess = new BpmProcessId() { id = moniker },
tArg = new GetBpmMonitoringWorkspaceArg()
{
id = instanceKey
}
};
// Get information about structure of executed process instance
var result = somClient.GetBpmMonitoringWorkspace(tGet);
return result;
}

See also:

Working with Processes