Skip to main content

Transaction tracking, deduplication, retry handling and audit trail for Python-based RPA and backend automation.

Project description

rpa-tracker

rpa-tracker is a lightweight Python library for transaction tracking, retry control, deduplication and auditability in RPA and backend automation workflows.

It is designed for long-running, multi-platform processes where:

  • a single transaction touches multiple systems
  • retries must be controlled and observable
  • business errors must stop the flow
  • system errors may be retried
  • full traceability is required for operations and reporting

This library focuses on governance and execution control, not on orchestration engines or schedulers.


Key Concepts

Transaction

A logical unit of work identified by a UUID.
A transaction may pass through multiple platforms and stages.

Platform

A system involved in the transaction flow.
Platforms are defined in a central catalog with execution order and retry policy.

Stage

The execution of a transaction in a specific platform.

Execution Result

Derived from an error code:

  • 0 → success
  • < 0 → system error (retryable)
  • > 0 → business error (non-retryable)

Core Features

  • Transaction lifecycle tracking
  • Platform-based execution flow
  • Configurable retry policies per platform
  • Unlimited or limited retries
  • Business vs system error handling
  • Deduplication strategies per process
  • Full audit trail (events, attempts, timestamps)
  • SQLAlchemy-based persistence
  • Reporting-ready data model
  • Designed for batch / hourly RPA execution

Architecture Overview

Process / Job
   |
   |-- DeduplicationStrategy (process-specific)
   |-- PlatformRegistry (catalog)
   |-- RetryPolicy (per platform)
   |
   |-- SqlTransactionTracker
           |
           |-- TxProcess   (transaction)
           |-- TxStage     (platform execution)
           |-- TxEvent     (attempts / audit)

The tracker does not decide business rules.
It only applies the configuration provided by the process.


Installation

pip install rpa-tracker

Basic Usage

1. Define Platforms and Retry Policies

from rpa_tracker.catalog.platform import PlatformDefinition
from rpa_tracker.catalog.registry import PlatformRegistry
from rpa_tracker.retry.policy import RetryPolicy

PlatformRegistry.register(
    PlatformDefinition(
        code="A",
        retry_policy=RetryPolicy(max_attempts=1),
        order=1,
    )
)

PlatformRegistry.register(
    PlatformDefinition(
        code="B",
        retry_policy=RetryPolicy(max_attempts=2),
        order=2,
    )
)

PlatformRegistry.register(
    PlatformDefinition(
        code="C",
        retry_policy=RetryPolicy(),  # unlimited retries
        order=3,
    )
)

2. Register Deduplication Strategy

from rpa_tracker.tracking.deduplication.registry import DeduplicationRegistry

DeduplicationRegistry.register(
    "MY_PROCESS",
    MyDeduplicationStrategy(...)
)

3. Start or Resume a Transaction

tracker = SqlTransactionTracker(session)

uuid, is_new = tracker.start_or_resume(
    "MY_PROCESS",
    payload
)

if is_new:
    for platform in PlatformRegistry.all():
        tracker.start_stage(uuid, platform.code)

4. Hourly / Batch Execution per Platform

from rpa_tracker.domain.execution_result import ExecutionResult

for platform in PlatformRegistry.all():
    pending = tracker.get_pending_stages(platform.code)

    for stage in pending:
        error_code = execute_platform(stage)
        result = ExecutionResult(error_code=error_code)

        tracker.log_event(
            stage.uuid,
            platform.code,
            result.error_code,
            result.description,
        )

        tracker.finish_stage(
            stage.uuid,
            platform.code,
            result.state,
            result.error_type,
            result.description,
        )

Retry Behavior

  • Business errors (error_code > 0)
    → transaction is REJECTED and stops

  • System errors (error_code < 0)
    → stage is TERMINATED and retried based on policy

  • Retry limits are platform-specific

  • Unlimited retries are supported

  • Exceeded retries simply stop appearing in pending queries


Reporting

from rpa_tracker.reporting.transaction_report_repository import (
    TransactionReportRepository
)

repo = TransactionReportRepository(session)

repo.transactions_between(start, end)
repo.summary_by_state(start, end)
repo.stage_summary_by_system(start, end)

Reporting output can be printed, exported to CSV, or consumed by BI tools.


Design Principles

  • Explicit configuration over magic
  • Process-driven policies
  • No orchestration assumptions
  • SQL-first, audit-friendly
  • Conservative, production-oriented design

When to Use rpa-tracker

  • Multi-platform RPA processes
  • Hourly or batch execution models
  • Strong audit and traceability requirements
  • Controlled retries and failure handling

When NOT to Use It

  • Real-time streaming systems
  • Stateless microservices
  • One-step scripts

License

GNU General Public License v3 (GPLv3)


Author

Jonathan Bolo
Senior Software & RPA Architect

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rpa_tracker-0.0.2.tar.gz (22.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rpa_tracker-0.0.2-py3-none-any.whl (25.2 kB view details)

Uploaded Python 3

File details

Details for the file rpa_tracker-0.0.2.tar.gz.

File metadata

  • Download URL: rpa_tracker-0.0.2.tar.gz
  • Upload date:
  • Size: 22.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.2

File hashes

Hashes for rpa_tracker-0.0.2.tar.gz
Algorithm Hash digest
SHA256 eb4bb8d8b4a2f90420ee5b35c88126f8edcc9cd3a23c3a48e4264232fe53499a
MD5 3eab0e9b8a56b46c240dccd8e9f00f89
BLAKE2b-256 441ac2be595e35d4bb128e2524cf284730f40463aa1650c8a44e955a7f35d9b9

See more details on using hashes here.

File details

Details for the file rpa_tracker-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: rpa_tracker-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 25.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.2

File hashes

Hashes for rpa_tracker-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1e0c0609926408c804d6d60e4e63ff50b18b2ff38b60e5d14b6feab75a1ab981
MD5 1092be1e541b3d0fd3afaba4e9466fa9
BLAKE2b-256 e58d939a32fdd1e5f3d717372b3a981f9410695840f4716d0a6a9c85d5fe4244

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page