SetBpmProcAdministration: Operation

SetBpmProcAdministrationResult SetBpmProcAdministration(OdId tObject, BpmProcAdministrationPageArg tPage, BpmProcAdministrationInfo tArg)

Parameters

Description

The SetBpmProcAdministration operation changes business process administration settings.

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.

Example

Below is the example of changing process scheduler settings. The request contains moniker of the Business Process component and server execution settings to be applied. The response contains whether new settings are successfully applied.

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>BPAEMDDLNENAGOAEACLJJOFEKIJHADNEIIMIFGGIJKIJCJOK!M!143520</id>

</tObject>

</tPage>

<clEx>false</clEx>

<biInf>

<servEx>false</servEx>

</biInf>

</srvExecInf>

</schInf>

</tArg>

</SetBpmProcAdministration>

</s:Body>

</s:Envelope>

SOAP response:

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

<soapenv:Body>

</SetBpmProcAdministrationResult>

</soapenv:Body>

</soapenv:Envelope>

JSON request:

{
 "SetBpmProcAdministration" : 
  {
   "tObject" : 
    {
     "id" : "BPAEMDDLNENAGOAEACLJJOFEKIJHADNEIIMIFGGIJKIJCJOK!M!143520"
    },
   "tPage" : 
    {
     "page" : "Sch"
    },
   "tArg" : 
    {
     "schInf" : 
      {
       "clEx" : "false",
       "biInf" : 
        {
         "servEx" : "false"
        },
       "srvExecInf" : 
        {
         "taskCnt" : "5",
         "taskIntrv" : "5",
         "deadF" : "true",
         "deadInterv" : "15"
        }
      }
    }
  }
}

JSON response:

{
 "SetBpmProcAdministrationResult" : 
  {
   "res" : "1"
  }
}

public static SetBpmProcAdministrationResult SetBpmProcAdministration(MbId mb)
{
    var somClient = new SomPortTypeClient(); // Proxy object for operation execution
    // Operation execution parameters
    var tSet = new SetBpmProcAdministration()
    {
        tObject = new OdId() { id = mb.id + "!" + FindObjectById(mb, "BPM_COMPONENT").k },
        tPage = new BpmProcAdministrationPageArg()
        {
            page = BpmProcAdministrationInfoPage.Sch
        },
        tArg = new BpmProcAdministrationInfo()
        {
            schInf = new BpmSchedulerInfo()
            {
                clEx = false,
                srvExecInf = new BpmSchedulerServExecInfo()
                {
                    taskCnt = 5,
                    taskIntrv = 5,
                    deadF = true,
                    deadInterv = 15
                },
                biInf = new BpmSchedulerBiServiceInfo()
            }
        }
    };
    // Change scheduler settings
    var result = somClient.SetBpmProcAdministration(tSet);
    return result;
}

SetBpmProcAdministration

Syntax