Since 1994
Application Systems Design, Development, Training, Support & Support Services
Ready-made Customizable Solutions

Solutions: Page Generators : Manufacture List: Install & Use

:

Description - Installation & Use - FAQs

Manufacture List - Installation and Use

Filename: ML-ReadMe.html

PURPOSE:

Describes installation and use of Manufacture List.

DEPENDENCIES:

mds.cgi - Manufacture Directory (not found handling; see: mds.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:

m.cgi (web interface component)
m.htm (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: ML
COMPONENT TYPE SIZE AUTH*
cgi-bin/dbmtabs/dbmparms.txt TEXT 1501 750
cgi-bin/dbmtabs/dbmtabs.incl TEXT 1954 700
cgi-bin/dbmtabs/dbmtabs.pl TEXT 2022 750
cgi-bin/geog.pl TEXT 11601 750
cgi-bin/jhzcs.pl TEXT 35038 750
cgi-bin/license.incl TEXT 7907 700
cgi-bin/pg/m.cgi TEXT 11259 750
cgi-bin/pg/m.incl TEXT 12497 700
cgi-bin/pg/pg.pl TEXT 13800 750
css/pg/pg.css TEXT 3381 750
data/IID/c.dat TEXT 13693 700
data/IID/i.dat TEXT 2463973 700
data/IID/m.dat TEXT 15181 700
images/JHZCS.gif BINARY 745 750
logs/errorlog.txt TEXT 91 750
tmpls/pg/m.htm TEXT 5891 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 the Manufacture List template:

m.htm

Any data item defined to the IID may be referenced. Variable name (column header name) wrapped in less than greater than pairs.

Two special keywords are supported for use of variable references within HTML anchor names, anchor references and CGI URL parameter values. Since the values returned these instances may contain space, use of these special keywords cause those spaces to be converted as required:

ANCHOR (spaces convert to underscores)
PARAM (spaces convert to %20)

EXAMPLE:

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

Special mark-up within Manufacture 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 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 the installation and configuration by invoking m.cgi from within a web browser by entering the URL to m.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 m.cgi with the appropriate parameters to yield the desired result.

USAGE:

Following successful installation and satisfaction of dependencies and requirements, "m.cgi" should be invoked via the GET method passing a valid manufacture name value pair(s).

EXAMPLE:

		m.cgi (Search Manufacture Directory is invoked listing all manufactures)
		m.cgi?m=value (lists all items for the specified manufacture)
		m.cgi?m=value&c=value (lists items of the specified category for the specified manufacture)

where:

"m=value" equals a valid manufacture name value
"c=value" equals a valid category name value

If no manufacture is specified, the Search Manufacture Directory is invoked with an informational message to select the desire manufacture.

If the specified manufacture is invalid, the Search Manufacture Directory is invoked with a Not Found error message and the error is logged and the webmaster notified.

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