New Parameters for 2.0 and beyond

Chapter 3: New Parameters

The following list describes the parameters that have been added to NetStores in v2.0 and any parameters that have changed functionality. You can set these parameters in your params.sh files.

ACCTOP

Set this parameter to the HTML code you want used at the top of the page that lets customers open a new account. (/dwos-bin/gen-acct.pl?store-abbrev) If you don't define ACCTOP, NetStores provides a standard introduction that includes your CNAME and LOGO. For example, you might use:

    ACCTOP="<HTML><HEAD>\
    <TITLE>$CNAME Account Setup</TITLE></HEAD>\
    $BBGD<center><IMG SRC=/$nccust/images/$LOGO alt=$CNAME>\
    </center><p>\
    <H2 ALIGN=center>New Account Setup</H2><hr>\
    <h3>Welcome!  Please fill in the following information\
    <EM>completely</EM>.</h3>\
    <P>Leave the <em>Account #</em> field blank if you want\
    us to assign an account number. If you want to choose an\
    account number that is easy for you to remember, type it here.\
    If the number you enter is available we'll let you have it."

ACCOUNT_LOGIN_SETUP

This parameter is used to specify which parts of the account screen should be displayed when the shopper is logging into a store. This allows the merchant to prevent the creation of new shopper accounts. (Currently, this parameter should be used with the LEVEL parameter to insure a true lockdown.)

This parameter is used with this link (/dwos-bin/gen-acct.pl?store-abbrev&function=acct_display) to show only those parts of the account page requested by the merchant. The parameter has two parts, one section says what to normally display, and the other says what to display in case there is a login failure. A section has a list of flags, telling what parts of the account page to display in that situation. The flags are: "I" to display the account login part, "L" to display the account lookup part, and "C" to display the account creation part. The sections are labeled "N" for the normal section, and "F" for the failure section. The label for a section is separated from the that section's flags with a "=", and the sections are separated from each other with a "!".

Example:

ACCOUNT_LOGIN_SETUP="N=I!F=ILC"

This means that normally only the account login part is displayed, and that the account login, account lookup, and account creation parts are displayed if there was an account login failure.

AUTOSECURE

This parameter has two options -- "1" and "2". Option "1" enables an HTTP refresh page that switches users to HTTPS before they are asked to enter their credit card information. Option "2" enables JavaScript that does the same, except more smoothly. If AUTOSECURE is set to "12", then Option "2" works for browsers that support JavaScript and Option "1" works for other browsers.

AVGWGT

If you want to charge for shipping based on the average weight of your products, set this parameter to the average weight of the items you sell in pounds. (Express fractions of a pound as a decimal value, not in ounces.) This average is used to calcula te shipping costs for UPS shipments. For example:

    AVGWGT=.5

If your items have weights that vary a lot, instead of defining the AVGWGT parameter, you can use the WGHTFLD parameter to identify a field in the itmfil.asc file that contains the weights of individual items. If AVGWGT is defined, t he WGHTFLD parameter is ignored.

CCINFO_ENCRYPT

If your account is configured to store credit card number information (SAVE_CCINFO="YES"), set this parameter to "YES" to store it in encrypted format using 3DES encryption.

Possible values are:

NO
YES

CCINFO_STAR

If your account is configured to store credit card number information (SAVE_CCINFO="YES"), setting this parameter to "YES" will store all but the first 6 and last 4 digits of the card number as 'X'. E.g.: 432187XXXXXX1234.

Possible values are:

NO
YES

CLRBUTN

Set this parameter to the text you want shown on the button in the Shopping Basket page that clears the quantities for the order. (The left button in the set of "Order Options" buttons.) For example:

    CLRBUTN="Clear"

CMNTOFF

If you set this parameter to anything other than zero (0) or blank (""), the Comment field is not included in the Order Total page. If you set this parameter, the CMNTERR, CMNTLIT, and CMNTREQ parameters are ignored. For example:

    CMNTOFF=1

COMBUTN

Set this parameter to the text you want shown on the button in the Shopping Basket page that takes you to the page where you can complete the order. (The right button in the set of "Order Options" buttons.) For example:

    COMBUTN="Complete"

CONBUTN

Set this parameter to the text you want shown on the buttons in the Results page and in the Shopping Basket page that let you continue searching for more items using the current search settings.

In the Shopping Basket page, only the text you provide for this parameter will be shown (for example, "Continue"). In the Results page, the word "Search" will be added after the text you provide (for example, "Continue Search"). For example:

    CONBUTN="Continue"

CUSFIL_DL_HEADERS

This parameter is used to give custom headers to the downloading of the customer file. It is usually used to give custom headers to the customer record's two 'unused' fields when they have been used to gather 'extra' information from the customer.

Format of Parameter: Headers for all of the fields in the customer record separated by pipes.

CUSFIL_DL_SHOW

This parameter is used to show the fields available for the downloading of the customer file. It is usually used to show the customer record's two 'unused' fields when they have been used to gather 'extra' information from the customer so that the information in the fields can be downloaded.

Format of Parameter: Either a '1' or '0' ('1', show, '0', don't show) for each field separated by commas. The default is not to show the two 'unused' fields or the password field.

Example: CUSFIL_DL_SHOW="1,1,1,1,0,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"

CVV2_REQUIRED

Set this parameter to 1 to have the cart ask for the CVV2/CVC2/CID code from the shopper's credit card.

DISCOUNTFIELD

This parameter is the field number of a field in itmfil.asc that describes quantity discounts for a product. The field in itmfil.asc is a series of quantity and price pairs separated by exclaimation point characters. In the example below, the hat would cost $5.00 each for any quantity from 1 to 3, from 4 to 5 it would cost $4.50, from 6 to 7 it would cost $4.00, and from 8 on they would cost $3.50 each.

Example:
in params.sh: DISCOUNTFIELD=5
in itmfil.asc: HAT001|5.00|A hat|This fine hat fits all heads.|4=4.50!6=4.00!8=3.50

DISTAB

Set this parameter to a non empty value (such as "1") to activate the discount codes in the distab file.

Entries in the distab file are of the following format.

 Name!!unit,type<(range=val),(range=val)...>|unit,type<(range=val),...>
   unit = [p,q,w]
   type = [v,x]
   range -> min:max
   val -> value

Essentially, entries in the distab file have two parts. First is the 'Name', which is the actual discount code that the shopper will enter, and which identifies this particular discount code table. Next (after the '!!') is a list of simple discount tables separated by pipes '|'. Each list has a "unit", and "type" associated with it. The "unit" specifies whether the "mini-table" is by price (p), quantity (q), or weight (w). The "type" specifies whether the mini-table's values are flat values (v) or rates / multiplication values (x).

The mini-table itself is composed of a comma separated list of ranges and values of the form "min:max=val". If the minimum or maximum bounds are not set then that range is considered to be "open" on that end (so ":10=X" would capture anything less than 10, and "20:=X" would capture anything more than 20). A value is considered to be inside the range if it is greater than the minimum and less than or equal to the maximum. You can use as many "mini-tables" as you want to create complicated formulas. For example, the following entry would for "Rocket Express" would give a flat $5 discount, plus a $10 discount for orders over 120 pounds, plus a discount for $0.75 per pound, plus a discount for 1.3% of the value of the order for orders up to $150, 2.2% for orders up to $1,000, and 3% for orders over 1000.

Rocket Express!!w,v<:=0.75>|p,v<:=5>|w,v<120:=10>|p,x<:150=0.013,150:1000=0.022,1000:=0.03>

Here is a simpler example:

The discount code is MAY
   The breakdown is as follows:
   $15 off on purchases of $60.00 or more
   $10 off on purchases of $45.00 - 59.99
   $5 off on purchases of $30.00 - 44.99

MAY!!p,v<60.00:=15,45.00:59.99=10,30.00:44.99=5>

Notes:
A discount code in the distab file must not have spaces in it.
A discount by percentage must be multiplied out in the "mini-table". Example: A 5% discount shows up in the table as '0.05'. (See the "Rocket Express" example above.)

DSCFLDS

Set this parameter to the field numbers in itmfil.asc that contain descriptions for each item. These fields will be included in the Results page and the Shopping Basket page. You can specify a single field or multiple fields. If you specif y multiple fields, separate the field numbers with the pipe ("|") character.

If you set the DSCFLDS parameter, the DSC1FLD, and DSC2FLD parameters are ignored.

    DSCFLDS="1|6|7"

DSCLENS

Set this parameter to the number of letters you want to allow for the descriptions in the invoice. Specify lengths for fields in the same order you did in the DSCFLDS parameter. If you specify multiple field lengths, separate them with the pipe ("|") c haracter.

If you set the DSCLENS parameter, the DSC1LEN, and DSC2LEN parameters are ignored. If you set a field length to zero (0), that field is included in the Shopping Basket page but not in the invoice. For example:

    DSCLENS="0|30|15"

DYNAMIC_OBJECTS

This will allow all product pages to be made using a dynamic html template. If this variable has a value, the object field in itmfil.asc will be ignored, and items in the search table will be linked to a perl script which reads the file "dynamic.html": from the merchant's directory and replaces certain "magic" strings in the file with fields from itmfil.asc. Here is an example of a dynamic.html file:

<html><head></head><body>

   
<img src="dbfld3"> Here is our product,, the amazing dbfld2!!

   
</body>

Assuming field 3 of itmfil.asc is the URL of an image and field 2 is the name of a product, the above example will display the image, the text, and the product's name.

EMAIL_FROM_CUS_IN_CR

This parameter allows the sending of any field(s) from the customer record in a catalog request email to the merchant. It is usually used with the two 'unused' fields in the customer record to send any 'extra' customer information to the merchant. The 'extra' customer information is usually gathered by placing a custom form on the 'new account' page.

Format of Parameter:

<section header>!<customer field number>=<label for field>,(information for next field),...

<section header> is the label that will be given to this section of the email.

<customer field number> specifies which field will be sent from the customer record.

<label for field> what label this field will given in this section.

EMAIL_FROM_CUS_IN_OE

This parameter allows the sending of any field(s) from the customer record in the order emails to the customer and merchant. It is usually used with the two 'unused' fields in the customer record to send any 'extra' customer information to the merchant. The 'extra' customer information is usually gathered by placing a custom form on the 'new account' page.

Format of Parameter:

<section header>!<customer field number>=<label for field>,(information for next field),...

<section header> is the label that will be given to this section of the email.

<customer field number> specifies which field will be sent from the customer record.

<label for field> what label this field will given in this section.

FINALMSG

The value of this variable is displayed at the final checkout message pages. If it has no value, then the default "Thanks again for visiting our store on the internet ... Come back soon." is displayed.

FOOTER

The value of this variable is displayed at the bottom of all cart generated pages. If it has no value, then the default copyright notice is displayed.

FORM_MAIL_RECIPIENT

This parameter is used with the shopping cart's script for sending the contents of a HTML form to a email address (/dwos-bin/sendform.pl). This parameter is used in conjunction with the "FORM_MAIL_TARGET" parameter and both must be present before the script will work (to prevent spamming). If there is a problem, either the merchant's or Netstore's home page will be displayed.

This is the email address that the form's contents should be sent to, and can be any vaild email address form ("info@example.com", "Support <support@example.com>").

FORM_MAIL_TARGET

This parameter is used with the shopping cart's script for sending the contents of a HTML form to a email address (/dwos-bin/sendform.pl). This parameter is used in conjunction with the "FORM_MAIL_RECIPIENT" parameter and both must be present before the script will work (to prevent spamming). If there is a problem, either the merchant's or Netstore's home page will be displayed.

This is the location (URL) of the page displayed after the shopper clicks on the form's "Submit" button, and is usually some type of a "thank-you" page.

FREE_SHIP_MIN_AMT

This parameter is for setting the “free shipping minimum amount” for the shipping methods. The format of the parameter is: "ship_method=min_amount!valid_country=valid_place,valid_place,...!valid_country=valid_place,..|ship_method=..."

Broken down, the format goes like this:
“<name of the shipping method>” [The name _must_ match the name given to the method in the ‘shpvia’ file.]
“=”
“<minimum amount for this shipping method>” [There is only one minimum amount per shipping method, the parameter currently does not the ability to have different amounts in different areas.]
“!” [Separator between the different parts of a free ship setting for a particular shipping method.]
“<ISO two letter code for the first country for which this free ship setting is valid>”
“=”
“<list of places in the country that this free ship setting is valid, separated by commas>” [A place is an regular expression. A regular expression is used because not all countries have the same address format. For example, in Ireland they don’t have postal abbreviations or postal codes (in fact, it is possible to have an address in Ireland without a single digit in it.)]
“!”
“<information for the next valid country>”
“!”
“<repeat valid countries as necessary>”
“|”
“<information for the next shipping method>”
“|”
“<repeat shipping methods as necessary>”

Since there are different address formats for different countries, different parts of the address are used for specific countries to determine what is a valid location for free shipping. For example, if the order country is US, then the state (the two letter postal abbreviation) is used to determined valid free shipping locations (which allows a merchant to offer free shipping in only the lower 48 states). However, another country may not even have states / provinces, so the city and/or postal code should be used instead. If nothing is specified for the order country, the parameter will use the "state" code.

FROMCUST

When not set to "", it will use the email address of the customer as the "from" address for email invoices sent to the merchant. Default is NetStores. (1-19-00)

FROMZIP

Set this parameter to the merchant's zip code. This is used to calculate UPS shipping costs based on the type of shipping the customer selects, the customer's zip code, and the shipping weight. For example:

    FROMZIP=07023

FROMCOUNTRY

This parameter is used to specify in which country the merchant is located. The parameter should be set to either the two letter ISO country code for the merchant's country or the full name of the country.

*FRMT

ALLFRMT
ITMFRMT
DSCFRMT
PRCFRMT

Set these parameters to the table formatting code for either the Item Code, Description(s), or Price columns in the shopping cart results table. For example, the following entries will produce center aligned Item Code cells with a green background color, right aligned Description(s) cells, and right aligned Sub-Total cells with white backgrounds.

    ITMFRMT="BGCOLOR=#00FF00 ALIGN=\"CENTER\""
    DSCFRMT="ALIGN=\"RIGHT\""
    PRCFRMT="BGCOLOR=#FFFFFF ALIGN=\"RIGHT\""

However, the "ALLFRMT" parameter overrides the above parameters to create simply 
red background cells in the Item Code, Description(s), and Sub-Total price areas.

    ALLFRMT="BGCOLOR=#FF0000"

*FONT

ITMFONT
DSCFONT
PRCFONT

Set these parameters to the HTML code to be used before the Item Code, Description, or Price entries in the results table. For example, the following parameters / values will produce a table with Item Code's using the Arial font, blue color Description text, and 10pt, Arial font, italic Prices.

    ITMFONT="<font face=\"Arial\">"
    DSCFONT="<font color=\"blue\">"
    PRCFONT="<span style=\"font-family: Arial; font-size: 10pt; font-style: italic;\">"

Note: if you use a <font> or <span> tag, a corresponding </font> or </span> tag will be added after the cell contents for proper balance.

(The custship file is no longer used to calculate shipping and handling charges.)

HCBYD

Define this parameter if you want to add a handling charge that is calculated based on the order subtotal amount. If you define HCBYI, any definition for HCBYD is ignored.

Both the order value and the handling charge should be in dollars. The format should be:

    value=charge|value=charge|...

The values should be listed in order by increasing order values. For example, the following definition adds a handling charge of $2.50 for orders up to $49.99. It adds a handling charge of $4.00 for orders between $50.00 and $99.99. It adds no ha ndling charge for orders of $100 or more.

    HCBYD="49.99=2.5|99.99=4|100=0"

No handling charge is added if you do not define either HCBYD or HCBYI. (The custship file is no longer used to calculate shipping and handling charges.)

HCBYI

Define this parameter if you want to add a handling charge that is calculated based on the order quantity. If you define HCBYI, any definition for HCBYD is ignored.

The handling charge should be in dollars. The format should be:

    quantity=charge|quantity=charge|...

The values should be listed in order by increasing quantity. For example, the following definition adds a handling charge of $3.50 for quantities up to 3. It adds a handling charge of $5.00 for quantities between 4 and 10. It adds a handling char ge of $5.50 for quantities of 11 or more.

    HCBYI="3=3.5|10=5|11=5.5"

No handling charge is added if you do not define either HCBYD or HCBYI. (The custship file is no longer used to calculate shipping and handling charges.)

HCLIT

Set this parameter to the text you want to use in the Shopping Basket page next to the handling charge computed using the HCBYD or HCBYI parameter. For example:

    HCLIT="Handling Charge"

HLPMSG

Set this parameter to the HTML you want to use to provide a link to a help page in the Search page and in the Results page. For example:

    HLPMSG="See our <A HREF=/mystore/help.html>help</A> on \ searching and ordering."

ICCV_MESSAGE

Set this parameter to the message you want to have in the "Secure Check Out Center" page just above the "CheckOut" button. For example:

ICCV_MESSAGE="Please wait a minute after pressing the \"CheckOut\" button."

IMGFLD

Set this parameter to the field number in itmfil.asc that contains the file location of a thumbnail image for this item. You'll probably want to put the files in the /store-abbrev/images subdirectory of your page root directory. The thumbnail images will be shown in the first column of the Results page. Make sure the images are small enough to allow customers to see the whole table.

For example, if you use this definition, the 10th field of the itmfil.asc file should contain values like /mystore/images/itm23.gif.

    IMGFLD=10

INOFLDS

Set this parameter to the field number or numbers in itmfil.asc that make up the unique key for each record. You can include as many fields as you want. Separate field numbers with the pipe ("|") character. The contents of the fields you l ist will be printed in the order form and the order acceptance form.

If you set the INOFLDS parameter, the INOFLD, INO2FLD, and INO3FLD parameters are ignored. For example:

    INOFLDS="1|7"

INOLENS

Set this parameter to the number of letters you want to allow for the INOFLDS in the invoice. Specify lengths for fields in the same order you did in the INOFLDS parameter. If you specify multiple field lengths, separate them with the pipe ("|") charac ter.

If you set the INOLENS parameter, the INO1LEN, and INO2LEN parameters are ignored. If you set a field length to zero (0), that field is included in the Shopping Basket page but not in the invoice. For example:

    INOLENS="10|8"

IPRCLEN

Set this parameter to the number of letters you want to allow for the IPRCFLD in the invoice. If you do not define this parameter, the item price can contain up to 7 digits. For example:

    IPRCLEN=8

MAIL_CCINFO

Determines whether CC Credit Card Number information is mailed to the merchant. If not specified, behavior is determined by CARDPROC setting (MALL, yes, CCASH, no, all others, yes). This variable will override any setting of CARDPROC. Perl module affected is proc_ordc.pl.

Possible values are:
NO
YES

MAXSRCH

Set MAXSRCH to 1 if you want the search results to list items that match all the customer's search words even if the words are not in order.

For example, if a customer searches for product names that include "dog training" and MAXSRCH is set a shown below, the search results would include an item called "Training Your Dog". If MAXSRCH is not set, the search results won't include "Training Y our Dog" because the words are in the wrong order.

    MAXSRCH=1

MODBUTN

Set this parameter to the text you want shown on the button in the Shopping Basket page that modifies the order total based on any changes you have made to the quantities in your order. (The middle button in the set of "Order Options" buttons.) For exa mple:

    MODBUTN="Update Total"

NCADMIN

Set this parameter to the IP address of the NetStores administrator. If you access NetStores from this IP address, you can run ./dwos-bin/gen-rpt.pl (which provides a report of the search criteria customers are using) and /dwos-bin/gen-mrc h.pl (which lets you fill out a form to set up a new store). This keeps unauthorized users from accessing these programs. If you set this parameter to "*", anyone can access these programs. For example:

    NCADMIN="204.192.123.*"

NEWBUTN

Set this parameter to the text you want shown on the button in the Shopping Basket page that takes you back to the Search page so that you can search for more items to add to your order. (The left button in the set of "Search Options" buttons.) For exa mple:

    NEWBUTN="New"

NEWGUI

If you set this parameter to 1 or Y, NetStores uses the new "shopping basket" user interface, which includes the following behavior:

Uses the new set of five buttons in the Shopping Basket page (New Search, Continue Search, Clear Order, Modify Order, and Complete Order).
Includes the Shipping Method field if there is a shpvia file in the /dwos/data/store-abbrevdirectory or in the /dwos/malldata directory.
Allows customers to add items to their shopping baskets without providing an account number and password. They mu st enter an account number a password to place the order.

For example:

    NEWGUI=1

NOSEARCH

Set this parameter to remove the search interface from the shopping cart. For example:

NOSEARCH="1"

OPEN_ACCT_MSG

Set this parameter to the HTML code you want used for opening a new account. Default is "Click Here to Open a $CNAME Account"

ORDRMSG

Set this parameter to the HTML code you want used for the order message in the Order Total Message Default is:

 

If you complete this order we will ship your $ORDRMSG2 to the following address::

ORDRTOP

Set this parameter to the HTML code you want used at the top of the Shopping Basket page. For example:

    ORDRTOP="<HTML><HEAD>\
    <TITLE>$CNAME Shopping Basket</TITLE></HEAD>\
    $BBGD\
    <center><IMG SRC=/$nccust/images/$LOGO alt=$CNAME>\
    </center>"

PASSWORD_EXPIRES

This parameter specifies the expire date and time for your account password when the PASSWORD_REQUIRES_EXPIRATION parameter is set to "YES". When your account password expires you will be prompted to enter a new one. This parameter will be automatically updated after the new password is created.

Format: YYYY-MM-DD HH:MM:SS

E.g.: 2005-12-31 23:59:59

PASSWORD_REQUIRES_ENCRYPTION

When this parameter is set to "YES", your account password is stored encrypted in params.sh.

Possible values are:

NO
YES

PASSWORD_REQUIRES_EXPIRATION

When this parameter is set to "YES", your account password will expire every 90 days. If your password is expired when you login to the merchant administration area, you will be prompted to create a new password. The new expire date will be automatically stored in the PASSWORD_EXPIRES parameter.

Possible values are:

NO
YES

PASSWORD_REQUIRES_STRONG

When this parameter is set to "YES", any new password you create for your account is required to be at least 7 characters in length and contain at least one alpha and one numeric or special character.

Possible values are:

NO
YES

QCHECKOUT

Gives the customer the ablity to checkout without creating an account.

When "QCHECKOUT" is set to "0", quick checkout is not allowed.

When "QCHECKOUT" is set to "1", there is a "quick checkout without creating an account" option on the "customer error" page in the checkout. When they click the button, it performs the same functions as with the regular quick checkout.

When "QCHECKOUT" is set to "2", no account setup etc. screens are encountered, a customer account is created at the end of checkout (with a made up password and an automatically generated customer number).

QTYSIZE

If you set QTYSIZE to 0 (zero), the "Quantity" column cannot be modified. You can use this capability to create an inventory reporting system. The quantity on hand can be stored in the itmfil.asc file and displayed as one of the DSCFLDS. For example:

    QTYSIZE=0

REQFLD_NAMES

This parameter specifies which fields the customer is required to fill out when creating an new account. It's used with REQFLD_LIST, customer fields must be listed in the same order in both parameters.

Parameter Format: customer field names internal to the cart separated by pipes.

REQFLD_LIST

This parameter specifies which fields the customer is required to fill out when creating an new account. It's used with REQFLD_NAMES, customer fields must be listed in the same order in both parameters.

Parameter Format: label for the customer fields separated by pipes.

SAVE_CCINFO

This determines whether CC Credit Card Number information is saved to the order file (ordopn and ordfil). If not specified, behavior is determined by CARDPROC setting (MALL, yes, CCASH, no, all others, yes). Perl modules affected are fail_card.pl and proc_ordc.pl

Possible values are:

NO
YES

SCBYD

Note: This system has been superceded by the new multiple shipping table system, see SHPTAB.

Define this parameter if you want to add a shipping charge that is calculated based on the order subtotal amount. If you define SCBYI, any definition for SCBYD is ignored.

Both the order value and the shipping charge should be in dollars. The format should be:

    value=charge|value=charge|...

The values should be listed in order by increasing order values. For example, the following definition adds a shipping charge of $3.00 for orders up to $49.99. It adds a shipping charge of $5.00 for orders between $50.00 and $99.99. It adds a shi pping charge of $10.00 for orders of $100 or more.

    SCBYD="49.99=3|99.99=5|100=10"

If either your /dwos/data/store-abbrev directory or the /dwos/data/malldata directory contains a shpvia file, the FROMZIP parameter is defined, and either AVGWGT or WGHTFLD is defined, then NetStores att empts to use UPS' online "Quick Cost Calculator" which estimates UPS charges for shipments in the 48 contiguous United States. If this calculation is successful, the SCBYD and SCBYI parameters are ignored. However, you may still want to define these param eters for occasions when the UPS server is temporarily not available.

(The custship file is no longer used to calculate shipping and handling charges.)

SCBYD_FOREIGN

Define this parameter if you want a separate series of shipping charges for foreign orders. The format is the same as SCBYD.

SCBYI

Note: This system has been superceded by the new multiple shipping table system, see SHPTAB.

Define this parameter if you want to add a shipping charge that is calculated based on the order quantity. If you define SCBYI, any definition for SCBYD is ignored.

The shipping charge should be in dollars. The format should be:

    quantity=charge|quantity=charge|...

The values should be listed in order by increasing quantity. For example, the following definition adds a shipping charge of $3.50 for quantities up to 3. It adds a shipping charge of $5.00 for quantities between 4 and 10. It adds a shipping char ge of $10.00 for quantities of 11 or more.

    HCBYI="3=3.5|10=5|11=10"

(The custship file is no longer used to calculate shipping and handling charges.)

SCBYI_FOREIGN

Define this parameter if you want a separate series of shipping charges for foreign orders. The format is the same as SCBYI.

SCLIT

Set this parameter to the word or words you want to use to describe the customer's current set of items ordered. For example, you might want to call this the "Order", the "Basket", or the "Shopping Cart". This text will appear in the following places.

In the "Add/View" button on the Results page (unless you also define the SUBMSG parameter).
In the title and heading at the top of the Shopping Basket page (unless you also define the ORDRTOP parameter).<

For example:

    SCLIT="Shopping Cart"

SHPTAB

Set this parameter to a non empty value (such as "1") to activate the shipping information in the shptab file.

Entries in the shptab file are of the following format.

    Name!!unit,type<(range=val),(range=val)...>|unit,type<(range=val),...>

    unit = [p,q,w]
    type = [v,x]
    range -> min:max
    val -> value

Essentially, entries in the shptab file have two parts. First is the Name, which will show up in the shipping methods pull-down menu on the Order Total page, and which identifies this particular shipping rate table. Next (after the '!!') is a list of simple rate tables separated by pipes '|'. Each list has a "unit", and "type" associated with it. The "unit" specifies whether the "mini-table" is by price (p), quantity (q), or weight (w). The "type" specifies whether the mini-table's values are flat values (v) or rates / multiplication values (x).

The mini-table itself is composed of a comma separated list of ranges and values of the form "min:max=val". If the minimum or maximum bounds are not set then that range is considered to be "open" on that end (so ":10=X" would capture anything less than 10, and "20:=X" would capture anything more than 20). A value is considered to be inside the range if it is greater than the minimum and less than or equal to the maximum. You can use as many "mini-tables" as you want to create complicated formulas. For example, the following entry would for "Rocket Express" would charge a flat $5 handling fee, plus a $10 handling fee for orders over 120 pounds, plus $0.75 per pound, plus 1.3% of the value of the order for insurance for orders up to $150, 2.2% for orders up to $1,000, and 3% for orders over 1000.

    Rocket Express!!w,v<:=0.75>|p,v<:=5>|w,v<120:=10>|p,x<:150=0.013,150:1000=0.022,1000:=0.03>

Here is another example:

Standard Shipping- 1 piece-   4.95
   2 pieces- 5.95
   3 pieces-  7.95
   4 pieces +  - 9.95


UPS 3-DAY SELECT- 1 piece-  6.95
    2 pieces- 7.95
    3 pieces- 9.95
    4 pieces + - 11.95

International Shipping box,  will automatically charge $29.95 for 1 piece and $3.00 more for each
additional piece.

Standard Shipping!!q,v<:1=4.95,1:2=5.95,2:3=7.95,3:4=9.95,4:=9.95>
UPS 3 DAY SELECT!!q,v<:1=6.95,1:2=7.95,2:3=9.95,3:4=11.95,4:=11.95>
FOREIGN Shipping!!q,v<0:=26.95>|q,x<0:=3>

In addition, You can create a custom field in your item file:

	ie: ISHPFLD="7"

and an Item File that has:

	1219|1.95|Isobutane Fuel|2-ounce can of isobutane fuel|Isobutane Fuel|http://www.athenainternational.com/1219.html|X-Fuel Surcharge

with a shptab of:

	X-Fuel Surcharge!!q,v<:3=6,3:12=23,12:24=30,24:36=45,37:=65>
	Shipping!!p,v<:30=4.50,30:60=7.25,60:75=9.75,75:100=12.25,100:150=14.95,150:200=17.25,200:=20.00>

The X-Fuel Surcharge will then be added shipping charge for that item only.

SHPTOMSG

Set this parameter to the text you want to use in the Order Total page for shipping message.(12-13-99)

SHPYMSG

Set this parameter to the text you want to use in the Order Total page before the fields that allow the customer to select a shipping method and a payment method. The shipping method field appears only if the NEWGUI parameter is defined and you have created a file called /dwos/data/store-abbrev/shpvia or /dwos/malldata/shpvia. For example:

    SHPYMSG="Changes to shipping method may change order total."

SRCHS

This parameter determines which fields will be used in your Search page. Provide a list of field definitions separated by the pipe ("|") character. Put the field definitions in the order you want them to appear in your form. Each field definition shoul d have one of the following formats:

   field_name=field_number

or

   field_name=field_number,size,max

field_name should be the text you want to use before the field in your form. Don't use spaces, commas, quotation marks, <, >, =, &, or | in any field names.
field_number should be the field number for this field in your itmfil.asc file. Fields in itmfil.asc are numbered beginning with 1.
size is an optional field size, or width. If you do not specify th e size, NetStores creates a text field with a width of 18 or a pull-down list field if there is a .lst file for this field. However, if you use a size of 0 (zero), NetStores creates a hidden field instead. This field will be included i n the "Sort By" list and URLs that perform directed searches with drv-srch.pl can qualify this field. (See page 7 for details on drv-srch.pl.)
max is an optional maximum number of characters the field can contain. If you do not specify the maximum length, NetStores uses 60. If you use a size of 0 (zero) to create a hidden field, the max value is used as the value of the hidden field.

For example, this definition for SRCHS simply lists the fields. The fields will have a SIZE=18 and a MAXLENGTH=60.

    SRCHS="Item#=1|Artist=3|Title=4|Label=7|Category=2|Config=6"

However, if you use this definition:

    SRCHS="Item#=1,10,10|Title=2,25,50|Description=3,30,75|
    Platform=7,0,MAC"

The HTML for the fields in the Search page will be:

    <INPUT NAME=Item# SIZE=10 MAXLENGTH=10>
    <INPUT NAME=Title SIZE=25 MAXLENGTH=50>
    <INPUT NAME=Description SIZE=30 MAXLENGTH=75>
    <INPUT NAME=Platform TYPE=hidden VALUE="MAC">

SRCHTAG

If you define this parameter, the button in the Results page that lets you start a new search will contain this text. If you do not define this parameter, NetStores creates a text link to the Search page instead of a button. For example:

    SRCHTAG="New Search"

SRCHTOP

Set this parameter to the HTML code you want used at the top of the Search page and the pages that allow you to search for orders and quotes. For example:

    SRCHTOP="<TITLE>$CNAME Search Form</TITLE>\
    $BBGD<CENTER>\
    <FONT SIZE=6>S E A R C H</FONT></EM><BR>\
    <FONT SIZE=4>the shelves of:</FONT><BR>\
    <IMG SRC=/mystore/images/logo_small.gif></CENTER>"

TBLFRMT

Set this parameter to the options for the <table> tag for all tables in the shopping cart. For example:

    TBLFRMT="BORDER=1 BGCOLOR=#FFFF00"

TBLMSG

This is an HTML string that appears above the search results table.

STAR_CCNUMBER

Determines whether CC Credit Card number will have the last four digits replaced with asterisks ('****') in emails to the merchant. If not set, behavior is not affected by the code changes. Possible value: YES

TAXBASIS

"TAXBASIS", when set to a value of "2" the Tax basis includes the shipping and handling (not just the order total) (2-29-00)

UCHOOSE

Give this variable a value to allow customers to select their own account number when they set up a new account with your store. For instance, if the following line is added to params.sh,

UCHOOSE="YES"

then when a user sets up a new account with your store an input at the top of the customer information form will ask for the account number they want, in case they want an account number that they can easily remember.

UPS_RATE_CHART

This parameter tells how UPS gets the package from the merchant. The choices are:

'Regular Daily Pickup' -- [UPS makes a daily stop at the merchant.]
'On Call Air' -- [The merchant calls UPS to come and pickup a package being shipped Next or 2nd Day.]
'One Time Pickup' -- [The merchant calls UPS to come and pickup the package.]
'Letter Center' -- [The merchant drops off the package at a UPS 'Letter Center' kiosk.]
'Customer Counter' -- [The merchant takes the package to the local UPS office.]

Rates vary depending on package origin and destination address. If a store's params.sh file is being manually changed, be sure to quote these strings.

UPS_CONTAINER

This parameter specifies the container in which the merchant ships their packages via UPS. It's set to one of 00, 01, 03, 21, 22, or 23 according to this chart:

'00' -- 'Your [merchant's] Packaging'
'01' -- 'UPS Letter Envelope'
'03' -- 'UPS Tube'
'21' -- 'UPS Express Box'
'22' -- 'UPS Worldwide 25KG Box'
'23' -- 'UPS Worldwide 10KG Box'

UPS_*

The following set of parameters are used to indicate which UPS methods the merchant wishes to offer to their customers. If the method has been selected, the parameter is set to 'UPS', if the method hasn't been selected, then the parameter is set to ''.

Parameter Shipping Method

UPS_NEXTDAY
UPS Next Day

UPS_NEXT_EARLY
UPS Next Day Air Early AM

UPS_NEXT_SAVER
UPS Next Day Air Saver

UPS_2
UPS 2nd Day

UPS_2_AM
UPS 2nd Day Air AM

UPS_3
UPS 3rd Day

UPS_GROUND
UPS Ground

UPS_CANADA
UPS Canada Standard

UPS_WW_EXPD
UPS Worldwide Expedited

UPS_WW_EX
UPS Worldwide Express

UPS_WW_EXPR
UPS Worldwide Express Plus

UPS_*_DEL

This set of parameters allows the merchant to specify where each of the UPS methods will be delivered (residential or commercial addresses). Specify 'COM' for commerical addresses or 'RES' for residential addresses.

Parameter Shipping Method

UPS_1DA_DEL
UPS Next Day

UPS_1DM_DEL
UPS Next Day Air Early AM

UPS_1DP_DEL
UPS Next Day Air Saver

UPS_2DA_DEL
UPS 2nd Day

UPS_2DM_DEL
UPS 2nd Day Air AM

UPS_3DS_DEL
UPS 3rd Day

UPS_GND_DEL
UPS Ground

UPS_STD_DEL
UPS Canada Standard

UPS_XPD_DEL
UPS Worldwide Expedited

UPS_XPR_DEL
UPS Worldwide Express

UPS_XDM_DEL
UPS Worldwide Express Plus

USEAWK

Set this parameter to 1 if you want NetStores to use the "awk" utility to search the itmfil.asc file. If you do not set this parameter, NetStores will use the Perl language to search. Searching with "awk" is faster than searching with "Perl", so you will probably want to set this parameter on UNIX servers. However, the "awk" utility is not available on most non-UNIX systems. For example, on a UNIX server, you would use this definition:

    USEAWK=1

VERTICAL_EMAIL

Set this parameter to 1 if you want the e-mail invoices sent to the customer and merchant to be formatted vertically instead of horizontally. For instance, the following line in the e-mail:

4  1234  Amazing Widget Device  This widget dev $4.00 $16.00

would become:

4 1234
  Amazing Widget Device
  This widget device improves readability by 400%!!
  $4.00
  $16.00

WGHTFLD

Set this parameter to the field number in itmfil.asc that contains the weight of this item in pounds. (Express fractions of a pound as a decimal value, not in ounces.) The item's weight will be used to calculate the total weight of the shipment. For example,

    WGHTFLD=10.5

If all your items have approximately the same weight, you can define the AVGWGT parameter instead. If AVGWGT is defined, the WGHTFLD parameter is ignored.

NetStores v2.0 Update
NetStores v1.0

1: What's New in v2.0?
2: New URLs and Files

3: New Parameters
4: Credit Card Processing Variables

Copyright © 1999 NetStores

Parameter	Shipping Method
UPS_NEXTDAY	UPS Next Day
UPS_NEXT_EARLY	UPS Next Day Air Early AM
UPS_NEXT_SAVER	UPS Next Day Air Saver
UPS_2	UPS 2nd Day
UPS_2_AM	UPS 2nd Day Air AM
UPS_3	UPS 3rd Day
UPS_GROUND	UPS Ground
UPS_CANADA	UPS Canada Standard
UPS_WW_EXPD	UPS Worldwide Expedited
UPS_WW_EX	UPS Worldwide Express
UPS_WW_EXPR	UPS Worldwide Express Plus

Parameter	Shipping Method
UPS_1DA_DEL	UPS Next Day
UPS_1DM_DEL	UPS Next Day Air Early AM
UPS_1DP_DEL	UPS Next Day Air Saver
UPS_2DA_DEL	UPS 2nd Day
UPS_2DM_DEL	UPS 2nd Day Air AM
UPS_3DS_DEL	UPS 3rd Day
UPS_GND_DEL	UPS Ground
UPS_STD_DEL	UPS Canada Standard
UPS_XPD_DEL	UPS Worldwide Expedited
UPS_XPR_DEL	UPS Worldwide Express
UPS_XDM_DEL	UPS Worldwide Express Plus

NetStores v2.0 Update NetStores v1.0
1: What's New in v2.0? 2: New URLs and Files	3: New Parameters 4: Credit Card Processing Variables
Copyright © 1999 NetStores

ACCTOP

ACCOUNT_LOGIN_SETUP

AVGWGT

CCINFO_ENCRYPT

CCINFO_STAR

CLRBUTN

CMNTOFF

COMBUTN

CONBUTN

CUSFIL_DL_HEADERS

CUSFIL_DL_SHOW

CVV2_REQUIRED

DISCOUNTFIELD

DISTAB

DSCFLDS

DSCLENS

DYNAMIC_OBJECTS

EMAIL_FROM_CUS_IN_CR

EMAIL_FROM_CUS_IN_OE

FINALMSG

FOOTER

FORM_MAIL_RECIPIENT

FORM_MAIL_TARGET

FREE_SHIP_MIN_AMT

FROMCUST

FROMZIP

FROMCOUNTRY

*FRMT

ALLFRMT ITMFRMT DSCFRMT PRCFRMT

*FONT

ITMFONT DSCFONT PRCFONT

HCBYD

HCBYI

HCLIT

HLPMSG

ICCV_MESSAGE

IMGFLD

INOFLDS

INOLENS

IPRCLEN

MAIL_CCINFO

MAXSRCH

MODBUTN

NCADMIN

NEWBUTN

NEWGUI

NOSEARCH

OPEN_ACCT_MSG

ORDRMSG

ORDRTOP

PASSWORD_EXPIRES

PASSWORD_REQUIRES_ENCRYPTION

PASSWORD_REQUIRES_EXPIRATION

PASSWORD_REQUIRES_STRONG

QCHECKOUT

QTYSIZE

REQFLD_NAMES

REQFLD_LIST

SAVE_CCINFO

SCBYD

SCBYD_FOREIGN

SCBYI

SCBYI_FOREIGN

SCLIT

SHPTAB

SHPTOMSG

SHPYMSG

SRCHS

SRCHTAG

SRCHTOP

TBLFRMT

TBLMSG

STAR_CCNUMBER

TAXBASIS

UCHOOSE

UPS_*

UPS_NEXTDAY

UPS_NEXT_EARLY

UPS_NEXT_SAVER

UPS_2

ALLFRMT
ITMFRMT
DSCFRMT
PRCFRMT

ITMFONT
DSCFONT
PRCFONT