Previous Topic: getPendingUserInteractionsNext Topic: getProcessStatus

SOAP API Reference › Web Services Methods › getProcessLogs

getProcessLogs

Use this method to get the logs of a process instance.

Message Levels

CA Process Automation process instance logs display the following message levels:

Message Categories

CA Process Automation process instances have the following message categories:

Process

Logs messages for a process instance.

Operator

Logs messages for operators in process.

Handler

Logs messages when lane change or exception handler is invoked.

Response

Logs messages when agents send a response back to the Orchestrator.

Custom

When you log messages without any category, these messages are grouped in the Custom category. You can provide the category as Custom to retrieve such messages.

Custom Messages

You can define your own categories for logging. For example:

logEvent(3, "SD_MESSAGES", "this messages is logged for Service Desk operators "

To retrieve such messages, specify the category as  SD_MESSAGES in the request.

To retrieve log messages

Use the following SOAP request:

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<tns:getProcessLogs xmlns:tns="http://www.ca.com/itpam">
<tns:auth>

	<!--xsd:Choice Type-->
	<tns:token>token__</tns:token>

<tns:user>Joe</tns:user>
<tns:password>thisismypassword</tns:password>
<tns:auth>
<tns:processID>72</tns:processID>
<tns:filter>
<tns:level>2</tns:level>
<tns:categories>
<tns:category>process</tns:category>
<tns:category>operator</tns:category>
<tns:category>handler</tns:category>
<tns:category>response</tns:category>
<tns:category> SD_MESSAGES </tns:category>
</tns:categories>
</tns:filter>
</tns:getProcessLogs>
</SOAP-ENV:Body></SOAP-ENV:Envelope>

<level> </level> can have a value of error, warning, notice, and normal.

If the user specifies the level as “normal”, all messages with a level of normal and above are retrieved.

When the error is at the top-most level and the user specifies the level as “error”, only messages with the “error” level are retrieved.

If the user specifies an invalid level, it is treated as normal (the lowest level).

To retrieve logs with multiple categories:

        <tns:categories>
          <tns:category>userMsg</tns:category>
          <tns:category>process</tns:category>
        </tns:categories>

In this example, all messages with the category “userMsg” and “process” are retrieved. Only log messages that match the level and one of the categories are returned.

Example

<tns:getProcessLogs xmlns:tns="http://www.ca.com/itpam">
<tns:auth>
<!--xsd:Choice Type-->
<tns:user>Joe</tns:user>
<tns:password>thisismypassword</tns:password>
<tns:auth>
<tns:processID>72</tns:processID>
<tns:filter>
<tns:level>2</tns:level>
<tns:categories>
<tns:category>process</tns:category>
<tns:category>operator</tns:category>
<tns:category>handler</tns:category>
<tns:category>response</tns:category>
</tns:categories>
</tns:filter>
</tns:getProcessLogs>

SOAP Request

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<tns:getProcessLogs xmlns:tns="http://www.ca.com/itpam">
<tns:auth>
<tns:user>Joe</tns:user>
<tns:password>thisismypassword</tns:password>
<tns:auth>
<tns:processID>72</tns:processID>
<tns:filter>
<tns:level>2</tns:level>
<tns:categories>
<tns:category>process</tns:category>
<tns:category>operator</tns:category>
<tns:category>handler</tns:category>
<tns:category>response</tns:category>
</tns:categories>
</tns:filter>
</tns:getProcessLogs>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

SOAP Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<getProcessLogsResponse xmlns="http://www.ca.com/itpam">
<processLogs>
<processlog category="Process" level="Notice">
<logMessage>'LaneChangeHandler_30_72' instance was created.</logMessage>
<time>2012-03-01T13:18:43.248+05:30</time>
</processlog>
<processlog category="Process" level="Notice">
<logMessage>'LaneChangeHandler_30_72' is in 'Queued' state.</logMessage>
<time>2012-03-01T13:18:43.248+05:30</time>
</processlog>
<processlog category="Process" level="Notice">
<logMessage>Process started at '03/01/2012 13:18:43' by 'pamadmin'.</logMessage>
<time>2012-03-01T13:18:43.592+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Start_Script_1' is enabled following 'Start_1'.</logMessage>
<time>2012-03-01T13:18:43.639+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Start_1' is 'Completed' on 'Current Server'.</logMessage>
<time>2012-03-01T13:18:43.639+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>A service request was sent for 'Start_Script_1'.</logMessage>
<time>2012-03-01T13:18:44.123+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Start_Script_1' is 'Running' on 'Current Server'.</logMessage>
<time>2012-03-01T13:18:44.139+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Start_Script_1' is 'Completed'</logMessage>
<time>2012-03-01T13:18:47.904+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Start_Script_1_1' is enabled following 'Start_Script_1'.</logMessage>
<time>2012-03-01T13:18:47.935+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Lane_Change_1' was reset.</logMessage>
<time>2012-03-01T13:18:47.982+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Calculation_1' was reset.</logMessage>
<time>2012-03-01T13:18:47.998+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Lane_Change_2' was reset.</logMessage>
<time>2012-03-01T13:18:48.014+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Calculation_1_1' was reset.</logMessage>
<time>2012-03-01T13:18:48.029+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Lane_Change_3' was reset.</logMessage>
<time>2012-03-01T13:18:48.029+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Calculation_1_2' was reset.</logMessage>
<time>2012-03-01T13:18:48.045+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Calculation_1' is enabled following 'Lane_Change_1'.</logMessage>
<time>2012-03-01T13:18:48.045+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Lane_Change_1' is 'Completed' on 'Current Server'.</logMessage>
<time>2012-03-01T13:18:48.060+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>A service request was sent for 'Calculation_1'.</logMessage>
<time>2012-03-01T13:18:48.092+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Calculation_1' is 'Running' on 'Current Server'.</logMessage>
<time>2012-03-01T13:18:48.092+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Calculation_1' is 'Completed'</logMessage>
<time>2012-03-01T13:18:48.576+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>A service request was sent for 'Start_Script_1_1'.</logMessage>
<time>2012-03-01T13:18:48.639+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Start_Script_1_1' is 'Running' on 'Current Server'.</logMessage>
<time>2012-03-01T13:18:48.654+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Start_Script_1_1' is 'Completed'</logMessage>
<time>2012-03-01T13:18:49.060+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Start_Script_1_2' is enabled following 'Start_Script_1_1'.</logMessage>
<time>2012-03-01T13:18:49.076+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Lane_Change_1' was reset.</logMessage>
<time>2012-03-01T13:18:49.154+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Calculation_1' was reset.</logMessage>
<time>2012-03-01T13:18:49.170+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Lane_Change_2' was reset.</logMessage>
<time>2012-03-01T13:18:49.201+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Calculation_1_1' was reset.</logMessage>
<time>2012-03-01T13:18:49.217+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Lane_Change_3' was reset.</logMessage>
<time>2012-03-01T13:18:49.217+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Calculation_1_2' was reset.</logMessage>
<time>2012-03-01T13:18:49.248+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Calculation_1_1' is enabled following 'Lane_Change_2'.</logMessage>
<time>2012-03-01T13:18:49.248+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Lane_Change_2' is 'Completed' on 'Current Server'.</logMessage>
<time>2012-03-01T13:18:49.248+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>A service request was sent for 'Calculation_1_1'.</logMessage>
<time>2012-03-01T13:18:49.279+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Calculation_1_1' is 'Running' on 'Current Server'.</logMessage>
<time>2012-03-01T13:18:49.295+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Calculation_1_1' is 'Completed'</logMessage>
<time>2012-03-01T13:18:49.639+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>A service request was sent for 'Start_Script_1_2'.</logMessage>
<time>2012-03-01T13:18:49.701+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Start_Script_1_2' is 'Running' on 'Current Server'.</logMessage>
<time>2012-03-01T13:18:49.701+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Start_Script_1_2' is 'Completed'</logMessage>
<time>2012-03-01T13:18:50.123+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Start_Script_1_3' is enabled following 'Start_Script_1_2'.</logMessage>
<time>2012-03-01T13:18:50.154+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Lane_Change_1' was reset.</logMessage>
<time>2012-03-01T13:18:50.217+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Calculation_1' was reset.</logMessage>
<time>2012-03-01T13:18:50.248+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Lane_Change_2' was reset.</logMessage>
<time>2012-03-01T13:18:50.264+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Calculation_1_1' was reset.</logMessage>
<time>2012-03-01T13:18:50.279+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Lane_Change_3' was reset.</logMessage>
<time>2012-03-01T13:18:50.310+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Calculation_1_2' was reset.</logMessage>
<time>2012-03-01T13:18:50.326+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Calculation_1_2' is enabled following 'Lane_Change_3'.</logMessage>
<time>2012-03-01T13:18:50.342+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Lane_Change_3' is 'Completed' on 'Current Server'.</logMessage>
<time>2012-03-01T13:18:50.342+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>A service request was sent for 'Calculation_1_2'.</logMessage>
<time>2012-03-01T13:18:50.373+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Calculation_1_2' is 'Running' on 'Current Server'.</logMessage>
<time>2012-03-01T13:18:50.373+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Calculation_1_2' is 'Completed'</logMessage>
<time>2012-03-01T13:18:50.842+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>A service request was sent for 'Start_Script_1_3'.</logMessage>
<time>2012-03-01T13:18:51.107+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Start_Script_1_3' is 'Running' on 'Current Server'.</logMessage>
<time>2012-03-01T13:18:51.123+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Start_Script_1_3' is 'Completed'</logMessage>
<time>2012-03-01T13:18:55.982+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Normal_Stop_1' is enabled following 'Start_Script_1_3'.</logMessage>
<time>2012-03-01T13:18:56.014+05:30</time>
</processlog>
<processlog category="Operator" level="Notice">
<logMessage>'Normal_Stop_1' is 'Completed' on 'Current Server'.</logMessage>
<time>2012-03-01T13:18:56.060+05:30</time>
</processlog>
<processlog category="Process" level="Notice">
<logMessage>Process is 'Completed'.</logMessage>
<time>2012-03-01T13:18:56.060+05:30</time>
</processlog>
</processLogs>
</getProcessLogsResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>