PortaOne CDR Aggregate - Version 17.5

Modified on Thu, 30 Jul at 9:15 AM

Overview

The PortaOne CDR Aggregate - Version 17.5 collector retrieves aggregated call detail record (CDR) data from a PortaOne billing and switching environment, covering voice call activity across Reseller, Reseller Customer, and Retail customer types.

This collector provides visibility into call volumes and costs at an aggregated level, grouping call records by customer, destination, and date. This enables organizations to validate charges and allocate costs within Varibill without the granularity of individual call records.

The collector retrieves rated data, meaning call cost values are supplied by PortaOne and submitted directly to Varibill. An optional VAT factor can be applied to adjust charged amounts before submission. Pricing markups can be applied within Varibill without requiring separate price lists.

This is a historically capable collector, meaning each execution retrieves CDR data for a configurable date range in the past, rather than a snapshot of the current state.

For general instructions on creating and running Source Collectors, see: Configuring a New Cloud Source Collector

Collector Summary

Field	Value
Source Collector Name	PortaOne CDR Aggregate - Version 17.5
Collection Behavior	Historically Capable
Rating Model	Rated
Vendor Name	PortaOne
Product	PortaSwitch / PortaBilling
Purpose	Retrieves aggregated call detail records from PortaOne for billing and cost allocation within Varibill

About PortaOne

PortaOne is a telecommunications software company that provides integrated billing and service management solutions for communication service providers worldwide. Founded in 2001, PortaOne serves over 500 telecom operators across more than 100 countries, ranging from wholesale carriers to retail service providers.

PortaOne’s core platform, PortaSwitch, is a unified service management and delivery platform covering voice, messaging, IoT/M2M, and data traffic. PortaBilling, its accompanying billing component, enables service providers to manage subscriber accounts, rating, and revenue collection.

PortaOne is used by a broad range of providers including Mobile Virtual Network Operators (MVNOs), cloud PBX operators, traditional carriers, and internet-based telephony providers.

Note: PortaOne documentation is available at docs.portaone.com. Documentation is version-specific — ensure you are referencing the guide for your deployed PortaOne release.

Data Collected

The PortaOneCDRAggregate collector retrieves aggregated call detail records from PortaOne for a configurable historical date range. Rather than submitting individual call records, this collector groups voice call data by customer, destination, and date, and submits a single aggregated record for each grouping.

Each aggregated record includes:

The total number of calls (quantity) for the grouping
The total charged amount for the grouping, adjusted by the configured VAT factor
The destination country and description that identify the call type
The customer name, customer type (Reseller, Customer, or Retail), and reseller name (where applicable)

The collector retrieves the customer account data needed to scope collection — covering Reseller, Reseller Customer, and Retail customer types. Customer filtering options allow collection to be limited to or exclude specific customers.

The time window covered by each collection run is configurable, enabling the collector to align with your billing cycle and to recover data from prior periods where needed. A time zone offset parameter ensures that date boundaries align with your local time zone.

Note: This collector submits rated data — call cost values from PortaOne are included in each record. The configured VAT Factor is applied as a divisor to strip embedded VAT before submission to Varibill.

Prerequisites

Before configuring this collector, ensure that:

You have access to a PortaOne environment (PortaSwitch / PortaBilling)
You have a PortaOne user account with read access to CDR data
You have an API token associated with that account
You have noted the base URL of your PortaOne instance (for example, https://portaone.example.com)
You have access to the Varibill Source Collector configuration screen

Tip: PortaOne API tokens are typically generated or retrieved from within the PortaOne administrative interface. Contact your PortaOne system administrator if you do not have a token or are unsure of the correct host URL.

Warning! The PortaOne Token grants API access to your PortaOne environment. Store it securely and do not share it. The token is masked in the Varibill UI once saved.

Configuration Parameters

The parameters below are entered when configuring the collector in Varibill. They are grouped by function.

Connection Parameters

These parameters identify and authenticate against your PortaOne instance.

Parameter	What it is	Where to find it
Portaone Host	The base URL of your PortaOne instance	Your PortaOne management interface URL. Format: `https://portaone.example.com` (include `https://`, no trailing slash)
Portaone Username	The username of the PortaOne account used to connect	Your PortaOne user account name
Portaone Token	The API token associated with the PortaOne user account	Generated or retrieved from the PortaOne administrative interface

Warning! The Portaone Token is a sensitive credential. It is masked in the Varibill UI once saved. If it is compromised, revoke and regenerate it immediately in the PortaOne administrative interface.

Rating Parameters

Parameter	What it is	Default
Vat Factor	A divisor applied to the PortaOne charged amount to strip embedded VAT before submission to Varibill. Set to `1` if PortaOne values are already exclusive of VAT.	`1`

Tip: If your PortaOne environment returns call costs inclusive of VAT, set the VAT Factor to the applicable factor (for example, 1.15 for 15% VAT) so that Varibill receives the VAT-exclusive amount.

Customer Filtering Parameters

These parameters control which PortaOne customers are included in or excluded from each collection run.

Parameter	What it is	Default
Collect for Specific Customer	When populated, only CDRs for this PortaOne customer ID are collected. Leave blank to collect all customers.	(blank — all customers)
Exclude Specific Customer	When populated, CDRs for this PortaOne customer ID are excluded from the collection. Leave blank to exclude no customers.	(blank — no exclusions)
Filter Specific Customer on Reseller Level	When set to true, the values in Collect for Specific Customer and Exclude Specific Customer are matched against the parent reseller ID rather than the direct customer ID.	`false`

Customer Type Collection Switches

These parameters control which categories of PortaOne customer are included in each collection run. Set each switch to false to exclude that customer type.

Parameter	What it controls	Default
Collect Reseller	When set to true, collects CDRs for Reseller-type customers	`true`
Collect Reseller Customers	When set to true, collects CDRs for customers that belong to a Reseller	`true`
Collect Retail	When set to true, collects CDRs for direct Retail customers	`true`

Note: All three customer type switches default to true. Disable any switch to exclude that customer category from collection.

Identifier Parameters

Parameter	What it is	Default
Use Account as Client Identifier	When set to true, the Client Identifier submitted to Varibill is constructed as the PortaOne customer ID followed by `#` and the account ID. When set to false, only the customer ID is used.	`false`

Note: The Product Identifier submitted to Varibill is constructed as {country}#{description}, where the country and description values are derived from the PortaOne CDR data. For example: South Africa#Internet Solutions, Australia#Australia.

The Record Identifier indicates the date covered by the aggregated record — for example, Calls made on 2026-06-25.

The Unique Identifier is a CRC32 hash computed from the Client Identifier, Product Identifier, and date combination.

Ensure your Varibill product configuration accounts for these formats.

Date Range Parameters

These parameters define the time window of CDR data collected on each run.

Parameter	What it is	Default
Days Offset	The number of days back from today to start the collection window	`1`
Days Range	The number of days to collect, starting from the offset date	`3`
Time Zone Hourly Offset	Applied as a negative shift to PortaOne UTC timestamps to convert them to local time. A value of `2` shifts timestamps back by 2 hours (UTC+2).	`2`
Date Format	The date format used for date calculations	`yyyy-MM-dd`

Note: For example, with Days Offset = 1 and Days Range = 3, the collector will retrieve CDRs for the period beginning 1 day ago and spanning 3 days. Adjust these values to match your billing cycle and scheduling frequency.

Operational Parameters

These parameters control API pagination and file management behavior.

Parameter	What it is	Default
API Page Limit	The number of records requested per API page when paginating through results. Must be at least 100.	`500`
Delete data files older than	The number of days after which locally stored collection files are automatically deleted. Must be at least 1.	`62`
Maximum number of records per file	The maximum number of records written to a single output file before a new file is started. Must be between 1,000 and 50,000.	`10000`

Configuration Steps

Step 1: Prepare Your PortaOne Environment

Confirm that your PortaOne instance is accessible via HTTPS.
Identify the PortaOne user account that Varibill will use to connect. This account must have read access to CDR data for the customer scope you intend to collect.
Obtain or generate an API token for that user account.
Note the base URL of your PortaOne instance (for example, https://portaone.example.com).

Step 2: Configure the Collector in Varibill

In the Varibill User Interface, open the Source Collector configuration screen.
Enter the required field values under the Details tab:
- Hosting Provider: Select Varibill Cloud
- Source Collector Name: Select PortaOne CDR Aggregate - Version 17.5
Enter the connection parameters:
- Portaone Host: The base URL of your PortaOne instance
- Portaone Username: The PortaOne user account name
- Portaone Token: The API token for that account
Set the Vat Factor according to whether your PortaOne environment returns call costs inclusive or exclusive of VAT.
Configure the customer filtering and collection switch parameters to match the customer scope you want to collect.
Set the date range parameters (Days Offset and Days Range) to match your billing cycle.
Set the Time Zone Hourly Offset to reflect the UTC offset of your local time zone.
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: Configuring a New Cloud Source Collector

Troubleshooting

If the collector fails to connect to PortaOne, verify that:

The Portaone Host URL is correct and includes https:// with no trailing slash.
The Portaone Username is correct and the account is active.
The Portaone Token is valid and has not expired or been revoked.
The PortaOne instance is reachable from the Varibill Cloud environment. If your PortaOne instance restricts access by IP, ensure Varibill’s collector IP addresses are permitted.

If the collector connects successfully but returns no data, verify that:

The Days Offset and Days Range values cover a period in which CDR data exists.
At least one customer type collection switch (Collect Reseller, Collect Reseller Customers, Collect Retail) is set to true.
The Collect for Specific Customer value, if populated, corresponds to a valid PortaOne customer ID that has CDR data in the requested date range.

PortaOne References

The following resources may assist with locating values or understanding your PortaOne configuration.

PortaOne Documentation (External)

Note: PortaOne documentation is provided for reference. Interface labels and available features may vary depending on your deployed PortaOne release version.