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

Solutions: Page Generators : Category List: Install & Use

:

Description - Installation & Use - FAQs

Category List - Installation and Use

FILENAME: CL-ReadMe.html

PURPOSE:

Describes installation and use of Category List.

DEPENDENCIES:

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

REQUIREMENTS:

c.cgi (web interface component)
c.htm (template)
c_nf.htm (not found handling template)

Optional:

Support for Item Compare, 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: CL
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/c.pl TEXT 12431 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/c.htm TEXT 5119 750
.jhz-cs/tmpls/solutions/pg/c_nf.htm TEXT 3664 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/c.incl TEXT 13006 700
public_html/cgi-bin/solutions/pg/c.cgi TEXT 860 750
public_html/css/solutions/pg/pg.css TEXT 3340 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 templates for content and appearance as desired:

c.htm
c_nf.htm

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

EXAMPLE:

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

Special mark-up within Category List (Found) and Category List (Not Found) Templates 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 -->

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 c.cgi from a web browser.

Enter the URL to c.cgi with parameters; see example in USAGE section below.

  1. Test passing a valid parameters

  2. Test passing an invalid parameters and verify installation and configuration is correct.

For initial installation test each possible valid category value.

Add hyperlinks to Category List to static pages and dynamic page templates as desired including the appropriate parameter and value to yield the desired results.

USAGE:

Following successful installation and satisfaction of dependencies and requirements, "c.cgi" should be invoked via the GET method passing a valid item category name value pair as input using the name "c".

EXAMPLE:

c.cgi (invokes not found process, listing all categories formatted using the not found template)

	c.cgi?c=x

where "x" equals a valid category value contained within the IID (Item Information Dataset).

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