Waiting for engine...
Skip to main content

Environment Process Configuration object

The Environment Process Configuration object manages configuration settings for individual processes that are deployed to a specific environment, such as an SDK listener worker. It supports viewing, querying, creating, updating, and bulk modification of these configurations.

When a configuration is saved or updated, the platform triggers internal messaging to the runtimes to save the settings to the file system. The runtime then updates and refreshes the necessary components.

Required privileges​

Read access (QUERY, queryMore)

Requires any of the following privileges:

  • ATOM_MANAGEMENT — Configure and administer integration runtimes.
  • ATOM_MANAGEMENT_READ_ONLY — Read only access to runtime configuration and administration.
  • ATOM_MANAGEMENT_READ_ONLY_NO_EXTENSIONS — Read only access to runtime configuration and administration, without the ability to view environment extensions.
  • ATOM_MANAGEMENT_NO_EXTENSIONS — Configure and administer integration runtimes, without the ability to view or edit environment extensions.

Write access (CREATE, UPDATE)

Requires one of the following privileges:

  • ATOM_MANAGEMENT — Configure and administer integration runtimes.
  • ATOM_MANAGEMENT_NO_EXTENSIONS — Configure and administer integration runtimes, without the ability to view or edit environment extensions.

You must also not have the following privilege in the target environment:

  • ENV_MANAGEMENT_READ_ACCESS — Read only access to environment configuration and administration.

Endpoint​

All objects and operations share a single SOAP endpoint per account.

POST:

  • US: https://api.boomi.com/api/soap/v1/<accountId>
  • GB: https://api.platform.gb.boomi.com/api/soap/v1/<accountId>

Where accountId is the ID of the authenticating account for the request.

Structure​

<EnvironmentProcessConfiguration>
   <environmentId></environmentId>
   <environmentName></environmentName>
   <processId></processId>
   <processName></processName>
   <createdDate></createdDate>
   <modifiedDate></modifiedDate>
   <listenerConfiguration>
      <maximumConcurrentExecutions></maximumConcurrentExecutions>
      <runInListenWorker></runInListenWorker>
   </listenerConfiguration>
   <message></message>
</EnvironmentProcessConfiguration>
FieldTypeDescription
environmentIdstringThe ID of the environment to which the process is deployed. Required to save, update, or delete a configuration.
environmentNamestringThe name of the environment. Read-only; populated by the platform in responses.
processIdstringThe ID of the process associated with this configuration. Required to save, update, or delete a configuration.
processNamestringThe name of the process. Read-only; populated by the platform in responses.
createdDatedateTimeISO 8601 timestamp of when the configuration was created. Read-only; set by the platform.
modifiedDatedateTimeISO 8601 timestamp of when the configuration was last modified. Read-only; set by the platform.
listenerConfiguration (child element)objectListener-specific configuration settings for the process. This is a child element, not an attribute. Contains maximumConcurrentExecutions and runInListenWorker.
maximumConcurrentExecutionsintSets how many executions the listener worker runs at once in the cloud. Executions over this limit are queued and are also limited by connector settings and quotas. Default is -1 (unlimited).
runInListenWorkerbooleanWhether the process uses a dedicated listener worker for connections. Applies to Runtime cloud runtimes only. Default is false.
messagestringA confirmation message returned by the platform after a successful CREATE or UPDATE operation. Read-only; not present on GET or QUERY results.

Supported operations​

GETQUERYqueryMoreCREATEUPDATEEXECUTEDELETEbulk
Not supportedSupportedSupportedSupportedSupportedNot supportedNot supportedNot supported

Using the QUERY operation​

You can use the following fields as QUERY filters for the Environment Process Configuration object:

FieldAllowed values
environmentIdAny string value.
processIdAny string value.

The operators allowed for the Environment Process Configuration object filters are:

  • BETWEEN
  • CONTAINS
  • EQUALS
  • GREATER_THAN
  • GREATER_THAN_OR_EQUAL
  • IN
  • IS_NOT_NULL
  • IS_NULL
  • LESS_THAN
  • LESS_THAN_OR_EQUAL
  • LIKE
  • NOT_CONTAINS
  • NOT_EQUALS
  • NOT_IN
  • STARTS_WITH

If the QUERY includes multiple filters, you can connect them with a logical AND or a logical OR operator. The request body is optional; when you omit it, the query returns all process configurations. For general information about the structure of QUERY filters, refer to the Query filters topic.

Using the queryMore operation​

If the QUERY response contains more than 100 records, use the queryToken from the query response to retrieve the next page of results. For more information, refer to the Query paging topic.

Using the CREATE operation​

The CREATE operation saves process configuration settings for a single process ID and the environment ID to which the process is deployed. The environmentId and processId you provide must be valid, and the specified process must already be deployed to the corresponding environment. You must also include a listenerConfiguration element with maximumConcurrentExecutions and runInListenWorker.

Using the UPDATE operation​

The UPDATE operation updates the process configuration settings for an existing configuration, identified by its environmentId and processId. As with CREATE, the environmentId and processId must be valid, the process must already be deployed to the environment, and you must include a listenerConfiguration element with maximumConcurrentExecutions and runInListenWorker.

SOAP implementation​

  • QUERY operation

    The following example query returns process configurations for environment 0c4d7b27-95f9-4117-99fe-11fe853e0757 and process bfe8d5d7-d53c-4a93-b09e-779e71a3b412.

    Request:

    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
       <soapenv:Header>
          <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
             <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
                <wsse:Username>user@boomi.com</wsse:Username>
                <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">password</wsse:Password>
             </wsse:UsernameToken>
          </wsse:Security>
       </soapenv:Header>
       <soapenv:Body>
          <api:query>
             <api:objectType>EnvironmentProcessConfiguration</api:objectType>
             <api:queryConfig>
                <api:QueryFilter>
                   <api:expression operator="and" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:GroupingExpression">
                      <api:nestedExpression operator="EQUALS" property="environmentId"
                         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
                         <api:argument>0c4d7b27-95f9-4117-99fe-11fe853e0757</api:argument>
                      </api:nestedExpression>
                      <api:nestedExpression operator="EQUALS" property="processId"
                         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
                         <api:argument>bfe8d5d7-d53c-4a93-b09e-779e71a3b412</api:argument>
                      </api:nestedExpression>
                   </api:expression>
                </api:QueryFilter>
             </api:queryConfig>
          </api:query>
       </soapenv:Body>
    </soapenv:Envelope>

    Response:

    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
          <bns:queryResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
             <bns:results numberOfResults="1">
                <bns:result xsi:type="bns:EnvironmentProcessConfiguration">
                   <bns:environmentId>0c4d7b27-95f9-4117-99fe-11fe853e0757</bns:environmentId>
                   <bns:environmentName>Local</bns:environmentName>
                   <bns:processId>bfe8d5d7-d53c-4a93-b09e-779e71a3b412</bns:processId>
                   <bns:processName>CustomSingleTonConnectorTest</bns:processName>
                   <bns:createdDate>2026-05-05T18:40:07Z</bns:createdDate>
                   <bns:modifiedDate>2026-05-05T18:49:41Z</bns:modifiedDate>
                   <bns:listenerConfiguration>
                      <bns:maximumConcurrentExecutions>10</bns:maximumConcurrentExecutions>
                      <bns:runInListenWorker>false</bns:runInListenWorker>
                   </bns:listenerConfiguration>
                </bns:result>
             </bns:results>
          </bns:queryResponse>
       </S:Body>
    </S:Envelope>

  • queryMore operation

    The following example retrieves the next page of results using a queryToken returned by a previous QUERY call.

    Request:

    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
       <soapenv:Header>
          <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
             <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
                <wsse:Username>user@boomi.com</wsse:Username>
                <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">password</wsse:Password>
             </wsse:UsernameToken>
          </wsse:Security>
       </soapenv:Header>
       <soapenv:Body>
          <api:queryMore>
             <api:queryToken>/nd0PlROcmuUK8MV8KPzCVXwA/pgZZ0NfsYjhqLNyothPzrFIh0OQLP6Hq3ERMSAl38Dz3NV5otJ/0+a....</api:queryToken>
          </api:queryMore>
       </soapenv:Body>
    </soapenv:Envelope>

    Response:

    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
          <bns:queryMoreResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
             <bns:results numberOfResults="1">
                <bns:result xsi:type="bns:EnvironmentProcessConfiguration">
                   <bns:environmentId>0c4d7b27-95f9-4117-99fe-11fe853e0757</bns:environmentId>
                   <bns:environmentName>Local</bns:environmentName>
                   <bns:processId>bfe8d5d7-d53c-4a93-b09e-779e71a3b412</bns:processId>
                   <bns:processName>CustomSingleTonConnectorTest</bns:processName>
                   <bns:createdDate>2026-05-05T18:40:07Z</bns:createdDate>
                   <bns:modifiedDate>2026-05-05T18:49:41Z</bns:modifiedDate>
                   <bns:listenerConfiguration>
                      <bns:maximumConcurrentExecutions>10</bns:maximumConcurrentExecutions>
                      <bns:runInListenWorker>false</bns:runInListenWorker>
                   </bns:listenerConfiguration>
                </bns:result>
             </bns:results>
          </bns:queryMoreResponse>
       </S:Body>
    </S:Envelope>

  • CREATE operation

    Request:

    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
       <soapenv:Header>
          <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
             <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
                <wsse:Username>user@boomi.com</wsse:Username>
                <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">password</wsse:Password>
             </wsse:UsernameToken>
          </wsse:Security>
       </soapenv:Header>
       <soapenv:Body>
          <api:create>
             <object xsi:type="api:EnvironmentProcessConfiguration" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <api:environmentId>0c4d7b27-95f9-4117-99fe-11fe853e0757</api:environmentId>
                <api:environmentName>Dev</api:environmentName>
                <api:processId>bfe8d5d7-d53c-4a93-b09e-779e71a3b412</api:processId>
                <api:processName>CustomSdkListener</api:processName>
                <api:listenerConfiguration>
                   <api:maximumConcurrentExecutions>5</api:maximumConcurrentExecutions>
                   <api:runInListenWorker>true</api:runInListenWorker>
                </api:listenerConfiguration>
             </object>
          </api:create>
       </soapenv:Body>
    </soapenv:Envelope>

    Response:

    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
          <bns:createResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
             <result xsi:type="bns:EnvironmentProcessConfiguration">
                <bns:environmentId>0c4d7b27-95f9-4117-99fe-11fe853e0757</bns:environmentId>
                <bns:environmentName>Dev</bns:environmentName>
                <bns:processId>bfe8d5d7-d53c-4a93-b09e-779e71a3b412</bns:processId>
                <bns:processName>CustomSdkListener</bns:processName>
                <bns:listenerConfiguration>
                   <bns:maximumConcurrentExecutions>5</bns:maximumConcurrentExecutions>
                   <bns:runInListenWorker>true</bns:runInListenWorker>
                </bns:listenerConfiguration>
                <bns:message>Process configuration is saved for the 0c4d7b27-95f9-4117-99fe-11fe853e0757 environment and configuration is sent to the runtimes</bns:message>
             </result>
          </bns:createResponse>
       </S:Body>
    </S:Envelope>

  • UPDATE operation

    Request:

    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
       <soapenv:Header>
          <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
             <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
                <wsse:Username>user@boomi.com</wsse:Username>
                <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">password</wsse:Password>
             </wsse:UsernameToken>
          </wsse:Security>
       </soapenv:Header>
       <soapenv:Body>
          <api:update>
             <object xsi:type="api:EnvironmentProcessConfiguration" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <api:environmentId>0c4d7b27-95f9-4117-99fe-11fe853e0757</api:environmentId>
                <api:environmentName>Dev</api:environmentName>
                <api:processId>bfe8d5d7-d53c-4a93-b09e-779e71a3b412</api:processId>
                <api:processName>CustomSdkListener</api:processName>
                <api:listenerConfiguration>
                   <api:maximumConcurrentExecutions>10</api:maximumConcurrentExecutions>
                   <api:runInListenWorker>false</api:runInListenWorker>
                </api:listenerConfiguration>
             </object>
          </api:update>
       </soapenv:Body>
    </soapenv:Envelope>

    Response:

    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
          <bns:updateResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
             <bns:result xsi:type="bns:EnvironmentProcessConfiguration">
                <bns:environmentId>0c4d7b27-95f9-4117-99fe-11fe853e0757</bns:environmentId>
                <bns:environmentName>Dev</bns:environmentName>
                <bns:processId>bfe8d5d7-d53c-4a93-b09e-779e71a3b412</bns:processId>
                <bns:processName>CustomSdkListener</bns:processName>
                <bns:listenerConfiguration>
                   <bns:maximumConcurrentExecutions>10</bns:maximumConcurrentExecutions>
                   <bns:runInListenWorker>false</bns:runInListenWorker>
                </bns:listenerConfiguration>
                <bns:message>Process configuration is updated for the 0c4d7b27-95f9-4117-99fe-11fe853e0757 environment and configuration is sent to the runtimes</bns:message>
             </bns:result>
          </bns:updateResponse>
       </S:Body>
    </S:Envelope>
On this Page