[Index]
To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com
Activity on the VOSS Automate system results in transactions that are recorded. The Transaction list view provides auditing information for each transaction.
View specific transaction details by clicking on a transaction. The Back button on the button bar (or the See all transactions link on the transaction details screen) can be used to navigate to the previous screen, for example from the parent transaction screen to the list view of all transactions.
Details
Information recorded includes data such as:
| Info | Details |
|---|---|
| Transaction ID | Identifier of 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. |
On the Admin Portal, details of a specific transaction are displayed when the transaction is selected from the list view. Refer to Bulk Load Transactions.
When a transaction is selected, the Base tab shows details of the columns of the transaction list view. The button bar on the detail list view shows Help and Refresh buttons if the transaction is still running.
If the transaction is running, click the Refresh button to update the Progress field. On the Admin Portal, a Auto-refresh check box is also available to automatically update the progress every 5 seconds.
Lists of transactions and sub-transactions can also be filtered. Refer to "Filtering Lists" and "Filtering Transactions" for details.
Note
If the transaction queue service stops and is restarted, any queued transactions will resume processing, while processing transactions will fail and show a message: Transaction aborted due to queue service restart.
Cancel
If you want to cancel a transaction while it is still running, click the Cancel button. If a transaction is cancelled, its Status is marked as Fail and the Message field shows Transaction canceled.
If a transaction, with sub-transactions, is canceled, the sub-transaction currently in progress will complete. This sub-transaction as well as all preceding sub-transactions will then roll back to their previous states. Note that bulk load transactions do not follow this behavior. Each bulk load sub-transaction is seen as a main transaction, and only the 'in progress' sub-transaction will roll back to its previous state.
Replay
A Replay button is available if the transaction is complete. A transaction can be replayed if required, for example if a transaction failed because a target system service was not running. The replay of the transaction can then be used instead of re-entering data on an Admin Portal form.
Edit and Replay
An Edit and Replay button is also available for completed transactions. This is similar to the Replay button, but allows you to first make changes to the previously submitted form before the transaction is resubmitted.
The button is available for transactions that did not originate from bulk loads, or pop-up forms.
Edit and Replay opens the original input form that resulted in the transaction. The form also contains the original data that was posted. This data can be edited and the form can be submitted to replay the transaction. This functionality can therefore be used to for example edit a failed transaction or to modify data of a successful transaction.
Since GUI Rules apply to a form from a specific hierarchy, the Edit and Replay functionality should only be used from the same hierarchy as the original transaction was executed.
Note
Replay and Edit and Replay functionality are not supported by the bulk loader, because the bulk load files are not stored by default. The bulk loader extracts data from the spreadsheets and then performs the necessary action(s). The only time a bulk load file is stored in the database is when the bulk load is scheduled. In this case, the bulk loader keeps the file until it is triggered by the scheduler to execute the actions in the file. When the data is extracted from the file, it is deleted.
When using Edit and Replay for a failed Quick Add Subscriber transaction, the following user information fields will not automatically update when changing the Username field:
These need to be edited manually.
Sub-transactions
If a transaction has sub-transactions, a sub-transaction list 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.
Logs
The Logs section 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.
You can only view transactions that are relevant to your specific hierarchy level. For instance, if you are logged into the system as a Customer Administrator you will be able to view all transactions that were performed at the customer for which you are the administrator. This includes transactions that were performed at any of the sites that belong to the customer. If you are logged in as a Site Administrator you will be able to view only the transactions that were performed at your specific site. Refer to the topic on Data Partitioning in the Core Feature Guide and to the API Guide to view transactions by means of the API. The steps below can be followed on the Admin Portal.
Choose Administration Tools > Transaction.
By default, the Transaction list view shows all parent transactions in progress or executed. This is indicated in the Status column of the list.
If you also want to see the child transactions (sub-transactions) in the list view, select the parent transaction. The list view shows both parent and sub-transactions.
For completed transactions, the Status column displays either Success, Success With Async Failures, or Fail. Failed transactions are highlighted in red by default, but this can be overridden in the Theme if required. An exclamation icon is also displayed next to the word Fail.
The Detail column provides additional details on the transaction if available. See "Transaction Details" for more information.
Click an individual transaction or sub-transaction (if required) to show a detailed view. If the top-level transaction has the status Success With Async Failures, the list of failed async transactions show below the list of sub-transactions. The failed async transactions can be at any level below the top-level transaction. Click the transaction to see the details of the failed async transaction(s). The Detail also shows the number of failed async transactions.
The transaction log is available on the user interface after a bulk load transaction has been run. Refer to the topics on transactions and viewing transactions in the documentation.
Go to the Transaction menu. Bulk load transactions show in the log:
In the list view, the bulk load is shown in the Action column of the log. If the bulk load was scheduled, this is shown as a schedule with the detail column indicating it to be a bulk load. The Action column will show "Execute Bulk Load" or "Execute Schedule" respectively.
The submitted, start and stop time for the entire bulk load transaction is also shown.
The Detail section will hold the name of the file that is bulk loaded as well as the workbook sheet number and the number of successful rows out of the total, for example:
[ 8/9 ] succeeded from [ 1 ] sheet in data_Users_bulkloadsheet.xlsx.
Checks are made to validate the user's access profile, the provided hierarchy information and data constraints for the bulk load transaction when updating the target models. The parent bulk load transaction will show the error message if this validation fails and no rows will be loaded.
Where rows are loaded, each row in the bulk load sheet appears as a sub-transaction within the bulk load transaction. The Message box shows the number of successful and failed rows loaded.
For each loaded sheet, bulk load transactions are run in series for each row. Multiple bulk load sheets can be loaded and these transactions will load in parallel.
Sheet rows can be processed in parallel. The sheet should then not contain multiple, sequence dependent models. Refer to Bulk Load Sheet Layout.
For each row of the bulk load sheet carrying out the default add action, a Create action is shown on the list of transactions. Sheet rows that led to a successful Create action have a Success status, while rows that failed show a Fail status. If a row fails, the load process continues. For failed actions, the transaction can be selected to show the error message.
If one or more rows of the sheet failed to load, the Bulk Load Sub Transaction shows a Success status, while the Log list will show "error" for failed rows.
On the list of sub transactions, you can inspect the details of each sub transaction. For example, the submitted, start, and stop time for the bulk load sub transaction corresponding with a row on the bulk load sheet is shown. In the case of a failed sub transaction, further information about the failure - such as the error message and row data - is shown in the sub transaction.
A canceled bulk load transaction means the Processing worksheet sub transaction, as well as all sub transactions within the worksheet transaction in a Processing or Queued state, will fail.
For parallel transactions, multiple resource transactions may be in a Queued or Processing state. By default, 14 rows are processed in parallel. Refer to Bulk Load Sheet Layout for more details. If a worksheet transaction fails as a result of bulk load transaction cancellation, subsequent worksheet tabs in the bulk load workbook will not be processed by the bulk loader.
| Title | Description | Details |
|---|