Documentation

Introduction

You have chosen the affilinet module for your OXID eShop. This module facilitates your daily work by integrating essential functionalities of our affilinet platform into your usual store.

OXID eShop and the affilinet module

You have chosen the affilinet module for your OXID eShop. This module facilitates your daily work by integrating essential functionalities of our affilinet platform into your usual store.

The affilinet module enables you to integrate important affiliate marketing features into your OXID eShop. Affilinet presents performance marketing, an attractive, success-based payment model for users directed to your website, high quality, transparent tracking and reporting as well as a sales network with 500.000 publishers (website operators, promoting your products online). This module offers you new customer potentials to expand your reach.

Using this module offers you concretely:

  1. an easy providing of product data feeds to promote your products via dynamically generated ads
  2. retargeting of (non-purchasing) store visitors
  3. tracking of customers, which were directed to your store via affilinet
  4. publisher statistics display of generated clicks, leads and orders.

Besides the fully integrated process of affiliate marketing functionalities within the module, you can always login to the affilinet advertiser portal (https://advertiser.affili.net) for using the additional affilinet options.

Module use requirements

In addition to the OXID eShop you need an affilinet account to use the module. If you already have an affilinet account, you can easily provide your affilinet programID (see also http://advertiser.affili.net/Account/ProgramData.aspx) as well as your affilinet webservice login details (see also http://advertiser.affili.net/Account/AccountData.aspx) in the settings. Now you have access to all functionalities.

New clients can directly apply for an affilinet account via the registration tab.

Supported OXID eShop editions

The affilinet module supports the following editions:

  1. OXID eShop CE (Community Edition) versions 4.5, 4.6, 4.7, 4.8
  2. OXID eShop PE (Professional Edition) versions 4.5, 4.6, 4.7, 4.8
  3. OXID eShop EE (Enterprise Edition) versions 4.5, 4.6, 5.0, 5.1

If you have further questions about supported OXID eShop versions or problems with the installation, please contact our technical support.

Supported PHP versions

System requirements

Installation

Before you process an installation or an update:

  1. Make sure, that you fulfill the system requirements, which are necessary for the OXID eShop system
  2. Make a backup of your OXID eShop and your database.

For OXID eShop (CE,PE,EE)
v4.5.1 – v4.5.9

  1. Unzip the affilinet module package
  2. Copy the folder content "copy_this" in the main directory of your eShop (Upload in binary mode)
  3. Adjust the templates from the "changed_full" folder to your OXID basic theme templates at the marked lines:
    <!-- BEGIN | Affiliate Modul -->
    ....
    <!-- END | Affiliate Modul -->
  4. Execute the SQL installation queries from the "install" folder: install.sql, blocks.sql
    You can use a data management service of your choice (e.g. phpMyAdmin) or a service of the OXID eShop > Service/Tools
  5. Edit the file /modules/function.php and add the following line:
    require_once 'nrAffilinet/autoloader.php';
  6. Give write access for the web-user (e.g. 775, 777) to the directories:
    [shoproot]/modules/nrAffilinet/csv/
    [shoproot]/modules/nrAffilinet/out/pictures/logo/
  7. Please empty the "tmp" shop directory
  8. Open Basic settings (Grundeinstellungen) > System > Moduls (Module) in your shop backend and add the following line:
    oxviewconfig => nrAffilinet/views/nrAffilinetTrackingViewConfig
    (if Multishop/EE add this for all shops, which should use the affilinet module)
  9. Switch on the production mode (Produktivmodus) under Master data (Stammdaten) > basic settings (Grundeinstellungen) > Master (Stamm), if not done so
  10. Logout of the backend and login again

Additional information

  • If you create a new shop of your EE version after the module installation, you need to rerun the steps 4. > SQL installation queries (install.sql und blocks.sql) for the new shop.
  • To use the automatic product feed generator, it will be necessary to create a cronjob. The following crontab command will help your admin to create the needed cronjob:
    */1 * * * * curl "http://[shop-domain-name]/admin/index.php?cl=nraffilinet_feed_main&fnc=cron&keyapi=[WS Benutzername]" > /dev/null 2>&1

    Please replace the following placeholder:

    [shop-domain-name] means the shop domain (e.g. www.meinedomain.de)
    [WS Benutzername] means the affilinet webservice username, which you defined within the backend settings of your OXID affilinet module.

    Your webservice account must be created in the affilinet advertiser portal under: http://advertiser.affili.net/Account/AccountData.aspx

For OXID eSHOP (CE,PE,EE)
v4.6.x-v4.8.x and v5.0.x-v5.2.x

  1. Unzip the affilinet module package
  2. Copy the folder content "copy_this" in the main directory of your eShop (Upload in binary mode)
  3. Execute the SQL installation queries from the "install" folder: install.sql, blocks.sql
    You can use a data management service of your choice (e.g. phpMyAdmin) or a service of the OXID eShop > Service/Tools
  4. Give write access for the web-user (e.g. 775, 777) to the directories:
    [shoproot]/modules/nrAffilinet/csv/
    [shoproot]/modules/nrAffilinet/out/pictures/logo/
  5. Please empty the "tmp" shop directory
  6. Open Enhancements (Erweiterungen) > Moduls (Module) on your shop backend and activate the module nrAffilinet (if Multishop/EE, do this for all shops)
  7. Switch on the production mode (Produktivmodus) under Master data (Stammdaten) > basic settings (Grundeinstellungen) > Master (Stamm), if not done so
  8. Logout of the backend and login again

Additional information

  • If you create a new shop of your EE version after the module installation, you need to rerun the steps 3. > SQL installation queries (install.sql und blocks.sql) for the new shop.
  • To use the automatic product feed generator, it will be necessary to create a cronjob. The following crontab command will help your admin to create the needed cronjob:
    */1 * * * * curl "http://[shop-domain-name]/admin/index.php?cl=nraffilinet_feed_main&fnc=cron&keyapi=[WS Benutzername]" > /dev/null 2>&1

    Please replace the following placeholder:

    [shop-domain-name] means the shop domain (e.g. www.meinedomain.de)
    [WS Benutzername] means the affilinet webservice username, which you defined within the backend settings of your OXID affilinet module.

    Your webservice account must be created in the affilinet advertiser portal under: http://advertiser.affili.net/Account/AccountData.aspx

Update

Before every update to a new version and its activation in the backend, you have to execute the following SQL:

/update/update.sql.

For OXID eShop (CE,PE,EE)
v4.5.1 – v4.5.9

  1. Make a backup of your OXID eShop and your database
  2. Deactivate the affilinet module tracking under "Settings" > Basket/Standard/Retargeting
  3. Unzip the affilinet module package
  4. Copy the folder content "copy_this" in the main directory of your eShop (Upload in binary mode)
  5. Adjust the templates from the "changed_full" folder to your OXID basic theme templates at the marked lines:
    <!-- BEGIN | Affiliate Modul -->
    ....
    <!-- END | Affiliate Modul -->
  6. Please empty the "tmp" shop directory
  7. Logout of the backend and login again
  8. Reactivate the affilinet module tracking under "Settings" > Basket/Standard/Retargeting
  9. Switch on the production mode (Produktivmodus) under Master data (Stammdaten) > basic settings (Grundeinstellungen) > Master (Stamm), if not done so
  10. Open the Feed Generator > Standard-Feed and click "forward" ("weiter") or "Save" ("Speichern") to update the feed to the new standard settings
  11. Please note, your feeds will still run after the update, but the settings "only active articles" ("Nur aktive Artikel") and "only available articles" ("Nur bestellbare Artikel") are still deactivated.

For OXID eSHOP (CE,PE,EE)
v4.6.x-v4.7.3.x and v5.0.x-v5.2.x

  1. Make a backup of your OXID eShop and your database
  2. Deactivate the affilinet module tracking under "Settings" > Basket/Standard/Retargeting
  3. Unzip the affilinet module package
  4. Copy the folder content "copy_this" in the main directory of your eShop (Upload in binary mode)
  5. For v4.6.x: Adjust the templates from the "changed_full" folder to your OXID basic theme templates at the marked lines:
    <!-- BEGIN | Affiliate Modul -->
    ....
    <!-- END | Affiliate Modul -->
  6. Please empty the "tmp" shop directory
  7. Open Enhancements (Erweiterungen) > Moduls (Module) on your shop backend and activate the module nrAffilinet (if Multishop/EE, do this for all shops)
  8. Switch on the production mode (Produktivmodus) under Master data (Stammdaten) > basic settings (Grundeinstellungen) > Master (Stamm), if not done so
  9. Logout of the backend and login again
  10. Reactivate the affilinet module tracking under "Settings" > Basket/Standard/Retargeting
  11. Open the Feed Generator > Standard-Feed and click "forward" ("weiter") or "Save" ("Speichern") to update the feed to the new standard settings
  12. Please note, your feeds will still run after the update, but the settings "only active articles" ("Nur aktive Artikel") and "only available articles" ("Nur bestellbare Artikel") are still deactivated.

Module Overview

Here you get general information about module installation, configuration and handling. Furthermore you can see the support contact details and access the support instruction.

Functional overview

The affilinet module automatically integrates essential functionalities of the affilinet platform into your OXID eShop. Below you find an overview about configuration options that are available in the module.

  • Registration
  • Settings
    • General settings
    • Tracking
    • Retargeting
    • Productdata feed
  • Feed-Generator
  • Orders
  • Statistics

Registration

If you don’t have an affilinet account so far, you can easily apply for an affilinet account at any time under the tab "Registration" ("Voranmeldung").

Affilinet will check your application and will provide all necessary documents on acceptance.

OXID eShop (Backend) > Affilinet > Voranmeldung (Registration)

Settings

If you have already an affilinet account, you can start immediately. Enter your affilinet programID, your webservice login details as well as your company logo in the settings and choose your currency.

Additionally the expert mode (Expertenmodus) for enhanced feed configuration can be activated. As soon as you have saved your settings, the tracking will be activated and you can start using the module.

Please note: The currency of the German affilinet platform is Euro. If you define a foreign currency in the settings, the amounts will be converted in Euro (based on to the daily exchange rate) and accordingly displayed in the affilinet portal. Therefor the "currency conversion" must be activated by affilinet. Please contact the affilinet Support at support@affili.net.

OXID eShop (Backend) > Affilinet > Settings (Einstellungen)

Tracking Settings

Basket Tracking

The affilinet basket tracking system allows you to submit shopping basket information on item level to affilinet. That information enables you to perform detailed statistical analyses and allows your publishers to optimize their marketing activities even further.

In the affilinet basket tracking system, we distinguish between baskets and basket items. Baskets can be confirmed and cancelled like regular transactions, but before you do this, you can update the contained basket items: you can update the quantity of single items or remove single items from the basket (e.g. if the article was returned by the customer); the publisher’s commission is automatically updated.

In order to evaluate the baskets even better, you can activate two additional tracking parameters (psub 1,2) in the basket tracking settings, which are only visible for the advertiser (you). You can specify whether you want to submit OXID eShop default values as payment method or shipping method to be displayed in your statistics.

As product attributes you can submit additional parameters for the basket items as e. g. size, color, material etc.. These attributes will also be displayed in the publisher’s statistics for optimization purposes. Please transfer only data, which should be visible for publishers as well.

OXID eShop Backend > Affilinet > Tracking > Basket Tracking

Standard Sale Tracking

Tracking is the basis of affiliate marketing, enabling you to register your orders which have been generated by affilinet publishers.

Furthermore it enables the advertiser to pay a publisher commission also, if the customer buys not before the second or another shop visit within a certain time.

OXID eShop (Backend) > Affilinet > Tracking > Standard Tracking

Retargeting

This technology enables you to re-address specifically interested customers. Potential customers, who left your online shop without a purchase, can be returned to your store via personalized ads (e. g. dynamic product banners). These ads will be displayed through affilinet retargeting publishers within their media reach.

OXID eShop (Backend) > Affilinet > Tracking > Retargeting

Newsletter Tracking

Within the settings you can activate/deactivate the Newsletter tracking. requirement for the setting is an existing lead type and the rate for the Opt-In. This is then the publisher commission. Corresponing to your configurations it will be automatically updated.

Productdata feed

For many shop products, feeds must be generated within several steps.

Here you can define the number of products, which should be processed per step.

Feed Generator

The feed generator creates an affilinet matching product feed, based on your OXID eShop product database. You can check this feed in a few steps and submit it to affilinet. On the basis of this product datafeed publishers can build dynamic product ads and deliver them to specific target groups. So customers with a special product desire will come to your store.

OXID eShop (Backend) > Affilinet > Feed Generator

How to setup a product feed?

  • Step 1 - Configuration: Besides the affilinet standard feed you are able to create publisher individual product datafeeds (e. g. for Valentine's Day, Easter or Christmas promotions).

  • Step 2 - Preview/Export: You can view the data of your feed, created in the first step, with a preview and generate a csv export.

  • Step 3 - Cronjob Settings: Here you can specify when the cronjob should start to create the configured product feed and place it on your server as csv file.

  • Step 4 - Finish: Feed name, feed logo, start time of the cronjob and the feed link will be displayed for checking. As soon as your data will be checked you can click the button "submit the feed to affilinet" („Produktdaten an Affilinet senden“) and your data will be submitted.

The affilinet product data team will now check your feed and enable feed submission deferred to the defined setting terms. So your product datafeed is always up to date.

The feed generator provides various options for item feed configuration.

General Settings

Name, logo and CSV parameter.

There are additional feed filter options as "Filter active articles", "Filter active stock" and "Only one product variation".

Field/Content Selection

  • set column titels
  • Pre-/Suffix, to modify columns with a fix text
  • Database field selection
  • Concatenation to string different columns together
  • In expert mode: regular expressions to modify the field contents

Filter

  • Field-based filters with SQL-conditions

Cronjob

If and at what time the cronjob should be executed.

Filename, where the feed is placed.

Feed Submission

The feed can be submitted to affilinet.

Orders

This module area enables you to view all orders, generated by customers, who were directed to your website by affilinet publishers. You can search for periods, publishers, channels as well as individual oderIDs and their transaction status and confirm or cancel order commissions.

OXID eShop (Backend) > Affilinet > Orders (Bestellungen)

If the order commissions will not be edited (confirmed/canceled) within the contractually defined time period, orders will be confirmed automatically. Orders with CPC (cost-per-click) based commission for publishers are not shown by defeault, because the commission must be paid for the click on a banner and not for an occurred purchase (order).

Statistics

In the statistics module area you get an overview about the performance of your affilinet publishers. As well as for orders you can select in detail what information for what period should be displayed.

OXID eShop (Backend) > Affilinet > Statistics (Statistiken)

Based on your filter criteria the statistic displays the publisher URL as well as generated views, clicks, leads/sales and commissions.