ForkedExecutionProperties object

The ForkedExecutionProperties API lets you manage and configure forked execution properties of runtime cluster and runtime cloud cluster. You can configure heap settings for runners, workers, and browsers.

Structure

<ForkedExecutionProperties runtimeId="" partialUpdate="">
  <ForkedExecutionStandardProperties runnerHeapSize="" workerHeapSize="" browserHeapSize="" clientDefaultConnectTimeout="" clientDefaultReadTimeout="" dnsTimeToLive="" heapDumpOnOutOfMemoryError="" javaLibraryPath="" preferIpv4Stack="" retryHttpPost="" />
  <customSystemProperties>
    <!-- Add custom system properties here -->
  </customSystemProperties>
</ForkedExecutionProperties>

Required privileges:

You need these privileges in the target environment:

• Write access

  • ATOM_MANAGEMENT — Configure and administer integration runtimes.

• Read access

  • ATOM_MANAGEMENT — Configure and administer integration runtimes.

  • OR ATOM_MANAGEMENT_READ_ONLY

Name	Type	Description
browserHeapSize	string	The amount of memory allocated to a JVM is used for browsing connector operations that run in forked executions. The default allocation is 512 MB. (-Xmx)
clientDefaultConnectTimeout	integer	The amount of time that the runtime cluster or cloud cluster should attempt to establish an HTTP client connection. Increase this value if the HTTP endpoints take longer than two minutes to return a response.(-Dsun.net.client.defaultConnectTimeout)
clientDefaultReadTimeout	integer	The amount of time that the runtime cluster or cloud cluster should attempt to read data from an established HTTP client connection. Increase this value if the HTTP endpoints take longer than two minutes to return a response. (-Dsun.net.client.defaultReadTimeout)
dnsTimeToLive	integer	The amount of time that successful DNS lookups should be cached. Decrease this value if you call external hosts that frequently change IP addresses to their DNS hostname. Entering a value of -1 seconds enables continuous caching, while entering 0 seconds disables caching.
heapDumpOnOutOfMemoryError	boolean	Specifies whether the runtime cluster or cloud cluster should automatically generate a heap dump when it encounters an Out Of Memory error. Refer to the topic High-volume troubleshooting. This property should be used only as directed by the Support team. (-XX:+HeapDumpOnOutOfMemoryError)
javaLibraryPath	string	Identifies one or more directories to be searched for native libraries.
preferIpv4Stack	boolean	Specifies whether the runtime cluster or cloud cluster should use IPv4 for networking. This configuration has been tested with IPv4. Therefore, strongly recommends enabling this property. (-Djava.net.preferIPv4Stack)
retryHttpPost	boolean	Specifies whether an unsuccessful HTTP POST request should be automatically resent to the server. (-Dsun.net.http.retryPost)
runnerHeapSize	string	The amount of memory that is allocated to a JVM is used for forked execution. The default allocation is 512 MB. (-Xmx)
workerHeapSize	string	The amount of memory allocated to a JVM used for execution workers that use forked execution. The default allocation is 512 MB. (-Xmx)
partialUpdate	boolean	Specifies how forked execution properties are updated. The default value is false. If true, only the property values specified in the request are updated. All other existing properties remain unchanged. If false, you must provide all three heap sizes: runnerHeapSize, workerHeapSize, and browserHeapSize. Property values specified in the request are updated, while any other property values not included are removed.
runtimeId	string	Read-only. System-generated unique identifier of a runtime cluster or cloud cluster. To view the runtime ID in the UI, go to Manage > Runtime Management.

Supported operations

GET	QUERY	CREATE	UPDATE	EXECUTE	DELETE

Using the GET operation

Retrieves the details of forked execution properties of a runtime cluster or cloud cluster. Retrieving forked execution properties is an asynchronous process:

1. Send a GET request that specifies both the account ID and runtime ID to the Boomi Enterprise Platform:

   • US:

     https://api.boomi.com/api/soap/v1/<accountId>/async/ForkedExecutionProperties/<runtimeId>

   • GB:

     https://api.platform.gb.boomi.com/api/soap/v1/<accountId>/async/ForkedExecutionProperties/<runtimeId>

   The accountId is the ID of the authenticating account for the request, and runtimeId is the ID of the runtime.

2. The platform returns a token.

3. Send one or more GET requests that include the token:

   • US:

     https://api.boomi.com/api/soap/v1/<accountId>/async/ForkedExecutionProperties/response/<token>

   • GB:

     https://api.platform.gb.boomi.com/api/soap/v1/<accountId>/async/ForkedExecutionProperties/response/<token>

note

The runtime (cluster or cloud cluster) that you are calling must be online..

Initial GET response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <bns:asyncGetResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
            <bns:result responseStatusCode="202">
                <bns:asyncToken token="ForkedExecutionProperties-faf6d06f-0ad6-47a0-8487-311aa9868cfc"/>
            </bns:result>
        </bns:asyncGetResponse>
    </S:Body>
</S:Envelope>

Subsequent GET response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <bns:asyncResultResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
            <bns:results responseStatusCode="200">
                <bns:result xsi:type="bns:ForkedExecutionProperties" runtimeId="de97fe3a-4163-4cda-ab8c-a741595c1d75">
                    <bns:forkedExecutionStandardProperties runnerHeapSize="513m" workerHeapSize="514m" browserHeapSize="515m" clientDefaultConnectTimeout="600000" clientDefaultReadTimeout="600000" heapDumpOnOutOfMemoryError="true" preferIpv4Stack="true" retryHttpPost="false"/>
                    <bns:customSystemProperties>
                        <bns:property>-Dcom.boomi.container.property.enabled=true</bns:property>
                        <bns:property>-Dcom.boomi.container.property.timeout=5000</bns:property>
                    </bns:customSystemProperties>
                </bns:result>
            </bns:results>
        </bns:asyncResultResponse>
    </S:Body>
</S:Envelope>

Using the UPDATE operation

Adds, removes, or updates forked execution properties of a runtime cluster or cloud cluster. You need to provide at least one property to perform the update operation. The update operation includes the optional flag, partialUpdate. By default, it is set to false:

• If set to true, only the property values specified in the request are updated. All other existing properties remain unchanged. If set to false, property values specified in the request are updated, and all other properties not included in the request are removed.

Updates to runnerHeapSize, workerHeapSize, and browserHeapSize properties are saved in the appropriate vmoptions file: procrunner, procworker, or procbrowser. Any changes to other forked execution properties are saved in all three vmoptions files.

note

When partialUpdate is false, you must provide the heap size of the worker, runner, and browser in the request.

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
 <soapenv:Body>
      <api:update>
          <object xsi:type="api:ForkedExecutionProperties"
              runtimeId="de97fe3a-4163-4cda-ab8c-a741595c1d75"
              partialUpdate="false"
              xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
              <api:forkedExecutionStandardProperties 
                 runnerHeapSize="512m"
                 workerHeapSize="512m"
                 browserHeapSize="518m"
                 clientDefaultConnectTimeout="650000"
                 dnsTimeToLive="60 "
                 clientDefaultReadTimeout="250000"/>
              <api:customSystemProperties>
                  <api:property>-Dcom.boomi.container.property.enabled=true</api:property>
                  <api:property>-Dcom.boomi.container.property.timeout=5000</api:property>
              </api:customSystemProperties>
          </object>
      </api:update>
 </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
  <S:Body>
      <bns:updateResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
          <result xsi:type="bns:ForkedExecutionProperties" runtimeId="de97fe3a-4163-4cda-ab8c-a741595c1d75">
              <bns:forkedExecutionStandardProperties runnerHeapSize="512m" workerHeapSize="512m" browserHeapSize="518m" clientDefaultConnectTimeout="650000" clientDefaultReadTimeout="250000" dnsTimeToLive="60"/>
              <bns:customSystemProperties>
                  <bns:property>-Dcom.boomi.container.property.enabled=true</bns:property>
                  <bns:property>-Dcom.boomi.container.property.timeout=5000</bns:property>
              </bns:customSystemProperties>
          </result>
      </bns:updateResponse>
  </S:Body>
</S:Envelope>