Transaction Logging and Audit#
Overview#
Transactions are a record of all activities that occur in VOSS Automate. You can inspect the summary list view of past and in-progress transactions in the Transaction Log, where you can drill into the details of a transaction and related sub-transactions, as well as view the logs to audit the transaction steps.
Related Topics
View a Transaction#
In the Transaction logs you can click on a transaction to view the transaction details, and if available for this transaction, any sub-transactions, as well as the logs.
Three tabs may be available for transaction details:
Details
Sub Transactions
Logs
Transaction Toolbar Actions#
When viewing the details of a transaction, while it’s in progress or complete, the following toolbar action may be available:
Refresh |
You can click the Refresh button while a transaction is running, to update its progress and status in realtime |
Auto-refresh |
Select Auto-refresh to automatically refresh the transaction progress and its status, every 5 seconds, while the transaction is running. |
Cancel |
You can cancel a transaction while it’s still running. The status of a cancelled transaction updates to Fail, with a message that says Transaction canceled. If you cancel a transaction that has sub-transactions, a currently in-progress sub-transaction will complete, and then this sub-transaction as well as any preceding sub-transactions will rollback to their previous states. However, for a cancelled bulk transaction, the system views each bulk load sub-transaction as a main transaction, and thus only the currently in-progress sub-transaction is rolled back to its previous state. |
Replay |
For completed transactions, you can click the Replay button to repeat (replay) the transaction, if required. For example, let’s say a transaction fails because a target system service was not running. In this case, you can replay the transaction instead of having to re-input data on the form in the Admin Portal. |
Edit and Replay |
Click Edit and Replay to first open the form that was used for input data prior to running a transaction. You can now make changes to the input data that was used, and then re-run the transaction. This is useful where, for example, incorrect input data causes a transaction to fail. Note the following:
|
Note
If the transaction queue service stops and is restarted, any queued transactions
will resume processing, while processing transactions will fail and displays the following message:
Transaction aborted due to queue service restart
.
Transaction - Details Tab#
This tab provides high level transaction details, such as the transaction ID, the user who initiated the transaction, duration, and so on.
The table describes the details available for transactions:
Field |
Description |
---|---|
Transaction ID |
Unique identifier for the transaction. |
Action |
The type of action recorded in the transaction, for instance Execute, Create, Modify, Data Import and so on. |
Detail |
A brief description of the processed transaction. |
User |
The user who initiated the transaction. |
Priority |
The priority of the transaction, for example Normal. |
Status |
For transactions to process, this is Queued. For running transactions, this is In Progress; for completed transactions it is Fail or Success. |
Message |
The message displayed upon completion of the transaction. |
Submitted Time, Started Time and Completed Time |
The date and time indicating the transaction progress. |
Submitted on Node |
The host name of the application node that scheduled the transaction. On a clustered system, this can differ from the ‘Processed on Node’ name below. |
Processed on Node |
The host name of the application node that processed the transaction (this value will only be set once the transaction is processed). On a clustered system, this can differ from the ‘Submitted on Node’ name above. |
Rolled Back |
Indicates whether the transaction was rolled back or not. |
Duration |
The duration of the selected transaction. If there are sub-transactions, this parent transaction duration is the total duration of the transaction. This includes the total duration of import transactions that carry out provisioning workflows asynchronously. |
Transaction - Sub-transactions Tab#
Sub-transactions display in a list for transactions that have sub-transactions:
On the Admin Portal, the sub-transaction list will show below the transaction details if there are 10 or less sub-transactions. Otherwise, a Sub Transactions tab is available on the form to list sub-transactions. A navigator bar and list page show at the bottom of the list.
On the Legacy Admin GUI, the sub-transaction list will show below the transaction details and if there are more than 10 sub-transactions, a list length (Items/page) and pager (Page n of m (k items)) is available.
Sub-transactions also contain links to their details and the sub-transaction form displays a link to its parent transaction.
Failed transactions show a Message of the error. However, a sub-transaction with a Create action that has a “fail on error” workflow condition for duplicates, may show its Status as Fail when not creating a duplicate, while the parent transaction then shows its Status as Success.
For asynchronous transactions and sub-transactions, refer to Parent and Sub-transactions for Asynchronous Transactions.
Transaction - Logs Tab#
The Logs tab displays a time stamp, Message and Severity details of transactions.
If the Severity has the status of error
, the Message section can be expanded
to inspect the error, and optionally copy it and send it to Support.
If a workflow is inspected, a separate log entry provides details of each step with a log message as Step n, starting with Step 0.
Resource or Record#
Depending on the transaction type, an option is available to navigate to the original record where a resource changed.