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

Solutions: Search : Manufacture Dir: Install & Use

:

Description - Installation & Use - FAQs

Manufacture Directory - Installation and Use

FILENAME: MD-ReadMe.html

PURPOSE:

Describes installation and use of Manufacture Directory.

DEPENDENCIES:

se.pl - Search 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:

mds.cgi (web interface component)
mds.htm (template)

OPTIONAL:

Support for 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: MD
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/se/mds.cgi TEXT 10889 750
cgi-bin/se/mds.incl TEXT 11333 700
cgi-bin/se/se.incl TEXT 4018 700
cgi-bin/se/se.pl TEXT 2616 750
images/JHZCS.gif BINARY 745 750
logs/errorlog.txt TEXT 91 750
tmpls/se/mds.htm TEXT 2824 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:

mds.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

EXAMPLES:

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 -->
<!-- Body Start -->
<!-- Manu Dir Entry Start -->
	<!-- Manu Dir Col Start -->
	<!-- Manu Dir Col End -->
<!-- Manu Dir Entry End -->
<!-- Body 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 mds.cgi from a web browser.

Enter the URL to mds.cgi with and without 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.

Add hyperlinks to Manufacture Directory 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, "mds.cgi" should be invoked via the GET method either with or without parameters.

EXAMPLES:

Without parameters invokes Manufacture Directories default processing, resulting in all Manufactures being displayed.

	mds.cgi

With parameters invokes Manufacture Directories default processing, resulting in all Manufactures being displayed.

	mds.cgi?M1=A+M2=A

where "M1" and "M2" (variable name value pairs) qualifies the list of Manufactures to those within range starting with M1 and ending with M2. The example above is using the value of "A" for both the start and end of the range to display.

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