About the Calix Cloud Platform

The Calix Cloud software platform provides a robust data analytics and SaaS services solution for Broadband Services Providers (BSPs). The Calix Cloud platform hosts the award-winning Calix Cloud services applications (Engagement Cloud, Operations Cloud, Service Cloud), provides the management and user administration functions for each Calix Cloud organizational instance, and provides a robust API presence for web integrations with BSP back-office systems.

This document constitutes the software release notes for Calix Cloud Platform.

What's New in this Release

New features or enhancements to the Calix Cloud platform introduced in release 25.1:

Category	Feature/Enhancement	Description
APIs	Subscriber Service API enhancements for multi-dwelling units operating with SmartMDU	Ability to apply a filter on the GET /subscribers call to return all SmartMDU enabled tenants. Support for OSS/BSS integration, allowing periodic polling of the endpoint to capture tenant information.
	Subscriber Service API feature	Reduces the number of API calls required to turn up new subscribers and swap the RGs of existing subscribers.
	Calix Cloud Persona API For Service enhancement	Ability to retrieve and set Wi-Fi parameters.
SmartLife Managed Services	SmartMDU solution	Introduces a broadband services management solution for multi-dwelling units (MDUs) that provides: Property-wide Wi-Fi connectivity management, including for residential living units and common areas. Exceptional Wi-Fi experiences for residents throughout the property via personalized network protection, content security and controls, a dedicated connection managed through the CommandIQ mobile app, and unique guest SSIDs for visitors. The ability to scale property management from smaller apartment buildings with fewer than 10 units to large multi-building complexes with hundreds of units—extending coverage across entire properties to connect dog walks, fitness facilities, and common areas—while supporting a variety of access network connection types. Streamlined operations for service providers and property managers via PropertyWorx—an easy-to-use administrative portal with custom-built dashboards to quickly identify a resident's unit within the property. The federated login functionality grants secure access for property managers into the PropertyWorx portal. ¹ Additional license(s) required to enable SmartLife features

For new features and enhancements to Calix Cloud services applications in this release, please refer to the Release Notes for each application:
Calix Deployment Cloud | Calix Engagement Cloud | Calix Operations Cloud | Calix Service Cloud

General Notes

All Calix APIs are subject to usage rate-limit enforcement. To identify rate limits for your organization, consult with your Calix Customer Success Manager.
API calls must originate from an IP address defined in the Calix Cloud organization ACL or a user ACL. If a call originates from an IP address outside the space configured in the ACLs, the call will fail with an “Org ACL enabled" message. (TM-3104)
Guidance: Update the Organization ACL (Administration > Organization ACL) or a user ACL (Administration > Users [edit user] > Users detail > ACL (+) Add subnet(s)) to add all required IP scopes, including for any systems that may call the Calix Cloud APIs.
In the Calix Cloud Developer Portal, if a requested API product shows as Disabled, this status indicates that your organizational instance is missing a required entitlement (for example, the Call Outcome API requires an active "Service Cloud" entitlement to function) or is otherwise unavailable.
Setting the "isONTService" flag in the service provisioning API to false deletes the service.

Known Anomalies

The following table lists known anomalies in Calix Cloud.

Issue Number	Description
CCL-95670	The Billing Upload Service API supports uploading multiple subscribers with the same ONT in parallel, however uploading subscribers one by one with the same ONT is not supported. Calix recommends not using the Billing Upload Service API for MDU ONTs.
CCL-56268	When using Subscriber Service API endpoint POST/subscribers/{subscriberId}/services to attach voice and data together, the response is error code 400. Workaround: Use PUT/subscribers/{subscriberId}/services to attach voice and data together. Use POST/subscribers/{subscriberId}/services to create the services one by one—first data and then voice.

Issue Number

Description

CCL-95670

The Billing Upload Service API supports uploading multiple subscribers with the same ONT in parallel, however uploading subscribers one by one with the same ONT is not supported. Calix recommends not using the Billing Upload Service API for MDU ONTs.

CCL-56268

When using Subscriber Service API endpoint POST/subscribers/{subscriberId}/services to attach voice and data together, the response is error code 400. Workaround:

Use PUT/subscribers/{subscriberId}/services to attach voice and data together.
Use POST/subscribers/{subscriberId}/services to create the services one by one—first data and then voice.

Open Issues

The following table lists the open issues that are applicable to this release.

Issue Number	Description
CCL-108850	An SSID for the unified, 2.4 GHz, or 5 GHz custom network types cannot be created from Service Cloud or CommandWorx.

API Change Logs

Each Calix Cloud software release may introduce changes to Calix Cloud APIs. Such changes may include modifying existing APIs, adding new APIs, or deprecating older APIs.

To help developers keep track of changes that may affect existing integrations, each API's Swagger doc page (in the Calix Cloud Developer Portal) now provides a log of changes to the API in the current release, where applicable. To view the change log for an API, go to the Calix Cloud Developer Portal > APIs page. Select the API > View Documentation, then click the Change Log link.

About Entitlements in Calix Cloud

Calix Cloud uses system-generated entitlement records to enable access to applications and services. When BSPs purchase Calix Cloud software applications or managed services, Calix generates an entitlement record (license) for each app that gets imported into Calix Cloud for app activation. Applications and features become available and visible in the Calix Cloud UI when the governing entitlements are present and active.

To view the entitlements for your Calix Cloud instance, go to the "Organization Info" area of the Calix Cloud Administration console (User > Administration > Organization Info). All imported entitlements display here, with Status = Active to indicate which apps and features are currently enabled.

A summary of and the matching entitlements is shown below for reference.


Calix Cloud Services Applications
Application Name	Entitlement Name(s)	Description
Calix Deployment Cloud	Calix Cloud Foundation EXOS Framework¹ EXOS Support¹	Calix Deployment Cloud (aka Revenue EDGE Deployment Cloud) provides the essential cloud services management platform for Calix EDGE systems. EXOS EDGE systems with a Calix Cloud Foundation license enables creation of a dedicated Deployment Cloud instance to manage these systems.
Calix Engagement Cloud	Engagement Cloud Platform Engagement Cloud Service Calix Engagement Cloud Plus	Activates, enables access to the Calix Engagement Cloud application. The Engagement Cloud Plus license enables access to premium features.
Calix Operations Cloud	Calix Operations Cloud Calix Operations Cloud Flow Limited	Activates, enables access to the Calix Operations Cloud application Enables access to thin Calix Operations Cloud client for Flow Analyze migrations (limited use)
Calix Service Cloud	Service Cloud Service Cloud Basic Calix Service Cloud for SmartHome Calix Service Cloud for SmartBiz Calix Service Cloud for Gateway Manager Service Cloud Performance Testing Broadband Performance Testing	Activates, enables access to the Calix Service Cloud application, Experience Management edition (EME) Activates, enables access to the Calix Service Cloud application, Device Management edition (DME) Enables the FCC broadband performance testing enhancement for Service Cloud
Calix SmartLife Managed Services
Managed Services	Entitlement Name(s)	Description
SmartHome	ProtectIQ ExperienceIQ ExperienceIQ and ProtectIQ	Enables availability of ProtectIQ network security application in your org instance Enables availability of ExperienceIQ home network Wi-Fi access management app in your org instance Enables availability of the two-app ExperienceIQ + ProtectIQ bundle in your org instance
	ARLO ARLO Unlimited ARLO Unlimited Plus	Enables availability of ARLO Secure cameras managed service in your org instance Service editions: Standard \| Unlimited \| Unlimited Plus
	Bark Premium Bark Junior	Enables availability of Bark managed service in your org instance Service editions: Premium \| Junior
	Servify Platinum Servify Gold Servify Silver	Enables availability of Servify Care device protection managed service in your org instance Service editions: Platinum \| Gold \| Silver
SmartTown	SmartTown Communities SmartTown Organizational Users SmartTown Wi-Fi - Subscribers¹	Supports creating and managing subscriber, education, visitor, and first responder communities. Supports creating and managing organization communities.
SmartBiz	SmartBiz	Enables access to SmartBiz services and Subscriber Unlimited systems management
SmartMDU	SmartMDU Property Manager Portal Paywall SmartMDU	Enables the SmartMDU solution Enables PropertyWorx Enables tenant self-service activation of internet service
Speed Tests
Ookla	Ookla SpeedTest Ookla SpeedTest Private	Enables speed tests from supported equipment to either the public Ookla servers or a private Ookla server.
Calix Cloud APIs
API Name	Entitlement Name(s)	Description
Subscriber Service	Calix Cloud Subscriber Service API	API used to integrate subscriber records data from an OSS to Calix Cloud
Calix Cloud Persona API for Engagement	Calix Cloud Persona API	API used to export engagement insights. Usage also requires an active "Engagement Cloud" entitlement in tandem to function.
Calix Cloud Persona API for Subscribers	Calix Cloud Persona API	API used to export subscriber insights. Usage also requires active "Calix Cloud Foundation" and "Service Cloud" entitlements in tandem to function.
Calix Cloud Persona API for Service	Calix Cloud Persona API	API used to export subscriber "Wi-Fi experience insights" data. Usage also requires an active "Service Cloud" entitlement in tandem to function.
¹ No longer in use, but older records may be present in your instance.

Web Browser Requirements

Using Calix Cloud requires the following minimum web browser versions:

Chrome 100.0.4896.88 or above
Firefox 96.0 or above

Technical Support

Engage Calix technical support online from the My Calix portal.