saveCreditRecordTool - Francis

This workflow provides a centralized tool for saving and updating credit tracking records in a PostgreSQL database. It handles the complex logic of maintaining credit balances, recovery tracking, and micro-action logging for credit management operations.

Purpose

No business context provided yet — add a context.md to enrich this documentation.

How It Works

1. Receives Input: The workflow is triggered by another workflow with comprehensive credit tracking data including customer information, credit amounts, recovery targets, and micro-action details.

2. Database Upsert: Executes a sophisticated PostgreSQL query that either inserts a new credit record or updates an existing one based on the phone number. The query handles complex calculations for credit balances and recovery tracking.

3. Returns Summary: Formats and returns a human-readable summary of the saved record including total credit locked, weekly recovery progress, and current module stage.

Workflow Diagram

graph TD
    A[When Executed by Another Workflow] --> B[upsertCreditRecord]
    B --> C[setOutput]

Trigger

Execute Workflow Trigger: This workflow is designed to be called by other workflows, not run independently. It accepts 18 different input parameters covering all aspects of credit tracking.

Nodes Used

Node	Type	Purpose
When Executed by Another Workflow	Execute Workflow Trigger	Receives input parameters from calling workflows
upsertCreditRecord	PostgreSQL	Inserts or updates credit tracking records with complex business logic
setOutput	Set	Formats the response message with key credit metrics

External Services & Credentials Required

• PostgreSQL Database: Requires connection to a PostgreSQL database (configured as "PostgresOnSupabase")
  • Database must contain a creditTracking table with appropriate schema
  • Credentials needed: host, port, database name, username, password

Environment Variables

No environment variables are used in this workflow. All configuration is handled through n8n credentials.

Data Flow

Input Parameters

• phoneNumber (string): Customer identifier
• creditCustomersCount (number): Number of credit customers
• totalCreditBaseline (number): Baseline credit amount
• creditCustomerTypes (string): Types of credit customers
• creditTypicalDays (number): Typical credit duration
• weeklyRecoveryTarget (number): Target recovery amount per week
• targetCustomers (number): Target customer count
• creditGivenToday (number): Credit amount given today
• creditRecoveredToday (number): Credit amount recovered today
• microActionType (string): Type of micro-action performed
• microActionScript (string): Script used for micro-action
• microActionAttempted (boolean): Whether micro-action was attempted
• microActionOutcome (string): Result of micro-action
• amountRecovered (number): Amount recovered from action
• nextAction (string): Planned next action
• creditModuleStage (string): Current stage in credit module
• creditSkipReason (string): Reason for skipping credit action
• weekNumber (number): Current week number

Output

• output (string): Formatted summary message containing:
  • Total credit locked amount
  • Weekly recovery progress
  • Current credit module stage

Error Handling

This workflow does not implement explicit error handling. Database errors from the PostgreSQL node would cause the workflow to fail and return an error to the calling workflow.

Known Limitations

No specific limitations documented in the business context.

Related Workflows

No related workflows specified in the current context.

Setup Instructions

1. Import Workflow: Import the workflow JSON into your n8n instance.

2. Configure Database Credentials:

   • Create a PostgreSQL credential named "PostgresOnSupabase"
   • Configure connection details for your database

3. Database Schema: Ensure your PostgreSQL database has a creditTracking table with the following columns:

   • phoneNumber (primary key)
   • creditCustomersCount, totalCreditBaseline, creditTypicalDays, weeklyRecoveryTarget, targetCustomers (numeric fields)
   • creditCustomerTypes, microActionType, microActionScript, microActionOutcome, nextAction, creditModuleStage, creditSkipReason (text fields)
   • creditGivenToday, creditRecoveredToday, amountRecovered, weekNumber, totalCreditLocked, weeklyRecoveredSoFar (numeric fields)
   • microActionDate (date field)
   • microActionAttempted, creditModuleActive (boolean fields)
   • updatedAt (timestamp field)

4. Test Integration: Create a test workflow that calls this workflow with sample data to verify the integration works correctly.

5. Activate: The workflow is currently inactive - activate it when ready for production use.