STiM User Manual v0.1 - swarminglabs.com · Magento Extension once configured, ... • Capability...

Swarming Technology | (414) 207-6400 | 2222 N Farwell Ave., Suite 200, Milwaukee, WI 53202 | www.swarmingtech.com

USER’S MANUAL v0.1.0

STiM IBM SilverPop

Magento Extension


1. GENERAL INFORMATION General Information section explains in general terms the system and the purpose for which it is intended. 1.1 System Overview

STiM along with Swarming Technology Magento SilverPop Extension (STMSE) allows collecting information from Magento Commerce Application. Magento Extension once configured, using the STiM – Middle Ware, enables the communication between commerce engine and SilverPop. Current configuration handles the abandoned cart and orders placed

1.2 Organization of the Manual The user’s manual consists of five sections

General Information, System Summary, Getting Started, Using the System. General Information section explains in general terms the system and the purpose for which it is intended. System Summary section provides a general overview of the system. The summary outlines the uses of the system’s hardware and software requirements, system’s configuration and system’s behavior in case of any contingencies. Getting Started section explains how to get extension and install & configure it in the commerce environment (Beta Version). Using The System section provides a detailed description of system functions (Beta Version).


2. SYSTEM SUMMARY

System Summary section provides a general overview of the system. The summary outlines the uses of the system’s requirements, system’s configuration and system’s behavior in case of any contingencies. 2.1 Overview

2.2 About The Extension

• Plug and play architecture • Ability to configure Security Keys for making secure API calls to IBM SilverPop • Capability to configure the events and event data crons. The extension will allow the users to define

the cron frequency • The system is designed to be non-monolithic using enterprise service bus. This architecture enables

the loose coupling of the commerce system and IBM SilverPop integrator (STiM) • Built in auditing & logging

2.3 Software & Hardware Requirements Extension is designed to work on the client’s existing Magento EE (enterprise edition) 1.9 and up and Magento CE (community edition) 1.4 and up. The extension and corresponding crons are light weight & the non-monolithic nature of the application makes it fairly independent of the client environment.


2.4 Resubmission of Failed API calls

The application is designed to accommodate resubmission of the filed API calls due internet connectivity issues. The cron will go through the message log entries where the message id is null and the counter is less than 5 and resubmit the request.


3. GETTING STARTED

3.1 High Level Install & Configuration Instruction Installing and Configuring the SilverPop Integration Manager

o Download the extension from Magento connect. o Extract the files into a separate folder. o Copy the files into the root of your Magento installation, the module should now be installed

successfully. o Disable caching within the Magento admin under System -> Cache Management. o Copy the extension files into your Magento installation folder. o In the Magento admin, under System -> Cache Management, click the ‘Flush Cache Storage’ button. o Log out of the Magento admin and then log back in. o Re-enable caching within the Magento admin under System -> Cache Management. o The module should now be installed successfully. o Once the module is installed, you will need to ensure that cron is installed properly for your site. o Cron is required for the abandoned cart event to work properly, and depending on your settings, may

also be required for the order placement event. o To configure SilverPop specific settings, from the Magento Admin panel, proceed to the SilverPop

Settings menu:


o Enter your General configuration settings:

1. The Maximum Resent Attempts setting determines how many times a request should be sent to the middleware, in the event an error in submission occurs, before ceasing submission attempts of a given request.

2. The Cart Abandonment Notifications Enabled setting determines whether Abandoned Cart events will be sent to SilverPop or not


3. The abandoned cart feature runs on a cron job, meaning that the server will automatically check for abandoned cart events at some frequency. The Start Time and Frequency settings determine at what time the cron job will execute initially, and how often the cron will run thereafter.

4. The New Order Notifications Enabled setting determines whether New Order events will be sent to SilverPop or not

5. The Submit on Cron setting will determine if order placed events should be sent as a batch on a schedule (setting set to Yes) or sent immediately (setting set to No). If yes, you will see options for Start Time and Frequency. These settings determine at what time the cron job will execute initially, and how often the cron will run thereafter.

o Enter your API Settings:

1. The Swarming Technology team will provide you with SilverPop API Settings that you will need in order to configure the End Point URI, Username, and Authorization token. These settings are required for the SilverPop integration manager to function properly.

2. To enable debug logging for SilverPop, set the Enable Debug Log setting to Yes. A log file will be written to the /var/log directory within the Magento root.

o Press the Save Config button. The SilverPop Integration Manager is now active.

1. When you click the Save Config button on the API Settings screen, the extension will verify your End Point URI, Username and Authorization Token and report any connectivity issues.


4. USING THE SYSTEM

4.1 Abandoned Cart – The IBM SilverPop Payload Requirement


4.2 Cart Purchased – The IBM SilverPop Payload Requirement


4.3 Auditing and resubmission if initial submission failed

A log will be created with each submission attempt. A custom model with proper database resource will need to be created to accommodate this requirement. The log table will contain the following fields.


o log_id : Primary key o JSON : A file path to where the JSON payload for the API request made is stored o counter : A counter for the number of submission attempts that have been made for the given API

request o message_id : API response I o submission_time : Stores the time when the request was originally submitted o endpoint : Identifier for which API to call

If the attempt is successful:

o Log ID is incremented o No need to store JSON o Counter set to 0 o Message ID set to be the transaction id returned from the API o Submission time updated appropriately o Endpoint updated appropriately

If the attempt is unsuccessful: o Log ID is incremented o Request is stored in parse-able JSON format o Counter set to 0 o Message ID set to null o Submission time updated appropriately o Endpoint updated appropriately

Completion Criteria Log information is stored and updated appropriately based on API response.


4.4 High Level Workflow

STiM User Manual v0.1 - swarminglabs.com · Magento Extension once configured, ... • Capability...

Documents

Transcript of STiM User Manual v0.1 - swarminglabs.com · Magento Extension once configured, ... • Capability...