Solutions : Page Generators : Manufacture List
Manufacture List
Description
Manufacture List dynamically generates lists of items defined to a specified manufacture within the Item Information Dataset (IID). Each time it's invoked a new page is generated picking up the most current updates to both template and data. It's template is fully customizable!
Invocation
Supports both GET and POST methods. Input is a valid "manufacture" parameter name value pair. Optionally supported is additional passing of a valid "category" parameter name value pair; when specified results are restricted to the specified category of items belonging to the specified manufacture.
Results
Resulting items are grouped by category and subcategory sorted alphabetically and formatted using a fully customizable template. Template processing automatically generates links and controls supporting:
- Item Detail links
- Category List links
- Subcategory List links
- Shopping Cart "Add-To-Cart" function links
- Item Search controls w/dynamic parameter setting
- Banner Rotator System markup replaced hyperlinked images
- Item Compare controls
Results include a manufacture information header containing address, telephone and website (hyperlinked when available). Each category and subcategory represented in the results is anchor name link listed, at the top of the page, to their respective groups for easy user click-down. Category and subcategory group heading is linked to Subcategory List and Category List when they are installed.
Exception Handling
If an invalid manufacture value is passed as input control is passed to Manufacture Directory when it is installed; see that product for details. Optionally, a not found page, Category List, Subcategory List or Item Detail w/o an Item ID can be invoked as an exceptional handler.
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
Manufacture List
Installation and Usage
Filename: m.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 | 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/m.cgi | TEXT | 11170 | 750 |
| cgi-bin/pg/m.incl | TEXT | 13106 | 700 |
| cgi-bin/pg/pg.pl | TEXT | 13315 | 750 |
| 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/m.htm | TEXT | 6071 | 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:
- Download solution to PC development platform and expand installation package (use any standard archive application such as WinZip®, StuffIt Expander® or TAR command)
- Modify configuration settings
- Upload to server
- Set access authorization permissions
- Test
- Customize Templates
- Test
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 "/")
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 PARAM>>
<a href="#<<category ANCHOR>>"> <a name="<<category ANCHOR>>">
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 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 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.
FAQs
Do I upload templates as Text or Binary?
Upload templates as Text.
What IID files are used to by Manufacture List?
The "i.dat" and "m.dat" files.
I have new items for a new manufacture, how to I cause them to be included?
Add the new items and the new manufacture to the IID.
JHZ-CS Solutions are distributed exclusively under terms and conditions of the JHZ-CS Software License Agreement.
