![[ Previous ]](prev.gif){kind=small}
![[ Contents ]](home.gif){kind=small}
![[ Chapter TOC ]](up.gif){kind=small}
![[ Index ]](help.gif){kind=small}
![[ Next ]](next.gif){kind=small}
Chapter 4: Technical
Reference
|
|
The following lists describes all the
parameters you can set in your params.sh files. Each
definition lists which interfaces use the parameter. Other interfaces
will ignore the parameter. Click on the procedure button (![[ Procedure ]](proc.gif){kind=small}
)
to see the part of this manual that tells how to set related
parameters.
(gen-srch interface)
Set this parameter to "bottom" if you want the fields for entering an account number and password to be at the bottom of the order form of the gen-srch interface. Otherwise, the fields will be at the top of the form (below the LOGO and the TOPMSG).
(gen-cat and gen-srch interfaces)
Set this parameter to the text you want to use for the choice in
the pay options field that adds this item to the order and allows you
to look for more items. For example, "Accept and Add
More".
(gen-cat interface)
Set this parameter to the text you want to use in the gen-cat interface instead of "Add to Shopping Cart" on the button that adds an item to the order. For example: "Add to Order".
(mall-level parameter)
Provide the IP address of the NetStores administrator. Browsers
accessing NetStores from this IP address can run
./dwos-bin/dwos-cat, which lets you examine files in
the /dwos directory tree. This keeps unauthorized users
from accessing customer and order data. (All users can use dwos-cat
to look at the files for sample stores.) For example,
"204.192.123.42".
(gen-acct form)
Set these parameters to any words you want to use in place of "Address-1", "Address-2", and "Address-3" in the new account form.
(gen-srch interface)
Set this parameter to "Y" if you want customers to be able to open new accounts. If LEVEL is "dist", the search form will contain a link to open an account. If LEVEL is anything other than "dist", the order form will contain a link to open a new account. By default, customer accounts are shared by all stores in the mall. See "Creating account and transaction files" for details on setting up store-level customer accounts.
(gen-srch interface)
Set this parameter to the text you want to use for the option in a category list that matches all records. The default text is "Any". For example, you might want to set this parameter to "All" as was done for the form in the previous picture. (gen-srch interface)
(all interfaces)
Provide the entire HTML <BODY> tag you want to use for the store pages. You can include the BACKGROUND, BGCOLOR, TEXT, LINK, and VLINK attributes. ake sure you put the entire parameter definition on a single line.
Put the background image in the
./dwos/data/store-abbrev/images
directory. This directory is referenced by an alias from the
./htdocs/store-abbrev/images
directory. So, the image location you type for this parameter should
have the format
"/store-abbrev/images/filename.gif".
For example, "<BODY
BACKGROUND=/abc/images/bkgd.gif>"
(all interfaces)
Set this parameter to "MALL" if you want to accept all credit card orders and get payment authorization offline. Set this parameter to "CCASH" if you want the CyberCash servers to provide credit card authorization.
(all interfaces)
If you want to use your own credit card authorization script, set
this parameter to the location of the CGI program you want to run
when a customer selects a payment option and submits the order. Set
this to the full URL minus "http://" needed to run the program. For
example, www.netstores.com/dwos-bin/post-form.
(all interfaces)
Set this parameter to the HTML code or text you want to use below
the words "Credit Card Information" in the form where customers
provide credit card information. For example, you might want to
include a message that says "<P>SSL encryption will be
used to protect your credit card numbers if you are using a browser
such as Netscape that supports SSL."
(gen-srch interface)
Set this parameter to the field names you want to use for the
checkboxes in the search form. Separate the fields names with the
pipe ("|") character. The number of field names must match the number
of digits in your checkbox field in itemfil.asc. For
example, "This Weeks New Arrivals|Upcoming New
Releases".
If a customer checks multiple boxes, only records that have 1's in all the checked fields will be listed. (It's an "and" search, not an "or" search.) An unchecked field matches records with either a 0 or 1.
(gen-srch interface)
If you have a checkbox field in itemfil.asc, set this
parameter to the field number of that field. For example, set this
parameter to 8 if your record format looks like this:
item_#|category|artist|title|price|media|label|checkfields|
(all interfaces)
Set this parameter to the HTML code you want NetStores to use if
CMNTREQ=1 and a customer does not provide a Comment. For
example, "<B>You must request a specific shipping method.
Click your BACK button and type one please.</B>"
(all interfaces)
Set this parameter to the HTML code you want NetStores to use
above the Comment field in the Order Acceptance form. For example,
"<h4>Type the shipping method you want used
here:</h4>"
(all interfaces)
Set this parameter to "1" (one) if you want NetStores to require the customer to type something in the Comment field in the Order Acceptance form.
(all interfaces)
Set this parameter to the name of this store. For example,
"Flowers `n' Fun".
(mall-level parameter)
Provide the email username (at DOMAINNAM) for the credit manager
for credit card processing. For example, "creditdept".
(all interfaces)
Set this parameter to "$CUSDIR/cusfil" if you want
NetStores to maintain a separate customer file for this store.
(all interfaces)
Set this parameter to the name of your store if you want customers to open store-level accounts. Set it to the name of the mall if you want customers to open mall-level accounts.
(gen-srch interface)
If you want to provide discounts for certain customers, use a
series of price fields (with the first field referenced by IPRCFLD).
Also, set CUSPRC parameter to the number of the field in the customer
file (cusfil) that contains a value indicating which
price field in itmfil.asc to use for this customer. If
the value in this field of cusfil is 0 (zero) or blank,
NetStores uses the first price field. If the value is 1 (one),
NetStores uses the second price field (and so on).
If you want to allow customers to open their own accounts with the
gen-acct form, you should set CUSPRC to 32. If you generate your own
cusfil from a database, you can put the CUSPRC value in
any field you aren't using. See "Creating
account and transaction files" for information on creating the
cusfil.
(all interfaces)
Set this parameter to "yes" if you want customers to be able to
have an order confirmation faxed to them automatically. If you do not
set this parameter to "yes", customers can choose to receive
confirmation by email or no confirmation. (The default
./dwos-bin/faxdoc script sends the fax remotely from
megamart.com. Edit this script to send faxes using the
appropriate commands for your server. NetStores sends the MERCHFAX
phone number as a parameter to this script.)
(gen-srch interface)
If INOFLD (the first field of the unique key) is a date with the
YYNNDD format (961231), set this parameter to the field number in
itmfil.asc that contains this date. NetStores will
reformat the date in the NN/DD/YY format (12/31/96). (gen-srch
interface)
(all interfaces)
NetStores creates files in the
./dwos/data/store-abbrev/tmp
directory while a customer is building an order. If you set the DEBUG
parameter to anything other than zero (0), these temporary files are
not deleted when the transaction is complete.
(gen-srch interface)
Set this parameter to "Y" if you do not want NetStores to check
the ./objects directory for HTML or image files to be
linked to the items listed in the order form. See "Customizing
the "look" of the store" for details.
(mall-level parameter)
Provide the domain name of your mall for email addresses. For
example, "megamart.com"
(gen-srch interface)
Set these parameters to field numbers in itmfil.asc
that contain descriptions for each item. These fields will be
included in the order form and order acceptance form.
(gen-srch interface)
Set these parameters to the number of letters you want to limit each description field to when a customer is using a browser that may not support tables.
(gen-cat interface)
Set this parameter to the number of letters you want to limit the description field for the gen-cat interface to when a customer is using a browser that may not support tables.
(gen-srch interface)
Provide text headings you want to use in the table that totals the order. These headings are used with browsers that may not support tables. Use spaces to line up the headers with the columns. Test the column alignment to get the spacing right. For example:
Qty Stock # Description Price
(all interfaces)
Set this parameter to the number of hours you will wait before shipping an order if the customer requested confirmation by email or fax. If you do not set this parameter, the customer will receive a message that says they have 48 hours to contact you if they want to cancel an order.
(gen-srch interface)
Set these parameters to the field numbers in
itmfil.asc that make up the unique key for each record.
You don't need to define INO2FLD if your unique key requires only one
field.
(gen-srch interface)
Set these parameters to the number of letters you want to limit each key field to if a customer is using a browser that may not support tables.
(all interfaces)
Set this parameter to the column headers you want to use in the invoice that is emailed or faxed to the customer. For example:
"Qty Stock # Description Price Ext"
(gen-srch interface)
Set this parameter to the field number in itmfil.asc
that contains the price of each item. This field will be included in
the order form and order acceptance form. If you want to have
different price lists for different customers, you can create a
series of price fields and set IPRCFLD to the number of the first
price field in itmfil.asc. You'll also need to set the
CUSPRC parameter.
(gen-srch interface)
Set this parameter to a comma-separated list of the field numbers
that make up the unique key. If the unique key is made up of only one
field and that field is the first field in itmfil.asc,
you don't need to set this parameter.
(gen-srch interface)
Set this parameter to "dist" if you want to require customers to provide an account number and password before they can search your product list. Wholesale distributors may only want to allow customers with accounts to search the product list. Retail merchants probably want few barriers to casual browsing. If you do not define LEVEL, customers will be able to provide an account number later when they want to add an item to their order.
(all interfaces)
Put your store logo in the
./dwos/data/abbrev/images directory.
This directory is referenced by an alias from the
./htdocs/abbrev/images directory.
For this parameter, provide only the filename of the image (no
directory location is needed.) For example, "mystore.gif".
(mall-level parameter)
Provide the system email directory. (The software polls this
directory.) For example, "/var/spool/mail".
(mall-level parameter)
Provide the email username (at DOMAINNAM) that should receive
alert messages. For example, "webmaster".
(mall-level parameter)
Provide the entire HTML <BODY> tag you want to use for the mall pages. You can include the BACKGROUND, BGCOLOR, TEXT, LINK, and VLINK attributes. ake sure you put the entire parameter definition on a single line.
Put the background image file in the ./dwos/malldata/images
directory. This directory is referenced by an alias from the
./htdocs/mallimages directory. So, the image location
you type for this parameter should have the format
"/mallimages/bkgrnd.gif".
For example, "<BODY
BACKGROUND=/mallimages/mallbkgd.gif>"
(mall-level parameter)
Put your mall's logo in the ./dwos/malldata/images
directory. This directory is referenced by an alias from the
./htdocs/mallimages directory. So, the image location
you type for this parameter should have the format
"/mallimages/logofile.jpg".
(mall-level parameter)
Set this to the name of your mall. For example, "Joe's
Megamall".
(all interfaces)
Set this parameter to the name of your store or business. For example, "Jack's Pet Shop".
(all interfaces)
Set this parameter to the email address of the store. If you set
this parameter, NetStores will email a copy of each order receipt to
the merchant. For example, "orders@JacksPets.com".
(all interfaces)
Set this parameter to the fax number for the store. If you set
this parameter, NetStores will fax a copy of each order receipt to
the merchant. For example, "800-555-3456". (The default
./dwos-bin/faxdoc script sends the fax remotely from
megamart.com. Edit this script to send faxes using the
appropriate commands for your server. NetStores sends the MERCHFAX
phone number as a parameter to this script.)
(all interfaces)
Set this parameter to the credit card merchant identification number for this store.
(mall-level parameter)
Set this parameter to "demo" if you want this to be a demonstration store merchants can use to evaluate opening a storefront at your mall.
(mall-level parameter)
If your Web server does not set DOCUMENT_ROOT, provide the full path to the page root directory with this parameter.
(gen-cat interface)
Set this parameter to the text or HTML you want to use instead of
"Next Item" in the link to the next catalog page. For example,
"<IMG
SRC=/store-abbrev/images/nextbtn.gif>"
(all interfaces)
Set this parameter to "$CUSDIR/nxtcus" if you want
NetStores to maintain a separate series of customer numbers for this
store.
(all interfaces)
Set this parameter to "$CUSDIR/nxttrx" if you want
NetStores to maintain a separate series of transaction numbers for
this store.
(gen-srch interface)
You can set this parameter to a field number in
itmfil.asc that contains a URL to link to for this
product. Another way to have NetStores automatically add links for
products is to use the objects directory as described in
"Customizing the "look" of the
store".
(gen-srch interface)
Set this parameter to a list of order price breaks above which the
discounts specified by the ORDPCT parameter should apply. Separate
the amounts with the pipe ("|") character. For example,
"100|1000|5000".
(gen-srch interface)
Set this parameter to a list of discount percents which should apply for the price breaks specified by the ORDDISC parameter. Separate the amounts with the pipe ("|") character.
For example, if ORDDISC="100|1000|5000" and
ORDPCT="5|10|15", then orders from $100 to $999.99 are
discounted by 5%, orders from $1000 to $4999.99 are discounted by
10%, and orders of $5000 or more are discounted by 15%.
(all interfaces)
Provide a word or words to fill in the blank: "If you complete
this order we will ship your ______ to the following address:" which
NetStores puts in the Order Acceptance form. For example,
"merchandise".
(all interfaces)
Set this parameter to the business name to which credit card
transactions should be payable. For example, "Jack Dolittle and
Associates".
(gen-cat interface)
Set this parameter to the text or HTML you want to use instead of
"Previous Item" in the link to the previous catalog page. For
example, "<IMG
SRC=/store-abbrev/images/backbtn.gif>"
(gen-srch interface)
If you set QTYSTYLE to 0, set this parameter to the number of digits you want customers to be able to type in the Quantity field.
(gen-srch interface)
Set this parameter to:
(gen-srch interface)
If you set QTYSTYLE to 2, set this parameter to a comma-separated list of the quantities you want customers to be able to choose from.
(gen-cat interface)
Set this parameter to text you want to use instead of "Remove This Item" on the button that removes an item from the order. For example: "Remove from Order".
(gen-cat interface)
Set this parameter to the number of letters you want to limit the field for the "Size" to when a customer is using a browser that may not support tables.
(gen-srch interface)
Set this parameter to the list of field names you want to use in
your form and the corresponding field numbers in your
itmfil.asc. Put the field names in the order you want
them to appear in your form. Don't use spaces, quotation marks, <,
>, =, &, |, or # in any field names.
The general format should look like this:
"fldname_1=fld_#|fldname_2=fld_#|fldname_n=fld_#"
Fields in itmfil.asc are numbered beginning with 1.
Separate fields with the pipe ("|") character. For example, the
previous form uses this definition for SRCHS:
"Item#=1|Artist=3|Title=4|Label=7|Category=2|Config=6"
A book catalog might use the following SRCHS definition:
"ISBN=1|Author=2|Title=3|Subject=6|Publisher=4"
(gen-srch interface)
Set this parameter to some HTML code that provides instructions for using the search form. The default SRCHTXT is "<h3>Enter keywords to search our catalog or leave fields blank for all.</h3>".
(gen-srch interface)
Set this parameter to the URL you want your store logo in the
search page to link to. If your store has a Web page or site with
general information about your store, you can use this parameter to
link to it. For example,
"http://www.myaddress.com/info.htm".
(gen-cat interface)
Set this parameter to the number of letters you want to limit the field for the "Style" to when a customer is using a browser that may not support tables.
(gen-cat interface)
Set this parameter to the text you want to use in the button
customers click to add items to an order. For example, "Add
Items to Order".
(gen-srch interface)
Set this parameter to any message you want to include in the last
row of the table (below the order subtotal) on the Order Acceptance
form. For example, "Five dollar shipping and handling charge
will be added to all orders shipped to arrive the next day."
(all interfaces)
Set this parameter to a list of sales tax rates that correspond to
the list of states specified by the TAXSTATE parameter. Separate the
tax rates with the pipe ("|") character. If you want to specify
multiple tax rates for a particular state, use a value of "ZIP" to
indicate that NetStores should examine the TAXZIP parameter. For
example, "ZIP|.075|.06".
(all interfaces)
Set this parameter to a list of states that correspond to the list
of sales tax rates specified by the TAXRATE parameter. For US states,
use the 2-letter postal abbreviations. Separate the states with the
pipe ("|") character. For example, "NY|CA|TX".
(gen-srch interface)
This parameter allows you to list sales tax rates for a number of zip code ranges in one or more states. They syntax for storing this information is a bit complex, so we'll break it down from the most general level to the specifics and then give examples. The general syntax is:
state_code|rate_expression|state_code|rate_expression
where state_code is the postal abbreviation matching a code in the definition of the TAXSTATE parameter, and rate_expression is:
part_1;part_2;...;part_n
where part_# is:
zip_expr,zip_expr,...,=rate
where rate is the sales tax rate (for example, .0725) and
zip_expr is a UNIX regular expression. Regular expressions are
described in the UNIX man page for "ed" and
can be fairly complex. However, for sales tax, you generally want to
specify a range of zip codes. To specify a zip code range from 90100
to 90799, use an expression like ^90[1-7], which
matches all zip codes beginning with 10 with a third digit from 1 to
7.
For example, here is a sample value for TAXZIP:
NY|^11[0346],=.085;^10[0-9],^112,=.0825;^1[100%],=.04
This means that in New York, zip codes in the 11000s, 11300s, 11400s, and 11600s have a tax rate of .085. Zip codes from 10000 to 10999 and zip codes in the 11200s have a tax rate of .0825. And, zip codes from 12000 to 14999 have a tax rate of .04.
(all interfaces)
Provide the HTML headings you want to use in the table that totals the order. These headers will be used for customers browsing with browsers know to support tables. The columns used in the table are set by NetStores if you are using the gen-cat interface. If you are using the gen-srch interface, the columns are determined by the parameters described in the previous section. For example:
<TR><TH>Qty</TH><TH>Stock #</TH><TH colspan=2>Description</TH><TH>Price</TH></TR>
(all interfaces)
Provide HTML code for a heading that describes what your store
sells. This theme will be used in various places, such as in the
mallfront page generated by the /dwos-bin/dwos program.
For example, "<FONT SIZE=+3 COLOR='red'>Your source for
quality pet supplies</FONT>".
(gen-srco and gen-srcq interfaces)
Set this parameter to the HTML code you want NetStores to include in the order form just below the image defined by the LOGO parameter.
(all interfaces)
Set this parameter to "$CUSDIR/trxlog" if you want
NetStores to maintain a separate transaction log file for this store.
(gen-srch interface)
If you do not set this parameter, all items are taxable. If some
items are non-taxable, set this parameter to the field number in
itmfil.asc that contains a "1" (one) if the item is
subject to sales tax and a "0" (zero) if the item is nontaxable.
(gen-cat interface)
Set this parameter to "graphic" when you are using the Catalog (gen-cat) interface. Don't set this parameter if you want NetStores to create links for this store that use the Search (gen-srch) interface.
(all interfaces)
Set this parameter to the URL you want customers to be able to
link back to after completing an order. The linked text will say
"Return to Main Mall here". For example,
"http://www.malldomain.com/dwos-bin/dwos".
(gen-cat interface)
Set this parameter to the text you want to use instead of "View Shopping Cart" on the button that lets the customer review the order. For example: "Review Order".
|
Copyright © 1996 NetStores |
|
