Reseller Record Correlation Reports

If you store entitlement data in your own systems, supply it daily to Bango so Bango can compare your records with the corresponding Bango entitlement data and return correlation reports. The record correlation process identifies records that match and highlights discrepancies. Unless otherwise agreed, Bango data is considered the source of truth.

Access control

When you onboard to the Bango Resale API for resellers, Bango Support provides:

Your Amazon S3 endpoint for correlation data
An access key for the S3 endpoint
A secret key for the S3 endpoint

Correlation types

Bango supports two correlation types.

Type	Description
Event Only (Default)	Include entitlements where an event occurred during the correlation period.
Active + Event	Include all `ACTIVE` entitlements and entitlements where an event occurred during the correlation period.

If an entitlement has more than one record in the same correlation period, provide only the latest record. Bango performs similar record correlation with merchants that make products and services available through Bango Resale.

Supply correlation data to Bango

Upload correlation data to the reporting Amazon S3 bucket provided by Bango by 04:00 UTC on the day after the end of the reporting period. Provide one file for each merchant for each correlation period.

Upload location

Upload files to:

s3://{customer}/CorrelationReports/{merchant}/Input

Variable	Description
`{customer}`	Your unique Amazon S3 bucket
`{merchant}`	The merchant account key used when creating an entitlement

File names

Bango supports three correlation periods:

Monthly
Weekly, from Monday to Sunday
Daily

Use this file naming convention:

{start}-{end}.csv

start and end are UTC dates in YYYYMMDD format. For monthly and weekly files, end is inclusive. For daily files, end is exclusive.

Period	Example	Meaning
Monthly	`20200101-20200131.csv`	January 2020
Weekly	`20200106-20200112.csv`	January 6–12, 2020
Daily	`20200105-20200106.csv`	January 5, 2020

Input file format

Files must:

Use Windows-1252 encoding
Contain RFC 4180-compliant CSV
Use UTC for all timestamps

Supply these columns:

Column	Type
`ExternalEntitlementId`	String
`CustomerIdentifier`	String
`EntitlementId`	UUID string
`Status`	String
`MerchantAccountKey`	String
`ProductKey`	String
`OfferKey`	String
`DisplayName`	String
`CreatedDate`	ISO 8601 timestamp
`ActivatedDate`	ISO 8601 timestamp or `null`
`SuspendedDate`	ISO 8601 timestamp or `null`
`ResumedDate`	ISO 8601 timestamp or `null`
`ExpiryDate`	ISO 8601 timestamp or `null`
`EndDate`	ISO 8601 timestamp or `null`

Data comparison

Bango correlates each record using EntitlementId, also known as BangoEntitlementId. The following values are compared:

CustomerIdentifier
ProductKey
Status

Correlation output

Bango generates four output files for each correlation period and stores them in:

s3://{customer}/CorrelationReports/{merchant}/Output

File name	Description
`[ResellerId]-[Merchant]-[Reporting Period]-Matched.csv`	Entitlements that matched
`[ResellerId]-[Merchant]-[Reporting Period]-BangoOnly.csv`	Entitlements present in Bango but not in the reseller system
`[ResellerId]-[Merchant]-[Reporting Period]-[ResellerId]Only.csv`	Entitlements present in the reseller system but not in Bango
`[ResellerId]-[Merchant]-[Reporting Period]-MisMatched.csv`	Entitlements present in both systems where one or more compared values differ

Output files use Windows-1252 encoding and RFC 4180-compliant CSV. Each output file contains:

Column	Description
`EntitlementId`	UUID identifying the entitlement
`ExternalEntitlementId`	Reseller identifier for the entitlement
`CorrelationResult`	Result of the record comparison

Possible CorrelationResult values include:

OK: Entitlement data matches
Error: Extra Entitlement detected in Bango system
Error: Missing Entitlement detected in Bango system
Error: ProductKey is different
Error: Status is different
Error: CustomerIdentifier is different
Error: Multiple differences

Example reports

Matched

EntitlementId,ExternalEntitlementId,CorrelationResult
f5666778-dcee-4365-93a1-5f385f40eafc,,OK: Entitlement data matches
15dc371d-8c62-4c14-8cfc-5561d352f2e1,,OK: Entitlement data matches

Bango only

EntitlementId,ExternalEntitlementId,CorrelationResult
8a679908-2004-4ec8-a8c7-4c36e8dd5a5f,,Error: Extra Entitlement detected in Bango system

Reseller only

EntitlementId,ExternalEntitlementId,CorrelationResult
bbb63636-3fe7-450e-bcda-073e2b6eee89,,Error: Missing Entitlement detected in Bango system

Mismatched

EntitlementId,ExternalEntitlementId,CorrelationResult
6c92895b-b521-44f2-afb8-1a83db9aff50,,Error: ProductKey is different
ee803684-847b-4549-84cf-7c7879221571,,Error: Status is different
9915b3f5-d5bb-4569-afb0-3e64bde9909e,,Error: CustomerIdentifier is different
d1a70dcc-0b24-4531-991a-47df73b5caf3,,Error: Multiple differences

To resolve discrepancies, use Batch processing where appropriate. Contact Bango Support if you need help determining the correct action.

General

Reseller

Merchant

End of Life