PortaOne - PortaOne CDR Detail - 19.4

Modified on Mon, 30 Mar at 12:25 PM

Overview

The PortaOne CDR (Detail) Collector retrieves usage and billing data from the PortaOne platform via API integration.

This collector provides visibility into telecom usage data, including call detail records (CDRs), messaging activity, and service usage, enabling organisations to validate usage, allocate costs, and generate billing within Varibill.

The collector can retrieve rated or unrated data, depending on the PortaOne configuration.

This is a range-based (windowed) collector, retrieving usage data based on a defined date range and offset.

For general instructions on creating and running Source Collectors, see:
Varibill Cloud Source Collectors – Setup and Configuration Guide

Collector Summary

Field	Value
Source Collector Name	PortaOne - PortaOne CDR Detail - 19.4
Collection Behavior	Discrete (Range-based)
Data Rating Model	Rated or Unrated
Vendor Name	PortaOne
Product	PortaBilling / PortaSwitch
Purpose	Retrieves telecom usage and billing data for processing and invoicing within Varibill

Data Collected

The PortaOne CDR (Detail) Collector retrieves telecom usage data, which may include:

Call Detail Records (CDRs)
Data session usage
Messaging (SMS) records
Rated transaction data (if available)
Customer or account identifiers

Each record typically represents a single usage event and may include:

Event timestamp
Usage quantity (e.g. duration or volume)
Source and destination identifiers
Service or product reference
Cost (if rated)

Important: PortaOne data is typically high-volume and event-based. Ensure appropriate scheduling and filtering to maintain performance and billing accuracy.

Prerequisites

Before configuring this collector, you must:

Have access to the PortaOne API (REST or XML API)
Obtain valid API credentials (username, password, or token)
Ensure required permissions to access usage and/or billing data
Define the required billing period or data extraction window
Ensure network access to the PortaOne environment (VPN or allowlisting if required)

Configuration Parameters

The following parameters are required when configuring the PortaOne CDR (Detail) Collector in Varibill:

Parameter	What it is	Notes
Portaone Host	The PortaOne API host URL	Base endpoint used for API requests
Portaone Username	Username for API authentication	Provided by PortaOne
Portaone Token	API authentication token	Used in place of password
Product Identifier Prefix	Prefix applied to product identifiers	Used for product mapping within Varibill
Client Identifier Prefix	Prefix applied to client identifiers	Helps align PortaOne accounts with Varibill clients
Unique Identifier Prefix	Prefix used to ensure record uniqueness	Prevents duplication across datasets
VAT Factor	VAT multiplier applied to retrieved data	Optional, depends on billing requirements
Collect for Specific Customer	Limits collection to a specific customer	Optional filter
Collect Reseller	Enables collection at reseller level	Useful for multi-tier billing
Use Account as Client Identifier	Uses account ID as the client identifier	Overrides default mapping behaviour
Collect Retail	Enables collection of retail-level data	Increases data granularity
Run as Unrated	Treats collected data as unrated	Pricing applied within Varibill
Days Offset	Offset applied to collection window	Helps align with delayed data availability
Days Range	Number of days of data to retrieve	Defines collection window
Time Zone Hourly Offset	Adjusts timestamps for timezone differences	Ensures alignment with billing periods
Date Format	Format used for date values	Must match PortaOne API expectations
API Page Limit	Number of records retrieved per API call	Impacts performance and paging
Maximum number of records per file	Limits file size during processing	Prevents oversized batches
Delete data files older than	Retention period for collected files (days)	Controls storage cleanup

Configuration Steps

Step 1: Prepare PortaOne

Ensure API access is enabled
Confirm credentials and permissions
Identify required data endpoints and filters

Step 2: Configure the Collector in Varibill

In the Varibill User Interface, open the Source Collector configuration screen
Enter the required field values:

Hosting Provider: Select Varibill Cloud
Source Collector Name: Select PortaOne - PortaOne CDR Detail - 19.4
API Endpoint URL: PortaOne API endpoint
API Credentials: Username and password/token

Configure collection filters and processing rules
Save the collector configuration

Step 3: Run the Collector

Run or schedule the collector according to your standard Source Collector execution process.

For detailed instructions, see:

Varibill Cloud Source Collectors – Setup and Configuration Guide

Troubleshooting

If the collector fails to retrieve data, verify that:

API endpoint URL is correct and reachable
Credentials are valid and not expired
Required permissions are configured
Network access (VPN / firewall rules) is correctly set