Get Transaction Count
Get Transaction Count is a component that retrieves transaction counts based on the associated project. It can be used for monitoring and reporting transactions for a specific queue and date range, with results available in message, JSON, or DataFrame format.
When Tool Mode is enabled, the component is exposed as a tool that an Agent can invoke to retrieve transaction count information when required.
Parameters
| Parameter | Description |
|---|---|
| Transaction Status | Specifies the transaction status for which the count is retrieved. |
| From Date Time | Specifies the start date and time for retrieving transactions. The date format is MM/DD/YYYY. |
| To Date Time | Specifies the end date and time for retrieving transactions. The date format is MM/DD/YYYY. |
| Queue Name | Specifies the queue from which transaction counts are retrieved. |
| Actions |
Specifies the format in which the transaction count is returned. Available only in Tool Mode. GET_TRANSACTION_COUNT_MESSAGE – Returns the transaction count as a message. GET_TRANSACTION_COUNT_JSON – Returns the transaction count as structured JSON data. GET_TRANSACTION_COUNT_DATAFRAME – Returns the transaction count as a DataFrame for tabular data processing. |
| Timeout (Seconds) | Specifies the maximum time, in seconds, the component waits for the API request or other blocking operation to complete. Default: 30 seconds. |
| Retry Count | Specifies the number of times the component retries the operation when an execution attempt fails. Default: 1. |
| Delay Between Retries (Seconds) | Specifies the time, in seconds, to wait between consecutive retry attempts. Default: 1 second. |
| Delay Before Execution (Seconds) | Specifies the time, in seconds, to wait before the component starts execution. Default: 0 seconds. |
| Delay After Execution (Seconds) | Specifies the time, in seconds, to wait after the component completes execution. Default: 0 seconds. |
| Continue on Error |
Determines the behavior when an unrecoverable error occurs. Stop Workflow – Halts workflow execution. Continue – Skips the current step and continues workflow execution without passing the error downstream. Continue Using Error Output – Continues workflow execution and routes the error details through the error output handle. |
Outputs
| Output | Description |
|---|---|
| Message | Returns the transaction count as a message output. |
| JSON Data | Returns the transaction count as structured JSON data for use in downstream components. |
| DataFrame | Returns the transaction count as a tabular DataFrame for further data processing. |
How It Works
1. Specify the required Transaction Status.
2. Specify the From Date Time and To Date Time to define the transaction retrieval period.
3. Select the required Queue Name.
4. Configure the Timeout, Retry Count, and execution delays as required.
5. Configure Continue on Error to define how the workflow should behave if transaction retrieval fails.
6. Execute the component to retrieve the transaction count that matches the configured criteria.
Tool Mode
When Tool Mode is enabled, Get Transaction Count is exposed as a callable tool for the Agent.
1. Specify the From Date Time and To Date Time.
2. Select the required Action.
3. The Agent invokes the tool when transaction count information is required.
4. The component retrieves the transaction count for the associated project.
5. The result is returned in the format specified by the selected action:
a. GET_TRANSACTION_COUNT_MESSAGE – Message
b. GET_TRANSACTION_COUNT_JSON – JSON
c. GET_TRANSACTION_COUNT_DATAFRAME – DataFrame
The Agent can use the returned transaction information for monitoring, analysis, and decision-making within the workflow.
Key Benefits
a. Monitor the number of transactions in a specific queue.
b. Retrieve transaction counts for a defined date-time range.
c. Use transaction count information in Agent Tool Mode for monitoring and decision-making.
d. Use JSON or DataFrame output for downstream processing and analysis.
e. Support queue-level monitoring and operational reporting.
