Customizer Installation & Configuration Manual For .fr

Sep 30, 2004 - CUSTOMIZER – installation and configuration manual ... This document presents the implementation of the configuration tool Customizer ...
352KB taille 22 téléchargements 251 vues
Customizer Installation & Configuration Manual For “e-commerce” mode

Version

Date

Author

Supervisor

1.0 2.0 3.0 3.1 4.0

30/09/2004 1/12/2004 01/07/2005 30/11/2005 04/04/2006

Laurent Tordjman Laurent Tordjman Laurent Tordjman Laurent Tordjman Laurent Tordjman

Jorge Dos Santos Jorge Dos Santos Jorge Dos Santos Frédéric Lemarchand Frédéric Lemarchand

I-Com Software www.i-comsoftware.com/ 2, rue du docteur Lombard F-92441 Issy les Moulineaux Cedex France

CUSTOMIZER – installation and configuration manual

TABLE OF CONTENT

1. Presentation

3

1.1. Purpose 1.2. Prerequisit

3 3

2. Operating mode

4

2.1. Presentation

4

3. Setup

5

3.1. Administration Portal 3.2. Reseller’s e-commerce site 3.2.1. The Calling Page 3.2.2. The Return Page

5 6 6 6

4. Glossary

11

2 / 11

CUSTOMIZER – installation and configuration manual

1.

Presentation 1.1.

Purpose

This document presents the implementation of the configuration tool Customizer developed by I-Com Software. The reseller may use Customizer in 2 modes : •

sales representative only



e-commerce

This document is dedicated to the e-commerce mode. For a sales representative mode only, please refer to the user manual.

1.2.

Prerequisit

In order to implement Customizer functionality to its e-commerce site, the Reseller must have : •

an internet e-commerce site and the necessary rights to add and/or modify pages



an access (Login / Password) to the Customizer administration portal http://customizer.i-comsoftware.com/[CountryCode]

3 / 11

CUSTOMIZER – installation and configuration manual

2.

Operating mode

2.1.

Presentation

The Reseller adds a link to Customizer on one or more pages of his e-commerce site (1). This link redirects to the IN page of the Customizer (2) and must contain up to 3 parameters ; the Reseller’s ID, a Session ID and a Tiering code used to compute the prices displayed in the Customizer. This redirection can be made through a Pop-Up page or in the main page of the Reseller’s e-commerce site. The IN page of the Customizer performs the necessary checks and redirects to the Customizer’s pages (3). Once the user has validated his selection, he is redirected to the OUT page (4). The OUT page reviews the selected products, builds the XML or the TEXT response and POSTs it to a “return page” on the Reseller’s e-commerce site.

4 / 11

CUSTOMIZER – installation and configuration manual

3.

Setup 3.1.

Administration Portal

PURPOSE : Configure Reseller’s account on the Administration Portal ACCESS : The Administration Portal address as follow : http://customizer.i-comsoftware.com/[CountryCode] With the following country codes :

ƒ

CH : Switzerland

ƒ

DE : Germany

ƒ

ES : Spain

ƒ

FR : France

ƒ

IT : Italy

ƒ

NL : Netherlands

ƒ

NO : Norway

ƒ

SE : Sweden

ƒ

UK : England

ƒ

...

The Reseller access the Administration Portal corresponding to his country with the Login / Password given by I-Com Software. For example : http://customizer.i-comsoftware.com/NO SETUP :

Login / Password : testBTO / BTOtest

The Administration Portal allows the Reseller to setup the following parameters : -

Site URL : the address of the Reseller’s e-commerce site

-

Return Page : the URL of the page to which the configurator redirects on exit (5)

-

Popup flag : Flag that indicates whether the Customizer is accessed through a popup or not. This info is mainly used to display the Reseller’s logo.

5 / 11

CUSTOMIZER – installation and configuration manual

3.2.

Reseller’s e-commerce site

3.2.1.

The Calling Page

PURPOSE : Add a link to the “IN” page of the Customizer SETUP : The link to the Customizer factory IN page is composed of : - A server : http://customizer.i-comsoftware.com/[CountryCode] - A page : /Configurator/BTO/asp/in.asp - One or more Parameters : (set in the QueryString) •

idReseller : An identifier provided by I-Com Software that uniquely identifies the Reseller. This identifier has a Microsoft GUID format and can be found in the Administration Portal setup page.



idSession : (optional) A unique identifier created by the Reseller to identify the session of the user that wants to access the Customizer functionality. This session ID is returned by the Customizer to the Return Page (5) If omitted, it will be generated by the Customizer as a number (13 digits minimum).



coTiering : (optional) A code used to identify the pricing level that will be applied by the configurator. This code value is 1, 2, 3 or 4 and is associated to the T1, T2, T3 and T4 pricing. If omitted, the default value is 1

Example : http://customizer.i-comsoftware.com/NO/Configurator/Customizer/asp/in.asp?idReseller=%7B3B228321CBE6-4ECA-8A26-56BAD6999203%7D&idSession=123456&coTiering=2

3.2.2.

The Return Page

PURPOSE : The Return Page (5) is set by the Reseller in the Administration Portal. This page belongs to the Reseller’s e-commerce site and is called by the Customizer’s OUT page when the user validates his selection. SETUP : The parameters are send by the OUT page (and therefore received by the Return Page) using a POST method. There are 2 parameters :

6 / 11

CUSTOMIZER – installation and configuration manual



idSession : Unique identifier given by the Reseller to the IN page (or generated by the Customizer if missing). This idSession can be used to retrieve the user’s current basket and append the selected Customizer products.



XML : XML string containing the Customizer result or TXT : a Text string containing the Customizer result.

The reseller can choose the response format (either XML or Text) in the Administration Portal. XML RESPONSE DESCRIPTION:

The XML response called ICOMBTORESPONSE is made of 3 sections : HEADER, BASKET and FOOTER. ™ HEADER section contains : ¾

idSession : same value than the POST idSession parameter

¾

ipAddress : IP address that has entered the Customizer (User’s one)

¾

dtDateIN : Date / Time the IN page was called (Customizer start time)

¾

dtDateOUT : Date / Time the OUT page was called (Customizer end time)

™ BASKET section contains : o

Node attributes ƒ

UCID : Unique configuration ID. Used by HP for tracking purpose.

ƒ

coConfig : selected configuration code

ƒ

lbConfig : selected configuration label

ƒ

qtQuantity : selected configuration quantity

ƒ

coTiering : Pricing level used to compute product prices (sent by the Reseller to

the IN page) ƒ ¾

coDelivery : delivery delay code. It can be “G”, “Y” or “R” for Top Config products. For Top Value products the value is always “0”

LINE section representing a config component (HP product) with the following attributes :

ƒ

coManufacturerRef : HP SKU

ƒ

coSupplierRef : Supplier (LSP) product reference

ƒ

ttDesignation : Product designation

ƒ

nvBuyPrice : Reseller’s buy price for this product. It is sent according to the “Send buy prices” check box of menu “Admin => e-Commerce parameters”

ƒ

nvPrice : Computed product price

ƒ

qtQuantity : Product quantity

7 / 11

CUSTOMIZER – installation and configuration manual

™ FOOTER section contains : ¾

coKey : a control Key generated by Customizer that allows further control of the XML

integrity

XML RESPONSE EXAMPLE :
1144056128562 10.168.0.132 03/04/2006 11:21:12 03/04/2006 11:22:08
88991661421a743268d5ce55377e2499


8 / 11

CUSTOMIZER – installation and configuration manual

XML INTERPRETATION CODE EXAMPLE



9 / 11

CUSTOMIZER – installation and configuration manual

TEXT RESPONSE DESCRIPTION : The Text response is made up of plain text lines. Each line contains the 6 fields separated by a comma, and is terminated by a “\n” (charcode = &0A). The fields are sequenced as follow : ¾

idSession : same value than the POST idSession parameter

¾

ipAddress : IP address that has entered the Customizer (User’s one)

¾

qtConfQuantity : selected configuration quantity

¾

coManufacturerRef : HP SKU

¾

qtQuantity : Product quantity

¾

nvPrice : Computed product price (decimal separator = “.”)

¾

nvBuyPrice : Reseller’s buy price for this product (decimal separator = “.”). It is sent according to the “Send buy prices” check box of menu “Admin => e-Commerce parameters”

¾

coDelivery : delivery delay code. It can be “G”, “Y” or “R” for Top Config products. For Top Value products the value is always “0”

¾

UCID : Unique configuration ID. Used by HP for tracking purpose

TEXT RESPONSE EXAMPLE (with Buy Price information) : 12345678,192.168.3.3,1,PU700AV,1,243.33,146.00,G,UK22713 12345678,192.168.3.3,1,PU723AV,1,184.50,110.70,G,UK22713 12345678,192.168.3.3,1,PV726AV#ABU,1,112.50,67.50,G,UK22713 12345678,192.168.3.3,1,PT967AV,1,61.50,36.90,G,UK22713 12345678,192.168.3.3,1,PU648AV,1,58.50,35.10,G,UK22713 12345678,192.168.3.3,1,PU660AV,1,24.00,14.40,G,UK22713 12345678,192.168.3.3,1,PU705AV,1,0.02,0.01,G,UK22713 12345678,192.168.3.3,1,PT972AV#ABU,1,12.00,7.20,G,UK22713 12345678,192.168.3.3,1,PV430AV,1,0.02,0.01,G,UK22713 12345678,192.168.3.3,1,PV429AV#ABU,1,0.02,0.01,G,UK22713 12345678,192.168.3.3,1,PX081AV,1,0.02,0.01,G,UK22713 12345678,192.168.3.3,1,PV733AV,1,0.02,0.01,G,UK22713 12345678,192.168.3.3,1,PT950AV,1,6.00,3.60,G,UK22713 12345678,192.168.3.3,1,ZD011A,1,23.53,20.00,G,UK22713

10 / 11

CUSTOMIZER – installation and configuration manual

4.

Glossary

WORD

DEFINITION

BTO

Build To Order

Administration Portal

I-Com Software e-commerce site used buy resellers to configure their Customizer offer. This site address as follow : http://customizer.i-comsoftware.com/[CountryCode]

11 / 11