Skip to main content

NextSwitch Report Testing

Overview

Report Testing is a key component of the SAN NextSwitch Migration Self-Certification, ensuring that participating institutions can successfully retrieve, generate, and validate reports from the new switch environment.

This step verifies not only the availability of reporting capabilities, but also the accuracy and reliability of report data, which is critical for reconciliation, monitoring, and operational readiness during migration.

Learn how to retrieve the report via Developer Portal using the API access (via bash script) and the portal's UI




SAN Reports test cases are acknowledgement-based, requiring participants to verify that reports are generated correctly and contain accurate data.

Participants can retrieve reports via:

  • API Access
  • Developer Portal's UI

Step 1: Access SAN report test suite

  1. Navigate to SAN Reports test suite in your project
  2. Click “View Test Suite”
test suite

Step 2: Configure SAN report test suite

2.1 Configure FIID

  1. Scroll to Configuration Management
  2. Locate Server Configuration
  3. Select your FIID (Financial Institution ID)
test suite
  1. Click “Save”
test suite

ℹ️ Ensure Server Configuration is saved before proceeding.

2.2 Configure SAN Reports API Keys

If you wish to retrieve the report via API access (bash script), you must configure the API key

  1. Go to Configure SAN Reports API Keys
  2. Click “View Configuration”
test suite
  1. You will be redirected to the Global Configuration page
test suite

a. If first time (No API Keys configured)

  • The API Keys section will be blank
  • Click "Create API Key" button to generate new API Keys
test suite
  • Client ID and Client Secret will be displayed
  • Save these credentials securely
test suite

b. If API Keys Already Exists

Your existing Client ID and Client Secret will be displayed in the test suite configuration

test suite

Step 3: Navigate to Test Case

  1. Return to SAN Reports test suite
  2. Select a test case to validate by clicking on the title
test suite

Step 4: Review Test Instructions

You will see two tabs:

  • Test Details (default)
  • Test Execution

Review the instructions in the Test Details tab

test suite

Step 5: Download and Verify Report

Option A: API Access Method

  1. Follow instructions in test case description
  2. Access provided GitHub script
test suite
  1. Use the Client ID and Client Secret from Configuration
test suite
  1. Follow the GitHub documentation to retrieve the report via API
  2. Validate the report data and format

Option B: Portal's UI Method

  1. Click “Report Page” link in test case
test suite
  1. A new tab will open with the Reports page
test suite
  1. Under "Product" dropdown, select "SAN"
  2. Three new fields will appear:
    • Financial Institution (FI) ID: Select your FIID
    • Report Type: Select the report type based on your test case (e.g., "SETL01")
    • Date and Period: Choose the the date and period based on transactions you have performed previously
test suite
  1. Click “Download Report”
  2. Validate the report data and format

⚠️ Important: You must verify report accuracy before acknowledging the test case.

Step 6: Acknowledging the test case

  1. Go back to test case page
  2. Click “Test Execution” tab
test suite
If you see a blank page or cannot view the Test Execution tab, go back to Configuration Management and ensure you saved the Server Configuration, then refresh the page and reopen the test case.
  1. Locate Test Acknowledgement section
test suite
  1. Confirm your FIID
  2. Check one or both checkboxes based on the testing method(s) you performed
  3. Click “Submit”
test suite
  1. Status changes from “Unstarted” → “Passed”
test suite
You can acknowledge via API access, portal method, or both - depending on which testing method you completed.


Troubleshooting

IssueSolution
Blank Test AcknowledgementEnsure FIID is saved, refresh page
Cannot create API KeyMax 3 API Keys per FIID
Report download failsCheck Product, FIID, Report Type, Date
GitHub script not workingVerify Client ID & Secret
Test status not changingEnsure checkbox selected before submit
General issuesContact Developer Portal Support