OmniRoam
OmniRoam is a GSMA TAP3 roaming settlement system by Omnitouch Network Services. OmniRoam rates mobile data usage, generates TAP files for roaming partners, sends those files to a clearing house, and processes the Returned Account Procedure (RAP) files that partners send back.
OmniRoam supports the TAP 3.12 format defined in GSMA TD.57 and the RAP format defined in GSMA TD.32.
Documentation
Operations and monitoring
- Operations Guide - Scheduled jobs, file transfer, archiving, log locations, and routine maintenance.
- Metrics Reference - Prometheus metrics and InfluxDB measurements.
- Troubleshooting - Common problems and their resolutions.
Configuration
- Configuration Reference - Complete
config.yamlandcounters.yamlreference.
Architecture and interfaces
- Architecture - Components, data flow, and integration points.
- HTTP API Reference - The OmniRoam API endpoints.
Records and settlement
- CDR Processing - CDR sources, ingestion, rating, and rounding.
- TAP File Generation - TAP file structure, naming, and sequence counters.
- RAP Processing - Returned Account Procedure files and alerts.
- TAP Validation - Validation checks and GSMA error codes.
What OmniRoam Does
OmniRoam settles outbound data roaming. A visited network carries a home subscriber's data. OmniRoam turns the usage records into a priced TAP file, sends the file to the home network through a clearing house, and tracks the partner's response.
- CDR ingestion - OmniRoam collects Call Detail Records (CDRs) from serving gateways and correlates the partial records into complete data sessions.
- Rating - OmniRoam prices each CDR against a per-partner rate through the Charging Engine.
- TAP file generation - OmniRoam builds TAP files per roaming partner and writes them for transfer.
- File transfer - OmniRoam sends TAP files to the clearing house and pulls inbound TAP and RAP files.
- RAP processing - OmniRoam reads the RAP files that partners return and alerts operators to rejections.
- Monitoring - OmniRoam exposes Prometheus metrics, InfluxDB analytics, an HTTP API, and a web interface.
Architecture Overview
See the Architecture guide for the full component map and data flow.
Configuration Structure
OmniRoam reads two configuration files. The Configuration Reference documents every parameter.
config.yaml- The main configuration. It holds a globalconfigsection and a per-partnerpartnerssection.counters.yaml- The TAP file sequence counters, one pair per recipient TADIG.
config:
# Global system configuration (paths, timezones, rating, schedule, metrics)
partners:
# Per-partner configuration (rates, TADIG codes, batch settings)
Standards References
| Standard | Title | Use in OmniRoam |
|---|---|---|
| GSMA TD.57 | Transferred Account Procedure (TAP) Data Record Format | TAP 3.12 file format and validation error codes |
| GSMA TD.32 | Returned Account Procedure (RAP) Format | RAP file structure and return severities |
| GSMA TD.13 | TADIG Naming Conventions | 5-character operator identifiers (TADIG codes) |
| ISO 4217 | Currency Codes | localCurrency and tapCurrency values |
| E.164 | International Numbering Plan | MSISDN and called-number formats |
Documentation Structure
By role
Operators and administrators:
- Start with the Operations Guide.
- Review the Metrics Reference.
- Keep the Troubleshooting guide available.
Roaming and settlement teams:
- Read TAP File Generation.
- Read RAP Processing.
- Review TAP Validation.
System integrators:
- Start with the Architecture guide.
- Read the Configuration Reference.
- Review the HTTP API Reference.