Projects/RPA Suite/Documentation
← Case Study

Returned Payment Automation Suite

Technical documentation for the 17-scenario unified RPA solution

17
Scenarios
10-22
Fields/Scenario
~45 sec
Processing Time
<0.5%
Error Rate

Quick Start

Prerequisites
  • UiPath StudioX 2024.10.12 LTS installed
  • Enterprise License via Orchestrator
  • Collections Portal access (manual login required)
  • Excel input file with required columns
Running the Bot
  1. Open the Collections Portal and log in manually
  2. Open the Excel input file with account data
  3. Ensure SCENARIO_CODE column contains valid codes (D, E, G, H, etc.)
  4. Run Main_AllScenarios.xaml from StudioX
  5. Monitor Processing Logs sheet for status updates

Scenario Reference

The bot handles 17 distinct scenarios, each with specific field configurations. Use the SCENARIO_CODE column in your Excel input to specify which scenario applies to each account.

CodeScenario NameTypeFields
D1st Return (<6 mo)Standard12
E1st Return (<6 mo) Full PrepayStandard18
G1st Return (12 mo)Standard10
H2nd Return (12 mo)Standard18
I3rd Return (<12 mo)Standard18
JRedraft - 2nd ReturnStandard18
LRTS RecourseRecourse14
MOTR RecourseRecourse14
NPilot DB - 2nd ReturnPilot16
QSecurity Deposit - 1stSpecial15
RSecurity Deposit - 2ndSpecial17
SSecurity Deposit - 3rdSpecial17
WC1WEX Capital - 1stCapital14
WC2WEX Capital - 2ndCapital16
WC3WEX Capital - 3rdCapital16
F1FLEET - 1stFleet12
F2FLEET - 2ndFleet15

Technical Architecture

Configuration-Driven

Scenario rules stored as data, not hardcoded logic. Add new scenarios without code changes.

Fail-Fast Validation

Collections Descriptor lock checked first. Prevents wasted processing on locked accounts.

State-Aware UI

Checkbox states queried before clicking. Prevents accidental unchecking of already-set values.

Dual Logging

Excel Processing Logs + UiPath logs. Full audit trail for compliance requirements.

Processing Flow

Excel Input→Scenario Parser→Flag Generator→Portal Navigation→Field Updates→Comment Generation→Status Logging

Field Matrix

Fields modified by the bot across portal tabs. Each scenario activates a specific subset based on its configuration.

FieldTabScenariosValues
Collections StatusCreditAllActive → Collections
Account DescriptorCreditAllBased on return count
Collections DescriptorCreditAllValidated first (fail-fast)
Credit HoldCreditG, H, I, JCheckbox: TRUE
Payment MethodPaymentAllCheck/ACH → Prepay
Application MethodPaymentI, JStandard → Prepay
Online PayPaymentAllDisabled on 2nd+ return
Credit LimitLimitsAllSet to $0 or calculated
Daily LimitLimitsK, L, M, NBased on account type
Returns QueueQueuesAllAssigned based on FLEET status
Review DateQueuesAllCalculated from return date
CommentCommentsAllGenerated with return details

Error Handling

The bot writes status codes to the Processing Logs sheet. Use these codes to identify issues and take corrective action.

Status CodeMeaningAction Required
1-SUCCESSAccount processed successfullyNone required
1-MANUAL REVIEWCollections Descriptor locked by another userProcess manually after lock released
1-AR NOT FOUNDAccount number not found in portalVerify AR number in source data
1-VALIDATION FAILPre-processing validation failedCheck account status and retry
1-TIMEOUTPortal response exceeded wait thresholdRetry; check portal performance
1-ELEMENT NOT FOUNDExpected UI element missingCheck for portal UI changes

Maintenance Guide

Adding a New Scenario

  1. Copy Column G template bot as the base
  2. Define the 18 binary flags for the new scenario
  3. Update the scenario lookup table in the Excel config
  4. Test with sample accounts in non-production environment
  5. Document the new scenario in the Bot Builder Matrix

Common Maintenance Tasks

Portal UI Change
Update selectors in affected activities
New Field Required
Add to appropriate tab handler sequence
Business Rule Change
Update flag configuration in Excel
Performance Issues
Review wait times and retry settings

⚠️ Important Notes

  • Always test changes in non-production environment first
  • Maintain the template bot pattern for consistency
  • Update documentation when modifying scenarios
  • Coordinate with Operations team before deploying changes
← Back to Case StudyView All Projects →