Since 1994
Application Systems Design and Development Services
Ready-made Fully Customizable Solutions

Solutions: Search : Item Search: Install & Use

:

Description - Installation & Use - FAQs

Item Search - Installation and Use

FILENAME: IS-ReadMe.html

PURPOSE:

Describes the installation and use of Item Search.

DEPENDENCIES:

se.pl - Search configuration and common logic modules (see: se.html)
jhzcs.pl - JHZ-CS configuration and common logic modules (see: jhzcs.html)
IID (Item Information Dataset)

REQUIREMENTS:

is.cgi (web interface component)
is.htm (template)

OPTIONAL:

Support for Item Compare and Banner Rotator System requires those components to be installed and configured according to their specifications. Inclusion of Special Template markup supporting those components must also be included within the template supported by this product. See sample template provided with this product.

PACKING (PARTS) LIST

PACKING LIST
PRODUCT ID: IS
COMPONENT TYPE SIZE AUTH*
.jhz-cs/.perl/solutions/dbmtabs/dbmparms.txt TEXT 1501 750
.jhz-cs/.perl/solutions/dbmtabs/dbmtabs.pl TEXT 2029 750
.jhz-cs/.perl/solutions/geog.pl TEXT 11609 750
.jhz-cs/.perl/solutions/jhzcs.pl TEXT 34046 750
.jhz-cs/.perl/solutions/se/is.pl TEXT 22132 750
.jhz-cs/.perl/solutions/se/se.pl TEXT 2604 750
.jhz-cs/data/solutions/IID/c.dat TEXT 15473 700
.jhz-cs/data/solutions/IID/i.dat TEXT 2560993 700
.jhz-cs/data/solutions/IID/m.dat TEXT 15181 700
.jhz-cs/logs/solutions/errorlog.txt TEXT 91 750
.jhz-cs/tmpls/solutions/se/is.htm TEXT 4611 750
public_html/Templates/solutions/dbmtabs/dbmtabs.incl TEXT 1966 700
public_html/Templates/solutions/license.incl TEXT 7904 700
public_html/Templates/solutions/se/is.incl TEXT 14548 700
public_html/Templates/solutions/se/se.incl TEXT 4042 700
public_html/cgi-bin/solutions/se/is.cgi TEXT 859 750
public_html/css/solutions/se/se.css TEXT 3069 750
public_html/images/solutions/JHZCS.gif BINARY 745 750
*AUTH - Authorization/permissions octal equilvalents where:
7=RWX, 6=RW, 5=RX, 4=R (R=Read W=Write X=Executable)
1 char indicates Octal number
2 char Owner
3 char Group
4 char All Others

INSTALLATION:

It is recommended that you read the entire installation process steps prior to performing installation. Each solution has specific instructions.

Installation Sequence

  1. Download solution to desktop
  2. Expand installation package (use any standard archive application; such as WinZip®, StuffIt Expander® or TAR command)
  3. Set configuration settings
  4. Upload components to server
  5. Set file permissions
  6. Test installation
  7. Customize Templates as desired
  8. Test customizations

Authorize non-Logic Components

  • Authorize graphic files for Read and Execute access; see "NOTE FOR NON-LOGIC COMPONENTS" below.
  • Authorize static HTML ".html" files for Read access; see "NOTE FOR NON-LOGIC COMPONENTS" below.
  • Authorize HTML Templates ".htm" files for Read access; see "NOTE FOR LOGIC COMPONENTS" below.

NOTE FOR NON-LOGIC COMPONENTS: Specify minimum required access permissions to achieve a more secure configuration; permission requirements for non-logic modules are dependent on server configuration where authorizations are required for either "group" only or for "owner", "group" and "other".

Modify Logic Components

Modify all logic components "*.cgi" and "*.pl" logic modules as follows:

  • First line of code (#!) correctly points to the PERL executable binary on the server (use command "which perl" or consult your server administrator)
  • All PERL "requires" statements contained in "*.cgi" and "*.pl" logic modules must use "absolute" directory paths (beginning with a forward slash "/")

Authorize Logic Components

Authorize logic components and dependent components (HTML and Email templates, and others) as follows:

  • Authorize "*.pl" logic modules for read access; see NOTE FOR LOGIC COMPONENTS below.
  • Authorize "*.cgi" logic modules for read and execute access; see NOTE FOR LOGIC COMPONENTS below.
  • Authorize all HTML and Email Templates documents for read access at the logic level; see NOTE FOR LOGIC COMPONENTS below.

NOTE FOR LOGIC COMPONENTS: Use minimum required permissions to achieve a more secure configuration; permission requirements for logic modules are dependent on the server configuration whether authorization is required for "owner" only (i.e., Apache with SUExec active), or "owner" and "group."

TEMPLATES:

Customize template for content and appearance as desired:

is.htm

The following Special mark-up within the Item Search template indicates the start and end of the repeating entries for the items matching the search criteria:

 
	<!-- Entry Start -->
	<!-- Entry End -->

Any variable contained in the IID may be referenced using the variables (column header name) wrapped in less than greater than pairs. The variable name cannot contain spaces.

Two special keywords are available for use when using a variable reference within web page anchor names, anchor references and CGI URL parameters. This allows use of referenced variables that equate to an item values containing spaces. The use of these special keywords causes spaces to be translated or escaped using the required character sequences.

The special keywords are:

 
ANCHOR

PARAM

EXAMPLES:

 
c.cgi?c=<<category%20PARAM>>
 
<a href="#<<category%20ANCHOR>>"> (link to subsequent name anchor)
<a name="<<category%20ANCHOR>>">

Uploading to Web Server

All dependent and required components must be successfully installed and configured. All components, with the exception of images, must be FTP uploaded as TEXT. Images must be FTP uploaded as BINARY.

TEST:

Test installation and configuration by invoking is.cgi from a web browser using a test page containing Item Search Controls.

  1. Test passing a valid search criteria

  2. Test passing an invalid search criteria

  3. Test all JHZ-CS page generators for correct replacement of Item Search parameters; "cat", "subcat" and "manufacture".

Add Item Search Controls to static pages and dynamic page templates as desired including the appropriate parameters and values to yield the desired results; e.g., category, subcategory, manufacture and search_all.

USAGE:

Insert Item Search Controls with markup in static pages and templates.

The JHZ-CS Page Generator Solution Templates already contain the Item Search Controls and will automatically set the hidden parameters (Form Fields) values as appropriate for the particular manufacture, category, and/or subcategory for the page being generated.

You may note the special markup variable <<search_text>> contained as a value for form field "search_text" in Item Search markup contained in Item Search Results templates. This causes the user entered Search Criteria to be retained in that field when the Item Search Results are generated and displayed.

<input type=text name="search_text"
value="<<search_text>>" size=12 maxlength=40>

For static page insertion use the following syntax to "search all departments".

<!-- JHZ-CS Search Template Start -->
<form action="/cgi-bin/se/is.cgi" method=post>
	<input type=hidden name="manufacture" value="">
	<input type=hidden name="cat" value="">
	<input type=hidden name="subcat" value="">
	<input type=hidden name="all_cats" value=1>
	<input type=text name="search_text" value="" size=12 maxlength=40>
	<input type=submit value="Search">
</form>
<!-- JHZ-CS Search Template End -->

The Special Directives "<!-- JHZ-CS Search Template Start -->" and "<!-- JHZ-CS Search Template End -->" identify Item Search variables to the JHZ-CS Page Generators for variable replacement of the hidden parameters; "cat", "subcat" and "manufacture". They must be present to cause the variables to be properly set during the dynamic page generation process.

In Category, Subcategory and Manufacture specific static pages you may restrict the search by putting values into the hidden input fields value parameters. Specify valid values contained in the IID. To allow the user to optionally search all departments, change the "all_cats" hidden input field to a checkbox and label it with text. Example:

<input type=checkbox name="all_cats" value=1> Search All Departments

JHZ-CS Solutions are offered exclusively under the terms and conditions of the JHZ-CS Software License Agreement.