Magento integration 1.0

Transcription

1 Reference guide Improving results together 1

2 Version history Version Date Author Modifications September 2013 Marcus Webb Draft Version September 2013 Marcus Webb Publication Version 2

3 Contents Version History... 2 Key Features of this Integration... 4 Key Benefits of this Integration Settings for the Magento Integration... 5 API Config List... 7 Newsletter Abandoned cart Cron manager Screenshots Figure 1 - API Config Screen... Figure 2- API Config - Validate Credentials... Figure 3 - List Module Disabled... Figure 4 - List Module Enabled... Figure 5 - Newsletter Module... Figure 6 - Module Figure 7 - Abandoned Cart Module Figure 8- Cron Manager Figure 9 - Force Resync on Cron Manager Module

4 What s in Version 1.0? Key Features of this Integration Full Synchronisation of Customer Data from Magento into PureResponse including the following fields: First Name Last Name Date Of Birth Address data Sign up date* Last order date Last order value Last product Total purchases Total spend Year to Date spend Create advanced segments within Magento and sync segments over to PureResponse** Refine and segment customers using list filters in PureResponse Support for Magento installation with multiple websites and stores Configure sync rules at Global, Website or Store levels linked to different profiles within PureResponse Send Transactional s through PureResponse using a separate profile Advanced set-up options for controlling frequency of syncs and log sync history Real-time sync of new newsletter sign ups & customers into PureResponse Automatically track amount of revenue generated and last product purchased by campaign Create automations within PureResponse based on synced list data Efficient sync process to sync databases with millions of customers Add Newsletter subscription option to any check out Easy to set up with One-click install from the Magento Connect store Developer-friendly configuration. Built in Debug information assisting in rapid issue diagnosis and support Sync databases with millions of customer records Key Benefits of this Integration Maximise revenue from customers by segmenting based on purchase behaviour Using targeted campaigns to move them along the Customer Lifecycle journey from interest to loyal customer and advocate Ability to increase customer loyalty by targeting infrequent purchasers and creating an incentive campaign Grow and maintain loyalty by sending regular product s to regular purchasers Increase revenue by targeting big spenders with high ticket item product s Ability to increase engagement by sending a welcome campaign to new customers and subscribers Drive brand advocacy by identifying VIP customers that are big spenders rewarding their loyalty based on Total lifetime spend Last order value Year to Date Spend 4

5 Real time communication with new sign-ups Improve Deliverability and Brand reputation of Transactional s by using PureResponse sending IPs Measure and analyse campaign success by tracking revenue and products bought Totally customisable Integration options for Magento environments with multiple websites or stores, enabling website or store specific lifecycle campaigns Increase revenue by sending Abandoned Cart s to customers that exit with products still in their basket with three specific triggers Increase subscribers by adding sign-up forms to key stages of the User journey Create successful campaigns by combining customer data imported from Magento with other PureResponse features such as dynamic content, split content testing and intelligent time sending Settings for the Magento Integration Now that you have your Magento Integration enabled, we will look in detail at each section of the Integration and review the options available to you. We cannot always tell you the exact values that are appropriate in each circumstance but you will be able to get a feel for what works best for your organisation and be able to tune the settings accordingly. You may find that over time you wish to re-visit these settings and amend them to suit your business needs. If you need to, whilst doing this, refer to this guide as explanations are given. Remember also, that these settings are scope specific (i.e. they will work at the level at which they are configured, so if set at the GLOBAL scope level they will work for all Websites and Stores beneath the scope) API Config The API Config section is where the primary parameters of the Integration are set. It is unlikely once these are set that you would want to revise this once the initial configuration has taken place with the exception of the items indicated below: Figure 1 - API Config Screen 5

6 Settings The following options are available: Enable Module Debug Advanced Config Max Sync Items Default Mode api url Positive Integer Values Positive Integer Values A valid fully expressed URL the Pure360 Integration Module the Debug mode for the Pure360 Integration. When enabled, log files can be examined in the Cron Manager section the Advanced Configuration options, allowing editing of settings in the Cron Manager section The maximum number of rows of data from Magento to be synced with the PureResponse system. You may wish to revisit this when your system is running Enabling this sets the Config for the entire Magento system. Disabling this allows you to set Config settings at lower levels such as Website and Store You will be provided this URL as part of your setup. Typically this will be: Marketing Profile Here you set the details of Username and Password provided to you for your Marketing profile. Username Password Unsubscribed or not. The username provided to you for system access. Typically this ends in.sys and is named the same as your company or profile ( e.g. marketingresponse.sys ) The password provided with the above username, usually consisting of lowercase letters ( e.g. xqirjsve ) When setting the Username and Password for each profile, click the Validate Credentials button on each profile enabled and assuming no errors occur, click the Save Config button. Figure 2- API Config - Validate Credentials 6

7 List Here is where you specify the List upload parameters. To enable this module, first change the settings for Enable Module to Enable. Click the Save Config button. This brings up the following screen: Figure 3 - List Module Disabled Figure 4 - List Module Enabled 7

8 Settings The following options are available: Enable Module the List Management Module List options The settings here allow you to create and modify lists on the PureResponse system as well as initialise options such as Reporting of value of sale items in a campaign in the PureResponse system List Name Domain Name Filter Success Page Tracking Tracking Token Double Opt-in List Status List Status The name for the list to sync with the PureResponse system Set this for filtering purposes to create test recipient lists ( ) Enable whether Purchases within Magento are reported in the PureResponse system Free text area to create a named token for tracking sales in Magento Enable Double Opt-in for verifying if a user wishes to subscribe to the Newsletter Shows the current state of the list within both Magento and PureResponse Field Mapping This section allows you to selectively pull across which data is synchronised with the PureResponse system, enabling you to segment and filter data effectively within the PureResponse system. You do not need to synchronise all available data within Magento, but if you amend the data that you want to synchronise, you will cause Automations in the PureResponse system to cease functioning. Note: You may also synchronise Customer Attributes if you are using them. These will be displayed in alphabetical order in the Customer Data Field Mapping section below. Customer data field mapping All fields are listed alphabetically, so this list may not be reflected in the exact same layout as the screenshot above shows, as your Customer Attribute fields may be interspersed between the preselected fields. Created at Customer Group Customer Segment* Date of Birth First Name The date the customer record was created in Magento Which Magento Group the customer record sits in The list of Segments the customer record sits in Recorded Date of Birth of the customer The First Name recorded in Magento against the customer record 8

9 Gender Last Name Middle Name/Initial Prefix Suffix Tax/VAT Number Customer Attributes The Gender recorded in Magento against the customer record The Last Name recorded in Magento against the customer record Any recorded Middle Name or Initial for the customer record in Magento If the customer record has a prefix it will be displayed in this field If the customer record has a suffix it will be displayed in this field Contains the customer VAT or Tax number record Synchronise selected Customer Attributes specific to your Magento installation with the PureResponse system (See note above) Customer Address Field Mapping There are no custom objects here so this table is alphabetical City Company Country Fax State/Province Street Address Telephone Zip Code The City recorded in Magento against the customer record The company recorded in Magento against the customer record The country recorded in Magento against the customer record The Fax number in Magento recorded against the customer record The State, Province or county recorded in Magento against the customer record The Street address for the customer record in Magento The provided telephone number in Magento (can be used to hold mobile data, and therefore conduct SMS campaigns to mobile phones) The Zip or Postal Code at which the Customer in the customer record resides 9

10 Customer Sales Field Mapping The data here relates to sales records against the customer. Last Order Date Last Order Value Last Product Total Purchases Total Spend Year to Date Spend Contains the date of the Last item purchased on the Magento site Contains the amount spent on the Last Item Purchased on the Magento site in the currency selected at this scope level Contains details of the last Item purchased. Sends the count of the total number of purchases held against the Customer Record Sends the total amount of Money spent on the site in customer lifetime Shows the total amount of Money spent on the site in the Year to Date List Here you can enable or disable Newsletter functionality. Our Newsletter module is designed to replace the Newsletter module within Magento. The increased customisation within the module allows you to specify where on the site you can request that customers can add themselves to the mailing list. If enabled on the Guest Checkout the module will collect the address and add this to the list along with the Date of Subscription, which Pure360 has added to the Newsletter Subscriber information. This now allows for historical tracking for the customer information, and will show any additions or amendments after the installation of the Integration. Whether this is collected for the first time or is an amendment of the Customer s preferences, the information is synchronised with the PureResponse system in real-time. Figure 5 - Newsletter Module 10

11 Settings The following options are available: Enable Module the Newsletter Module Checkout Use the settings here to specify where you wish to see the Newsletter Subscription Checkbox and what the text following it will say. Show on Guest Checkout Show on Register Checkout Show on Customer Checkout Show if Already Subscribed Checked by Default Checkbox Label Text Yes or No Yes or No Yes or No Yes or No Yes or No Yes or No If enabled, show the Newsletter Subscription checkbox here (with associated text) If enabled, show the Newsletter Subscription checkbox here (with associated text) If enabled, show the Newsletter Subscription checkbox here (with associated text) If enabled, show the Newsletter Subscription checkbox irrespective of the Customer subscription status When the Newsletter Subscription checkbox is shown will be checked if the Customer has subscribed, or if no Subscription exists for the Customer, display on the basis of this setting (i.e. if Yes, display a tick in the box or if No, do not display a tick in the box) Free text field allowing you to specify what to indicate to Customers that they can subscribe to the Newsletter here. In this section you can enable or disable Transactional functionality. If you disable this, Magento will revert to using its in-built transactional handling, and you will not receive any reporting information back to the PureResponse system when ing your Customers. Figure 6 - Module 11

12 Settings The following options are available: Enable Module the Transactional Module Abandoned Cart Pure360 have introduced Abandoned Cart functionality to the Integration. This will enable you to re-visit potential lost income and attempt to convert this into revenue for the business. To cater for this, we have allowed for three triggers in the system which you can configure. Should you have other Abandoned Cart software already in place, you can hook into the triggers placed into the Magento System. This is covered in the Administration Guide. Settings The following options are available: Figure 7 - Abandoned Cart Module Enable Module Max Carts to Process the Abandoned Cart Module Numerical value indicating how many Abandoned Carts the system should attempt to process when running. 12

13 The Three Triggers All three triggers work with the same settings, which are detailed below. The options selected will determine how and when the events take place, and which actions to take on that basis. Triggers 1, 2 and 3 Enable Module Trigger After Trigger Action Message Template (Customer) Message Template (Guest) Days Hours Minutes Events Only Reminder Clear Cart the relevant Trigger in question This should be an integer numeric value This un-named drop-down allows you to choose the time frame to match the numeric value in the box above This allows you to select what action to trigger when the above specified time period has elapsed. This drop-down allows you to select from template s within Magento which you are going to send to the customer. This drop-down allows you to select from template s within Magento which you are going to send to the guest. Actions Events Only This will record the fact that a trigger has occurred within Magento. To make use of this within other Cart Abandonment modules or software, you will want to set the Trigger Action to this value and then modify the relevant config.xml file All three triggers work with the same settings, which are detailed below. The options selected will determine how and when the events take place, and which actions to take on that basis. Reminder This is the trigger that will cause the system to send an Abandoned Cart to the Customer or Guest. You select the that you wish to send in the drop-down option just below the Action selected. Note: A Guest in this instance is someone who has entered details on Stage 1 of the Checkout process and as a result has provided an address. If a Guest has not entered details on Stage 1 the Abandoned Cart will not be processed. Clear Cart This enables you to clear the cart record. Once this is done, no further Abandoned Cart actions will be taken. It is therefore recommended that if the Abandoned Cart module is enabled that this is set as an action for either Trigger 2 or Trigger 3. Setting this for Trigger 1 is redundant, as it is better to disable the module if you do not require Abandoned Cart management. 13

14 Cron Manager The Cron Manager section allows you to specify the frequency of the jobs that synchronise with the PureResponse system and also to view any related log files if the Debug Mode is enabled. We recommend setting Debug mode on in the early stages of using the Integration, as this will help with any issues you may report to our Integration Team or Customer Support Team. Figure 8- Cron Manager Job Table On this screen you are able to modify the standard Cron entries or Force a resynchronisation of any jobs that are listed by clicking on the Force button. A maximum of 20 list jobs can be shown here. If you have more than 20 defined, you will be able to change the number displayed by clicking on the drop-down box here. The table below explains what the entries are that are shown in the Job Table. Table Entry Id Code Status Details Message Scope Internal reference to the cron job A Reference name for the Job The current status of the Job The name of the list to be synchronised with the PureResponse system Any additional diagnostic message that is relevant to the current or last execution of the job Status field indicating the scope of the job to be run (either global, website or stores) 14

15 Scheduled Executed Finished Crontab Crontab settings Time the job is next scheduled to execute as reported by the PureResponse system The time the job last started executing The last time the job finished executing, whether successful or unsuccessful Here you can change the frequency with which these jobs run For a more detailed explanation of Cron than can reasonably be entered into here, please see this link: Clicking the Force button results in a message as shown below. Figure 9 - Force Resync on Cron Manager Module Clicking Force on the PURE360_CART_TRIGGER job will result in the Abandoned Carts defined in the Abandoned Cart section to be processed as per the settings defined there. Pure360 Logs This section is only shown if Debug Mode is set to Enable. You may either Download or Clear the logs here. You may be asked for the Downloaded Log files to assist with Diagnosis. 15