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

Solutions: Page Generators : Item Detail: Install & Use

:

Description - Installation & Use - FAQs

Item Detail - Installation and Use

FILENAME: ID-ReadMe.html

PURPOSE:

Describes installation and use of Item Detail.

DEPENDENCIES:

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

REQUIREMENTS:

i.cgi
xxx.htm (multiple templates supported; see "Templates" below)

Supplied Sample Templates:
i_1.htm
i_2.htm
i_S.htm
i_all.htm (Display All)

Optional:

Support for Item Compare, Text Search and Banner Rotator System requires those components to be previously installed and configured with Special Template markup supporting these components to be included within this product templates.

PACKING (PARTS) LIST

PACKING LIST
PRODUCT ID: ID
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/i.pl TEXT 13313 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/i_1.htm TEXT 4427 750
.jhz-cs/tmpls/solutions/pg/i_2.htm TEXT 3620 750
.jhz-cs/tmpls/solutions/pg/i_S.htm TEXT 4596 750
.jhz-cs/tmpls/solutions/pg/i_all.htm TEXT 3693 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/i.incl TEXT 14759 700
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:

Item Detail includes three sample templates:

i_1.htm (standard display)
i_2.htm (large image display)
i_S.htm (specifications display)
i_all.htm (display all items processing)

For initial installation it is recommended to use the sample templates provided until after having tested the installation and verified the configuration modifications are working as expected. Then, create the templates desired or modify the sample templates.

Item Detail supports two templates per item to be defined in the IID. Invocation of Item Detail without the template parameter "t" results in the default template being used to generate the page. When the template parameter name and value pair is passed as "t=2" the alternate template is used as opposed to the default.

There is no restriction to the number of templates used; however, only two templates may be specified per item. Simply specify the names of the two templates to be used for each item in the IID and invoke Item Detail Page with or without the template parameter name and value pair to cause the desired template to be used.

Templates naming conventions are not strictly enforce; however, it is recommended that the filename extension of ".htm" is used to help assure proper platform conversion during FTP upload and download as ASCII text.

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>>">

The All Items template is used to generate results containing all items contained in the IID; 20 items at a time. The repeating entries, one for each item, are marked within the template using the following special markup directives (in the form of HTML comments).

<!-- Entry Start -->
<!-- Entry End -->

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 i.cgi from within a web browser by entering the URL to i.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 i.cgi with the appropriate parameters to yield the desired result.

USAGE:

Following successful installation and satisfaction of dependencies and requirements, "i.cgi" should be invoked via the GET method passing a valid item ID name value pair as input using the name "i", and optionally a template identifier name value pair as input using the name "t" with valid values of "1" (default if "t" not specified) or "2". And, test invoking "i.cgi" without input parameters to test Display All processing.

EXAMPLE:

Specify the domain URL to the location where i.cgi resides; i.e.,

	http://www.yourdomain.com/cgi-bin/pg/i.cgi

Without parameters resulting in an All Items List being generated:

	i.cgi

With parameters:

	i.cgi?i=x
	i.cgi?i=x&t=1
	i.cgi?i=x&t=2

where "x" equals a valid ITEM_NUM
where "t=1" means use the default template
where "t=2" means use the secondary template

all values are contained in the IID (Item Information Dataset)

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