Table of Contents

Calix Cloud Data Field Mappings

Jennifer Trower Updated by Jennifer Trower

Read Time: 5 mins

The tables below map the relationship between Sonar and Calix Cloud data fields used by the API integration. Use them to confirm what each Calix Cloud object receives and where in Sonar the value originates.

Core Field Mappings

Sonar Field
Sonar Object
Calix Cloud Field
Calix Cloud Object
Notes
ID
Account
Account
Subscriber
Name
Account
Account
Subscriber
First Name & Last Name
Contact
Name
Subscriber
The account's primary contact is used.
Phone Number
Contact
Phone
Subscriber
The primary contact's lowest-ID phone number is used.
Email Address
Contact
Email
Subscriber
The primary contact's email address is used.
Account Type
Account
Customer Sub-Type
Subscriber
The type of the account's associated account type is used.
Total Balance
Account
Overdue Balance
Subscriber
Custom Field Data
Custom Field
Field 1
Subscriber
Optionally mapped in integration settings. Account or serviceable address custom fields can be selected.
Custom Field Data
Custom Field
Field 2
Subscriber
Optionally mapped in integration settings. Account or serviceable address custom fields can be selected.
Custom Field Data
Custom Field
Field 3
Subscriber
Optionally mapped in integration settings. Account or serviceable address custom fields can be selected.
Custom Field Data
Custom Field
Field 4
Subscriber
Optionally mapped in integration settings. Account or serviceable address custom fields can be selected.
Custom Field Data
Custom Field
Field 5
Subscriber
Optionally mapped in integration settings. Account or serviceable address custom fields can be selected.
ID
Account
Subscriber ID
Service Location
ID
Address
Subscriber Location ID
Service Location
The serviceable address connected to the account is used.
Line 1, Line 2, City, Subdivision, Country, Zip
Address
Service Address
Service Location
Listed fields from the serviceable address are concatenated to pass the full address, including country.
City
Address
Service Address City
Service Location
City of the serviceable address is used.
Subdivision
Address
Service State
Service Location
Subdivision of the serviceable address is used.
Zip
Address
Service Post Code
Service Location
Zip of the serviceable address is used.
Latitude
Address
Service Latitude
Service Location
Latitude of the serviceable address is used.
Longitude
Address
Service Longitude
Service Location
Longitude of the serviceable address is used.
Attainable Download Speed
Serviceable Address
Attainable Rate (Download)
Service Location
Attainable download speed of the serviceable address is used. Converted to Mbps for Calix. Distinct from the subscribed service speed.
Attainable Upload Speed
Serviceable Address
Attainable Rate (Upload)
Service Location
Attainable upload speed of the serviceable address is used. Converted to Mbps for Calix. Distinct from the subscribed service speed.

Billing Address Mappings

Sonar Field
Sonar Object
Calix Cloud Field
Calix Cloud Object
Notes
Line 1, Line 2, City, Subdivision, Country, Zip
Address
Billing Address
Billing Address
Listed fields from the account's billing address are concatenated to pass the full address. If the account has no mailing address set, these fields are not populated.
City
Address
Billing City
Billing Address
Left unpopulated if the account has no mailing address set.
Subdivision
Address
Billing State
Billing Address
Left unpopulated if the account has no mailing address set.
Zip
Address
Billing Post Code
Billing Address
Left unpopulated if the account has no mailing address set.

Subscriber Profile and Status Mappings

Sonar Field
Sonar Object
Calix Cloud Field
Calix Cloud Object
Notes
Activation Date
Account
Signup Date
Subscriber Profile
Print Invoice
Account Billing Parameter
Electronic Communications Consent
Subscriber Profile
Accounts that receive their invoice electronically are set as having provided electronic communications consent.
Payment Method
Account
Autopay?
Subscriber Profile
Reflects whether a payment method on the account is set to Auto.
Next Recurring Charge
Account
Total Revenue Per Subscriber Per Month
Subscriber Profile
FIPS
Address
Census Tract
Subscriber Profile
FIPS for the serviceable address connected to the account.
Activation Date
Account
Service Start Date
Account Status/Details

Device and Endpoint Matching Mappings

Sonar Field
Sonar Object
Calix Cloud Field
Calix Cloud Object
Notes
Device ID
Devices
Devices
Devices
A comma-separated list of the devices associated with the account that are mapped in the Calix Cloud settings.
See Note
Account
Endpoint Matching Option 1
Flow Endpoint Matching Options
For mapped inventory models with a model category of RG, the corresponding inventory item's mapped Device ID field is used.
See Note
Account
Endpoint Matching Option 2
Flow Endpoint Matching Options
For mapped inventory models with a model category of ONT, the corresponding inventory item's mapped Device ID field is used.
See Note
Account
Endpoint Matching Option 3
Flow Endpoint Matching Options
For mapped inventory models with a model category set to anything besides RG or ONT, the corresponding inventory item's mapped Device ID field is used.
ID
Account
Endpoint Matching Option 4
Flow Endpoint Matching Options
The Sonar Account ID is always sent to Option 4 on every sync, regardless of the devices associated with the subscriber.

Service Definition Mappings

Sonar Field
Sonar Object
Calix Cloud Field
Calix Cloud Object
Notes
ID
Service
Service USOC
Global Service Definition
Type
Service
Service Type
Global Service Definition
Name
Service
Service Description
Global Service Definition
Data Service Download
Service
Download Speed
Global Service Definition
The download speed of the data service, converted to Mbps.
Data Service Upload
Service
Upload Speed
Global Service Definition
The upload speed of the data service, converted to Mbps.
Data Service Technology Code
Service
Technology Type
Global Service Definition
Amount
Service
Service Fee
Global Service Definition
The amount of the data service is used.

Engagement Cloud Mappings

The fields below are available for users subscribed to Calix's Engagement Cloud.

Calix Cloud Field
Calix Cloud Object
Sonar Field
Sonar Object
Notes
Opt Out
Account Status/Details
Marketing Opt In
Contact
When a Calix Cloud integration is enabled, this field is made visible on the Contact.
Location
Service Location
Subscriber Location
Calix Cloud Setting
Can be set to a fixed value (City, Subdivision, or Zip) or sourced from a custom field on the account or serviceable address.
Region
Service Location
Subscriber Region
Calix Cloud Setting
Can be set to a fixed value (City, Subdivision, or Zip) or sourced from a custom field on the account or serviceable address.
Service Group
Global Service Definition
Service Group Tiers
Calix Cloud Setting
Define up to 10 service group tiers based on data service download speed.

How did we do?

Atlas Digital CORE Integration

Calix SMx Integration: Overview

Contact