RuntimeProperties object

The RuntimeProperties object lets you manage and configure runtime and system properties, including custom runtime and system properties, across runtimes (basic runtime, runtime cloud, and local cluster).

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

Field	Type	Description
standardProperties	object	Runtime-specific settings. For more information about Standard Properties, refer to Basic and Advanced Properties
systemProperties	object	System properties are settings that apply to the Java Virtual Machine (JVM) and its configuration.
customRuntimeProperties	object	User-defined runtime properties to configure a basic runtime, runtime cloud, or a local cluster. Required for specific use cases or as directed by Boomi Support.
customSystemProperties	object	User-defined properties to configure JVM-specific settings used by the runtime.
partialUpdate	boolean	Supplied only in an UPDATE operation. Determines how existing container properties get updated. By default, it is set to false. If set to true, only the property values specified in the request get updated. All other existing properties within the container will remain unchanged, and any new custom properties will be appended to the existing ones. If set to false, property values specified in the request get updated. However, other standard and system property values not included in the request are reset to their default values, and unspecified custom properties are removed.
shouldRestartRuntime	boolean	By default, it is set to false. Setting the flag to true triggers a runtime restart after the runtime properties are updated. Setting the flag to false updates the runtime properties without initiating a runtime restart.
runtimeId	string	Read-only. System-generated unique identifier of the runtime.

Supported operations

GET	QUERY	CREATE	UPDATE	EXECUTE	DELETE

Using the GET operation

Retrieves the details of standard and system properties, and custom runtime and system properties of a specific runtime. Retrieving runtime and system properties is an asynchronous process:

Send a GET request that specifies both the account ID and runtime ID to the Boomi Enterprise Platform. https://api.boomi.com/api/soap/v1/<accountId>/async/RuntimeProperties/<runtimeId>
The accountId is the ID of the authenticating account for the request, and runtimeId is the ID of the runtime.
The platform returns a token.
Send one or more GET requests that include the token. https://api.boomi.com/api/soap/v1/<accountId>/async/RuntimeProperties/response/<token>
The platform returns a list of the properties associated with the specific runtime.

note

The runtime 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="RuntimeProperties-685ebf65-3b87-42fa-ba0d-7200e2ece06e"/>
            </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:RuntimeProperties" runtimeId="de97fe3a-4163-4cda-ab8c-a741595c1d75">
                    <bns:standardProperties containerHostName="192.168.1.9" containerForceRestart="0" useLocalStorageForRuntimeAssets="false" workingDataLocalStorageDirectory="/opt/boomi/local" clusterNetworkTransportType="UNICAST" debugLogging="true" standardOutputAndErrorLogging="true" executionWorkersEnabled="true" forceStartSharedWebServer="true" maxForkedExecutionTimeInCloud="120000" containerName="Local_Cloud_12_Dec" containerPurgeImmediately="false" containerPurgeDays="30"/>
                    <bns:systemProperties heapSize="512m" clientDefaultConnectTimeout="120000" clientDefaultReadTimeout="120000" javaClassPathPrepend="/usr/lib/jvm/java-11-amazon-corretto/lib/tools.jar" javaSecurityCompatibility="JVM_DEFINED" jgroupsClusteredLibraryVersion="3" jmxRemoteAuthentication="false" jmxRemotePort="6005" jmxRemoteSsl="false" preferIpv4Stack="true" retryHttpPost="true"/>
                    <bns:customRuntimeProperties>
                        <bns:property name="com.boomi.container.is.orchestrated.container" value="true"/>
                        <bns:property name="com.boomi.container.cloudlet.findInitialHostsTimeout" value="1"/>
                        <bns:property name="com.boomi.container.account.schedule.defaultTimeZone" value="Asia/Calcutta"/>
                        <bns:property name="com.boomi.container.enableUI" value="false"/>
                        <bns:property name="com.boomi.container.usePlatformUrlForFeatureDownload" value="true"/>
                    </bns:customRuntimeProperties>
                    <bns:customSystemProperties>
                        <bns:property>-Dcom.sun.management.jmxremote</bns:property>
                        <bns:property>-Dcom.sun.management.jmxremote.local.only=false</bns:property>
                        <bns:property>-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5005</bns:property>
                    </bns:customSystemProperties>
                </bns:result>
            </bns:results>
        </bns:asyncResultResponse>
    </S:Body>
</S:Envelope>

Using the UPDATE operation

Adds, removes, or updates standard and system properties, as well as custom runtime and system properties for runtimes, through a single API call. The update operation includes the optional flags, partialUpdate and shouldRestartRuntime.

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:RuntimeProperties"
              runtimeId="edfbe7a2-8ffa-4079-84b3-3f469c5ee8e5"
              partialUpdate="true"
              shouldRestartRuntime="true"
              xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
              <api:standardProperties 
                  containerHostName="cloud_cluster2"
                  containerForceRestart="0"
                  useLocalStorageForRuntimeAssets="false"
                  workingDataLocalStorageDirectory="/opt/boomi/local"
                  clusterNetworkTransportType="UNICAST"
                  debugLogging="true"
                  standardOutputAndErrorLogging="true"
                  forceStartSharedWebServer="true"
                  containerName="cloud_cluster2"
                  containerPurgeImmediately="false"
                  containerPurgeDays="37"/>
              <api:systemProperties 
                  heapSize="513m"
                  clientDefaultConnectTimeout="120001"
                  clientDefaultReadTimeout="120000"
                  javaClassPathPrepend="/usr/lib/jvm/java-11-amazon-corretto/lib/tools.jar"
                  javaSecurityCompatibility="JVM_DEFINED"
                  jgroupsClusteredLibraryVersion="3"
                  jmxRemoteAuthentication="false"
                  jmxRemotePort="6005"
                  jmxRemoteSsl="false"
                  preferIpv4Stack="true"
                  retryHttpPost="false"/>
              <api:customRuntimeProperties>
                  <api:property name="com.boomi.container.is.orchestrated.container" value="true"/>
                  <api:property name="com.boomi.container.enableUI" value="false"/>
                  <api:property name="com.boomi.container.metrics.enabled" value="false"/>
                  <api:property name="com.boomi.container.enableRuntimeRestartOnRuntimePropsUpdate" value="true"/>
              </api:customRuntimeProperties>
              <api:customSystemProperties>
                  <api:property>-Dcom.sun.management.jmxremote</api:property>
                  <api:property>-Dcom.sun.management.jmxremote.local.only=true</api:property>
                  <api:property>-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5005</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:RuntimeProperties" runtimeId="edfbe7a2-8ffa-4079-84b3-3f469c5ee8e5">
              <bns:standardProperties containerHostName="cloud_cluster2" containerForceRestart="0" useLocalStorageForRuntimeAssets="false" workingDataLocalStorageDirectory="/opt/boomi/local" clusterNetworkTransportType="UNICAST" debugLogging="true" standardOutputAndErrorLogging="true" forceStartSharedWebServer="true" containerName="cloud_cluster2" containerPurgeImmediately="false" containerPurgeDays="37"/>
              <bns:systemProperties heapSize="513m" clientDefaultConnectTimeout="120001" clientDefaultReadTimeout="120000" javaClassPathPrepend="/usr/lib/jvm/java-11-amazon-corretto/lib/tools.jar" javaSecurityCompatibility="JVM_DEFINED" jgroupsClusteredLibraryVersion="3" jmxRemoteAuthentication="false" jmxRemotePort="6005" jmxRemoteSsl="false" preferIpv4Stack="true" retryHttpPost="false"/>
              <bns:customRuntimeProperties>
                  <bns:property name="com.boomi.container.is.orchestrated.container" value="true"/>
                  <bns:property name="com.boomi.container.enableUI" value="false"/>
                  <bns:property name="com.boomi.container.metrics.enabled" value="false"/>
                  <bns:property name="com.boomi.container.enableRuntimeRestartOnRuntimePropsUpdate" value="true"/>
              </bns:customRuntimeProperties>
              <bns:customSystemProperties>
                  <bns:property>-Dcom.sun.management.jmxremote</bns:property>
                  <bns:property>-Dcom.sun.management.jmxremote.local.only=true</bns:property>
                  <bns:property>-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5005</bns:property>
              </bns:customSystemProperties>
          </result>
      </bns:updateResponse>
  </S:Body>
</S:Envelope>

Supported operations​

Using the GET operation​

Using the UPDATE operation​

Supported operations

Using the GET operation

Using the UPDATE operation