Skip to main content

Connect

1. Overview

The Connect module in Sumo Ledger monitors and tracks all external API connection requests made by processes during transaction processing. When a process stage needs to communicate with an external system — such as a core banking system (CBS), a blacklist check service, a credit scoring API, or a token authentication endpoint — that communication is logged as a connection request.

The Connect module provides visibility into the volume, success rate, and failure rate of these external integrations, helping administrators identify integration issues quickly.

Navigation: Connect (main sidebar menu)

URL: https://las.ledger.raralabs.dev/connect


2. Connect Overview Page

2.1 Connect Requests Trend

An area chart showing the volume of connection requests over time. The x-axis shows dates and the y-axis shows the count of requests. Peaks in the chart indicate periods of high external API activity.

2.2 Connection Summary Table

Below the chart, a table summarizes connection activity for the Last 30 Days:

ColumnDescription
Process / StageThe process and stage that initiated the connection, displayed as process_name/stage_name (e.g., customer_account_opening/cbs_integration, ias_demo_api/check_balance_api). Clicking navigates to the detail view for that connection.
Connection RequestsThe total number of connection attempts made in the last 30 days.
SuccessThe number of successful connections.
FailureThe number of failed connections.

2.3 Common Connection Types

The Process/Stage entries reflect the external integrations configured in your processes. Typical examples include:

Process/StagePurpose
customer_account_opening/cbs_integrationConnecting to the core banking system during account opening.
customer_account_opening/blacklist_checkChecking a customer against a blacklist during onboarding.
ias_demo_api/check_balance_apiChecking account balances via an external API.
ias_demo_api/get_credit_scoreFetching credit scores from an external service.
insert_scrip_prices/get_share_pricesPulling market share prices from an external source.
las/tokenAuthenticating with an external system using token-based auth.
credit_score/user_registrationRegistering users with a credit scoring service.
verify_issue_loan/loginAuthenticating before loan verification.

3. Connection Detail View

Clicking on a Process/Stage entry in the summary table opens the detail view, showing individual connection request logs for that specific integration point.

Note: This view may show individual request records with timestamps, request/response details, and status codes. The exact columns depend on the connection configuration.


4. How Connect Works in Practice

Connection Flow

  1. A transaction enters a process stage that has an external connection configured.
  2. The system makes an HTTP/API call to the configured endpoint.
  3. The result (success or failure) is logged in the Connect module.
  4. If the connection fails, the process stage handles the failure according to its configuration (retry, abort, or proceed with default values).

Monitoring for Issues

Use the Connect overview to identify:

  • High failure rates: A stage with many failures may indicate an external service outage or configuration error.
  • Zero requests: A stage with zero requests over the last 30 days may indicate that the integration is not being triggered, which could signal a process configuration issue.
  • Unusual spikes: A sudden increase in connection requests may indicate a batch processing event or a retry loop.

5. Best Practices

  1. Monitor failure rates daily. External API failures can silently block transaction processing. The Connect module is your first indicator of integration health.
  2. Investigate any stage with a high failure-to-success ratio. Check the external service status and the connection configuration in the process settings.
  3. Use the trend chart to correlate spikes with events. If you see a spike in connection requests, check whether a batch process or bulk import was running at that time.
  4. Ensure all external endpoints are correctly configured. Connection failures often stem from incorrect URLs, expired tokens, or firewall rules.
  5. Review connection logs after deploying process changes. Any changes to process stages that involve external connections should be verified through the Connect module.