Cloud Blue (CB) SaaS Data - Version 4.0

Overview

The Cloud Blue (CB) SaaS Data collector retrieves SaaS subscription and order data from the CloudBlue Commerce platform using the CloudBlue Commerce API.

This collector provides visibility into completed subscription orders across reseller and customer hierarchies, including order quantities, pricing, and subscription details, enabling service providers to validate SaaS consumption, reconcile order charges, and bill customers within Varibill.

The collector retrieves rated order data, meaning monetary values (cost and total) are included in the data supplied by the source system. Varibill can apply markups to these values without referencing price lists.

This is a historically capable collector, meaning each execution retrieves order 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

About CloudBlue Commerce

CloudBlue is a cloud commerce platform that enables service providers, distributors, and resellers to automate the delivery and management of cloud services. CloudBlue provides tools for subscription management, order fulfilment, and multi-tier channel distribution.

CloudBlue Commerce is the operational platform that manages subscription lifecycles, order processing, and product catalogues for service providers and their reseller networks. The platform supports multi-tier distribution models where a distributor manages resellers, each of whom manages their own customer subscriptions. Orders within the platform represent subscription activations, renewals, changes, and cancellations, each with associated pricing and quantity details.

For more information, see the CloudBlue Commerce documentation.

Data Collected

The Cloud Blue (CB) SaaS Data - Version 4.0 collector retrieves rated SaaS subscription order data from the CloudBlue Commerce API. Each record represents a completed order line item for a specific customer subscription, including quantity, pricing, and subscription details.

The collector captures the following data for each order record:

• Customer details — seller (reseller) and buyer (customer) internal identifiers and company names
• Subscription details — subscription identifier, subscription name, subscription period, and billing period
• Product details — manufacturer part number (MPN), resource name, and order line item description
• Pricing details — extended price (submitted as both cost and total), and quantity
• Order details — order date, order type, and order identifier

The following filtering is applied during processing:

• Only orders with a status of Completed are included
• Orders are filtered by the configured Order Type codes (for example, sales orders, billing orders, change orders, cancellation/fulfilment orders)
• Orders matching any configured Excluded Template IDs are excluded
• Orders matching any configured Exclude Resource Types are excluded (for example, refund adjustments)
• When Template IDs are configured, only orders matching those templates are included
• When Collect Reseller Level is enabled, reseller-level data is collected for the specified reseller IDs

Records are aggregated by client identifier, date, product code, unique identifier, and record identifier. Where multiple records share the same combination, their quantity, total, and cost values are summed.

The time window covered by each collection run is configurable using the Start Day, End Day, and Month Offset parameters, enabling the collector to target a specific day range within a given month.

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

• Client Identifier — constructed as {currency prefix}{Client Identifier Prefix}{sellerInternalId}#{buyerInternalId}#{subscriptionId}. For non-ZAR currencies, the currency code is prepended as an additional prefix (for example, USD#). For ZAR currency, no currency prefix is added. For example: PREFIX#1008482#1028737#1055159
• Product Identifier — constructed as {Client Identifier Prefix}{MPN}|{subscriptionPeriod}|{billingPeriod}. The subscription period is formatted as P1Y (yearly) or P1M (monthly), and the billing period as Yearly or Monthly. When Include Users in Product Identifier is enabled, a user tier range is appended as #{min}-{max}. For example: PREFIX#2018|P1Y|Monthly#1-49
• Record Identifier — the order line item description (for example, the product name with term and date range)
• Unique Identifier — constructed as {subscriptionId}#{internalOrderId}#{CRC32}, where the CRC32 is computed from the order line item type and description
• Tag — a multi-line value containing: Reseller: {reseller name}, Customer: {customer name}, Product Name: {resource name}, and Subscription Name: {subscription name}

Prerequisites

Before configuring this collector, ensure that:

• You have an active CloudBlue Commerce account with API access
• You have obtained OAuth 2.0 credentials: a Client ID, Client Secret, Username, and Password
• You have noted the CloudBlue Commerce host URL for your environment (for example, https://your-instance.platform.cloudblue.io)
• You know the Template IDs for the subscription templates you wish to collect
• You have access to the Varibill Source Collector configuration screen

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 CloudBlue Commerce environment. The collector uses OAuth 2.0 authentication with the Client ID, Client Secret, Username, and Password to obtain an access token.

Collection Filter Parameters

These parameters control which order data is collected. They allow you to narrow the scope of collection to specific templates, order types, resellers, and resource types.

Billing Parameters

Date Range Parameters

These parameters define the time window of order data collected on each run. The collector retrieves completed orders within a specific day range of a given month.

Operational Parameters

These parameters control file management behavior.

CloudBlue References

The following resources may assist with locating values or configuring your CloudBlue Commerce API access.

CloudBlue Documentation (External)

• CloudBlue Website
• CloudBlue Commerce Documentation

Configuration Steps

Step 1: Prepare Your CloudBlue Commerce Environment

1. Log in to the CloudBlue Commerce platform.
2. Navigate to the OAuth 2.0 client configuration.
3. Create or locate your Client ID and Client Secret.
4. Locate or create an API user account and note the Username and Password.
5. Note the host URL of your CloudBlue Commerce environment (for example, https://your-instance.platform.cloudblue.io).
6. Identify the Template IDs for the subscription templates you wish to collect.

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 Cloud Blue (CB) SaaS Data - Version 4.0

3. Enter the connection parameters:

   • Cloud Blue Host: The base URL of your CloudBlue Commerce environment (for example, https://your-instance.platform.cloudblue.io)
   • Cloud Blue Client ID: The OAuth 2.0 Client ID
   • Cloud Blue Secret: The OAuth 2.0 Client Secret
   • Cloud Blue Username: The API user username
   • Cloud Blue Password: The API user password

4. Configure the collection filter parameters:

   • Cloud Blue API Limit: The maximum records per API request (for example, 1000)
   • Template IDs: The subscription template IDs to collect (for example, 47)
   • Excluded Template IDs: Any template IDs to exclude (leave empty if none)
   • Order Type: The order type codes to collect (for example, SO,BO,CH,CF)
   • Include Users in Product Identifier: Set to true if different user tiers should produce separate Product Identifiers
   • Collect Reseller Level: Set to true to collect reseller-level data
   • Reseller IDs: The reseller GUIDs to collect (only required when Collect Reseller Level is enabled)
   • Exclude Resource Types: Any resource types to exclude (for example, REFUND_ADJ)

5. Enter the billing parameters:

   • Client Identifier Prefix: The prefix to apply to Client Identifiers and Product Identifiers (for example, MYPREFIX#)

6. Set the date range parameters:

   • Start Day: The first day of the collection window (for example, 1)
   • End Day: The last day of the collection window (for example, 7)
   • Month Offset: The number of months back to target (for example, 0 for the current month)

7. 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 CloudBlue Commerce, verify that:

• The Cloud Blue Host URL is correct and includes https:// with no trailing slash.
• The Cloud Blue Client ID is correct.
• The Cloud Blue Secret is valid and has not been revoked or regenerated.
• The Cloud Blue Username and Cloud Blue Password are correct and the API user account is active.
• No firewall or IP restriction rules are blocking the Varibill collector’s IP address from reaching the CloudBlue Commerce host.

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

• The Start Day, End Day, and Month Offset values cover a period in which completed orders exist.
• The Template IDs match valid subscription templates in your CloudBlue Commerce environment.
• The Order Type codes match order types that exist in your environment (for example, SO,BO,CH,CF).
• The Exclude Resource Types value is not filtering out all available records.
• Your CloudBlue Commerce environment has active subscriptions with completed orders.
• If Collect Reseller Level is enabled, confirm that the Reseller IDs are correct.