• Create a

• business owner user - When creating a new Business (or Merchant/Service Provider) via the back-end system, it’s also possible to create and invite an Admin user on-the-fly. Simply enable the respective toggle, and invite the User by completing their personal information in the area below. This action can also be performed by

Image Removed

• masquearading to the business and navigating to Settings > Security > User Roles & Users > Users > Invite User.

Image Added

When a Business user signs in to a business (or a Service Owner user masquerades as the business), they can access the business’s configuration by clicking on their user name in the top right-hand corner of the screen and then selecting My Business. Additional configuration is available at this level.

Image Added

• Enable WiFi Network - A Business, Merchant/Service Provider and/or Venue/Service Point can define whether WiFi Networks are supported (usually when they provide services related to Internet access, VoIP and IPTV to residential and Business customers).

• Enabling a WiFi Platform, a set of attributes should be provided

  • WiFi Platform - Defines the WiFi platform (e.g. Unifi) that such service will be provided.

  • Site Identifier - An

  id

  • ID provided by the WiFi Platform to identify the Organisation and keep track of service usage.

  • WiFi Network - Defines the wireless networks specific to each Organisation's physical location, enabling customers to connect and join these networks. Additional actions can be performed on such networks, such as enabling and/or disabling them.

  • Guest Portal - Defines the portal URL endpoint, where customers will land when joining a WiFi Network. Such a portal is responsible for authenticating customers, granting access to the Internet, or placing an order for additional usage (if already consumed)

• Opening Hours - Optionally specify the

• Business’s operating hours for ordering delivery and pick-up. Delivery and pick-up can also be

• closed using the toggles Is delivery closed? and Is pick-up closed?

Commercial Terms - Set the business' commercial terms by signing in or navigating to the Business level > select your signed-in user name in the top right-hand corner of the screen > My Business.

• Commercial Terms

  • Apply award settlement on spend? - The Business can define whether

  settlement takes place for the Merchants the moment

  • B2B settlements (business charges and rebates) are applied for Merchants when a Contact is awarded or

  upon the Contact spending

  • when a Contact spends.

  • Contact Self-submit Purchases - Contacts will be able to submit a purchase by scanning a QR code or Barcode and be awarded. A Business can define a set of soft rules to prevent unauthorised behaviour, such as the maximum number of purchases and/or purchased amount that a contact can submit.

Merchant/Service Provider Configuration

A Merchant/Service Provider would typically be created by a back-end Business user or a user who has masqueraded to as a Business.

When creating a Merchant/Service Provider, attention should be paid to the following settings:

• Address - If Google Places is configured, set the Business address and Google Place id - this is particularly useful if front-end apps are used.

• Create a Merchant/Service Provider Admin user - Create and invite an Admin user on-the-fly. Simply enable the respective toggle, and invite the User by completing their personal information in the area below. This action can also be performed by navigating to Settings > Security > User Roles & Users > Users > Invite User.

Image Removed

Image Added

Once created, select the Merchant/Service Provider to edit any of the following optional configurations:

• Anchor
  TAPs TAPs

  Transaction Acquiring Points - Define the

• devices where transactions are captured and/or processed on-site.

  • Name - The TAP name.

  • Code - A TAP’s main identification attribute is

• • its code which must be unique.

  • Type: Choose the TAP type:

    • External Reference -

  mapped

  • • Mapped to

  external reference integration

  • • an external integration. Select from the available types and proceed to configure the IP address and port settings.

    • POS - Represents a Point of Sale terminal, where purchase customer events are captured and submitted to CRM.COM. Each POS terminal usually has a unique code used for identification purposes (determining in which venue is installed); such code should be defined on the TAP code.

    • Receipt Printer - Allows provisioning and printing of CRM.COM orders to an external ESC/POS printer. Print provisioning requires the printer’s IP address and port to be defined on the TAP.

    • Card Terminal - Payment card machine.

To add a TAP for a Business, click on the ‘eye’ icon on the right-hand side of the screen.

Image Removed

Image Added

Enable WiFi Network - refer to Business configuration.

• Opening Hours - Optionally specify the Merchant’s/Service Provider’s operating hours for ordering delivery and pick-up. Delivery and pick-up can be disabled using the toggles Is delivery closed? and Is pick-up closed?

• Payment Methods

The settlement process charges participating Organisations (usually Merchants) the cost of awards. The settlement process creates financial transactions either in real-time or at a set time intervals (e.g. daily).

Image Removed

• Settle on award (default) - The Merchant will be debited for the awarded amount (and the award owner credited) upon awarding the Contact.

• Settle on spend - The Merchant will be debited for the awarded amount (and the award owner will be credited) when the Contact spends (redeems) their award.

Opening Hours - Specify the Merchant’s operating hours for ordering delivery and pick-up. Delivery and pick-up can be disabled using the toggles Is delivery closed? and Is pick-up closed?

Image Removed

Products not available for sale - Identify any temporarily unavailable products or those that can’t be delivered or picked-up by simply selecting the product, along with the supply method.

Image Removed

Venue/Service Point Configuration

These settings are applicable for Venues and Service Points.

Venue/Service Point has the same industry and business scope as it’s parent - A Venue/Service Point can inherit its parent’s business-related definitions or, alternatively, define its own.

Image Removed

Image Removed

Enable WiFi Network - refer to Business configuration.

Opening Hours

Refer to the Merchant/Service Provider section to see how to configure opening hours.

Products not available for sale

Refer to the Merchant/Service Provider section to define products unavailable for sale.

Copying and Deleting a Business

Service Owners have the ability to perform administrative actions, such as copying and deleting existing Business organisations.

Navigate to Business Network > Businesses > select the options button on the Business card > Copy/Delete

Image Removed

• Copy - Copies an entire Business organisation, including all its data and configuration, to a new Business organisation name. The following data is not copied:

  • Transactional data (e.g. customer events and financial transactions)

  • Creatives (of all modules)

  • Analytics (Insights and Reports)

  • Commerce products

  • Finance pass plans

  • Platform applications, custom forms, filters, import data and white-label settings

  • Tenancy & Security API Keys, users and webhooks

• Delete - Permanently deletes a Business organisation, including all its data (test and live) - such as contacts, transaction acquiring points, applications, orders and rewards. In addition, any Merchant/Venue or Service Provider/Service Point child organisations and their data will also be deleted.

To masquerade as another Organisation, navigate to the Business Network option from the sidebar menu and select the masquerade icon from the Service Owner, Transaction Processor, the Business, or Merchant/Service Provider screen.

Image Removed

To switch back to the Organisation from where you masqueraded - select your login name (top right-hand corner of the screen) > Switch to ….

Image Removed

Suppose a Service Owner, a Business or a Merchant/Service Provider wants to restrict the actions of a child organisation. In that case, they can do so by changing the Organisation's State to either Inactive or Suspend. If need be, this action can be reversed at any point in time.

Navigate to the summary screen where the Organisation appears, locate the Business/Merchant/Venue, select the options button and choose the required action.

Image Removed

To reactivate an organisation, follow the same procedure, but this time select Activate.

Applied Restrictions

As mentioned previously, only Business, Merchant and Venue organisations have a state, and each state has a set of restrictions detailed below.

• For Business organisations

• ACTIVE

  • No restrictions apply, and any operations can be performed

INACTIVE

• Users (of any organisation type belonging to its business network, including Business users)

  • Cannot sign in to the back-end system

  • Cannot perform any actions (e.g. create a contact, create reward offers)

• Contacts

  • New contacts cannot register from front-end applications

  • Existing contacts cannot sign in to front-end applications

Organisation operations

• Cannot perform any operations - such as billing, reward evaluation, settlement, ordering

• Disconnection process is performed to inactivate any contact subscription services

• System users and external systems cannot perform any operations

• The Business organisation and its Business Network (Merchant/Service Providers, Venues/Service Points) are not retrieved in any business network-related APIs (e.g. for front-end and back-end systems)

Any child organisations (i.e

- Configure the Merchant/Service Provider’s payment methods, only the Account and Account Debit payment methods are available for configuration via the back-end. Payment methods are used primarily for B2B settlements.

• Anchor
  commercial-terms commercial-terms

  Commercial Terms - Configure the Merchant’s agreement and settlement process (typically for multi-merchant rewards platforms). Merchant agreements allow the Business to define whether settlement takes place the moment a Contact is awarded or upon Contact spending, along with the corresponding contribution.

The settlement process charges participating Organisations (usually Merchants) the cost of awards. The settlement process creates financial transactions either in real-time or at a set time intervals (e.g. daily).

Image Added

• Settlement- Select when settlement will be applied, on award (toggle disabled), or on spend (toggle enabled). Besides the Organisation’s settlement method, settlements also take into account the owner of the offer who funds the award.

  • Settle on award (default) - The Merchant will be debited for the awarded amount (and the award owner credited) upon awarding the Contact.

  • Settle on spend - The Merchant will be debited for the awarded amount (and the award owner (will be credited) when the Contact spends (redeems) their award.

• Contributions - The percentage of the awarded amount that will be contributed by the Merchant (debited for) when an award is granted. The stated percentage can be overridden by defining explicit offers with their own corresponding contribution percentages.

• Block Merchant - This option is available from the Merchant screen (Commercial Terms options) and allows the Business to block the Merchant from awarding Contacts and Contacts from spending their awards at the Merchant.

Opening Hours - Specify the Merchant’s operating hours for ordering delivery and pick-up. Delivery and pick-up can be disabled using the toggles Is delivery closed? and Is pick-up closed?

Image Added

Products not available for sale - Identify any temporarily unavailable products or those that can’t be delivered or picked-up by simply selecting the product, along with the supply method.

Image Added

---

Venue/Service Point Configuration

These settings are applicable for Venues and Service Points.

• Venue/Service Point has the same industry and business scope as its parent - A Venue/Service Point can inherit its parent’s business-related definitions or, alternatively, define its own.

Image AddedImage Added

• Enable WiFi Network - Does this Venue/Service Point support services related to Internet access, VoIP and IPTV? Refer to the Business configuration.

Image Added

• Opening Hours - Refer to the Merchant/Service Provider section to see how to configure opening hours.

• Products not available for sale - Refer to the Merchant/Service Provider section to define products unavailable for sale.

---

Anchor
state state

Parent Organisation’s Administrative Actions

A parent organisation can perform various administrative actions for its child organisations. The available actions differ depending on the organisation level. To see the available actions, a system user must navigate to the summary screen where the organisation’s child organisations are listed, locate the organisation, select the options button, and choose the required action.

Image Added

The following administrative actions can be performed by a Service Owner for a Business:

• Suspend - The following restrictions apply:

  • Users (of any organisation type belonging to its business network, including Business users):

    • Can access the back-end system and perform operations as usual, except creating new contacts, placing new orders, ordering services and activating new reward schemes/reward offers.

    • When attempting to authenticate, a business user will be notified that they must proceed with account re-activation.

  • Contacts:

    • New contacts cannot register.

    • Existing contacts can authenticate and access their data from front-end applications.

  • Organisation operations:

    • Can perform back-end operations, such as billing existing subscriptions, applying reward evaluation on customer events of existing contacts, perform merchant settlement.

    • Users and external systems can perform any operations, except create new contacts, place new orders activate new reward schemes/reward offers.

    • Any child organisations (e.g. Merchants/Venues, Service Providers/Points) also inherit

      the Inactive

      this state

      and comply with the respective conditions accordingly

    SUSPEND

    • System users , and suspension restrictions also apply to them.

• Deactivate - The following restrictions apply:

  • Users (of any organisation type belonging to its business network, including Business users)

    Can sign in to

    :

    • Cannot access the back-end system

      and perform operations as usual, with the exception of creating new contacts, placing new orders, ordering new subscription services, or activating new reward schemes/reward offersWhen business users sign in, they are informed that they should proceed with their business' re-activation

      , when attempting to authenticate, business users should be prompted to proceed with account re-activation.

    • Cannot perform any actions (e.g. create a new contact, create a reward offer).

  • Contacts

    • New contacts cannot register

      through front-end applications

      .

    • Existing contacts

      can still sign in through

      cannot authenticate or access their data from any front-end applications.

  • Organisation operations

  For Venue/Service Point organisations

  • ACTIVE

    • No restrictions apply, any operation can be performed on behalf of or by the Venue/Service Point

  • INACTIVE

    • The Business can still perform back-end operations,

      Cannot perform any operations - such as billing

      existing subscriptions

      ,

      applying reward evaluations to customer events of existing contacts, performing merchant settlements

    • System users and external systems can perform any operations except the creation of new contacts, new orders, new subscriptions or activation of new reward schemes/reward offers

    • The Business organisation and its business network (Merchant/Service Providers, Venues/Service Points) are retrieved in business network-related APIs (e.g. for front-end and back-end systems)

    Any child organisation

    reward evaluation, settlement, ordering.

    • For subscriptions - The disconnection process is performed and all subscriptions are set as inactive.

    • System users and external systems cannot perform any operations whatsoever.

    • Any child organisations (e.g. Merchants/Venues, Service Providers/Points) inherit the

      Suspend

      same state and

      adhere to the respective restrictions

• For Merchant/Service Provider organisations

  • ACTIVE

    • No restrictions apply, and any operations can be performed

  • INACTIVE

    • System users (of Merchants/Service Providers)

      • Cannot sign in to the back-end system, when attempting to sign in, Merchant/Service Provider users are notified that their Organisation is Inactive

      • Cannot perform any actions (e.g. create new reward offers etc.)

    • Contacts

      • Cannot specify the Inactive Organisation as a ‘preferred organisation’

    • Organisation operations

      • Cannot perform any operations, e.g. rewards related

      • Cannot order and purchase one-time or termed services

      • System users and external systems cannot perform any operations related to the Merchant/Service Provider

      • Merchant/Service Provider organisation and its business network (Venues/Service Points) should not be retrieved in any business network API that is used by external systems (e.g. for front-end and back-end systems)

  • SUSPEND

    • System users (of any organisation type)

      • Can sign in to the back-end system and perform operations as usual, with the exception of activating new reward schemes/reward offers

      • When Merchant/Service Provider users sign in, they will be informed that their Organisation is suspended

    • Contacts

      • Can still specify a suspended organisation as a ‘preferred organisation’

    • Organisation operations

      • The Organisation is still operational in terms of rewards (contacts awarding/spending)

      • The Organisation cannot order and purchase one-time/termed services

      • System users and external systems can perform any operations, with the exception of activating new reward schemes/reward offers

      • The Merchant/Service Provider organisation and its business network (Venues/Service Points) are still retrieved in any business network API that is used by external systems (e.g. for front-end and back-end systems)

• • • Not operational, e.g. the Venue/Service Point cannot fulfil an order, or post purchase events (even if its TAPs are active)the same restrictions apply.

• Copy - Copies an entire Business organisation, including all its data and configuration, to a new Business organisation name with the exception of the following data which is not copied:

  • Transactional data (e.g. customer events and financial transactions)

  • Creatives (of all modules)

  • Analytics (Insights and Reports)

  • Products, promotions, order catalogues

  • Pass plans

  • Applications, custom forms, filters, import data and white-label settings

  • Reward offers and tiers

  • API keys, organisations, partners, users and webhooks

  • Automations

• Delete - This action will permanently delete a Business organisation along with all its data, including both test and live data. This includes contacts, transaction acquiring points, applications, products, orders, rewards etc. It's important to note that any child organisations, such as Merchant/Venue or Service Provider/Service Point, and all their data will also be deleted.

A Business user can perform the Suspend and Deactivate actions for a Merchant/Service Provider, and a Merchant/Service Provider can only Deactivate a Venue/Service Point. All actions have the same effect as described above.

Anchor
masquerade masquerade

Masquerading

To masquerade as another Organisation, navigate to the Business Network option from the sidebar menu and select the masquerade icon from the Service Owner, Transaction Processor, the Business, or Merchant/Service Provider screen.

Image Added

To switch back to the Organisation from where you masqueraded - select your login name (top right-hand corner of the screen) > Switch to ….

Image Added

Merchant/Service Provider Financial Statement

Back-end Business users can issue a financial statement for their Merchant/Service Provider child organisation(s). The statement shows the Organisation’s basic account information and financial activities for a selected period of time. The statement can be exported in either PDF or .csv format.

To view a Merchant/Service Provider statement - sign in/masquerade to the Business > Business Network > My Merchants/My Service Providers > locate and Edit the Organisation> select the options button > Statement.

Info
Refer to the Financials manual for more information on the statement, including export options Businesses don’t have Accounts, therefore no statement is available

---

Business Network Settings

The Business Network settings vary depending on the organisation level at which a system user has logged into CRM.COM. System Below are the system settings for Service Owners, Businesses, and Merchants/Service Providers are covered here below.

To configure your Business Network settings, select Settings from the sidebar menu, then Business Network.

Image Removed

Service Owner

A Service Owner system user can configure the following business network-related system settings:

Billing Business

This setting is only relevant for Service Owners selling subscriptions to Businesses as a SaaS. Set the Business responsible for billing the subscription plans and select the default plan for new businesses signing-up. If this setting is not configured, then new businesses signing-up to the Service Owner won’t be billed.

To configure, navigate toSettings > Business Network > Billing & Subscriptions > Billing Business.

Anchor
partners partners

Partners

Service Owner partners (associates) can be defined at the Service Owner level and assigned to individual Businesses. As a result, the partner logo will appear at the bottom of the sidebar menu when a user of the Business or child organisation of the Business is logged in to the back-end system.

Partners are defined purely for the purpose of acknowledging an associate’s collaboration with the Service Owner in winning a business proposition and serve no other purpose in the system.

To configure partners and upload their logos, navigate to Settings > Platform > Partnerships > Partners.

To add a partner to a Business, navigate to Business Network > Businesses > locate and Edit the Business in question > click in Partners and select one or more partners from the drop-down list.

Business

The following Business Network settings are available only at the Business level (i.e. a user must be logged in as a Business user or have masqueraded down to a Business level).

Navigate to Settings > Business Network.

Anchor
business-network-model business-network-model

Business Network Model

Set up which (child) organisations your Business network will consist of. The chosen setting will appear throughout the back-end system UI.

For example, the sidebar menu options under Business Network’s (midnight) cut-off point will be processed

And is performed in three steps:

• Settlement Transactions - Settlement transactions are created against each event and determine whether the Organisation at hand should be credited or debited for such an event.

• Accounting Settlement - Determines whether a single debit or credit account journal entry should be created for each Organisation based on the total amounts (debit & credit) from all previously created settlement transactions posted against that Organisation.

• Financial Settlement - Creates a single debit or credit account journal entry for each Organisation. Depending on the account journal entry created, a respective payment or payout will be posted against the Organisation's primary payment method (if a primary is not specified, then on the first available payment method)

Settlement Fees

A Business can set up additional fees that will be applied on (award & spend) settlement transactions. Settlement fees are applicable only for merchant/service provider organisations and could be a fixed amount or percentage based against each award/spend

• on the account journal entry created, a respective payment or payout will be posted against the Organisation's primary payment method (if a primary is not specified, then on the first available payment method).

Anchor
org-groups-setup org-groups-setup

Organisation Groups

Select +Create Organisation Group and provide a name and description for the group.

Image Added

To assign an organisation group to a contact, navigate to the Merchant/Venue, Service Provider/Service Point screen, hover next to the Organisation Details section header, and select to edit.

Image AddedImage Added

B2B Spend

Required for collaborating businesses, refer to the B2B Network manual for configuration.

B2B Settlement

Required for collaborating businesses, refer to the B2B Network manual for configuration.

Settlement Rules

Set up supplementary rules that will be applied during the settlement process, such as:

• Financial Transaction Types: define the types that will be set on the posted financial transactions (payment or payout) as created from the settlement process

• Amount Allowance: defines the minimum & maximum amount that should be met from the settlement’s financial transaction to settle an organisation account

Teams

Create Teams to group Business users based on their area of responsibility, users can belong to multiple Teams. Teams can be added to a user during the invitation process, or when editing a user from Security settings.

Teams can then be assigned to carry out Activities, Leads, Orders, and Service Requests.

Merchant/Service Provider

The Business Network configurations available at the Merchant/Service Provider level are limited to Organisation Groups.

To configure your Business Network settings at the Merchant/Service Provider level, select Settings > Business Network.

Organisation Groups

Define groups for classifying Venues/Service Points based on common business characteristics. See Organisation Group configuration for Businesses.

---

Reference Material

You may also find it useful to refer to the following manuals for further reading about the Business Network.

B2B Network

B2B Network

Security

https://crmdevelopment.atlassian.net/wiki/spaces/TFDv2/pages/612991008

Communications

https://crmdevelopment.atlassian.net/wiki/spaces/TFDv2/pages/542703818

Integrations

Service Owner integration is used if the following integrations are not configured at the Business level.

• Address Registry

  • Google Places

• Communications

  • SMTP

  • SMPP

  • Twilio

  • WhatsApp

  • Firebase

Such communication integrations will be used ONLY for the following operational messages.

• Contact

  • Register Contact

  • Forgot Password

  • Request OTP

  • Refer a Friend

    • Only SMTP (email)

• Back-end User

  • Invite (Create) User

  • Resend Email Verification

  • Forgot Password

  • 2FA Communications

  • Reports

  • Insight Exports

https://crmdevelopment.atlassian.net/wiki/spaces/TFDv2/pages/1397522770

Rewards

https://crmdevelopment.atlassian.net/wiki/spaces/TFDv2/pages/432472155

Platform

https://crmdevelopment.atlassian.net/wiki/spaces/TFDv2/pages/1164476548