Merchant Record Correlation Reports

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. Bango support two types of correlation which are detailed below:

CorrelationType	Description
Event Only (Default)	All entitlements which have had an event in the correlation period being run. If there is more than one record for an entitlement in the same period you should provide us with the latest one.
Active + Event	Consists of all `ACTIVE` entitlements and all entitlements which have had an event in the correlation period being run. 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 resellers who offer your products and services to customers through Bango Resale. Unless otherwise agreed, the Bango data is considered the source of truth.

Supplying correlation data to Bango

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. All times should be in UTC. The files must be RFC 4180 CSV format, in a single file for each correlation period and uploaded to a dedicated input folder broken down by reseller. The naming convention for the reseller must match the resellerKey Bango use for the reseller. E.g. s3://merchant_identifier/CorrelationReports/[Reseller]/Input/ File name and examples

	File Name	Example File Name
Monthly	YYYYMMDD-YYYYMMDD.csv	Example correlation file name for January 2020 - `20200101-20200131.csv`
Weekly	YYYYMMDD-YYYYMMDD.csv	Weekly record correlation is defined as Monday to Sunday. Example correlation file name for Monday 6th January 2020 to Sunday 12th January 2020 - `20200106-20200112.csv`
Daily	YYYYMMDD-YYYYMMDD.csv	Example correlation file name for 5th January 2020 - `20200105-20200106.csv`

Bango will provide the merchant the following information to access their specific S3 storage area:

Information	Description
Amazon S3 Endpoint (dedicated to the merchant)	Endpoint used for the merchant to connect to their dedicated file storage (e.g. s3://merchant_identifier/)
Access Key	A string which acts as the username to access the Amazon S3 storage
Secret Key	A string which acts as the password to access the Amazon S3 storage

This information will be provided by our Bango support team as part of the provisioning process. Examples of accessing data stored in Amazon S3 are:

Data comparison results

When comparing the data you supply to the data in the Bango Platform, Bango checks the following: ExternalEntitlementId also known as the MerchantEntitlementIdProductKeyStatus

Record correlation report input format

The data you provide to Bango must be in the following format:

Header	Type
`ExternalEntitlementId`	String
`BangoUserId`	String
`EntitlementId`	UUID String
`Status`	String
`ResellerKey`	String
`ProductKey`	String
`OfferKey`	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
`EndDate`	ISO 8601 timestamp string or null

Record correlation report output files

Bango will provide four output files for each correlation execution in an output folder. The naming convention for the OTT service provider must match the merchantAccountKey value passed in the create entitlement. E.g. s3://merchant_identifier/CorrelationReports/[OTTServiceProvider1]/Output/

File name	File description
Matching Entitlements	All entitlements that matched
Bango Only Entitlements	Extra Entitlements detected in Bango system
[Merchant Name] Only Entitlements	Missing Entitlements detected in Bango system
Mismatching Entitlements	Entitlements which both Bango and the Reseller have in their system but there are discrepancies with the data held

Record correlation report output results

Column name	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. Expected values are `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`, or `Error: Multiple differences`.

Bango recommends that merchants resolve any discrepancies identified by contacting Bango Support. Here’s an example of a 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

Here’s an example of a 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

Here’s an example of a 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

Here’s an example of an unmatched correlation report:

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

General

Reseller

Merchant

End of Life

Supplying correlation data to Bango

Data comparison results

Record correlation report input format

Record correlation report output files

Record correlation report output results

​Supplying correlation data to Bango

​Data comparison results

​Record correlation report input format

​Record correlation report output files

​Record correlation report output results

Supplying correlation data to Bango

Data comparison results

Record correlation report input format

Record correlation report output files

Record correlation report output results