OpenMonitoringWS: Operation

OpenMonitoringWSResult OpenMonitoringWS(BpmProcessId tObject, OpenMonitoringWSArg tArg)

Parameters

Description

The OpenMonitoringWS operation gets URL of the page with process instance execution monitoring.

Comments

To execute the operation, in the tObject field specify moniker of opened process instance. The moniker can be obtained after executing the OpenBpmProcess operation. In the tArg.key field specify unique key of executed process instance. The key is available in the list collection of execution results of the GetProcessInstances operation. In the tArg.giud field specify GUID of structure of the executed process instance, that is available in the instId field of result of the GetBpmMonitoringWorkspace operation.

The operation results in the URL of the page with process execution monitoring. This URL can be used to provide a permanent connection between browser and BI server via a WebSocket protocol. Number format that should be sent to the WebSocket designer: ws://BI server URL[:port]/service?id= + output URL.

Example

Below is the example of getting monitoring page URL. The request contains moniker of opened process, process instance key, and process structure GUID. The response contains monitoring page URL.

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>CDIKMKCKEHJCGOAELMMPKEGKAJIPBMFELKNPPPKHHFAHIIHI!M!S!BPFGPGKNCKEHJCGOAEHJDEHIPJFHBPODGEKJCMFANHBFPHKIDC</id>

</tObject>

</tArg>

</OpenMonitoringWS>

</s:Body>

</s:Envelope>

SOAP response:

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

<soapenv:Body>

<url xmlns="">BPMMONID!{6EF312B6-180F-4671-B70E-7D1D26F0E0A7}!1712312919</url>

</OpenMonitoringWSResult>

</soapenv:Body>

</soapenv:Envelope>

JSON request:

{
 "OpenMonitoringWS" : 
  {
   "tObject" : 
    {
     "id" : "CDIKMKCKEHJCGOAELMMPKEGKAJIPBMFELKNPPPKHHFAHIIHI!M!S!BPFGPGKNCKEHJCGOAEHJDEHIPJFHBPODGEKJCMFANHBFPHKIDC"
    },
   "tArg" : 
    {
     "key" : "51021",
     "guid" : "{6EF312B6-180F-4671-B70E-7D1D26F0E0A7}"
    }
  }
}

JSON response:

{
 "OpenMonitoringWSResult" : 
  {
   "url" : "BPMMONID!{6EF312B6-180F-4671-B70E-7D1D26F0E0A7}!1712312919"
  }
}

public static OpenMonitoringWSResult OpenMonitoringWS(string moniker, int instanceKey, string instanceWSGUID)
{
    var somClient = new SomPortTypeClient(); // Proxy object for operation execution
    // Operation execution parameters
    var tGet = new OpenMonitoringWS()
    {
        tObject = new BpmProcessId() { id = moniker },
        tArg = new OpenMonitoringWSArg()
        {
            key = instanceKey,
            guid = instanceWSGUID
        }
    };
    // Get monitoring age URL
    var result = somClient.OpenMonitoringWS(tGet);
    return result;
}

OpenMonitoringWS

Syntax