James H. Zisch - Computer Services

Solutions : Page Generators : Subcategory List

 

Subcategory List

PRICE:  $249.99 (subject to change without notice)

Description
Requirements
Usage
FAQs

Description

Subcategory List generates lists of items defined to a specified subcategory within the Item Information Dataset (IID). Each time it's invoked a new page is generated picking up the most current updates to both templates and data.

Invocation

Supports both GET and POST methods. Input is a valid "subcategory" parameter name value pair. Links to Subcategory List are automatically generated by reference with appropriate input parameters by the various JHZ-CS Page Generator Solutions.

Results

Resulting items are grouped by manufacture sorted alphabetically and formatted using the fully customizable template. Template processing includes automatic generation of links and controls supporting:

NOTE: The example below shows only one Manufacture. When more than one Manufacture has items defined to the specified subcategory, items are grouped by manufacture with multiple name anchors generated to each group. Each manufacture represented in the results is anchor link listed at the top of page pointing to each manufacture group for easy click-down. Manufacture group heading are linked to Manufacture List for display of all items for the respective manufacture when installed.

Exception Handling

If no subcategory parameter name value pair, or an invalid subcategory value, is passed as input control is passed to Manufacture Directory; when it is installed. When an invalid subcategory parameter value is passed, the first character is used to determine the initial display of the Manufacture Directory; as shown in example below. Optionally, Subcategory List may be configured to pass control to Category List for sites without manufacture specific products or when Manufacture Directory is not installed.

Web Server Requirements:

  • Operating Systems Supported: Unix, Linux, Macintosh OS X® and Windows®
  • HTTP 1.x with CGI (Common Gateway Interface) PERL 5.x (check with your ISP or Server Administrator; this requirement is typically supported on most systems)
  • Optional: SENDMAIL (supported on most all Unix/Linux platforms), or PERL NET:SMTP (available from CPAN) (commonly used on Windows® server platforms) with an SMTP system pre-installed and configured. This optional requirement supports automatic email notification to the webmaster when execution errors are detected.
  • Optional: For configurations using an RDBMS (Relational Database Management System) data source requires a supported RDBMS, the PERL DBI module and the RDBMS specific DBD module to be previously installed and configured

Subcategory List
Install and Use

FILENAME: s.html

DEPENDENCIES:

PURPOSE:

Describes the installation and use of Subcategory List.

c.cgi - Category List (see: c.html)
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:

s.cgi
s.htm

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: SL
COMPONENT TYPE SIZE AUTH*
cgi-bin/dbmtabs/dbmparms.txt TEXT 1501 750
cgi-bin/dbmtabs/dbmtabs.incl TEXT 1970 700
cgi-bin/dbmtabs/dbmtabs.pl TEXT 1998 750
cgi-bin/geog.pl TEXT 11750 750
cgi-bin/jhzcs.pl TEXT 47225 750
cgi-bin/license.incl TEXT 7565 700
cgi-bin/pg/pg.pl TEXT 13315 750
cgi-bin/pg/s.cgi TEXT 9504 750
cgi-bin/pg/s.incl TEXT 12600 700
css/pg/pg.css TEXT 3008 750
data/IID/c.dat TEXT 15117 700
data/IID/i.dat TEXT 2584820 700
data/IID/m.dat TEXT 15181 700
images/JHZCS.gif BINARY 745 750
logs/errorlog.txt TEXT 91 750
tmpls/pg/s.htm TEXT 5104 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 strongly recommended that you read the entire installation process steps prior to performing any installations. Each solution has specific instruction that must be followed precisely.

The Installation Process

The installation process follows this order:

  1. Download solution to PC development platform and expand installation package (use any standard archive application such as WinZip®, StuffIt Expander® or TAR command)
  2. Modify configuration settings
  3. Upload to server
  4. Set access authorization permissions
  5. Test
  6. Customize Templates
  7. Test

Authorize non-Logic Components

Authorize non-logic components as follows:

  • authorized all images for read and execute access; see NOTE FOR NON-LOGIC COMPONENTS below
  • authorized all static HTML ".html" documents for read access; see NOTE FOR NON-LOGIC COMPONENTS below
  • authorized all HTML Templates ".htm" documents for read access at the logic level; see NOTE FOR LOGIC COMPONENTS below
  • authorized all images for read and execute access; see NOTE FOR NON-LOGIC COMPONENTS below.

NOTE FOR NON-LOGIC COMPONENTS: Use the minimum required permissions to achieve most secure configuration; permission requirements for non-logic modules are dependent on the server configuration whether authorization is required for group only or for both 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 on the server (use command "which perl" or consult your server administrator)
  • all "requires" statements contained in all "*.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:

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

NOTE FOR LOGIC COMPONENTS: Use the minimum required permissions to achieve most 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 for both owner and group.

TEMPLATES:

Customize the Subcategory List template 's.htm' for desired content and appearance.

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 PARAM>> 
	
	<a href="#<<category ANCHOR>>">
	<a name="<<category ANCHOR>>">

Special mark-up within Subcategory List 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 -->

Uploading to Web Server

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

TEST:

Test the installation and configuration by invoking s.cgi from within a web browser by entering the URL to s.cgi with parameters using the syntax in the example in the USAGE section below. First test passing valid parameters, then test passing invalid parameters to assure installation and configuration is correct. It is recommended that you test each possible valid value upon initial installation, and perform function and regression testing each time a new valid value is added to the website configuration.

Add hyperlinks within static pages and dynamic page templates to point to s.cgi with the appropriate parameters to yield the desired result.

USAGE:

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

EXAMPLE: 

	s.cgi?s=x

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

FAQs

Do I upload templates as Text or Binary?

Upload as Text.

The sample template contains markup for Item Compare and Text Search, but I do not have them installed. What do I do?

Simply remove the markup from the template.

The sample template contains markup to link to Manufacture List for each item. I do not have Manufacture List installed. What do I do?

If you do not have manufactures for your items, remove the data column from the template. If you have manufactures for you items, keep the data column and simply remove the "<a href=...>" and "</a>" portion of the markup and leave the <<manufacture>> variable.

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