Applet: uCatalogInitialize

Description:
The uCatalogInitialize applet provides the means by which you can configure tax rates, shipping rates, handling fees, and many other general settings. This applet should be placed on one of the initial pages of your store so that the settings get applied as soon as possible. Ideal locations for this applet are your store's "Enter" page or if using a "frames" layout, in the small frame where the small shopping cart applet is located. An "image" parameter allows you to use any image to configure this applet's appearance - or you can just set WIDTH and HEIGHT of this parameter to 2 x 2 so that the applet is virtually invisible.

Example:

<-- This is just an animated .gif that gets hidden by a standard JavaScript "onLoad" function.
<-- This is the uCatalogInitialize applet. It appears after everything is loaded. (Note the reason why this applet takes a few seconds to load is because it is reading the order template file.)

<APPLET CODE="uCatalogInitialize.class" CODEBASE="../classes/" WIDTH=201 HEIGHT=61>
<PARAM NAME="image"                 VALUE="ucatalog_logo.gif">
<PARAM NAME="cart_font"             VALUE="Verdana,Arial,Helvetica">
<PARAM NAME="cart_font_color"       VALUE="#000000">
<PARAM NAME="cart_background_color" VALUE="#FFFFFF">
<PARAM NAME="cart_title_color"      VALUE="#D0CADD">
<PARAM NAME="currency_symbol"       VALUE="$">
<PARAM NAME="show_euro"             VALUE="NO">
<PARAM NAME="tax_rate_default"      VALUE="0.0%">
<PARAM NAME="tax_table"             VALUE="FL,FLORIDA">
<PARAM NAME="tax_shipping"          VALUE="NO">
<PARAM NAME="shipping_table"        VALUE="Standard Shipping,FLAT_FEE,$5.00;
                                          Overnight Shipping,FLAT_FEE,$25.00">
<PARAM NAME="handling_fee_default"  VALUE="$0.00">
<PARAM NAME="billing_first_name"    VALUE="First Name">
<PARAM NAME="billing_last_name"     VALUE="Last Name">
<PARAM NAME="billing_address"       VALUE="Address">
<PARAM NAME="billing_city"          VALUE="City">
<PARAM NAME="billing_zip_code"      VALUE="Zip Code">
<PARAM NAME="billing_country"       VALUE="Country">
<PARAM NAME="shipping_first_name"   VALUE="Shipping First Name">
<PARAM NAME="shipping_last_name"    VALUE="Shipping Last Name">
<PARAM NAME="shipping_address"      VALUE="Shipping Address">
<PARAM NAME="shipping_city"         VALUE="Shipping City">
<PARAM NAME="shipping_zip_code"     VALUE="Shipping Zip Code">
<PARAM NAME="shipping_country"      VALUE="Shipping Country">
<PARAM NAME="shipping_method"       VALUE="Shipping Method">
<PARAM NAME="payment_method"        VALUE="Payment Method">
<PARAM NAME="cc_name_on_card"       VALUE="Name On Credit Card">
<PARAM NAME="cc_number"             VALUE="Credit Card Number">
<PARAM NAME="cc_expiration"         VALUE="Credit Card Expiration">
</APPLET>


Parameters:

Applet Parameters
Name Description
codebase This parameter is actually part of the <APPLET> tag and therefore should be specified on the first line of the Applet (see example). It allows you to specify the location of this applet's class file. The recommended value is "../classes/". See codebase for more information.
image This parameter allows you to specify the image that the applet will appear as. Note that due to the security restrictions built into IE, when loading any image by an applet, the image must be located in the same directory as the applet's class file. So be sure that the image that you specify here is located in your "classes" directory. Note that for this applet, you do not have to specify any image at all here - but rather, you can make this applet virtually invisible by setting the WIDTH and HEIGHT to 2 x 2.
link If desired, this parameter allows you to make this applet a link to any other page. This is sometimes desireable if the applet is on a special "Enter Store" page - in which case, you can make this applet a link to a page inside your store. The format of this parameter is simply the name (and relative path) to the page that you want to link to. If you do not want this applet to be a link, simply leave this parameter blank or set it to "NONE".
target If this applet is also configured to be a link, then this parameter allows you to specify the "target" page for the link. The default value of this parameter is "".
order_template The name of the order template file. The default value for this parameter is "ucatalog_template.html". This file should be located in your "classes" directory. See the uCatalogTM User's Guide for more information about setting up the order template file.
javascript_template The name of the javascript source file. The default value for this parameter is "ucatalog_javascript.js". This file should be located in your "classes" directory. See the uCatalogTM User's Guide for more information about ucatalog_javascript file.
Company/Store Information Parameters
Name Description
store_name The name of your store. Not used at this time.
store_address The mailing address of your store. Not used at this time.
store_phone The phone number of your store. Not used at this time.
store_fax The fax number of your store. Not used at this time.
store_email The email address of your store. Not used at this time.
store_url The URL of your store. Not used at this time.
Shopping Cart Preferences/Parameters
Name Description
cart_font The font that will be used for the shopping cart that is displayed on your final order pages. (This is not to be confused with the font in the uCatalogCart applets - that font is controlled by the individual applets). For this parameter, you can specify any standard HTML fonts such as "Arial", "Helvetica", etc. You can also specify this parameter with default fonts such as "Verdana,Arial,Helvetica". The default value is "Verdana,Arial,Helvetica".
cart_font_color The font color of the text that will be used for the shopping cart that is displayed on your final order pages. (This is not to be confused with the font color in the uCatalogCart applets - that color is controlled by the individual applets). For this parameter, you can specify any standard HTML-formatted colors such as "#000000" for black or "#0000FF" for blue. The default value is "#000000".
cart_background_color The background color that will be used for the shopping cart that is displayed on your final order pages. (This is not to be confused with the background color in the uCatalogCart applets - that color is controlled by the individual applets). For this parameter, you can specify any standard HTML-formatted colors such as "#FFFFFF" for white (recommended). The default value is "#000000".
cart_title_color The color that will be used in the column titles of the shopping cart that is displayed on your final order pages. For this parameter, you can specify any standard HTML-formatted colors such as "#D0D0D0" for light gray or "#FFFFFF" for white. The default value is "#D0CADD" (a light violet - to match the default colors in the example order templates).
cart_show_id This parameter lets you specify whether to show the product IDs in the shopping cart that is displayed on your final order pages. Valid values are "YES" or "NO". The default value is "YES".
cart_show_name This parameter lets you specify whether to show the product Names in the shopping cart that is displayed on your final order pages. Valid values are "YES" or "NO". The default value is "YES".
cart_show_description This parameter lets you specify whether to show the product Descriptions in the shopping cart that is displayed on your final order pages. Valid values are "YES" or "NO". The default value is "YES".
cart_show_weight This parameter lets you specify whether to show the product Weights in the shopping cart that is displayed on your final order pages. Valid values are "YES" or "NO". The default value is "YES".
cart_show_quantity This parameter lets you specify whether to show the product Quantities in the shopping cart that is displayed on your final order pages. Valid values are "YES" or "NO". The default value is "YES".
cart_show_price This parameter lets you specify whether to show the product Prices in the shopping cart that is displayed on your final order pages. Valid values are "YES" or "NO". The default value is "YES".
cart_show_totals This parameter lets you specify whether to show the product Totals in the shopping cart that is displayed on your final order pages. Valid values are "YES" or "NO". The default value is "YES".
Currency Preference Parameters
Name Description
currency_symbol The currency symbol that will be used throughout your store. Valid values are "$", "£", "DM", etc. The default value depends on the language module that you are using - "$" for US, "£" for UK, etc.
show_euro This parameter allows you to specify whether to also display the subtotal in EURO dollars. Valid values are "YES" or "NO". The default value is "NO".
euro_symbol The currency symbol that will be used when displaying the EURO subtotal. The default value is "EURO".
euro_conversion_rate The current conversion rate that is used to convert from your base currency to the EURO dollar. The EURO total will be determined by the formula:

Euro Total = Total / Conversion Rate,

where the Conversion Rate is the current conversion rate from your currency to the EURO dollar. You can look up the current conversion rates at the Yahoo Currency Converter. Typical values for this parameter will be something like "0.6568" for conversion from "£" to EURO or "1.956" for conversion from "DM" to EURO. The default value is "1.0".
Tax Preference Parameters
Name Description
tax_rate_default The default tax rate. Valid values are "0.0%", "6.0%", etc. (Be sure to specify the % sign).

As an example, suppose you wanted to charge all customers a tax rate of 7.0%. To do this, just set this value to "7.0%".

Often, this tax_rate_default parameter will be used in correlation with one or more of the tax table parameters below. The default value is "0.0%".
tax_table This parameter allows you to specify specific states and/or countries that don't go by the default tax rate. Typically this parameter would be used by in correlation with a tax selection menu on your order form.

As an example, suppose you want to charge a default tax rate of "0.0%" for everyone except for customers from Florida. To do this, you would set the "tax_rate_default" (see above) to "0.0%" and you would set this "tax_table" parameter to "FL,FLORIDA". On you order form, you could put a note that "Customers from Florida must select the tax rate for their area." This "tax_table" parameter would then make sure that customers from "FL" or "FLORIDA" select a tax rate other than the "tax_rate_default".

The default value for this parameter is "NONE".
tax_state_table This parameter allows you to automatically assign a specific tax rate based on what state the customer lives. The format of this parameter is STATE=TAXRATE, where STATE is the state and TAXRATE is the tax rate that will be assigned to customers from that state. You can specify as many STATE=TAXRATE combinations as you like, just be sure to separate each combination with a comma.

As an example, suppose you wanted to automatically charge customers in Florida a tax rate of 6.0% and customers in Texas a tax rate of 7.0%. You would then set this parameter to "FL=6.0%,FLORIDA=6.0%,TX=7.0%,TEXAS=7.0%". (All other customers will be charged the tax_rate_default)

The default value for this parameter is "NONE".
tax_country_table This parameter allows you to automatically assign a specific tax rate based on what country the customer lives. The format of this parameter is COUNTRY=TAXRATE, where COUNTRY is the country and TAXRATE is the tax rate that will be assigned to customers from that country. You can specify as many COUNTRY=TAXRATE combinations as you like, just be sure to separate each combination with a comma.

As an example, suppose you wanted to automatically charge customers in France a tax rate of 16.0% and customers in Germany a tax rate of 18.0%. You would then set this parameter to "FRANCE=16.0%,GERMANY=18.0%". (All other customers will be charged the tax_rate_default)

The default value for this parameter is "NONE".
tax_shipping This parameter allows you to specify whether to tax the shipping charge. Valid values are "YES" or "NO". The default value is "NO".
Shipping Preference Parameters
Name Description
shipping_table See the uCatalogTM User's Guide for a complete description of configuring the shipping options.
Handling Fee Preference Parameters
Name Description
handling_fee_default This parameter allows you to specify the default handling fee that all customers will be charged. The format of this parameter is simply the fee that you want to charge such as "$5.00" or "$2.00".

As an example, suppose you wanted to charge all customers a handling fee of $1.00. To do this, just set this parameter to "$1.00".

Often this parameter will be used in correlation with one of the handling table parameters below. The default value for this parameter is "$0.00".
handling_state_table This parameter allows you to specify specific handling fees for customers from specific states. The format of this parameter is STATE=HANDLINGFEE, where STATE is the state and HANDLINGFEE is the handling fee that will be charged to customers from that state. You can specify as many STATE=HANDLINGFEE combinations as you like, just be sure to separate each combination with a comma.

As an example, suppose you wanted to charge customers in California a handling fee of $2.00 and customers in New York a handling fee of $3.00. You would then set this parameter to "CA=$2.00,CALIFORNIA=$2.00,NY=$3.00,NEW YORK=$3.00". (All other customers will be charged the handling_fee_default)

The default value for this parameter is "NONE".
handling_country_table This parameter allows you to specify specific handling fees for customers from specific countries. The format of this parameter is COUNTRY=HANDLINGFEE, where COUNTRY is the country and HANDLINGFEE is the handling fee that will be charged to customers from that country. You can specify as many COUNTRY=HANDLINGFEE combinations as you like, just be sure to separate each combination with a comma.

As an example, suppose you wanted to charge customers in Canada a handling fee of $2.00 and customers in England a handling fee of $3.00. You would then set this parameter to "CANADA=$2.00,ENGLAND=$3.00". (All other customers will be charged the handling_fee_default)

The default value for this parameter is "NONE".
Required Order Form Fields
Name Description
The fields in this sections provide the means by which you make certain fields on your order forms "required". Fields marked as "required" will be checked to make sure the customer enters values in the fields when filling out the order form. To make a field required, simply specify the label for the field. If you do not want the field to be required, then set the field to "" or don't specify the parameter at all. See the uCatalogTM User's Guide for more information about setting up order forms and configuring required fields.
billing_first_name To make this field required, simply specify a the label for this field such as "First Name". Otherwise, leave this parameter blank.
billing_last_name To make this field required, simply specify a the label for this field such as "Last Name". Otherwise, leave this parameter blank.
billing_company To make this field required, simply specify a the label for this field such as "Company". Otherwise, leave this parameter blank.
billing_customer_id To make this field required, simply specify a the label for this field such as "Customer ID". Otherwise, leave this parameter blank.
billing_street1 To make this field required, simply specify a the label for this field such as "Address". Otherwise, leave this parameter blank.
billing_street2 To make this field required, simply specify a the label for this field. Otherwise, leave this parameter blank.
billing_city To make this field required, simply specify a the label for this field such as "City". Otherwise, leave this parameter blank.
billing_state To make this field required, simply specify a the label for this field such as "State". Otherwise, leave this parameter blank.
billing_zip_code To make this field required, simply specify a the label for this field such as "Zip Code". Otherwise, leave this parameter blank.
billing_country To make this field required, simply specify a the label for this field such as "Country". Otherwise, leave this parameter blank.
billing_phone To make this field required, simply specify a the label for this field such as "Phone". Otherwise, leave this parameter blank.
billing_fax To make this field required, simply specify a the label for this field such as "Fax". Otherwise, leave this parameter blank.
billing_email To make this field required, simply specify a the label for this field such as "Email Address". Otherwise, leave this parameter blank.
billing_url To make this field required, simply specify a the label for this field such as "Website URL". Otherwise, leave this parameter blank.
billing_extra1 To make this field required, simply specify a the label for this field such as "My Custom Field". Otherwise, leave this parameter blank.
billing_extra2 To make this field required, simply specify a the label for this field such as "My Custom Field". Otherwise, leave this parameter blank.
billing_extra3 To make this field required, simply specify a the label for this field such as "My Custom Field". Otherwise, leave this parameter blank.
billing_extra4 To make this field required, simply specify a the label for this field such as "My Custom Field". Otherwise, leave this parameter blank.
billing_extra5 To make this field required, simply specify a the label for this field such as "My Custom Field". Otherwise, leave this parameter blank.
shipping_first_name To make this field required, simply specify a the label for this field such as "First Name". Otherwise, leave this parameter blank.
shipping_last_name To make this field required, simply specify a the label for this field such as "Last Name". Otherwise, leave this parameter blank.
shipping_company To make this field required, simply specify a the label for this field such as "Company". Otherwise, leave this parameter blank.
shipping_customer_id To make this field required, simply specify a the label for this field such as "Customer ID". Otherwise, leave this parameter blank.
shipping_street1 To make this field required, simply specify a the label for this field such as "Address". Otherwise, leave this parameter blank.
shipping_street2 To make this field required, simply specify a the label for this field. Otherwise, leave this parameter blank.
shipping_city To make this field required, simply specify a the label for this field such as "City". Otherwise, leave this parameter blank.
shipping_state To make this field required, simply specify a the label for this field such as "State". Otherwise, leave this parameter blank.
shipping_zip_code To make this field required, simply specify a the label for this field such as "Zip Code". Otherwise, leave this parameter blank.
shipping_country To make this field required, simply specify a the label for this field such as "Country". Otherwise, leave this parameter blank.
shipping_phone To make this field required, simply specify a the label for this field such as "Phone". Otherwise, leave this parameter blank.
shipping_fax To make this field required, simply specify a the label for this field such as "Fax". Otherwise, leave this parameter blank.
shipping_email To make this field required, simply specify a the label for this field such as "Email Address". Otherwise, leave this parameter blank.
shipping_url To make this field required, simply specify a the label for this field such as "Website URL". Otherwise, leave this parameter blank.
shipping_extra1 To make this field required, simply specify a the label for this field such as "My Custom Field". Otherwise, leave this parameter blank.
shipping_extra2 To make this field required, simply specify a the label for this field such as "My Custom Field". Otherwise, leave this parameter blank.
shipping_extra3 To make this field required, simply specify a the label for this field such as "My Custom Field". Otherwise, leave this parameter blank.
shipping_extra4 To make this field required, simply specify a the label for this field such as "My Custom Field". Otherwise, leave this parameter blank.
shipping_extra5 To make this field required, simply specify a the label for this field such as "My Custom Field". Otherwise, leave this parameter blank.
billing_tax_rate To make this field required, simply specify a the label for this field such as "Tax Rate". Otherwise, leave this parameter blank.
billing_comments To make this field required, simply specify a the label for this field such as "Comments". Otherwise, leave this parameter blank.
shipping_method To make this field required, simply specify a the label for this field such as "Shipping Method". Otherwise, leave this parameter blank.
payment_method To make this field required, simply specify a the label for this field such as "Payment Method". Otherwise, leave this parameter blank.
cc_name_on_card To make this field required, simply specify a the label for this field such as "Name On Credit Card". Otherwise, leave this parameter blank.
cc_number To make this field required, simply specify a the label for this field such as "Credit Card Number". Otherwise, leave this parameter blank.
cc_expiration To make this field required, simply specify a the label for this field such as "Credit Card Expiration Date". Otherwise, leave this parameter blank.
cc_issue To make this field required, simply specify a the label for this field such as "Credit Card Issue Number". Otherwise, leave this parameter blank.
echeck_bank_name To make this field required, simply specify a the label for this field such as "Bank Name". Otherwise, leave this parameter blank.
echeck_bank_address To make this field required, simply specify a the label for this field such as "Bank Address". Otherwise, leave this parameter blank.
echeck_name_on_check To make this field required, simply specify a the label for this field such as "Name On Check". Otherwise, leave this parameter blank.
echeck_check_number To make this field required, simply specify a the label for this field such as "Check Number". Otherwise, leave this parameter blank.
echeck_account_number To make this field required, simply specify a the label for this field such as "Account Number". Otherwise, leave this parameter blank.
echeck_routing_number To make this field required, simply specify a the label for this field such as "Routing Number". Otherwise, leave this parameter blank.
echeck_transit_code To make this field required, simply specify a the label for this field such as "Transit Code". Otherwise, leave this parameter blank.