Back to e-Business Applet

Parameters

e-Business Applet is a java applet. Java applets are small programs that are run by the web browser and extend the functionality of the browser. Java applets consist of one or more files with the extension *.class. The class files is located at the web server together with html documents. When a html document contains the special <APPLET ....> .... </APPLET> tag the browser will download and execute the applet specified in this tag. The applet tag can include parameter statements that can be used to configure the applet.

mark the parameters that are required.

General parameters
PROPERTIES <PARAM NAME="PROPERTIES" VALUE="ebusi.properties">
All the parameters except CABBASE can be set in the file specified with the PROPERTIES parameter.
The value of the PROPERTIES parameter is the name of the file that contain the applet properties.
CABBASE <PARAM NAME="CABBASE" VALUE="CatviewPro.cab">
Don't change this parameter. CatviewPro.cab is a compressed archive of java class files that is used by Microsoft Internet Explorer.
LICENSE_KEY <PARAM NAME="LICENSE_KEY" VALUE="iu309u0jdoifj09u230hsng">
You get the value of the license parameter when you purchase a license. Without a correct license parameter the applet displays a unlicensed dialog every time it loads.
TITLE <PARAM NAME="TITLE" VALUE="My Product Catalog">
title displayed while e-Business Applet loads

 
Parameters that control data
DATA_FILE_NAME <PARAM NAME="DATA_FILE_NAME" VALUE="data.txt">
name of your text data file. Default is data.txt. If the data file is placed in another directory than the applet this parameter must include the relative path from the directory of the applet. For example:
The applet is in http://www.javazine.net/catviewpro/ and the data file is in http://www.javazine.net/catviewpro/db/data.txt then this parameter must be <PARAM NAME="DATA" VALUE="db/data.txt">
DATA_FILE_DELIMITER <PARAM NAME="DATA_FILE_DELIMITER" VALUE="COMMA">
specify the character used to separate columns in your data file. Valid DELIMITER values are COMMA, SEMICOLON, TAB, QMARK (') or DQMARK (").
COMMA is default.
DATA_FILE_ROW_COUNT <PARAM NAME="DATA_FILE_ROW_COUNT" VALUE="1200">
number of rows in your data file
COLUMN_X

X is the column number starting from 1

ADD A COLUMN PROPERTY FOR EACH COLUMN IN YOUR DATA FILE BEGINNING WITH COLUMN_1, COLUMN_2 ...
COLUMN PROPERTIES HAVE MULTIPLE ATTRIBUTES EACH WITH A SYNTAX LIKE NAME=VALUE
COLUMN ATTRIBUTES ARE SEPARATED BY SEMICOLONS (;)
THE NAME ATTRIBUTE IS THE COLUMN NAME
THE WIDTH CAN BE USED TO SET THE INITIAL WIDTH OF THE COLUMN. 
BY DEFAULT THE COLUMN WIDTH IS AUTOMATICALLY CALCULATED
THE TYPE ATTRIBUTE CAN HAVE THE FOLLOWING VALUES
TYPE=STRING (COLUMNS OF TYPE=STRING WILL ARE SORTED AS STRINGS WHEN THE COLUMN HEADER IS CLICKED)
TYPE=NUMBER (COLUMNS OF TYPE=NUMBER WILL ARE SORTED AS NUMBERS WHEN THE COLUMN HEADER IS CLICKED)
TYPE=URL (COLUMNS OF TYPE=URL ARE LINKS THAT WILL BE SHOWN WHEN CLICKED ON)
TYPE=IMAGE (COLUMNS OF TYPE=IMAGE ARE LINKS TO IMAGES THAT WILL BE SHOWN WHEN CLICKED ON)
TYPE=CATEGORY (COLUMNS OF TYPE=CATEGORY ARE USED GROUP THE DATA INTO CATEGORIES)
THE BASEURL ATTRIBUTE CAN BE USED FOR COLUMNS OF TYPE=URL OR TYPE=IMAGE
THE VALUE IN COLUMNS OF TYPE=URL OR TYPE=IMAGE ARE ADDED TO THE BASEURL ATTRIBUTE VALUE
WHEN THE COLUMNS ARE CLICKED ON
COLUMNS WITH AN ALIAS ATTRIBUTE WILL DISPLAY THE ALIAS INSTEAD OF THE COLUMN VALUE FOR COLUMNS OF TYPE=URL OR TYPE=IMAGE THE ALIAS=link OR ALIAS=Photo IS USEFULL

Notice that attributes are separated with semicolons.

type= Description
STRING text or dates. Sorted in alphabetical order when user click on column header
NUMBER numeric data. Sorted in numerical order when user click on column header
URL links (as text). When the user click on a cell in a URL type column the applet will try to load the link in a browser window.
IMAGE link to images (gif or jpeg). When the user click on a cell in a URL type column the applet will try to load it in a image viewer
PRICE prices as numbers. The price column is used to calculate the price of the selected items of an order. This column must only contain numeric data. There can only be one column of type PRICE
CATEGORY entries in this column is used to group the rows in categories. The categories can then be selected from a drop down list that make a quick filtering by category
ID unique identifier for this row. The IDs of selected items are submitted together with quantities when the order is posted to a cgi script. This advanced feature can be used to integrate e-Business Applet with a backend e-commerce server. There can only be one column of type ID


For example:
<PARAM NAME="COLUMN_1" VALUE="name=JournalId; type=NUMBER>
<PARAM NAME="COLUMN_2" VALUE="name=Journals; type=URL; baseurl=http://www.javazine.dk/journals/;target=_new; alias=Link>
<PARAM NAME="COLUMN_3" VALUE="name=Author; width=100">
<PARAM NAME="COLUMN_4" VALUE="name=Journal Picture; type=IMAGE; alias=Photo">

In this case column 1 Journal ids, column 2 are links to the Journal, column 3 are just some authors and column 4 are links to pictures.  When users click on fields in column 2 the applet will construct a hyperlink from  http://www.javazine.net/journals/ + "value in the column clicked on" and try to load this document in a new browser window. The same thing happens when the user clicks on column 4 where the browser will try to load an image. In column 4 there is no BASEURL specified, thus data in this column must contain absolute links to the images that should be loaded. If a column is of type URL you can also specify the target. The target can be a new window (default) or one of the windows _self, _parent, _blank, or a frame.

 
Parameters that control the ordering
ORDER_PROTOCOL
<PARAM NAME="ORDER_PROTOCOL" VALUE="smtp">
<PARAM NAME="ORDER_PROTOCOL" VALUE="http">

If ORDER_PROTOCOL is set to smtp the applet try to connect directly to the server specified in the email_host parameter below. When set to "http" the applet will use a form mail cgi to email the orders. This will normally work for all.
If your email ordering does not work use "http"

ORDER_EMAIL_HOST <PARAM NAME="ORDER_EMAIL_HOST" VALUE="mail.compuserve.com">
Only used if email_protocol is set to "smtp"

Set the ORDER_EMAIL_HOSTparameter to the outgoing email server (smtp server) or incoming POP3 server you use in other email clients. If the ORDER_EMAIL parameter is you@yourserver.com the ORDER_EMAIL_HOST parameter may be something like mail.yourserver.com. For test purposes you can try to use www.javazine.net as the email host.
ORDER_CGI <PARAM NAME="ORDER_CGI" VALUE="http://www.javazine.net/orderprocess.pl">
The applet will make a http post of the order content to the cgi script specified in this parameter. This feature will allow e-Business Applet to integrate with a backend e-commerce server. It is called ORDER_CGI but the cgi script can do anything with the order data. Here is detailed specification of the form field parameters.
ORDER_EMAIL <PARAM NAME="ORDER_EMAIL" VALUE="admin@trading.dk">
orders are sent to this email address.
ORDER_EMAIL_SUBJECT <PARAM NAME="EMAIL_SUBJECT" VALUE="Order info from MyShop">
ORDER_EMAIL_HEADER <PARAM NAME="EMAIL_HEADER" VALUE="Thank you for ordering from my shop">
specify a header line in the order email
ORDER_TEXT_1
ORDER_TEXT_2
ORDER_TEXT_3 ...
<PARAMETER NAME="ORDER_TEXT_1" VALUE="this is the first line in the free order text>
Set free order text in the order form dialog one line of text per parameter
ORDER_CURRENCY <PARAM NAME="ORDER_CURRENCY" VALUE="DKK">
Indicate the currency. Default USD
PAYMENT_X

There can be multiple PAYMENT parameters beginning with PAYMENT_1

<PARAM NAME="PAYMENT_1" VALUE="name=Visa; type=CREDITCARD; fee=0>

Type can be:
CREDITCARD
BANK
CHECK
ACCOUNT
MONEYORDER
OTHER

ORDER_SECRET_KEY <PARAMETER NAME="ORDER_SECRET_KEY" VALUE="af3d34gh4d21">
This is an encrypted representation of a password you choose. The password is used to decrypt credit card numbers before the order is submitted. Use the Crypt Applet utility to generate a secret key parameter and to decrypt the credit card numbers in the orders you receive.
ORDER_VALUE_ADDED_TAX <PARAM NAME="ORDER_VALUE_ADDED_TAX" VALUE="25">
Enter the value added tax in percent. Default is 0%. The VAT is calculated and added to the total cost.
ORDER_SHIPPING_COST <PARAM NAME="ORDER_SHIPPING_COST" VALUE="10">
Add a fixed cost for shipping. Added to the total cost. Default 0
ORDER_HANDLING_COST <PARAM NAME="ORDER_HANDLING_COST" VALUE="5">
Add a fixed cost for handling. Added to the total cost. Default 0
ORDER_SHOW_CALCULATED_COST <PARAM NAME="ORDER_SHOW_CALCULATED_COST" VALUE="NO"> will hide the calculated cost on the order form dialog

 
Parameters that contain merchant information
This information is included in the order email
MERCHANT_EMAIL <PARAM NAME="MERCHANT_EMAIL" VALUE="contact email">
MERCHANT_NAME <PARAM NAME="MERCHANT_NAME" VALUE="contact name">
MERCHANT_COMPANY <PARAM NAME="MERCHANT_COMPANY" VALUE="company name">
MERCHANT_ADDRESS <PARAM NAME="MERCHANT_ADDRESS" VALUE="contact address">
MERCHANT_CITY <PARAM NAME="MERCHANT_CITY" VALUE="contact city">
MERCHANT_ZIP <PARAM NAME="MERCHANT_ZIP" VALUE="contact zip">
MERCHANT_STATE <PARAM NAME="MERCHANT_STATE" VALUE="contact state">
MERCHANT_COUNTRY <PARAM NAME="MERCHANT_COUNTRY" VALUE="contact country">
MERCHANT_TELEPHONE <PARAM NAME="MERCHANT_TELEPHONE" VALUE="contact telephone">
MERCHANT_FAX <PARAM NAME="MERCHANT_FAX" VALUE="contact fax">
MERCHANT_BILLING_CODE <PARAM NAME="MERCHANT_BILLING_CODE" VALUE="no used by credit card operator">

 
Parameters that contain customer information
These parameters can set customer information at load time. The parameters can for example be dynamically created by a cgi script as a part of a session with a customer. Mostly for advanced use.
CUSTOMER_ID <PARAM NAME="CUSTOMER_ID" VALUE="customer id">
CUSTOMER_EMAIL <PARAM NAME="CUSTOMER_EMAIL" VALUE="customer email">
CUSTOMER_NAME <PARAM NAME="CUSTOMER_NAME" VALUE="customer name">
CUSTOMER_COMPANY <PARAM NAME="CUSTOMER_COMPANY" VALUE="customer name">
CUSTOMER_ADDRESS <PARAM NAME="CUSTOMER_ADDRESS" VALUE="customer address">
CUSTOMER_CITY <PARAM NAME="CUSTOMER_CITY" VALUE="customer city">
CUSTOMER_ZIP <PARAM NAME="CUSTOMER_ZIP" VALUE="customer zip">
CUSTOMER_STATE <PARAM NAME="CUSTOMER_STATE" VALUE="customer state">
CUSTOMER_COUNTRY <PARAM NAME="CUSTOMER_COUNTRY" VALUE="customer country">
CUSTOMER_TELEPHONE <PARAM NAME="CUSTOMER_TELEPHONE" VALUE="customer telephone">
CUSTOMER_FAX <PARAM NAME="CUSTOMER_FAX" VALUE="customer fax">

 
Parameters that control the layout
LAYOUT_PRINT_BUTTON <PARAMETER NAME="LAYOUT_PRINT_BUTTON" VALUE="NO">
remove the print button
LAYOUT_ORDER_BUTTON <PARAMETER NAME="LAYOUT_ORDER_BUTTON" VALUE="NO">
remove the order button
LAYOUT_SEARCH_BUTTONS <PARAMETER NAME="LAYOUT_SEARCH_BUTTONS" VALUE="NO">
remove the search buttons and search entry field
LAYOUT_NAVIGATION_BUTTONS <PARAMETER NAME="LAYOUT_NAVIGATION_BUTTONS" VALUE="NO">
remove the navigation buttons
LAYOUT_ABOUT_BUTTON <PARAMETER NAME="LAYOUT_ABOUT_BUTTON VALUE="NO">
remove the about button

 
Form parameters posted to cgi (only for advanced users)
RECEIPT_NO unique 10 digit number + a modulus10 check digit. This number is generated automatically for each order
MERCHANT_BILLING_CODE merchant id used by some credit card operators and payment gateways
CUSTOMER_ID The customer id can be set as a parameter at load time. This can be used to assign a unique ID to a customer.
CUSTOMER_EMAIL email given by customer in the order
CUSTOMER_NAME name given by customer in the order
CUSTOMER_COMPANY company given by customer in the order
CUSTOMER_ADDRESS address given by customer in the order
CUSTOMER_CITY city given by customer in the order
CUSTOMER_ZIP zip given by customer in the order
CUSTOMER_STATE state given by customer in the order
CUSTOMER_COUNTRY country given by customer in the order
CUSTOMER_TELEPHONE telephone given by customer in the order
CUSTOMER_COMMENT email given by customer in the order
PAYMENT_METHOD payment method selected by the customer
CREDIT_CARD_NUMBER credit card number given by the customer. Credit card numbers are encrypted by the e-Business Applet and can be decrypted by the Crypt Applet
NAME_ON_CREDIT_CARD name on the credit card give by customer
EXPIRATION_MONTH expiration month od the credit card give by customer
EXPIRATION_YEAR expiration year of the credit card give by customer
ITEM_COUNT number of items ordered
ITEM_ID_1, ITEM_ID_2 ..... if the one of the columns are of type ID each ordered item is put in a form parameter with names running from item_id_1, item_id_2 ... to the number of items given in ITEM_COUNT above.
ITEM_QUANTITY_1, ITEMQUANTITY_2 .... the quantities for each item specified above in the item_id_1 ... parameters

Back to e-Business Applet