Bango uses cookies to give you the best website experience. By using this website you agree to let Bango use cookies. More info
OK
Bango Developer
  1. Bango Resale
  2. For resellers
  3. Reporting
  4. Reseller Record Correlation Reports

Reseller Record Correlation Reports

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.

Access control

When you sign up to use the Bango Resale API for resellers, Bango Support will supply you with:

  • Amazon S3 endpoint: all your correlation data will be uploaded here
  • Access key: your unique username for accessing the S3 endpoint
  • Secret key: your unique password for accessing the S3 endpoint

Correlation types

Bango supports two types of correlation:

TypeDescription
Event Only (Default)All entitlements for which an event occurred during the correlation period.
Active + EventAll 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.

Supplying correlation data to Bango

To supply correlation data to Bango, you must upload it to your reporting Amazon S3 bucket provided by Bango within 4 hours of the period finishing (periods are in UTC). Provide one file for each merchant for each correlation period.

Upload location

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

Where:

  • customer is your unique Amazon S3 bucket
  • merchant is a merchant account key, as used when creating an entitlement

Filenames

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:

PeriodExampleMeaning
Monthly20200101-20200131.csvJanuary 2020
Weekly20200106-20200112.csvMonday January 6, 2020 to Sunday January 12, 2020
Daily20200105-20200106.csvJanuary 5, 2020

File format

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:

ColumnType
ExternalEntitlementIdString
CustomerIdentifierString
EntitlementIdUUID String
StatusString
MerchantAccountKeyString
ProductKeyString
OfferKeyString
DisplayNameString
CreatedDateISO 8601 timestamp string
ActivatedDateISO 8601 timestamp string or null
SuspendedDateISO 8601 timestamp string or null
ResumedDateISO 8601 timestamp string or null
ExpiryDateISO 8601 timestamp string or null
EndDateISO 8601 timestamp string or null

Data comparison results

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
  • Record correlation report output files

    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:

    • customer is your unique Amazon S3 bucket
    • merchant is a merchant account key, as used when creating an entitlement

    The four correlation reports are:

    FilenameDescription
    Matching EntitlementsAll entitlements that matched
    Bango Only EntitlementsEntitlements in the Bango Platform but not in the reseller system
    [Reseller Name] Only EntitlementsEntitlements in the reseller sytem but not in the Bango Platform
    Mismatching EntitlementsEntitlements 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:

    ColumnDescription
    EntitlementId(UUID string) Unique identifier for an entitlement
    ExternalEntitlementIdUnique identifier for an entitlement held by the reseller
    CorrelationResult

    The result of the correlation for the individual entitlement. 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
    • Error: Multiple differences

    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
    Copyright © 2000–2021 Bango.net Limited