Reports to verify you hold the same entitlement data as Bango
If you store entitlement data on your own systems, you should supply it daily to Bango to allow Bango to perform a record correlation process and send you correlation reports.
The record correlation process checks that your data matches the Bango data, and highlights any discrepancies.
When you sign up to use the Bango Resale API for resellers, Bango Support will supply you with:
Bango supports two types of correlation:
Type | Description |
---|---|
Event Only (Default) | All entitlements for which an event occurred during the correlation period. |
Active + Event | All ACTIVE entitlements and all entitlements for which an event occurred during the correlation period. |
For both types of correlation, if there is more than one record for an entitlement in the same period you should provide us with the latest one.
Bango performs similar record correlation processes with merchants who make their products and services available through Bango Resale.
Unless otherwise agreed, the Bango data is considered the source of truth.
To supply correlation data to Bango, you must upload it to your 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.
s3://{customer}/CorrelationReports/{merchant}/Input
Where:
There are three correlation periods: monthly, weekly (Monday to Sunday), and daily.
Filenames include the start and end dates for the correlation period. Use this format:
{start}-{end}.csv
Where start
and end
are YYYYMMDD
UTC dates. For monthly and weekly periods, the end date is inclusive. For daily periods, the end date is exclusive (in other words, the day after the start day). Here are some examples:
Period | Example | Meaning |
---|---|---|
Monthly | 20200101-20200131.csv | January 2020 |
Weekly | 20200106-20200112.csv | Monday January 6, 2020 to Sunday January 12, 2020 |
Daily | 20200105-20200106.csv | January 5, 2020 |
All files must be Windows-1252 encoded and contain RFC 4180-compliant comma-separated values (CSV). All times must be UTC.
The data you provide to Bango must be in the following format:
Column | Type |
---|---|
ExternalEntitlementId | String |
CustomerIdentifier | String |
EntitlementId | UUID String |
Status | String |
MerchantAccountKey | String |
ProductKey | String |
OfferKey | String |
DisplayName | String |
CreatedDate | ISO 8601 timestamp string |
ActivatedDate | ISO 8601 timestamp string or null |
SuspendedDate | ISO 8601 timestamp string or null |
ResumedDate | ISO 8601 timestamp string or null |
ExpiryDate | ISO 8601 timestamp string or null |
EndDate | ISO 8601 timestamp string or null |
When comparing the data you supply to the data in the Bango Platform, Bango checks the following:
EntitlementId
– also known as the BangoEntitlementId
CustomerIdentifier
ProductKey
Status
Bango will generate four output files for each correlation period and store them in your S3 bucket at the location:
s3://{customer}/CorrelationReports/{merchant}/Output
Where:
The four correlation reports are:
Filename | Description |
---|---|
[ResellerId]-[Merchant]-[Reporting Period]-Matched.csv | All entitlements that matched |
[ResellerId]-[Merchant]-[Reporting Period]-BangoOnly.csv | Entitlements in the Bango Platform but not in the reseller system |
[ResellerId]-[Merchant]-[Reporting Period]-[ResellerId]Only.csv | Entitlements in the reseller sytem but not in the Bango Platform |
[ResellerId]-[Merchant]-[Reporting Period]-MisMatched.csv | Entitlements in both the Bango Platform and the reseller system, but not identical |
All report files are Windows-1252 encoded and contain RFC 4180-compliant comma-separated values (CSV). The columns are:
Column | Description |
---|---|
EntitlementId | (UUID string) Unique identifier for an entitlement |
ExternalEntitlementId | Unique identifier for an entitlement held by the reseller |
CorrelationResult | The result of the correlation for the individual entitlement. Values are:
|
To resolve any discrepancies, Bango recommends using our Batch processor. If you are unsure on the best steps to take to resolve the discrepancies please contact Bango Support.
Here are some example correlation reports:
Matched correlation report:
EntitlementId,ExternalEntitlementId,CorrelationResult
f5666778-dcee-4365-93a1-5f385f40eafc,,OK: Entitlement data matches
15dc371d-8c62-4c14-8cfc-5561d352f2e1,,OK: Entitlement data matches
5ec1ff0f-dc1d-4d0c-bc9e-b50b172193d6,,OK: Entitlement data matches
bb39454e-1841-4077-8ceb-a3828c0a9047,,OK: Entitlement data matches
Bango-only correlation report:
EntitlementId,ExternalEntitlementId,CorrelationResult
8a679908-2004-4ec8-a8c7-4c36e8dd5a5f,,Error: Extra Entitlement detected in Bango system
af6268b7-2029-4a60-b435-b21747efc54f,,Error: Extra Entitlement detected in Bango system
Reseller-only correlation report:
EntitlementId,ExternalEntitlementId,CorrelationResult,CorrelationDescription
bbb63636-3fe7-450e-bcda-073e2b6eee89,,Error: Missing Entitlement detected in Bango system
dfc92708-362c-472c-9052-d21e1e5b68fa,,Error: Missing Entitlement detected in Bango system
Unmatched correlation report:
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