.. _filtering_transactions: Filtering Transactions ---------------------- .. _20.1.1|VOSS-670|EKB-4802: .. _21.3-PB2|EKB-11638: Overview .......... A transaction filter is a logical AND operation based on column values in the Transactions list, defined as search criteria on the **Transaction Search Filter** dialog. Using Filters to Search for Transactions ........................................ 1. Log in to the VOSS Automate Admin Portal. 2. Go to (default menu) **Administration Tools > Transaction** to open the **Transaction** log. .. note:: * In the classic Admin GUI, you can also open the **Transaction** log via the toolbar **Notifications** icon. * In the Admin Portal, you can also open the **Transaction** log via the toolbar **Transaction Log** icon. 3. On the **Transactions** list view, inspect the list of parent transactions. You can click on a parent transaction to view details of the parent and its sub transactions. #. Open the search filter: * In the classic Admin GUI, to open the **Transaction Search Filter** dialog, either click the filter icon in the header row of the **Id** column, or click **Filter** at the bottom of the list. * In the Admin Portal, to open the **Filter** dialog, click the toolbar **Filter** icon. #. In the Filter dialog, specify search criteria for the transaction/s you wish to view: .. tabularcolumns:: |p{5cm}|p{10cm}| +-----------------------------+--------------------------------------------------------------------------------------+ | Field | Description | +=============================+======================================================================================+ | Transaction ID | Options depend on whether you're using the Admin Portal or the classic Admin GUI | | | | | | * Admin Portal: Enter a specific transaction ID, else, leave the field clear to | | | search on alternate criteria. | | | | | | * Legacy Admin GUI: | | | | | | * Equals (default). Filters only for an exact ID, and disables all other criteria. | | | | | | * Range. Filters for a range of IDs that match a start and end value. | | | | +-----------------------------+--------------------------------------------------------------------------------------+ | Include Sub Transactions | Apply filter criteria also to first level child transactions. Children of child | | | transactions (sub-transactions directly below the parent) are excluded. By default, | | | results show sub transactions above the parent (latest data on top) | +-----------------------------+--------------------------------------------------------------------------------------+ | Exclude System Transactions | Defines whether to exclude system-generated transactions (included by default); that | | | is, where the **Username** column value is ``system``. | | | | +-----------------------------+--------------------------------------------------------------------------------------+ | Status | Filter by transaction status. Options are: Any, Queued, Processing, Success, Success | | | with Async Failures, or Fail. | +-----------------------------+--------------------------------------------------------------------------------------+ .. tabularcolumns:: |p{5cm}|p{10cm}| +------------+--------------------------------------------------------------------------------------+ | Field | Description | +============+======================================================================================+ | Date Range | Predefined options are Last Day, Last Week, Last Month, or All. Alternatively, you | | | can specify a custom date range. | | | | | | When selecting a quick filter (Last Day, Last Week, Last Month), the next time the | | | filter is opened, the date selection displays as a Custom date range, since the | | | range is then less than the selected interval. | | | | | | When choosing a Custom date range: | | | | | | * In the Admin Portal, choose a start and end date from a date picker. | | | * In the legacy Admin GUI, choose a start date and time, and an end date and time. | | | | | | When specifying a start date, end date, and time, use a transaction date and time | | | range in the format of the system locale. For example, for language code | | | ``en-us``, the typed format is ``mm/dd/yyyy``. The number format "9" instead of | | | "09" is also valid. | | | | | | You can select a date range, or type in values. Time values can be selected for 15 | | | minute intervals, or type in values (the system locale format is default). | | | | | | Note that when adding filter criteria for Username, Detail, or Message (legacy Admin | | | GUI), filtering may be slower when the date range is greater than 7 days. | | | | | | The filter date/time is based on the browser local timezone, for example | | | GMT+0200. This time is converted to the UTC standard as used in the database. | | | (Time Conversion) | +------------+--------------------------------------------------------------------------------------+ | Action | Select an action to filter on, for example, ``Create Subscriber``, or start typing | | | to filter values in the drop-down. | +------------+--------------------------------------------------------------------------------------+ | Username | Case-insensitive field to filter on values in the **Username** column. | | | | +------------+--------------------------------------------------------------------------------------+ | Detail | Case-insensitive field to filter on values in the **Detail** column. | +------------+--------------------------------------------------------------------------------------+ | Message | Case-insensitive field to filter by text values in the **Message** column (legacy | | | Admin GUI). | | | | | | * For *failed transactions*, hover over the **Status** column to view a message, or | | | inspect it in the transaction detail view. | | | * Some *successful transactions* also show messages when viewing its details, for | | | example, data import and bulk load. | +------------+--------------------------------------------------------------------------------------+ (Time Conversion) |convert-transaction-time| .. note:: A filter timeout limits the filter search to 2 minutes. Try reducing the criteria to speed up filtering. Once you've viewed filtered results, remember to cancel or clear the filter to display all transactions in the log. Filters are also cleared when you log out. .. |convert-transaction-time| image:: /src/images/convert-transaction-time.png