eCommerce - UniLink Data Systems Pty Ltd | Centralising ... · eCommerce . Linking . A sample of...

©2015 UniLink Data Systems Pty Ltd Page 0 of 46

Back to School

Direct Invoicing

eCommerce

Financials

Inventory

Point of Sale

Purchases

Receive Orders

Returns to Suppliers

Special Orders, Reservations & Approvals

Textbooks

eCommerce

Contents Help! Logging a Support Request and Support Contacts? ................................................................................ 3

Technical Information for Web Designers ......................................................................................................... 4

Overview ........................................................................................................................................................ 4

Installation ..................................................................................................................................................... 5

Installing BookWeb for the first time ........................................................................................................ 5

Windows 2000/2003 ................................................................................................................................. 5

Unix Systems .............................................................................................................................................. 6

A current list of available BookWeb functions .............................................................................................. 6

Linking ................................................................................................................................................................ 9

A sample of some of the links available to get you started .......................................................................... 9

Customising ..................................................................................................................................................... 11

How to customise each of the BookWeb functions .................................................................................... 11

Templates .................................................................................................................................................... 12

<BOOKWEB-…..>html variables ....................................................................................................................... 22

Start Search ................................................................................................................................................. 22

Display Results List from search selection ................................................................................................... 24

Display Details of a selected item ................................................................................................................ 26

Display Current Order List ........................................................................................................................... 28

Display Final Confirmed Order .................................................................................................................... 30

University Subject Interface ............................................................................................................................ 32

How to interface to the Student Admin system and display Textbook requirements ................................ 32

Referal Pages ................................................................................................................................................... 36

Only allow defined pages to call the above functions ................................................................................. 36

Query String options ........................................................................................................................................ 37

Parameters that can be passed to the functions ........................................................................................ 37

Server Parameters ........................................................................................................................................... 39


eCommerce

A list of Parameters/Options used to control ............................................................................................. 39


eCommerce

Help! Logging a Support Request and Support Contacts?

To ensure that all Support issues are addressed and that we maintain a high level of service to each of our

customers, we use a Support program called Footprints. This program is designed to assist in the tracking and

reporting of all support issues. As a new issue is logged or additional information added, a copy of this will be

sent to the user and our Support Team. The email contains details of the request or additional information as

supplied; it will also have a support ticket number assigned to it. Please quote this ticket number when

talking to the Support Team.

It is essential that ALL issues are logged.

1. Open BookNet Menu, select Help > Support Centre 2. Enter Email Address, click [Login] 3. Select [Submit Request] 4. Enter Contact Information

- OR tick update information to make changes 5. Enter Brief Description 6. Enter Issue Information, including Current Version

number 7. Enter Description 8. Attach any relevant files 9. Add any cc email address, as required 10. Click Go to submit

An email will be sent to you with the request number and details. A further email will be sent acknowledging

that the Support Team have received it and then further action will be communicated.

UNILINK DATA SYSTEMS

Support Contact – 03 8545 1800

(press 1 for support)

[email protected]

OR

Open BookNet and

select the following:-

Help > Support Centre


eCommerce

Technical Information for Web Designers

Overview BookWeb is made up of several internal programs that can be used to perform specific functions using your

live BookNet data. Using the standard TCP/IP interface, the data can be accessed without jeopardising your

company’s file server security. No sensitive data is kept on the BookWeb server. All credit card details are

encrypted on the BookNet server if you elect to collect this information from the customer.

Each program in the suite is used to perform a task, initiated by the user’s request via their browser. The

web server is loaded with these executables and you can control the look and feel of the site by modifying

html pages. The pages are generated by the BookWeb executables based on current BookNet data and

your desired html content.

We supply sample html to get you started, but you will find, by visiting some of the sites that have already

installed BookWeb, the resultant pages and “shopping baskets” are quite unique. By modifying your own

html pages and keeping them in-line with your corporate image you can create any information and

ordering system that conforms to your requirements. You can include secure ordering forms which offer

the user payment options and link to several payment gateways currently offered by the banks.

Some of the features available include:

• Item Searching by Title, Author, Keyword or ISBN • Item Details including prices, cover images and Synopsis. • Item Availability Status for multiple sites • Customer logins, password updates and address changes • Subscription renewal updates • Textbook requirement listings • Student Information Integration for Subjects • Automatic Catalogue listings • Shopping basket accumulation • Order confirmation screens • Standard Headers and Footers • User defined Look & Feel

The following document describes, from a technical perspective, how the BookWeb system works, the

current features available and how to configure the parameters and html, in order to make it all happen.

Note: For a sample list of customers using BookWeb go to:-

http://www.unilink.com.au/clients.html


http://www.unilink.com.au/clients.html

eCommerce

Installation

Installing BookWeb for the first time

BookWeb must be installed on a web server that can “see” the BookNet server via the Internet of your own

internal LAN using TCP/IP. By default the system uses port 86/udp but this can be amended to any special

requirements.

You can install BookWeb on Windows 2000/2003, AIX, Dec Unix, Sun Solaris or Linux. The standard Web

server must be already be running configured on your operating system before loading the BookWeb suite.

You must add a virtual directory to your server called /bookweb which can then reside on any “real”

directory on the server. This directory should be setup as executable only, users should not need

browse/read access to this directory.

Windows 2000/2003

A CD can be supplied with an Installshield wizard which will take you through a series of questions and then

place BookWeb into your nominated directory. You will need to know the IP address of the BookNet server

before you start the install. This will be requested during the installation. A set of sample html pages can

also be optionally loaded onto your server.

BookWeb can also be downloaded from the UniLink ftp2 server in the /Apps directory. The file is called

BWebXX.exe (XX refers to the current version number) and requires a password to unlock the self

extracting installation. Only registered users will be issued the password which can be obtained from the

UniLink support desk.


eCommerce

Unix Systems

A compressed tar file will be supplied to registered users. This should be uncompressed and then extracted

into the nominated /bookweb directory. Sample html files are included.

A sample BOOKWEB parameter file is included (bookwebm.ini) and should be amended to your

requirements and then copied to BOOKWEB.INI in the executables directory. This is normally the \bookweb

directory. See the section on Server Parameters for instructions on how to set these values.Available Links

A current list of available BookWeb functions

BookWeb is made up of several internal programs that can be used to perform specific functions using your

live BookNet data. Using the standard TCP/IP interface, the data can be accessed without jeopardising your

company’s file server security.

The suite of programs may be added to over time. Currently the following functions are available. Section 3

describes their configuration requirements.

• Addlist

o Add a selected item to the shopping basket

• Address

o Update a customer’s address details (login required)

• Bwlogin

o Login a customer using their account code and password

• Bwlogout

o Logout a customer

• Catalog

o Display a Catalogue or List of items belonging to a unique Product Group, Category, Type or

Subject.

• Cardpay

o Check the returned status from the bank after a linked Credit card transaction. Updates

payments and authorised payments for accounts and credit card customers.


eCommerce

• Chk-Log

o Check if a customer is still logged in and if the result is positive, execute the successful page

display.

• Conf-Acc

o Accept the details of a customer account when they confirm the purchase should proceed.

If successful, the view-ord function is called and the order is given a reference number.

• Conf-det

o Accept the details of an unknown customer when they confirm an order should proceed.

View-Ord is called, if successful.

• Details

o Display the extended details of an item, including Title, Author, Category, Prices,

Availability, etc.

• File-Cat

o Display a page with the standard Header & Footer added

• Freeform

o Accept the details from a customer about an item they would like to order but cannot find

on the system. (Like one big comment passed to BookNet.)

• Invoices

o Display current invoices for the account that is currently logged in.

• Inv-det

o Display current invoice line item detail for the invoice and account that is currently logged

in.

• Mass-Add

o Add a group of items, selected from a search list, into the customer’s shopping basket.

• Password

o Allows the user to change their login password.

• Payment

o Sets up the payment transaction that calls the integrated Bank Credit card gateway.


eCommerce

A current list of the available BookWeb functions (..cont)

• Quantity

o Updates the shopping basket quantity values for items on list.

• Renewadd

o Adds selected subscription renewals to the shopping basket

• Renewals

o Displays a list of outstanding customer subscription renewals.

• Search

o Search by Keyword, Title, Author or APN and display a list of matches which can be

selected.

• Start

o Display the first search requirement page.

• Subject

o Display a list of Textbooks required for a particular subject or a group of subjects.

• Textlist

o Displays a published Textbook list for a given subject.

• View-Ord

o View the current confirmed order. Usually results from a successful order confirmation.

(see Conf-Acc & Conf-Det)

• ViewList

o View the current Shopping Basket contents.

• Where

o Show the details of an item and a breakdown of each shop which stocks the item and its

availability status at each shop.


eCommerce

Linking

A sample of some of the links available to get you started

The following information is useful to web page designers who wish to add reference links to the BookWeb

system from within pages that are to be implemented independently from the BookWeb System. A more

detailed document explaining how to design the actual pages that BookWeb uses is also available in Section

4.

There are a few different types of links that may be made to the BookWeb system, and these have been

highlighted below, by giving an example of each. For all the examples, the name ‘bookshop’ needs to be

replaced by the web site machine name. Also ".exe" indicates the CGI extension being used. With Windows

NT, this is usually .cgi and with Unix systems it is usually blank or ".cgi".

If you want to put a link in a page that points to a customer’s shopping basket: On most occasions, if a

customer is browsing the web site, they will not have a shopping basket. If they go to try and view it, it will

be empty, so it is not a good idea to put this link on a page unless there are other links to add items there

as well (then it would make sense!).

<a href=”http://bookshop/bookweb/viewlist.exe”>Click here</a>

If you want to put in a link to a particular item, so that the customer can view the details and stock status

of the item, then all you need to know is the item’s APN (known as the ‘Item #’ in BookNet). The final page

generated will contain a link to add the item directly to the shopping basket, and also a link to view the

shopping basket.

<a href=”http://bookshop/bookweb/

details.exe?ITEMNO=9780140368147”>

Click here to find out about Oliver Twist</a>


eCommerce

If you would like to put in a link for the customer to add an item directly to their shopping basket, then

the format is almost the same as the above option.

<a href=“http://bookshop/bookweb/addlist.exe?ITEMNO=9780140368147”>

Add Oliver Twist directly to your shopping basket!!!</a>

If you would like to add a link to send the customer to the beginning of the search system, then simply

put in the following:

<a href=”http://bookshop/bookweb/start.exe”>Click here to go to the search page</a>

Sometimes it may be needed to get a page to appear with the standard BookWeb header and footer:

Rather than coding this directly, you can simply call a program that will put in the header, then your HTML

file (say a bestsellers list, or some advertising), and then the footer. The actual HTML code created should

then simply have the text that will appear, with <BODY> and <TITLE> tags (etc!). This is quite straight

forward, however the HTML must be put in the same directory where the other BookWeb HTML files reside

(this is usually /WWW/cgi-bin/bookweb/html/). This constraint is for security purposes (so that an imposter

can’t simply view EVERY file on the system!).

There are two ways of putting in the link. The first method will make it appear like a hyperlink (underlined

clickable words), and the second will make it appear like a button (as in a HTML form).

METHOD 1 – Appear like a Hyperlink

<a href=”http://bookshop/bookweb/file-cat.exe?FILECAT=advert.html&

PAGETITLE=Title+Bar+Text&PAGE-IMG=TitleImageName”>Click here for a Message from our

sponsors</a>

Note: There should be NO spaces in the string above, and it should all appear on one line. To add spaces to the page title, simply insert “+”s. The ‘PAGETITLE’ is the string that will appear in the browser title bar. The PAGE-IMG value is the name of an optional .gif or .jpg image that you wish to display. (Don't include the suffix, this is set in the system's parameters)

METHOD 2 – Appear like a Button

<form method=GET action=”http://bookshop/bookweb/file-cat”>

<input type=hidden name=”FILECAT” value=”advert.html”>

<input type=hidden name=”PAGETITLE" value=”Title Bar text”>

<input type=hidden name=”PAGE-IMG " value=”TitleImageName”>

<input type=submit value=”Click here for a message from our sponsors”>

</form>


eCommerce

Customising

How to customise each of the BookWeb functions

The following information details information necessary to customise the HTML in the BookWeb System on

a ‘per site’ basis.

The BookWeb system uses templates of HTML data to create the web pages that the user will ultimately

see. There are many html files, and most pages are constructed using a combination of these files (i.e. one

template does not refer to one final page). An example of this is for the search results. The data to display a

line of results (in the table) is held within a file called results-line.html. This line is used repeatedly

depending on how many ‘hits’ there are for that search. The table is then completed using results-

end.html.

Embedded into the HTML are fields that the BookWeb system ultimately replaces with information. These

fields are in the form of <BOOKWEB-[FIELDNAME]>. They may be moved around, but be very careful, since

altering these fields may cause BookWeb to act in an unpredictable manner. Most of the fixed text (not

field names) may be altered to your liking. As always, if you are not sure of something please contact:

[email protected] or [email protected]

The best way of customising the system, is to run BookWeb (in a browser!) until the desired page is

reached. Then, look at the source for that page. It will show the names of the files that are used to create

the page. By editing those files, you can change the look and feel of the system.

A more detailed listing of the templates, and how they are used, follows.

Note: Most of the customisation will take place in the header.html and footer.html files. The templates are listed following the program that they refer to (and a description is given for each program). Note that the program name also appears in the ‘location’ bar of the browser being used.

IMPORTANT: Do Not use a visual editor such as FrontPage, Sausage or MSWord to amend the html templates. These editors will try to put headers and footers and matching tags into the html source. Because we actually construct the entire page by taking many different parts, some tags are actually matched in a separate html file and we do not want the editor trying to add/fix these tags and invalid headers.

Please use a pure text editor such as Notepad which doesn’t try to change your coding. ©2015 UniLink Data Systems Pty Ltd Page 11 of 46

mailto:[email protected]

mailto:[email protected]

eCommerce

Templates

start.exe This is the main start point for BookWeb, and contains a blank search form.

header.html

search.html This is the actual search form. It may be customised in any way.

extras.html This file is included only if it exists. It may be used optionally to add some

flashy comments to the introductory page.

footer.html

help screen This is accessible from the search form, in the form of the ‘HELP’ button.

search-howto.html This may be customised in any way, but the code for the ‘OK’ button

should remain in place. (This is found in search.html)

search.exe This is the page that is displayed when the user searches the system.

header.html

search.html A copy of the search form is displayed here, to allow the user to refine their

search.

results-start.html This file contains the start of the results table, and also an optional button

(that sometimes gets commented out!) to go to the previous page.

results-line.html &

results-line-alt.html

These pages are called alternately to display the actual items, They are

called like this to allow you to have alternating backgrounds or font

colours, etc.

results-empty.html If no hits, then results-empty.html will be used. This should instruct the

user that no matches have been found.

results-end.html This field ends off the search results table, and includes another button

(that sometimes gets commented out), to go to the next page.

footer.html


eCommerce

catalog.exe This is the page that is displayed when a catalog listing is requested.

header.html

catalog.html Catalog heading and the option to include the search procedure, to allow

the user to change their mind and do a search instead of Catalog listing.

cat-start.html This file contains the start of the catalog table, and also an optional button

(that sometimes gets commented out!) to go to the previous page.

results-line.html &

results-line-alt.html

These pages are called alternately to display the actual items, They are

called like this to allow you to have alternating backgrounds or font

colours, etc.

cat-empty.html If no hits, then cat-empty.html will be used. This should instruct the user

that no matches items have been found.

cat-end.html This ends off the catalog listing page, and includes another button (that

sometimes gets commented out), to go to the next page.

footer.html

details.exe This is the page that is displayed details about an item in the results list.

header.html

detail.html This is the page that is displayed details about the selected item

footer.html

where.exe This is the page that is displayed details about an item along with

availability.

header.html

where-start.html This is the page that is displayed details about the selected item before the

list of shops and location information.

where-line.html Displays one line for each shop/location and the availability of stock at that

shop

where-end.html Ends off the listing of shop availability.

footer.html


eCommerce

viewlist.exe This page shows the shopping list for a user.

header.html

list-start.html }

list-line.html }

list-empty.html

list-end.html }

List-empty is used in place of the three others if there are no items in the

shopping list. It normally would include a link to a search page (such as the

start page).

footer.html

freeform.exe This form is used to submit a request into BookNet, if an item that is

searched for, could not be found.

header.html

freeform.html The form that the user can use to enter freeform details. Can be changed

slightly, but not too much!

footer.html

subject.exe &

textlist.exe

This page will be accessed through the SIS system. When a student clicks

the button they will see a listing of the books they require for each of the

subjects they are enrolled in.

header.html

subject-start.html

subject-line.html,

subject-line2.html,

subject-line3.html

These lines are used to display the entries in the table. They are used as

follows:

subject-line.html is used to display an actual item title.

subject-line2.html is used to display a student’s subject.

subject-line3.html is used after subject-line2, but when there are no titles

listed for that subject.

The best way to get an idea of what is being displayed, is to look at the

HTML source for a page generated using this program.

subject-head1.html

subject-head2.html

subject-head3.html

The special comment lines can be displayed. 1 is the main

comment/header

2 is the sub-header and 3 is the miscellaneous line.

subject-end.html To end the table.

footer.html


eCommerce

Confirmation This is the page where the user is able to select which method they want to

finalise your order. This is usually by Account or contact details and calls

one of the next two screens.

confirm.html Options to chose confirmation by account or by Contact details. Also, the

chance to switch to a secure server at this point and use https:

Confirmation by

account

This is the form that the user sees when they choose to pay by account.

They must know a valid account code and a PIN.

header.html

confirm-

account.html

footer.html

Confirmation by

contact

This is the form that the user sees when they choose to pay by details.

Paying by details means that the user has to fill in the name/address

and/or credit card details.

header.html

confirm-

details.html

footer.html

view-ord.exe This is the page that the user sees after they successfully confirm an order.

Again the best way to get an idea of the structure of this page is to put

through an order, and then look at the HTML generated by the program.

header.html

order-empty No items have been saved for the order

order-dets.html This section holds the details about the order. Total Amount/items, etc

order-start.html

order-line.html For each line item in the order.

order-end.html

order-

freeform.html

Reference details for a request (from freeform). No actual items ordered.


eCommerce

footer.html

quantity.exe This resets the quantities for the shopping basket and recalls the ViewList

routine.

mass-add.exe This adds all selected items to the shopping basket and calls the ViewList

routine.

Optionally looks up the list from textlist file if subject value is defined

bwlogin.exe Use a form which calls this cgi to enable the user to login.

The cgi then calls the FILE-CAT.cgi to display the outcome. (The standard

header.html & footer.html is added to each of the following.)

The following html files are used to display the different results

logged-in.html Used to display a message that the user has been accepted and is now

logged in. Optionally uses LOG-IN.gif (or jpg) in the header

password-fail.html Used to display a message that the original Account number or password

was not correct. Optionally uses PASSFAIL.gif (or jpg) in the header

password-file.html Used to display a message that the password file could not be accessed

due to a server processing error. . Optionally uses PASSFAIL.gif (or jpg) in

the header

password-

reset.html

Used to display a message that the password is blank and it must now be

set using the password.exe command.


eCommerce

password.exe Use a form which calls this cgi to enable the user to change their existing

password. Fields to pass are ACCTNO (Account code), PASSWD (current

password), NEWPW1 (new password), NEWPW2 (new password again for

confirmation) The cgi then calls the FILE-CAT.cgi to display the outcome.

(The standard header.html & footer.html is added to each of the

following.)


password-ok.html Used to display a message that the password change has been successful.

Optionally uses PASS-OK.gif (or jpg) in the header

password-fail.html Used to display a message that the original Account number or password

was not correct. Optionally uses PASSFAIL.gif (or jpg) in the header

password-file.html Used to display a message that the password could not be changed due to

a server processing error. . Optionally uses PASSFAIL.gif (or jpg) in the

header

password-dup.html Used to inform the user that the new passwords they have entered are not

identical.

Optionally uses PASSFAIL.gif (or jpg) in the header

bwlogout.exe Use a form which calls this cgi to enable the user to logout.




logged-out.html Used to display a message that the user has been logged out.

Optionally uses LOGOUT.gif (or jpg) in the header

login-reqd.html Used to display a message that the user must login first.

Optionally uses LOGINRQD.gif (or jpg) in the header

address.exe Use a form which calls this cgi to enable the user to change their address.




address-saved.html Used to display a message that the user’s new address has been recorded.


eCommerce

Optionally uses ADDRSAVE.gif (or jpg) in the header



login-expd.html Used to display a message that the user must login again because of a

timeout period set by the BookWeb parameters has expired.

Optionally uses LOGINEXP.gif (or jpg) in the header

chk-log.exe Used to check if a user is still logged in and displays a page passed

from the query string is successful..

The cgi then calls the FILE-CAT.cgi to display the outcome. (The

standard header.html & footer.html is added to each of the

following.)




login-expd.html Used to display a message that the user must login again because

of a timeout period set by the BookWeb parameters has expired.


renewals.exe This checks that a customer is logged in, and if they are, displays

the current subscription renewal listing.

header.html

renewal-start.html }

renewal-line.html }renewal-empty.html

renewal-line-alt.html }

renewal-end.html }

renewal-empty is used in place of the three

others if there are no subscriptions awaiting

renewal.

footer.html







eCommerce

renewadd.exe This adds all selected renewals to the shopping basket and calls the

ViewList routine.



Login-expd.html Used to display a message that the user must login again because



invoices.exe This checks that a customer is logged in, and if they are, displays

the current outstanding invoices.

header.html

invoice-start.html }

invoice-line.html } invoice-empty.html

invoice-line-alt.html }

invoice-end.html }

invoice-empty is used in place of the three

others if there are no outstanding transactions.

footer.html







eCommerce

inv-det.exe This checks that a customer is logged in, and if they are, displays

the current details for the invoice selected.

header.html

inv-det-start.html }

inv-det-line.html } inv-det-empty.html

inv-det-line-alt.html }

inv-det-end.html }

invoice-empty is used in place of the three

others if there are no outstanding transactions.

footer.html






payment.exe This checks that a customer is logged in, and if they are, displays

the current outstanding balance and will pass the value to a Bank

Credit Card payment system. Will also accept a payment from non-

account if amount is included.

header.html

card-payment.html Message displayed that is used to pass the “pay now” form to the

bank.

invoice-credit.html Used if the total balance/amount is less than zero.

invoice-zero.html Used if the total balance/amount is equal to zero.

footer.html






eCommerce

cardpay.exe This checks that a customer is logged in, and the correct details are

returned from the bank’s system that match the initial request and

then updates BookNet.

header.html

card-success.html Message to display if transaction is successful

card-decline.html Message to display if transaction is unsuccessful

card-failed.html Message to display if details don’t match original request. Someone

is trying to trick the system.

footer.html




eCommerce

<BOOKWEB-…..>html variables A list of data that can be included and the special BOOKWEB tags used in your html pages

Start Search

header.html - Standard header used on all pages

BOOKWEB-TITLE The title of the page/ for the browser.

BOOKWEB-PAGETITLE The program description that the user sees.

BOOKWEB-BINHREF The href prefix for cgi scripts.

eg. http://www.unilink.com.au/bookweb/

BOOKWEB-BINHREF-S The href prefix for cgi in secure mode.

eg. https://www.unilink.com.au/bookweb/

BOOKWEB-CGIEXT CGI extension used.

Set blank for unix, ".exe" for WinNT

BOOKWEB-JPEG Optional image file name can be displayed

eg. search.gif displayed on search page.

footer.html - Standard footer used on all pages


eg. http://www.unilink.com.au/bookweb/


eg. https://www.unilink.com.au/bookweb/


Set blank for unix, ".exe" for WinNT

BOOKWEB-JPEG Optional image file name can be displayed

eg. search.gif displayed on search page.


eCommerce

search.html - Selection type and search text entered




BOOKWEB-ISBNSEARCH "selected" indicator for ISBN as default

BOOKWEB-TITLESEARCH "selected" ind when title is default

BOOKWEB-AUTHORSEARCH "selected ind when author is default

BOOKWEB-KEYWORDSEARCH "selected" ind when keyword is default

BOOKWEB-BUTTONTEXT "search" or "search again" on button

BOOKWEB-SEARCHTEXT The search string entered by user

extras.html - Extra information for start search page. Usually an Advert.





eCommerce

Display Results List from search selection

results-start.html - Start of current order list including quantities




BOOKWEB-STEXT Actual search text used

BOOKWEB-STYPE Type of search (TI, AU, KW or IS)

BOOKWEB-COM-BEG Controls previous page button

BOOKWEB-COM-END Used in conjunction with above control

BOOKWEB-START Page number of search

BOOKWEB-NUMROWS Max number of rows displayed on page

results-line.html & results-line-alt.html - Each line item in the search result list.




BOOKWEB-ISBN The item's ISBN code (if available)

BOOKWEB-APN The item's APN/EAN code

BOOKWEB-TITLE Title/Description

BOOKWEB-AUTHOR Author of the Book

BOOKWEB-PRICE Price = RRP less selling discount

BOOKWEB-RRP RRP

BOOKWEB-REPORT Report Code/Description

BOOKWEB-ETSS Calculated ETSS value if applicable

BOOKWEB-BINDING Binding

BOOKWEB-EDITION Edition Number

BOOKWEB-STOCK-IND Displays Yes or No based on Actual Stock

(may be actual stock qty if parameter set)

BOOKWEB-AVAIL-IND Displays Yes or No based on availability

BOOKWEB-ORDER-IND Displays Yes or No based on current orders


eCommerce

results-end.html - Completion of search list




BOOKWEB-STEXT Actual search text used

BOOKWEB-STYPE Type of search (TI, AU, KW or IS)

BOOKWEB-NEXT-BEG Controls next page button

BOOKWEB-NEXT-END Used in conjunction with above control

BOOKWEB-PREV-BEG Controls previous page button

BOOKWEB-PREV-END Used in conjunction with above control

BOOKWEB-START-N Page number of next page

BOOKWEB-START-P Page number of previous page

results-empty.html - Displayed if no matches were found.




Usually a link is placed here to go back and search.


eCommerce

Display Details of a selected item

details.html - Page of details for a selected item






BOOKWEB-AUTHOR Author



BOOKWEB-RRP RRP




BOOKWEB-PUBLISHER Publisher of the book

BOOKWEB-GROUP Product Group description

BOOKWEB-CATEGORY Product category description

BOOKWEB-TYPE Product type description

BOOKWEB-SUBJECT The subject code for the title (one 1st one)

BOOKWEB-SUBJECTDESC The subject description

BOOKWEB-INSTOCK In Stock description

BOOKWEB-ONORDER Stock order status description

BOOKWEB-AVAIL Stock availability description

BOOKWEB-STOCK-QTY Actual Stock quantity value (all shops)

BOOKWEB-AVAIL-QTY Available Stock quantity value (all shops)

BOOKWEB-ORDER-QTY On Order quantity value (all shops)

BOOKWEB-JPEG Full Name of image for the item

BOOKWEB-SYNOPSIS Current Synopsis for the item


Display a line status for each Shop’s stock position (where.exe)

where.start.html - Same details as above details.html parameters


eCommerce

where-line.html - For each shop in the system

BOOKWEB-CAMPUS Campus/Shop description

BOOKWEB-LOC Location description

BOOKWEB-INSTOCK In Stock description

BOOKWEB-ONORDER Stock order status description

BOOKWEB-AVAIL Stock availability description

BOOKWEB-STOCK-QTY Actual Stock quantity value

BOOKWEB-AVAIL-QTY Available Stock quantity value

BOOKWEB-ORDER-QTY On Order quantity value

where-end.html - Completion of shop/campus list






eCommerce

Display Current Order List list-start.html - Start of current order list including quantities




list-line.html - Each line item in the order.







BOOKWEB-QTY Quantity of this item required

BOOKWEB-UNIT Unit Price

BOOKWEB-NO-TAX Unit Price when tax free

BOOKWEB-ETSS Unit Price when ETSS rebate applies

BOOKWEB-ITEMTOTAL Extended Line total based on cookie status

list-end.html - Completion of current order list




BOOKWEB-FREIGHT Calculated Freight value.

BOOKWEB-FREIGHT-METHOD Description of chosen Freight from Table.

BOOKWEB-TOTAL Total order value.

BOOKWEB-REBATE Total special rebate value.

BOOKWEB-CONFIRM Confirmation html page value.

BOOKWEB-CUTOFF Cutoff message for textlists.

Following only valid for freight entries from a Table (xx = 01 to 09)

BOOKWEB-FREIGHT-ZONExx Zone number for freight table.

BOOKWEB-FREIGHT-DESCxx Description for freight table.

BOOKWEB-FREIGHT-VALxx Value for this freight table.

BOOKWEB-FR-CHECKEDxx Checked Status for this freight entry.

BOOKWEB-FR-SELECTxx Selected Status for this entry.


eCommerce

list-empty.html - Displayed if no lines have been currently saved.




Usually a link is placed here to go back and search.


eCommerce

Display Final Confirmed Order

order-start.html - Start of the committed order




(Above three also included in all following .html files)

order-dets.html - Details of the order (Total and reference).

BOOKWEB-ORDERNUM Order reference.

BOOKWEB-NAME Name of customer.

BOOKWEB-METHODNAME Contact type description (eg Phone/email.)

BOOKWEB-METHOD Contact reference.

BOOKWEB-LINEITEMS Number of different items.

BOOKWEB-ITEMS Total Quantity of items.

BOOKWEB-FREIGHT Total Freight

BOOKWEB-GST GST included in Total

BOOKWEB-ETSS ETSS included in Total

BOOKWEB-PAID Authorised credit card amount

BOOKWEB-REF Payment reference from bank payment

BOOKWEB-TOTAL Total order value

order-line.html - Each line item on the order.





BOOKWEB-UNIT Unit Price

BOOKWEB-ITEMTOTAL Extended Line total

order-end.html - Completion of order list

BOOKWEB-FREIGHT Total Freight

BOOKWEB-GST GST included in Total

BOOKWEB-ETSS ETSS included in Total

BOOKWEB-TOTAL Total order value


eCommerce

order-empty.html - Displayed if no lines have been currently saved.

No special variables are used.

order-freeform.html - Displayed if a free form request is received.

BOOKWEB-ORDERNUM Contact Request reference

BOOKWEB-NAME Customer's name

BOOKWEB-EMAIL e-mail address

BOOKWEB-PHONE Phone number


eCommerce

University Subject Interface

How to interface to the Student Admin system and display Textbook requirements

An interface to pass information from the University Web site to the Bookshop Web site has been

developed so that course identifiers relevant to a particular student can be made available to the Bookshop

site.

This is achieved by ensuring that when a student accesses the Bookshop site via the main University site, a

student id and pin number is requested. Once verified, the student record is accessed and the current

courses determined. This information is passed across to the Bookshop site (embedded in a page) as:

<form method=”get” action=”http://'bookshop'/bookweb/subject.exe/”>

<input type=hidden name=”subject1” value=”111111”>



. . . . (continued for each subject)

<input type=hidden name=”stype” value=”R”>

<input type=submit value=”click here for textbook list”>

Note: In the above example, 111111 is subject code 1, 222222 is subject 2, etc

Also only displays textbooks with a type. This can be used to just display Reference or Set texts or Course Notes, etc. Leave this blank to show all confirmed texts.

Alternatively the subject information can be passed across as a link

eg. The same three subjects are passed to the bookshop using the link:

http://bookshop/bookweb/subject.exe?subject1=111111&subject2=222222&subject3=333333&stype

=R

An example of this link working can be found at:-

http://www.unilink.com.au/textlist.html


http://www.unilink.com.au/textlist.html

eCommerce

When a student accesses the Bookshop site directly and seeks textbook information by course there should

be a link back to the University Student Admin site so that the student I.D./pin security check can be

invoked. The course detail can then be passed back to the Bookshop site.

When a valid Subject is found the following is displayed:

1. Standard header (header.html)

2. The header for the subject (subject-start.html & subject-line2.html)

3. All the textbooks that have been confirmed (subject-line.html)

a. Or a message to say no Textbooks are on file (subject-line3.html)

b. Or a message to say no Textbooks are confirmed (subject-line4.html)

c. Or a message saying the subject is not registered (subject-line5.html)

4. An optional comment for each textbook (comment-line.html)

5. End of the list (subject-end.html)

6. The standard footer (footer.html)


eCommerce

The resultant pages are produced with the related display variables:

subject-start.html - Start of subject results page




subject-line2.html - New subject found

BOOKWEB-SUBJECT Actual subject code

BOOKWEB-SUBJYEAR Subject Year

BOOKWEB-SUBJSEM Subject Semester

BOOKWEB-CAMPCODE Campus/Shop code for this subject

BOOKWEB-CAMPNAME Name of Campus/Shop for this subject

BOOKWEB-TEXTTYPE Type of Textbooks to include

(if “stype” used)

subject-line.html - Each Textbook in the subject listing.







BOOKWEB-AUTHOR Author of the Book

BOOKWEB-TYPE Type of Textbook (Prescribed, etc)


BOOKWEB-RRP RRP




BOOKWEB-STOCK-IND Displays Yes or No based on Actual Stock

(may be actual stock qty if parameter set)

BOOKWEB-AVAIL-IND Displays Yes or No based on availability


BOOKWEB-ORD-IND Special textlist Order Indicator

BOOKWEB-MAND-MSG Mandatory message

BOOKWEB-SEL-DFLT Default for Checkbox (“checked” if ON) ©2015 UniLink Data Systems Pty Ltd Page 34 of 46

eCommerce


comment-line.html - Optional special comment for an item

BOOKWEB-COMMENT The comment displayed, if it exists.

subject-head?.html - Header and sub-header lines ( ? is 1, 2 or 3 )

BOOKWEB-COMMENT The header details to be displayed.

subject-end.html - Completion of subject list

BOOKWEB-SUBJECT Actual subject code (if single code enquiry)

BOOKWEB-SUBJECTxx xx is a number (for multiple subjects codes)





eCommerce

Referal Pages

Only allow defined pages to call the above functions Many times we wish to protect information so the cgi cannot be called directly by a user. This is especially

useful for the above Subject link. We only want the authorised University Student pages to be able to

display the textbook lists.

To this we can include a referral file for each function.

These files are text files and can include as many different referral pages that you wish to give access.

eg. If a subject.ref file is created as follows:

http://www.unilink.com.au/student.html

http://www.bookshop.edu.au/

Only pages that begin with either of the above lines can process the textlist

So all www.bookshop.edu.au pages only the student.html page & www.unilink.com.au

The CHECK-REF parameter must be switched on in the Bookweb.ini file and the “xxxxxxx.ref” file must be

present for the referral feature to work.

The following .ref files are supported:-

addlist.ref address.ref

bwlogin.ref bwlogout.ref

catalog.ref cardpay.ref

chk-log.ref conf-det.ref

conf-acc.ref details.ref

file-cat.ref freeform.ref

invoices.ref inv-det.ref

mass-add.ref password.ref

payment.ref quantity.ref

renewadd.ref renewals.ref

search.ref start.ref

subject.ref textlist.ref

view-ord.ref viewlist.ref

where.ref


http://www.unilink.com.au/student.html



http://www.unilink.com.au/

eCommerce

Query String options

Parameters that can be passed to the functions Some of the routines can use parameters passed at the time that the function is called.

The above “subject” routine describes the two methods for passing parameters. Both use the “get”

procedure. (not “post”)

eg. details.exe?itemno=9781234567897

addlist.exe?itemno=9781234567897&qty=3&taxexempt

Some other Functions and their related query string parameters follow:

details itemno The item to display details about. where itemno The item to display details about. addlist itemno The item to display details about. qty Quantity of this item to add to basket taxexempt Use tax exempt prices for this order etss ON to use ETSS prices for this order OFF to not use ETSS prices for this order mass-add APN/ISBN ON to add the applicable item to the order (could be multiple items added) taxexempt Use tax exempt prices for this order etss ON to use ETSS prices for this order OFF to not use ETSS prices for this order subject If textlist has been used to create the choice list viewlist taxexempt Use tax exempt prices for this order etss ON to use ETSS prices for this order OFF to not use ETSS prices for this order conf-det name Customer full name sname Customer Surname phone Phone phone-ah Phone (After hours) email email ccno Credit card number or “BANKLINK” if bank integration ccexp c/c expiry ccname name on card paytype Type of payment INV=invoice,CHQ=cheque,C/C=card acctno Account code pord Customer’s purchase order fname Cust first name tname Cust title (Mr, Mrs,, etc) addr1 Address line 1 (also addr2 & addr3) city City state State


eCommerce

attention Attention order to.. pcode Post code/Zip country County fax fax freight freight code conf-det chqbsb BSB for cheque chqno Cheque number chqname Cheque Drawer notes Comment lines taxexempt Use tax exempt prices for this order etss ON to use ETSS prices for this order OFF to not use ETSS prices for this order file-cat pagetitle Title for the page that goes in heading page-img Name of image for heading/footer filecat Name of .html file to display with heading/footer search stype Type of search TI=title, AU=Author, KW=keyword, IS=ISBN stext The text to search for. start The page number to start current search results (default = 1) catalog stype Type of search P=Prod Grp, C= Category, T=Type, SU=Subject stext The group code to search for. start The page number to start current search results (default = 1) name Description of this catalog listing inv-det docref The invoice document code for the account

Other options can be found in the demonstration .html files supplied with the product. Many of the routines can be seen in action at:- http://www2000.unilink.com.au/bookweb_beta/


http://www2000.unilink.com.au/bookweb_beta/

eCommerce

Server Parameters

A list of Parameters/Options used to control

BOOKWEB.INI File must be setup in the BookWeb executable area.

The content of this file contains options and parameters used to control the characteristics and instruct the

BookWeb system where to find the required information.

Available Parameters: examples:

HTML-DIR directory where html include files live html\ MAGICFILE name of file that stores last magic reference number data\magic.dat ORDERFILE name of file that stores temporary order data data\orders.dat CGI-DIR cgi directory as it is known to server /bookweb/ PREFIX prefix used for orders placed WWW CGI-EXT extension for cgi programs (can be blank) .exe LOG name of file that stores logging history logs\bookweb.log TITLE Title that goes in browser status bar UniLink BookWeb MAX-LINES Max number of search result lines 012 CNT-FILE name of Booknet control file C:\BOOKNET\data\CBCTL.V02 STK-FILE name of BookNet stock master file C:\BOOKNET\data\STKITEM1.V02 STKX-FILE name of BookNet stock xref file C:\BOOKNET\data\STKXREF1.V02 STKS-FILE name of stock segments file C:\BOOKNET\data\STKSEGS1.V02


eCommerce

STKT-FILE name of stock transaction file C:\BOOKNET\data\STKTRAN1.V01 STKR-FILE name of stock reservations file C:\BOOKNET\data\STKRESV1.V02 RESV-FILE name of order reservaions file C:\BOOKNET\data\RESERVE1.V03 RESD-FILE name of order reservation details file C:\BOOKNET\data\RESVDTL1.V01 LEV-FILE name of stock levels file C:\BOOKNET\data\STKLEVL1.V01 ORD-FILE name of Internet orders file C:\BOOKNET\data\WEBORDS1.V01 KEYW-PREF prefix to stock keyword files C:\BOOKNET\data\ DRS-FILE name of customer master file C:\BOOKNET\data\ACRMAST1.V01 DSEG-FILE name of customer segments file. C:\BOOKNET\data\ACRSEGS1.V01 FINT-FILE name of customer transaction file. C:\BOOKNET\data\FINTRAN1.V02 FINH-FILE name of customer transaction history file. C:\BOOKNET\data\FINHIST1.V01 SUBS-FILE name of subscriptions file C:\BOOKNET\data\SUBMAST1.V01 SUBJ-FILE name of textbook subject file. C:\BOOKNET\data\TXTFACL1.V01 TXT-FILE name of textbook book file. C:\BOOKNET\data\TXTBOOK1.V02 TXT-LIST name of textbook remote publish file. C:\BOOKNET\data\TXTLIST1.V01 PUB-FILE name of order reservaions file C:\BOOKNET\data\PUBLISH1.V01 ADDR-FILE name of temporary address change file C:\BOOKNET\data\ADDRESS.TXT ADDR-UPPR convert the customer address to all uppercase characters NO


eCommerce

IMG-DIR directory where book cover images are kept. c:\inetpub\wwwroot\images\jpegs\ IMG-PREF position of images as referenced by browser. /images/jpegs/ IMG-SUFF suffix used for book cover images (usually .gif or .jpg). .jpg IMG-BLANK image name used if no cover image available. blank HIMG-SUFF suffix used for images included in the heading (optional). .gif HIMG-PREF position of the images as referenced by browser. Defaults to the same prefix that

IMG-PREF uses. EMB-DIR directory where school emblems are kept (Textlist.cgi). c:\inetpub\wwwroot\images\emblems\ EMB-PREF position of school emblems as referenced by browser. /images/emblems/ EMB-SUFF suffix used for emblem images (usually .gif or .jpg). .jpg EMB-BLANK image name used if no emblem available. blank SUB-M-IN subject details passed from browser. ABCDEF-H or ABCDEFGHIJKLMNOPQR SUB-M-OUT subject detail format passed to booknet. ABC-DEF H (subject, semester)

or ABCDEFGHIJS12006 (subject, sem, year) or ABCDEFGHIJS12006ME (subj, sem, yr, cmp)

TEXT-YEAR default year used for textbook subjects. 2006 DISCOUNT calculate discount for items (show as net price). YES EXT-TITLE If extender 120 character titles are required NO SYN-EMPTY message displayed if no synopsis is available for item. No extra details available for this item.


eCommerce

QTY-SRCH search for stock availability when displaying a list of items Yes will access quantities during a search Actual will display actual quantities. 1,2,3…9 displays actual if customer level is not lower than the value ORD-SRCH same as above for order quantities. MIN-QTY minimum qty to be in stock before displaying item in a search 000 (zero = no check) (qty-srch must = Y) MAX-AGE Also displays title if item received within this number of days (even if qty is less than the minumum) (qty-srch must = Y) 000 EX-PG check Product group exception file (PRODGRPS.INI) NO EX-CAT check Categories exception file (PRODCATS.INI) NO EX-TYPE check Types exception file (PRODTYPE.INI) NO INC-PG check Product group inclusions file (PRODGRPS.INI) NO EX-CAT check Categories exception file (PRODCATS.INI) NO EX-TYPE check Types exception file (PRODTYPE.INI) NO SERVICES are service items available to be sold? NO CHECK-REF check the existence of a refer page file for each program.

This contains a list of pages that are permitted to call the routines. Each program can have a different set of referrer pages.

NO TAX-FREE The tax code that is used for tax free items/groups TAX-GRP The default grouping for the Tax code for items that are not specifically flagged with a particular tax code. P = Product Group C = Category T = Type


eCommerce

TAX-RATE The percentage value used for the current Tax rate. 010000 = 10% TIMEOUT The number of 30 minute intervals before an account login Expires. 1 MS-STK Default message for item’s current stock quantity Currently In Stock MS-NOSTK Default message for item’s stock quantity when not in stock Not In Stock MS-AVAIL Default message for item’s current stock availability

(In Stock plus On Order less Reservations.) Currently Available MS-NOAVAIL Default message for item when not available Not Currently Available MS-ORD Default message for item’s order status On Back Order MS-NOORD Default message for item when not on order from a supplier. Not Currently On Order CARD-OK Message returned from the Bank for approved transaction APPROVED CARD-CUST Account used to store credit card payments when no account. ACCOUNTS Indicates if an Account file is available for balance updating during a card authorisation update. . YES or NO FRGHT-TYP Type of Freight calc T=table 37, V = value, Q = quantity FRGHT-BRK Order Value to charge the following freight charge Values 000010000 Qtys 000000100 (1) 000020000 000000200 (2) 000100000 009999900 (>2)


eCommerce

FRGHT-VAL Value of the freight for the above total order value (Up to 9 breakdowns can be used) 000001500 000002000 000000000 eg. $0 -$100 total, charge $15 freight or 1 item $100 - $200 total, charge $20 freight 2 items $>200, charge $0 freight >2 items FR-ZONE When FREIGHT-TYP T is used this refers to the freight zone in the BookNet freight

table (multiple entries can be made) Local

FR-METHOD When FREIGHT-TYP T is used this refers to the freight method in BookNet the freight table (multiple entries may be made)

XXXXX INV-AGE Maximum number of days to display invoices during a list of account invoices when they are already allocated. 030 (30 days) 000 (no fully allocated invoices displayed) CHECKBOX Default value for checkboxes in text list. “checked” is ON. MAND-MSG Mandatory item message. CUT-MSG Cut-off Date message for textlists with delivery cutoff

(%D = Date) REBATETYP Rebates based on text list C = Course code, S = School code, Y for Year code SCHOOLLEN Length of the school part of the subject split into school/year REBATEFOR Order Value to charge the following freight charge Eg. Value 06 Year 06 REBATEVAL Value of the rebate for the above level (Up to 9 breakdowns can be used) 000015000 $150 rebate


eCommerce

REDIRECT indicates if requested are redirected from a firewall server and cookie value and browser IP address are included in query string.

NO COOKIE name of variable when cookie passed via firewall server. cookie IP-ADDR name of variable when ip address passed via firewall server. ipaddr ASP-HREF full reference used for Bookweb pages if firewall server used. http://asp.server/pubs/html.asp?/bookweb/ ASP-SHREF full secure reference for Bookweb if firewall server used. https://asp.server/pubs/html.asp?/bookweb/ SCHEMA Indicator (P,C,or T) Alternate schema detail pages looks for detailsxx.html (where xx will be each product category) Use P for Prod grp, C for categories and T for types CONF-OS name of confirm.html page for overseas (eg. confirm-os) Alternative contact confirmation form depending on exemption status (overseas) when exempt uses this tag replaces <BOOKWEB-CONFIRM> in viewlist.cgi CONF-LOC name of confirm.html page for local (eg. confirm) Alternative contact confirmation form depending on exemption status (local) when not exempt uses this tag replaces <BOOKWEB-CONFIRM> in viewlist.cgi TRACE turn trace detail on for debugging purposes. All variables

and their values are displayed on the browser. NO

Note - Cookies must be enabled on the client’s browser for shopping basket, accounts and auto calculation of GST rate to work.


http://asp.server/pubs/html.asp?/bookweb/

https://asp.server/pubs/html.asp?/bookweb/

eCommerce

Notes


eCommerce - UniLink Data Systems Pty Ltd | Centralising ... · eCommerce . Linking . A sample of...

Documents

Transcript of eCommerce - UniLink Data Systems Pty Ltd | Centralising ... · eCommerce . Linking . A sample of...