Skip to content

← Back to Loyalty program

Introduction

Welcome to the configuration manual for the Loyalty Program, an integral component of the ONe B2B platform's plugin framework. With an array of plugins available on the platform, it's essential to ensure a seamless integration and optimal performance. This manual will guide you through the process of configuring the Loyalty Program, ensuring that it complements and enhances your platform experience.

Context

The ONe B2B platform, known for its modular architecture, supports a suite of plugins designed to extend functionality and offer tailored experiences for businesses. The Loyalty Program, a strategic tool to reward and retain customers, is one such plugin that dovetails into this architecture. However, setting it up requires attention to both its core data structures and its plugin-specific configurations.

Core Data & Shared Database

Certain foundational data elements for the Loyalty Program reside in our shared database, ensuring that they can interface harmoniously with other plugins when needed. This shared resource fosters interoperability and reduces redundancies, but a redundand storage of ONe.

Plugin-Specific Configurations

In addition to the core data, there are settings and configurations unique to the Loyalty Program plugin. These configurations ensure that the Loyalty Program operates in sync with your business objectives, without affecting the functionalities of other plugins.

As you navigate through this manual, you will gain insights into both these facets – the core data structures and the plugin-specific configurations, empowering you to tailor the Loyalty Program to your business needs effectively.

Shared Settings Configuration Guide

Welcome to the shared settings section of the Loyalty Program configuration manual. These settings, stored in the shared database, interact with various plugins on the ONe B2B platform, thus ensuring seamless interoperability across functionalities.

Below is a step-by-step guide to understanding and configuring each of the shared settings:

Company Logo URL

  • Description: This is the link where your company's logo is hosted. It will be displayed in various sections of the plugins.
  • Default Value: empty

Configuration Guide:

Ensure the URL provided is accessible publicly. Supported formats are typically .jpg, .png, and .svg. Update the URL whenever there's a change in the company's logo. We recommend to upload the image to the media libary of ONe and copy the link here.

Last Product Update Date

  • Description: This date indicates when the products were last updated. It helps in syncing products across plugins and tracking changes.

Configuration Guide:

Typically, this field is auto-updated whenever there's a change. Ensure it corresponds with the actual date of the last product update.

Event IDs

Description: Event IDs help track the last synchronization or update event for various entities. They ensure data consistency across plugins.

  • Last Product Update Event ID: Tracks product updates.
  • Customer Update Last Event ID: Tracks customer data updates.
  • Customer User Update Last Event ID: Tracks updates specific to customer users.
  • Order Synchronization Event ID: Tracks order data synchronization events.
  • Invoice Synchronization Event ID: Tracks invoice data synchronization events.

Configuration Guide:

These fields are generally auto-populated and should be monitored for consistency. If there are discrepancies, refer to the event logs or relevant plugin configurations.

Document Synchronization

  • Description: Determines if documents should be synchronized across plugins.
  • Configuration Guide: Toggle this setting based on business requirements.

Synchronization of Customer Users

  • Description: Determines if customer user data should be synchronized across plugins.
  • Configuration Guide: Enable or disable based on the business need. If customer user data is crucial across multiple functionalities, it's advisable to keep this enabled.

Synchronize Warehouses

  • Description: This setting controls the synchronization of warehouse data across plugins.

Configuration Guide:

If warehouse data is utilized in multiple plugins or functions, enable this setting.

Synchronize BackOffice Users

  • Description: Controls the synchronization of back-office user data across plugins.
  • Configuration Guide: Enable this if back-office user data needs consistency across the platform.

Loyalty Program Configuration Guide

Loyalty Program Declaration Type ID

  • Description: The Declaration Type ID refers to the unique identifier associated with the type of user agreement specific to the loyalty program conditions. It's pivotal for tracking and verifying if users, specifically those within the B2B (organization) type, have agreed to the terms and conditions of the loyalty program.
  • Source: The Type ID is derived from ONe's agreement types.
  • Default Value: mull

Configuration Guide:

  • To set up the Loyalty Program, the operator must first create a new agreement type within ONe's platform specifically tailored for the loyalty program.
  • Then the operator must create and activate a new agreement in the ONe’s platform Agreements configuration.
  • This ID is auto-generated and should linked directly into the plugin’s “Declaration type ID” field.
  • If changes are made to the loyalty program conditions, or if a new type of loyalty agreement is introduced, it's essential to update or add a new Declaration Type ID accordingly.

🛑 ATTENTION! In ONe, agreements undergo versioning. It's crucial to understand that when a new version of an agreement is introduced, ONe automatically marks the previously agreed-upon versions as disagreed for the users. To ensure consistency and avoid any potential confusion or disagreement issues, we highly recommend crafting your agreement document and associating it with a fixed URL. If there's a need to update the terms or conditions, simply modify the content behind this fixed URL. This approach helps you prevent the creation of multiple versions for the same agreement. By adhering to this best practice, you can maintain clarity in agreement management and uphold a streamlined communication process with your stakeholders. (User and Agreement defined in the next section)

  • Regularly monitor to ensure that B2B user agreements are being synchronized and correctly tracked using this ID. It's crucial to note that the Loyalty Program is designed exclusively for B2B clients and is not applicable to B2C customers.
  • Ensure that the agreement type set up is marked or categorized for B2B only to avoid any confusion or misapplication of loyalty terms to B2C customers.

Loyalty Points Expiration [Month]

  • Description: Determines the lifespan of loyalty points after they have been awarded to a user. After the set duration, the points will expire.
  • Default Value: 24

Configuration Guide:

  • Set the desired expiration period in months.
  • Ensure users are informed about the expiration timeline, so they can utilize their points effectively.
  • Regularly monitor and adjust based on customer feedback and business needs.

Adjustable Maximum Multiplier Value

  • Description: This setting denotes the maximum multiplier value that can be used for calculations involving loyalty points.
  • Default Value: 2

Configuration Guide:

The setting is useful in scenarios where promotions or bonuses are offered, and you want to control the maximum multiplier. what can given for a client in the point calculation rules.

Product Attribute Containing Loyalty Base Points (Not Global)

  • Description: Determines which specific product attribute should be used to define the base loyalty points.

Configuration Guide:

  • If loyalty points are defined at the product level (and not globally), specify which attribute should be considered.
  • This ensures that every product awards a consistent number of loyalty points based on its assigned attribute.

Ignore Items Invoiced from Offline Orders

  • Description: This setting decides whether items invoiced from offline orders should be considered for loyalty points.

Configuration Guide:

  • Toggle based on your business model. If your organization wishes to provide loyalty points only for online transactions, enable this feature.

Loyalty Program Scheduled Tasks

  • Description: These are the automated tasks set up to ensure the smooth functioning of the loyalty program, such as awarding points after a purchase or subtracting points upon expiry.

Configuration Guide:

  • Review these tasks regularly to ensure they are running as scheduled.
  • Modify or add tasks based on new features or changes in the loyalty program.