maybe3d auto install en

7
Automatic Installation of Maybe3D Products Technical Specification 2 nd February, 2011 Maybe3D LLC

Upload: grafegorkin

Post on 09-Apr-2018

226 views

Category:

Documents


0 download

TRANSCRIPT

8/7/2019 Maybe3D Auto Install En

http://slidepdf.com/reader/full/maybe3d-auto-install-en 1/7

8/7/2019 Maybe3D Auto Install En

http://slidepdf.com/reader/full/maybe3d-auto-install-en 2/7

Page 2

Overview

Maybe3D Employee

Webstore Product Page

Automatic Installation

The technique of Maybe3D Automatic Installation System is based on frequency

analysis of the occurrences of product names in the product page.

Most part of the work (about 70%) is done by a special robotic web service. Itdownloads the product web page, and determines which product Maybe3D must beinstalled on it. The answer is given almost immediately. In subsequent requests robot

gives the cached results.

If the Robot has doubts about the correctness of detection, it leaves a message for anMaybe3D employee about the necessity of verification and correction.

Within two business days all products will be installed.

All the product pages are checked by the Maybe3D Quality Assurance Dep.

Human Assistance&

Quality Assurance

Detect & Install

· 70% of products immediately

· 30% of products in two business days

Methods of Automatic Installation

Using Starter Utility

· Fast & Easy Installation. Significant human resources saving.

· No need to modify webstore server source code

· Every new page load emits request to AutoInstall WebService (small

lack of load 3D Product time & dependence of Maybe3D Server Status*)

Using Server-to-Server Request

· Need to modify webstore server source code

· Only few first time page loads emit requests to AutoInstall WebService(fastest 3D Product loading & independence of Maybe3D Server

Status*)

* Maybe3D Server with AutoInstall WebService is available 24x7 excludingvery rare short maintenance pauses.

© 2011 Maybe3D LLC

SyntaxRobot

8/7/2019 Maybe3D Auto Install En

http://slidepdf.com/reader/full/maybe3d-auto-install-en 3/7

Webstore

Maybe3D

AutoInstallWebService

ConsumerComputer Maybe3D QA

Starter RequestInitiated by first time page loading

Answer in less than 1 second· Approx. 70% products are automatically

installed immediately

· Approx. 30% product pages will be processed

by Maybe3D employees in next 2 business days

Opening product page

Auto-Launch of Starter Utility

Quality AssuranceAll product pages will be checked by

Maybe3D QA Dep in 2 business days

Answer for requested URL iscached at WebService for thenext fastest replies

Answer is cached for 48 h atconsumer computer to avoidrepeated requests

Starter Utility· Special tiny SWF file that should be embedded

in product page template

·

Starter is launched by product page opening andis invisible for the end-user

· It requests Maybe3D AutoInstall WebService 

to detect Maybe3D product that should appear atthe page

· After receiving answer Starter callbacksJavaScript function MTD_OnProductDetected 

on the product page

· This function is responsible to show Maybe3D

product and it can be changed by Customer

Best Product

Best Webstore

………….. …… ……

………. …… ……

 …….. ……….. ……

… ……… .………………

Starter

Images

3D

Page 3

Automatic Installation Using Starter Utility

© 2011 Maybe3D LLC

8/7/2019 Maybe3D Auto Install En

http://slidepdf.com/reader/full/maybe3d-auto-install-en 4/7

Page 4

Starter Utility Manual

Setup

The products you need should be copied to a folder on the server, for examplemywebstore.com/3dmodels. It is recommended to download all the models from theMaybe3D FTP server. This will eliminate the need to find out what exact models are neededand save time. This work for you will be done by Maybe3D server.

Download the archive with the starter utility:http://services.maybe3d.com/files/MTD_Starter.zip 

Unpack the archive to the server, for example to the folder mywebstore.com/MTD_Starter.

Folder MTD_Starter contains four files:

· MTD_Starter.swf  – starter utility, runs the needed product

· swfobject.js  – library SWFObject 2 is used for easement of embedding starter and product

· expressInstall.swf  – Adobe utility, that allows to upgrade Flash Player to the latest version

· example.html  – example file shows the functions of the starter

System Check

Open example.html in edit code mode.

Change the value of the variable productFolder at line 15 of block <script type="text/javascript"> to the path to the models Maybe3D on your server. Do not include domain name.

For example, if the models are placed at mywebstore.com/3dmodels, you must specify thevalue as productFolder: "3dmodels",

Run the example using path to the file example.html:http://mywebstore.com/MTD_Starter/example.html

A page with an example should appear. In the bottom of the page there are sample content ofproduct page, which will be used to determine product by Maybe3D Server. In the upper leftcorner you can see the starter.Examine the output of the starter. Status should be Pending. This means that the server hasstarted to determine which product should be installed. If you update the page, the productshould appear in the upper right corner of the page. For the next page reloads the productappears almost immediately, because the result of the product determination is cached onserver and user PC.

Troubleshooting

If the product does not appear after restarting the page, you must pay attention to the debuglog of the starter.

Look at the value of Status:

· Pending – the product is still determining (it may required the help of human onMaybe3D side)

· InvalidUrl – the server cannot access a page that displays the starter

· UnknownProduct  – the product was not released by Maybe3D

· Resolved – this value with an invisible product means that SWF file of the product wasnot found. Look what value of productPath at the starter log is printed.

Embedding product to the product page template

Embedding the starter into the template of product page should go the same way. It isrecommended to embed it into the bottom of the page.

For testing you can use the code from the example. After all the checks you can set a smallapplication size and set debugMode: “false”, so the end-user will not get a sight of thestarter.

After determination of the product, the starter calls JavaScript functionMTD_OnProductDetected(productPath), which should be contained in the code of theproduct page.

To implement this function you can use the same logic as in the example.html file to show3D-model directly in the page.

Another way of this function use is to create a «View in 3D» button. When user clicks it, apopup window with 3D-model should appear.

8/7/2019 Maybe3D Auto Install En

http://slidepdf.com/reader/full/maybe3d-auto-install-en 5/7

WebstoreMaybe3DAutoInstall

WebService

ConsumerComputer

Maybe3D QAAnswer in less than 1 second

· Approx. 70% products are automatically

installed immediately

· Approx. 30% product pages will be processed

by Maybe3D employees in next 2 business days

Opening product pageMaybe3D Product is

embedded by product pagegeneration server code

Quality AssuranceAll product pages will be checked byMaybe3D QA Dep in 2 business days

Answer for requested URL iscached at WebService for thenext fastest replies

Need to cache resultsin local database for48 h to avoid repeatedrequests

Best Product

Best Webstore

………….. …… ……

………. …… ……

 …….. ……….. ……

… ……… .………………

Images

3D

Page 5

Automatic Installation Using Server-to-Server Request

Server RequestInitiated by first time page loading

© 2011 Maybe3D LLC

8/7/2019 Maybe3D Auto Install En

http://slidepdf.com/reader/full/maybe3d-auto-install-en 6/7

Page 6

Server-to-Server Request Manual

AutoInstallXML WebService

WebstoreApplication

WebstoreDatabase

cacheProductForUrltimeFromLastCheck

 productIsCached 

getProductForUrl

DetectProduct

Remote Call

ProductPage

embedProductInPage

To obtain the data, use the request to XML Web Service.

Actual address: http://services.maybe3d.com/ai.asmx

You must request function DetectProduct.

Returned result consists of 3 string type fields:

· Status  – status of the determination of the product. Possible values: Pending, Resolved, UnkownProduct ,InvalidUrl

· MTD_ID  – product identification number. Using of this field is optional

· MTD_FILENAME  – the name of SWF file of the product. For example, Canon__EOS_60D

The logic of calling the function can be described by the pseudo-code:

function onProductPageLoad(url):

if timeFromLastCheck(url)  < 48h and productIsCached(url):

embedProductInPage(url, getProductForUrl(url))

  else:

serviceResult = remoteCall_DetectProduct(url)

  switch serviceResult.status:  case “Resolved”:

cacheProductForUrl(url, serviceResult.MTD_FILENAME)

embedProductInPage(url, serviceResult.MTD_FILENAME)

  case “InvalidUrl”:

  throw AIException(“Service can not access to web page: “ + url)

  case “UnknownProduct”:

cacheProductForUrl(url, null)

You can download an archive with the examples of the requests to the AutoInstall service on popular platforms .NET and

PHP by the following address: http://services.maybe3d.com/files/MTD_S-to-S.zip

8/7/2019 Maybe3D Auto Install En

http://slidepdf.com/reader/full/maybe3d-auto-install-en 7/7

Page 7

Privacy Policy

We understand the importance of maintaining confidentiality of yourinformation.

The only information that is transferred from your web store to our

server is a request for the definition of the product which must beinstalled on the page.

Our company uses special management and technical procedures toensure that any data of your store is not going to anyone besides theresponsible employees.

We also guarantee that the information received from your web storewill never and under no circumstances be provided to third parties.