GetBpmProcAdministration

Syntax

GetBpmProcAdministrationResult GetBpmProcAdministration(OdId tObject, BpmProcAdministrationPageArg tPage)

Parameters

tObject. Business Processes component moniker.

tPage. Operation execution parameters.

Description

The GetBpmProcAdministration operation gets administration settings for business processes.

Comments

This operation should be executed for the Business Processes component (the identifier: BPM_COMPONENT). The operation should be executed by the user who is a repository database (schema) owner or is included in the Administrators group.

To execute the operation, in the tObject field specify moniker of the Business Processes component, and in the tPage field specify the section with administration settings that should be obtained. The moniker can be obtained on executing the GetObjects operation.

The operation results in the obtained administration settings.

Example

Below is the example of getting settings of business process work scheduler. The request contains moniker of the Business Process component and type of obtained settings. The response contains the obtained settings.

The C# example uses the FindObjectById function, which code is given in the Getting Object Description by Its Identifier example.

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">
<GetBpmProcAdministration xmlns="http://www.fsight.ru/PP.SOM.Som">
<tObject xmlns="">
  <id>ELHOHPDLNENAGOAEFOGOLNDDNBMLBBJEDIEOJBLHMOGKOKLK!M!143520</id>
  </tObject>
<tPage xmlns="">
  <page>Sch</page>
  </tPage>
  </GetBpmProcAdministration>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<GetBpmProcAdministrationResult 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="">1</res>
<prAdmInf xmlns="">
<schInf>
  <clEx>0</clEx>
<biInf>
  <servEx>0</servEx>
  </biInf>
<srvExecInf>
  <taskCnt>5</taskCnt>
  <taskIntrv>5</taskIntrv>
  <deadF>1</deadF>
  <deadInterv>15</deadInterv>
  </srvExecInf>
  </schInf>
  </prAdmInf>
  </GetBpmProcAdministrationResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
 "GetBpmProcAdministration" : 
  {
   "tObject" : 
    {
     "id" : "ELHOHPDLNENAGOAEFOGOLNDDNBMLBBJEDIEOJBLHMOGKOKLK!M!143520"
    },
   "tPage" : 
    {
     "page" : "Sch"
    }
  }
}

JSON response:

{
 "GetBpmProcAdministrationResult" : 
  {
   "res" : "1",
   "prAdmInf" : 
    {
     "schInf" : 
      {
       "clEx" : "0",
       "biInf" : 
        {
         "servEx" : "0"
        },
       "srvExecInf" : 
        {
         "taskCnt" : "5",
         "taskIntrv" : "5",
         "deadF" : "1",
         "deadInterv" : "15"
        }
      }
    }
  }
}
public static GetBpmProcAdministrationResult GetBpmProcAdministration(MbId mb)
{
    var somClient = new SomPortTypeClient(); // Proxy object for operation execution
    // Operation execution parameters
    var tGet = new GetBpmProcAdministration()
    {
        tObject = new OdId() { id = mb.id + "!" + FindObjectById(mb, "BPM_COMPONENT").k },
        tPage = new BpmProcAdministrationPageArg()
        {
            page = BpmProcAdministrationInfoPage.Sch
        }
    };
    // Get scheduler settings
    var result = somClient.GetBpmProcAdministration(tGet);
    return result;
}

See also:

Working with Processes