- DATE:
- AUTHOR:
- TCB™ Product Team
TCB Version 2.0.0
Timezone Change
Overview
In this release, we are introducing changes to the timezone handling within the TCB Platform. Effective immediately, TCB will utilize the Atlantic Standard Time (AST) timezone for campaign start and redemption start times, and the Hawaii-Aleutian Standard Time (HST) timezone for campaign and redemption end times. Additionally, there are adjustments to timezone settings for reports, which will now consistently utilize the Greenwich Mean Time (GMT) timezone.
Key Changes
Timezone Standardization:
Campaign start and redemption start times will be referenced in the Atlantic Standard Time (AST) timezone.
Campaign end and redemption end times will be referenced in the Hawaii-Aleutian Standard Time (HST) timezone.
This standardization ensures consistency and clarity in scheduling and monitoring campaign activities across different time zones.
Four new time attributes will be added to Master Offer File fields /manufacturer/base_gs1s and /manufacturer/base_gs1/:base_gs1, /provider/base_gs1s and webhook notifications to allow for optimized syncing between partner systems:
campaign_start_time_utc = epoch time in sec
campaign_end_time_utc = epoch time in sec
redemption_start_time_utc = epoch time in sec
redemption_end_time_utc = epoch time in sec
Static Timezone Settings:
Timezone settings will no longer be dynamically set by the Enterprise. TCB will enforce the specified AST and HST timezones for campaign start, redemption start, campaign end, and redemption end times.
Report Timezone Alignment:
All generated reports will now uniformly utilize the Greenwich Mean Time (GMT) timezone.
This alignment simplifies data analysis and interpretation by providing a consistent timezone reference for all reporting purposes.
Impact and Considerations
Existing Campaigns: Existing campaigns will continue to operate as scheduled, but their time references will align with the new AST and HST timezones for start and end times respectively.
Reporting: Users should note the transition to GMT timezone for all reports, ensuring adjustments are made for accurate interpretation of data.
Enterprise Integration: Enterprises utilizing TCB should update their systems to accommodate the standardized timezone settings and ensure compatibility with report generation processes.
Deprecation of Bundle API for Local Bundling
Overview
In this release, we are announcing the deprecation of the Bundle ID API functionality. Going forward, bundling operations will occur locally without reliance on network connectivity or external APIs.
Key Changes
Deprecation of Bundle ID API:
The Bundle ID API, previously utilized for bundling operations, is now deprecated.
Bundling processes will no longer depend on external network connectivity for execution.
Local Bundling Implementation:
Bundling operations will be performed locally within the application environment.
This change eliminates potential points of failure related to network dependencies and enhances the reliability of bundling processes.
Simplified Integration:
Developers no longer need to manage interactions with external APIs for bundling purposes.
Integration efforts are streamlined, reducing complexity and potential points of failure associated with network requests.
Impact and Considerations
Migration Path: Existing implementations relying on the Bundle API should migrate to the updated local bundling approach.
Deprecation of TCB-Generated Fetch Code in Favor of Time-Bound Fetch Code
Overview
In this release, we are deprecating the TCB-generated fetch code functionality in favor of the newly introduced Time-Bound Fetch Code feature. The Time-Bound Fetch Code offers enhanced flexibility for providers by allowing time confinement, alphanumeric inclusion for e-commerce platforms, and customizable code length.
Key Changes
Deprecation of TCB Generated Fetch Code:
The previous method of generating fetch codes through TCB is now deprecated.
Users are encouraged to transition to the Time-Bound Fetch Code feature for all fetch code generation needs.
Introduction of Time-Bound Fetch Code:
Time-Bound Fetch Code is the new method for generating fetch codes within TCB.
This feature provides increased flexibility and customization options for fetch codes.
Enhanced Flexibility for Providers:
Time-Bound Fetch Code allows providers to set time constraints for code validity, ensuring codes are redeemable for specified/ extended timeframes.
Alphanumeric inclusion capability is introduced, particularly beneficial for e-commerce platforms requiring more complex code formats.
Customizable code length provides flexibility in adapting to different use cases and security requirements.
Impact and Considerations
Migration Process: Users currently utilizing TCB-generated fetch codes should migrate to the Time-Bound Fetch Code feature.
Integration Updates: Any integrations or systems relying on fetch codes generated by TCB should be updated to accommodate the transition to Time-Bound Fetch Code.
Deprecation of Delete Serialized Data String API
Overview
In this release, we are announcing the deprecation of the Delete Serialized Data String API functionality. Once a Serialized Data String is created, it will remain permanent. Providers can delete the serialized data string locally and hide it from the consumer experience to ensure the consumer cannot access the data string for redemption.
Replacement of Queryable Data Interface with Direct Downloadable Reports (CSV) Feature
Overview
In this release, we are introducing a significant enhancement by replacing the Queryable Data interface with the capability to directly download reports in CSV format from the portal. This enhancement aims to streamline data access and improve user experience by providing convenient and efficient access to report data.
Key Changes
Replacement of Queryable Data Interface:
The previous Queryable Data interface is deprecated and replaced with a more intuitive approach.
Users will no longer rely on querying data through an interface; instead, they can directly download reports in CSV format from the portal.
Direct Downloadable Reports (CSV):
The portal now offers a feature to download reports in CSV (Comma-Separated Values) format.
Users can access comprehensive data reports with ease and flexibility, enabling efficient analysis and decision-making.
Improved User Experience:
This enhancement significantly improves the user experience by eliminating the need for complex query operations.
Users can quickly obtain the data they need in a familiar CSV format, reducing time and effort required for data retrieval.
Impact and Considerations
Migration Considerations: Users accustomed to the Queryable Data interface should transition to the new method of downloading reports directly in CSV format.
Data Accessibility: Direct downloadable reports enhance data accessibility and usability, benefiting users across various roles and departments.
Training and Documentation: Updated training materials and documentation will be provided to guide users through the new process of downloading reports.
Introduction of New Authorized Partner Roles (L1, L2, L3)
Overview
In this release, we are introducing a significant enhancement to Authorized Partner classification and associated functionality. Authorized Partners will now be classified by levels 1, 2, and 3. Additionally, authorization for authorized partners is now granted at the Enterprise level, replacing brand-level permissions. With the new Authorized Partner Level 1 (L1) role, Enterprises gain comprehensive management capabilities for the Manufacturer feature set, including brand management, category management, and funder management. Level Details:
Level 1: Manage brands, brand categories, funder IDs, and master offer files. All master offer files will be visible
Level 2: Manage master offer files. Only master offer files created by the authorized partner will be visible
Level 3: View reports only.
Key Changes
Introduction of Authorized Partner Levels:
Three new authorized partner roles have been introduced: L1, L2, and L3.
These roles provide varying levels of access and permissions within the platform, tailored to the needs and responsibilities of different partners.
Enterprise-Level Authorization:
Authorization for authorized partners is now managed at the Enterprise level.
This replaces the previous method of granting permissions at the brand level, providing a more centralized and efficient authorization process.
Impact and Considerations
Role Assignment: Enterprises should review and assign appropriate roles (L1, L2, L3) to authorized partners based on their responsibilities and access requirements.
Migration from Brand-Level Permissions: Existing brand-level permissions are deprecated in favor of Enterprise-level authorization. Enterprises should adjust their authorization processes accordingly.
Deprecation of Long-Lived Tokens from TCB Login
Overview
In this release, we are deprecating the functionality allowing login with Time-Campaign-Backend (TCB) credentials to obtain long-lived tokens valid for two years. This decision is driven by security concerns associated with the use of non-expiring tokens, which pose a risk to the overall security posture of the system.
Key Changes
Deprecation of Login with TCB for Long-Lived Tokens:
The capability to obtain long-lived tokens (valid for two years) through TCB login is deprecated.
Users will no longer be able to obtain tokens with extended validity periods via this method.
Security Concerns Addressed:
The decision to deprecate long-lived tokens is driven by security concerns associated with their usage.
Non-expiring tokens present a higher risk of unauthorized access and compromise, as they do not automatically expire after a reasonable duration.
Enhanced Security Measures:
By deprecating long-lived tokens, we are strengthening the security posture of the system.
Users are encouraged to utilize token-based authentication mechanisms that adhere to industry best practices and employ token expiration policies for improved security.
Impact and Considerations
Transition to Short-Lived Tokens: Users relying on long-lived tokens obtained through TCB login should transition to short-lived tokens with reasonable expiration periods.
Addition of New Category Option for Brand Classification
Overview
In this release, we are introducing a new category option for brand classification within the system. Categories play a vital role in dashboard reporting and organizing data, providing users with enhanced clarity and organization of brand-related information.
Key Changes
Introduction of New Category Option:
A new category option has been added for brand classification purposes.
This option allows for further refinement and categorization of brands within the system.
Utilization in Dashboard Reporting:
The new category option will be utilized in dashboard reporting, enabling users to analyze and visualize brand data based on the assigned category.
Organization of Master Offer Files:
Categories will also be used to organize brand-related information within the Master Offer File.
Users can utilize categories to efficiently search, filter, and manage Master Offer Files, streamlining Master Offer File management processes.
Impact and Considerations
Data Organization: Users should familiarize themselves with the new category option and utilize it for organizing brand-related data effectively.
Updates to Master Offer File Change Criteria
Overview
In this release, we have updated the criteria for changes in the Master Offer File to ensure continuity of information between manufacturer partners. These updates include changes to offer lock/unlock functionality and editing restrictions to the campaign and redemption start and end dates.
Key Changes
Offer Lock/Unlock Functionality:
Offers can be locked or unlocked before the campaign start date.
Once the campaign starts, offers can no longer be unlocked, ensuring data integrity during the active campaign period.
Campaign and redemption dates, circulation, description, and UPCs can edited on locked campaigns.
Campaign Start Date Editing:
The campaign start date can now be edited to any time after the present date.
Campaign End Date Editing:
The campaign end date can be edited to any date after the present date and after the campaign start date.
Redemption Start Date Editing:
Redemption start dates can now be edited to any date after the present date and after the campaign start date.
Redemption End Date Editing:
Redemption end dates can be edited to any date after the present date and on or after the campaign end date.
Impact and Considerations
Improved Flexibility: These updates offer greater flexibility in managing campaign and redemption timelines within the Master Offer File.
Enhancement to Sub-Retailer Management and Retailer Name Editing
Overview
In this release, we are introducing enhancements to the Sub-Retailer management functionality, providing users with the capability to edit the Retailer Name.
Key Changes
Sub-Retailer Management Enhancement:
Sub-Retailers will now include the capability to edit the Retailer Name.
Users can update the Retailer Name associated with a Sub-Retailer as needed, providing greater flexibility and accuracy in managing retailer information.
Impact and Considerations
Enhanced Sub-Retailer Management: Users should familiarize themselves with the capability to edit Retailer Names for Sub-Retailers and incorporate it into their data management processes.
Introduction of Custom Provider Circulation for Master Offer Files
Overview
In this release, we are introducing the Custom Provider Circulation feature for Master Offer Files, allowing circulation limits to be set per provider for offers distributed by multiple authorized distribution providers. This feature enhances control over offer distribution and allocation, enabling customized circulation management based on provider-specific needs.
Key Changes
Custom Provider Circulation Capability:
Custom Provider Circulation allows circulation limits to be set per provider on Master Offer Files with multiple authorized distribution providers.
Circulation allocation can be made to any number of authorized providers, providing flexibility in distribution management.
Optional Restriction and Removal:
The circulation restriction is optional and can be added or removed at any time using the delete custom circulation API.
Users have the flexibility to adjust circulation settings as needed, adapting to changing distribution requirements.
API Support for Retrieval of Circulation Information:
A new GET API has been added for manufacturers to retrieve information about the allocated distribution.
This feature is currently accessible only through the API and is not available in the user interface.
Impact and Considerations
Enhanced Distribution Control: Custom Provider Circulation offers enhanced control over offer distribution, allowing for tailored circulation limits per provider.
API Integration: Users utilizing the Custom Provider Circulation feature must access it through the provided APIs.
Introduction of Retailer Restriction at Serialized Data String Level
Overview
In this release, we're introducing a new capability that allows providers to limit the redemption of serialized data strings to a particular retailer. This functionality is activated when a manufacturer designates the 8112 campaign as retailer-restricted by associating a group of retailers with the master offer file. Providers can then choose one from this list to further confine the redemption to a specific retailer.
Manufacturers also have the option to specify whether the retailer restriction is obligatory at the deposit level. This requirement compels the provider to choose one retailer from the assigned retailer list during the deposit process. This functionality is particularly useful in retailer loyalty programs, where providers can deposit coupons within the retailer app and ensure that the specific serialized data string is only redeemable at that particular retailer location.
Key Changes
Manufacture API to make the retailer restriction mandatory during deposit:
manufacturer/base_gs1/:base_gs1/serialized_gs1_retailer_restriction: This is available in the Manufacturer and the Authorized Partner.
restrict_retailer_email_domain attribute in /provider/deposit API
Impact and Considerations
This is an entirely optional feature specifically designed for handling retailer loyalty scenarios.
Enhanced Dashboard Experience
Overview
We've fully upgraded the dashboard to include new charts and graphs, providing a clearer view of your 8112 campaigns. Manufacturers can now filter the dashboard by brand or category and have the option to export the data as a CSV file for use in their internal BI tools.
Version 2.0.0 Load Testing Result
Overview
The TCB team has conducted thorough load testing of the platform, and we're thrilled to share that we've achieved a throughput of 6200 transactions per second. The comprehensive load testing results have been made available at https://perf.thecouponbureau.org. Below is an image illustrating an overview of the load testing outcomes.
