Download Atom worker log operation

The Download Atom worker log operation allows users to programmatically retrieve a link for downloading a given Execution worker's log.

When a Cloud owner enables the Enable Download of Execution Artifacts and Worker Logs property on the Cloud Attachment Quotas tab (Cloud Management) of the Integration user interface, account users can employ the Download Execution worker log operation to retrieve a download link for viewing a specific Execution worker**'s logs.

The functionality provided by the Download Execution worker log operation is similar to downloading Execution worker logs from the Workers panel in the Integration user interface (Manage > Runtime Management > select a Runtime cloud > Workers panel > Actions menu).

Retrieving an Execution worker log is an asynchronous process:

1. The client sends a CREATE or POST request to the Boomi Enterprise Platform API that specifies a Cloud ID in the endpoint and an Execution worker** ID in the request body.

2. The Enterprise platform returns a download URL for the specified Execution worker and a status code 202 while the request is in progress.

3. To download the link to your web browser, press CTRL and then left-click on the link.

   note

   You can also copy and paste the link into your web browser to start the download. You might need to enter your sign-in credentials.

4. The Enterprise platform downloads the SoaWorkerLog_log.zip file to the your local Downloads folder. You can open the Execution worker logs by extracting the zipped file.

Structure

POST request body:

<AtomWorkerLog xmlns="http://api.platform.boomi.com/" workerId=""/>

POST response:

<bns:LogDownload url="https://qa.boomi.com/account/..." message="" url="" statusCode=""/>

Field	Type	Description
Filter	Filter	Filter
message	string	A message stating that the download is initiated.
statusCode	string	The 202 status code returned from a POST or CREATE request that the link download started and is in progress.
url	string	The URL that initiates the Execution worker log download to local storage.
workerId	string	The name of an Execution worker. Locate the name of an Execution worker by navigating to the Workers panel in Manage > Runtime Management on the user interface.

Supported operations

GET	QUERY	CREATE	UPDATE	EXECUTE	DELETE
Not Supported	Not Supported	Supported	Not Supported	Not Supported	Not Supported

Using the CREATE operation

• You must have the Runtime Management privilege to perform the CREATE operation. If you have the Runtime Management Read Access privilege, you cannot download Execution worker logs.

• Additionally, as the Cloud owner, you must enable the Enable Download of Execution Artifacts and Worker Logs property for your account or tenant. This property permits you to download Execution worker log files, and is accessed on the Cloud Attachment Quota tab of Runtime Management > Cloud Management.

• After providing the endpoint and a request body containing the Execution worker ID, the CREATE response returns a download URL that you can open (or copy and paste) in your web browser, which initiates the log file download to your local drive.

SOAP implementation

CREATE operation

Sample SOAP request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
<soapenv:Header/>
<soapenv:Body>
      <api:create>
         <object xsi:type="api:AtomWorkerLog" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             workerId="worker-1c2345c-b6e7-8f9f-01e-2345678ad91-2020.08.31">
         </object>
      </api:create>
</soapenv:Body>
</soapenv:Envelope>

Sample SOAP response:

<?xml version='1.0' encoding='UTF-8'?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <bns:createResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
            <result xsi:type="bns:LogDownload" url="https://qa.boomi.com/account/account-123/api/download/SoaWorkerLog-cc12c34d-56e7-89d6-b012-3bb45678a9b" message="Beginning download." statusCode="202"/>
        </bns:createResponse>
    </S:Body>
</S:Envelope>