PortaOne Extensions - Version 10.0

Modified on Wed, 19 Aug at 9:51 AM

Overview

The PortaOne Extensions - Version 10.0 collector retrieves extension data from a PortaOne billing and switching environment, capturing a snapshot of all extensions provisioned across all customers.

This collector provides visibility into extension counts per customer, enabling organizations to bill for provisioned extensions within Varibill based on the number of active extensions in PortaOne.

The collector retrieves unrated data, meaning no monetary values are included in the collected records. Pricing is applied within Varibill using price lists configured against the Product Identifier.

This is a point-in-time collector, meaning each execution captures the current state of extensions at the time the collector runs, rather than data for a historical date range.

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

Collector Summary

Field Value
Source Collector Name PortaOne Extensions - Version 10.0
Collection Behavior Point-in-Time
Rating Model Unrated
Vendor Name PortaOne
Product PortaSwitch / PortaBilling
Purpose Retrieves extension data from PortaOne for per-extension billing 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 PortaOne Extensions - Version 10.0 collector retrieves extension data from PortaOne, capturing a snapshot of all extensions provisioned across all customers at the time of execution. The collector queries each customer’s extensions with detailed information, producing one record per extension.

Each record includes:

  • A quantity of 1, representing a single provisioned extension
  • The extension number and account identifier
  • The name of the person assigned to the extension, where available
  • The customer name associated with the extension

The collector retrieves the customer data needed to scope collection, then iterates through each customer to retrieve their extensions. Customers with no extensions are skipped automatically. Both the customer list and extension list are paginated using the configured API Page Limit.

The identifiers submitted to Varibill for each record are constructed as follows:

  • Product Identifier — the value configured in the Product Identifier parameter. This is a fixed code applied to every record (for example, PO-IPC)
  • Client Identifier — the PortaOne customer ID
  • Record Identifier — describes the extension number and account identifier, with the assigned person’s name where available. For example: Extension number 503 (AT-503) is assigned to PTA Recep or Extension number 100 (AZL_100) when no person is assigned
  • Unique Identifier — the PortaOne extension internal ID

Note: This collector submits unrated data — no monetary values are included. Pricing for extensions is applied within Varibill using price lists configured against the Product Identifier.

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 customer and extension 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 determined the Product Identifier code you want to use for extension billing in Varibill
  • 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.

Product Parameters

Parameter What it is Default
Product Identifier A code that identifies the product or service type for billing purposes within Varibill. This value is applied to every record collected and should match the product code configured in your Varibill price list. (blank)

Tip: Choose a Product Identifier that aligns with your Varibill billing configuration. For example, PO-IPC for PortaOne IP Communications extensions. This value must match the product code in your Varibill price list for pricing to be applied correctly.

Time Zone Parameters

Parameter What it is Default
Time Zone Hourly Offset The UTC offset of your local time zone, used to adjust the timestamp recorded for each extension record. A value of 2 represents UTC+2. (blank)

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

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

Step 2: Configure the Collector in Varibill

  1. In the Varibill User Interface, open the Source Collector configuration screen.

  2. Enter the required field values under the Details tab:

    • Hosting Provider: Select Varibill Cloud
    • Source Collector Name: Select PortaOne Extensions - Version 10.0
  3. 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
  4. Set the Product Identifier to the product code that corresponds to your Varibill price list configuration for PortaOne extensions.

  5. Set the Time Zone Hourly Offset to reflect the UTC offset of your local time zone.

  6. 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:

  • Customers exist in your PortaOne environment with provisioned extensions.
  • The PortaOne user account used for connection has read access to customer and extension data.

If the Product Identifier in Varibill does not match expected billing behavior, verify that:

  • The Product Identifier value matches the product code configured in your Varibill price list.

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.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article