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

Solutions: Page Generators : Item Compare: Install & Use

:

Description - Installation & Use - FAQs

Item Compare - Installation and Use

FILENAME: IC-ReadMe.html

PURPOSE: Describes Item Compare dependencies, requirements, installation and use.

DEPENDENCIES:

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

REQUIREMENTS:

e.cgi
e.htm ( Item Compare results template)

Optional:

Support for Text Search 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 templates supported by this product.

PACKING (PARTS) LIST

PACKING LIST
PRODUCT ID: IC
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/pg/e.pl TEXT 17455 750
.jhz-cs/.perl/solutions/pg/pg.pl TEXT 13293 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/pg/e.htm TEXT 4747 750
public_html/Templates/solutions/dbmtabs/dbmtabs.incl TEXT 1966 700
public_html/Templates/solutions/license.incl TEXT 7904 700
public_html/Templates/solutions/pg/e.incl TEXT 13402 700
public_html/cgi-bin/solutions/pg/e.cgi TEXT 862 750
public_html/css/solutions/pg/pg.css TEXT 3340 750
public_html/images/solutions/JHZCS.gif BINARY 745 750
public_html/images/solutions/compare/compare.gif BINARY 212 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 Item Compare results template for content and appearance as desired.

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 e.cgi from a web browser from a page containing Item Compare controls. These controls consist of:

  • HTML Form definition
  • Item Compare button(s)
  • Item Compare check boxes
  • hidden Item Compare item number text fields
  • HTML Form terminator

The values for Item Compare markup and controls must be hard coded within static page. Within dynamic page templates the values for the Item Compare markup and controls must be coded using special markup variables to assure proper dynamic generation of the appropriate values when the list pages containing them are produced. JHZ-CS Dynamic Real-time Page Generators supporting Item Compare markup and controls are:

c.cgi - Category List
s.cgi - Subcategory List
m.cgi - Manufacture List

Verify generated links to item categories, subcategories, manufacture and detail page for the items displayed in the Item Compare results page.

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

Two special keywords support variable reference for translation to web page anchor names, anchor references and CGI URL parameters. This allows use of referenced variables that equates to an item value containing embedded spaces causing them to be translated/escaped:

	ANCHOR
	PARAM

EXAMPLE:

	c.cgi?c=<<category%20PARAM>>
	<a href="#<<category%20ANCHOR>>">
<a name="<<category%20ANCHOR>>">

Special mark-up within Item Compare Template must respect group order sequence to support nested repeating groups.

Indentation illustrates nesting relationships:

<!-- Page Header End --> 
<!-- Categories List Header Start --> 
<!-- Categories List Header End --> 
<!-- Categories Repeat Line Start --> 
<!-- Categories Repeat Line End --> 
<!-- Categories List Footer Start --> 
<!-- Categories List Footer End --> 
<!-- Cat Group Start --> 
	<!-- Cat Header Start --> 
	<!-- Cat Header End --> 
	<!-- Cat Entry Start --> 
	<!-- Cat Entry End --> 
<!-- Cat Group End --> 
<!-- Page Footer Start -->

USAGE:

Following successful installation and satisfaction of dependencies and requirements, "e.cgi" may be invoked via an HTML Form using either GET or POST methods. The invoking page must contain the required Item Compare markup and controls. Both static and dynamic page templates may contain the Item Compare markup and controls. JHZ-CS Page Generators (except Item Detail with parameters), Item Search and Text Search resulting output automatic generate Item Compare Controls.

Display the page containing the Item Compare controls. Select the items to compare by clicking the check boxes for the desired items, then click the Compare button and the Item Compare results page will display its results.

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