Get documents about "ICM Cheat-Sheet Version v599z14 01142003
Document Sample
ICM Cheat-Sheet
Version v599z14
01/14/2003
The following describes the main PGI calls, SS TAGS (Server-Side), and Templates used for basic
ICM WEB Site set-up. Also included is a rudimentary explanation of the basics. It is assumed that the
ICM is installed and running at this time...
You should really read the complete ICM Documentation and Addendums found in PDF form at:
ftp://updates.businessprocessor.com/ICM/PDF_Addendums
**This is Case Sensitive...
THE BASICS:
The "Root" folder of the ICM WEB Server is "P.I.M.S. WWW Folder".
For instance, if you dropped a file called "index.html" into this folder you would access it by entering
the WEB Address (Domain name or IP Address) followed by "/index.html". An example would be:
http://216.101.117.256/index.html
There are default folders installed within this folder. They are:
CONTROLS
Current Listing Sets
Digits
Graphics
Help Files
HTML
LEDSign
LOGs
Templates
WWW Plug-Ins
It's best if you do not put anything of yours into these folders. They are used by the ICM and contain
files and documents used by it. The "Templates" folder contains text files that you need to modify, and
that's about the only exception. You can either dump all of your stuff into the Root folder, or create
folders of your own within the Root folder to better organize things. For those ICMs stored hear in the
ICM Server Farm, your FTP access drops you directly into the Root ("P.I.M.S. WWW Folder").
Like other WEB Servers and Modules in PIMS, the ICM has User-Modifiable Preferences. These can
either be accessed directly on the ICM in the ICM Module or remotely by calling the following URL:
http://216.101.117.nnn/pgi-ControlPanel
You will be prompted for a password. If you don't know what it is, ask EDC.
CONFIGURING YOUR WEB PAGES:
The ICM is a dynamic WEB Server that happens to be built directly into the PIMS application, and
resides as a fully integrated Module. This gives it direct access to ALL PIMS Files and Records. It
works with your WEB Site in the following way:
You put your "Static" WEB pages on the ICM, in the "P.I.M.S. WWW Folder" (the Root Directory),
modify a few ICM "Templates" (found in the "Templates" folder) using ICM-specific Server-Side
TAGs, and then add some HyperLinks (HREF) using some ICM-specific PGI calls. A "PGI" is the
ICM's equivalent of a"CGI". "PGI" stands for "PIMS Gateway Interface. That's it! (in it's simplest
form)...
Because the ICM contains the Database information itself (PIMS records), you simply tell it what to list
(HREF or Form ACTION), it finds the records you specify, and displays them using the specified
Template(s) that you have modified to suit your tastes and style with a series of Server-Side TAGS (SS-
TAGs).
** Most of the ICM set-up surrounds how information (specifically Inventory records) is set-up in PIMS.
Thought should be given to how Browsers will search for your Products on-line. How will they be
"Categorized". PIMS has an "ICM-Specific" page on the Inventory record so you can add more
"Category" information along with ICM-Specific "Keywords" so that you don't have to compromise your
existing Category information if need be.
MODIFYING TEMPLATES:
There are several User Templates in the ICM's "Template" folder, but we'll just deal with the common
ones in this document. The ones we will address are "Product Listing" and "Spec-Sheet" Templates.
The ICM has two built-in Templates called "Standard Text" and "Pictures & Text", for displaying
Product listings. These require no work on your part, but are very generic looking. They can be used to
start things off, while you create your own "User-Defined" Templates for later use. This setting is
called "Listing Type" and can be accessed by either ICM Preferences and/or "pgi-ControlPanel".
The best thing to do however is to modify the User-Defined Templates to give your ICM WEB Site that
personal look...
User-Defined Listing Templates are usually made up of three text files:
There is a text file that is loaded, processed, and delivered that represents the beginning of the product
listing. This file usually sets the tone for the listing including page navigation, logos, and the beginning
of the "Table" ("<TABLE>") that will contain the "rows" making up the product listing itself. This file
(Template) is denoted with the word "Before" in it's name.
The second text file that makes up a product listing Template Set (as they are called) is a file containing
the "Row" ("<TR>", "</TR>") and "Data Cells" ("<TD>", "</TD>") information. The ICM will
duplicate this information for every product listed (right after the "Before" Template). This Template
contains the word "During" in it.
The last text file (Template) of this set is the "After" Template. This text file contains a closing "Table"
element ("</TABLE>") and any other navigation or logo information you might want.
Basically, a "User-Defined" Template product listing is nothing more that a set of three Templates that
make up an HTML Table to display your products. It contains a beginning (Before), an automatically
repeating middle (During), and an ending (After).
The two most popular product listing Templates are the standard vertical listing and a product "Matrix"
listing. The standard listing is made up of the following Template Set:
Inventory Listing Before
Inventory Listing During
Inventory Listing After
This Template Set is used when the "User Defined" Listing Type is selected in Preferences, the standard
"Keyword" Search Actions, and standard "pgi-CustomListProducts?" URL call.
The ICM will supply everything between the "<HTML></HEAD>" and "</HEAD>" TAGs. This
means that the " Inventory Listing Before" Template should start with your "<BODY...>" TAG and the
beginning "<TABLE>" TAG. An example would be:
<body bgcolor="white">
<table border="0" cellpadding="0" cellspacing="2" width="600">
You would, of course, add things like your logo, maybe some fancy navigation links, some color, etc. to
this before phase.
The " Inventory Listing During" Template is the self-repeating TABLE rows section that actually
displays the products selected from Inventory. It must be the "ROW" section of the TABLE and can be
only one ROW high. An example would be:
<tr>
<td><a href="pgi-ProductSpec?[[PARTNO]]">[[PARTNO]]</a></td>
<td>[[DESCRIPTION]]</td>
<td>[[PRICE]]</td>
<td>[[ADDTOORDER]]</td>
</tr>
This simple example shows a product listing made up of the most basic Inventory elements and a
Quantity field with Order button. The displaying of this information is accomplished with simple SS-
TAGs that the ICM replaces with associated Inventory information. Specialty SS-TAGs like
"[[ADDTOORDER]]" are replaced with HTML Form information for adding an item to an Order
Request.
Notice the "HREF" containing the "pgi-ProductSpec" call. This is used to display a "Spec-Sheet" to
display more specific information about this product. These are referenced later in this document.
The final Template of the set (After) simply closes the Table. An example would be:
</table>
Notice that the "After" Template does not need the closing HTML document TAGs ("</Body>",
"</HTML>"). This is because they are provided by the ICM itself.
Because of the make up of this Template Set, you can see how you can make your Product Listing look
anyway you like. There are really no limits...
The "Matrix" listing set is a little more complicated. It can only be displayed by the "pgi-
CustomListProducts7?" call and is currently not available to "KeyWord" searches. It too is made up
of three text files, and they are called:
Inventory Listing Before-Matrix
Inventory Listing During-Matrix
Inventory Listing After-Matrix
They work in the same manner are the standard listing Template Set, with a few exceptions. It is best
that you read the ICM Addendum section on this for more information (found in the ICM Addendum for
v599z4, page #7).
THE SPEC-SHEET:
Another Template you will want to modify right away is the "Specsheet" Template, also found in the
ICM's Template folder.
This is a single text file Template used to display information for a specifically chosen product. It is
displayed using the "pgi-ProductSpec?" URL call.
This Template starts with the "<Body...>" TAG as well, and the ICM supplies the "</Body>",
"</HTML>" TAGs. With that in mind, you can create any kind of document you like to display
information about the given product.
You simply create a text document containing a rich variety of SS-TAGs mixed in with your HTML
code (or any code for that matter). The ICM will load this Template and replace the SS-TAGs with
Inventory record specific information, when called.
SERVER-SIDE TAGS (SS-TAGs):
There are three groups of SS-TAGs for the ICM. They are used for different documents, both "Static"
and Dynamically served:
Static Pages (page "stamping")
Product Listings (Template Sets)
Spec-Sheet
If no information is present for a given SS-TAG, then it is usually removed from your document.
If you have the "Filter User HTML Pages:" and "Replace User Fields" checked in ICM Preferences,
the ICM will load all of your "static" WEB Pages and process the following SS-TAGs:
[[DATE]], [[DATE1]], [[DATE2]], [[DATE3]], [[DATE4]], [[DATE5]], [[DATE6]]
the current date, in various date formats
[[TIME]]
the current time
[[Biz]]
the name of your company, as entered into PIMS' Company Info
[[Platform]]
the computer platform sent by the Browser
[[Browser]]
the Browser software being used to connect
[[Referer]]
the referring URL
[[CustCode]]
the Customer Code, if a valid Customer is logged-on
[[Customer]]
the Customer's name who is logged-in
[[EmplCode]]
the Employee Code of a valid logged-in Employee
[[Employee]]
the Employee's name
[[SessionID]]
the unique Session ID "cookie" used for unique Order Request creation.
[[SessionID2]]
** used by some custom plug-ins
[[LOGOFFhref]]
the complete URL for the log-off pgi ("HTTP://address/pgi-logoff")
[[Counter]]
a page counter graphic image for that page (starts with "<IMG SRC=")
[[Y2K]]
no longer used...
[[LOGOFF]]
if someone is logged-on, this will be replaced with a complete log-off graphic and HREF
if no one is logged on, this will be blank
[[SHOWORDERBUTTON]]
if an Order Request is created and associated with this Session ID, then this is replaced with a button to
show the current order
[[ORDERHREF]]
this is a complete URL to display the current Order Request. It uses either "$DisplayOrderRequest" or
"pgi-DisplayCurrentOrder?"
[[SEARCH]]
initiates Apple Sherlock search (no longer used)
[[KEYWORDSEARCH]]
this is replaced with the following "Keyword" search form:
[[KEYWORDSEARCH2]]
this is replaced with the following "Keyword" search form ("any" words is assumed):
[[ORDERITEMS]]
this will either display "Nothing On Order...", or the following table containing the items currently on
the Order Request:
[[MP:nn]]
this will be replaced with the current Price for a given and valid PIMS Inventory item. "nn" should be
replaced in your page with the Part# of the item desired. ie: [[MP:878475]]
** All "Templates" loaded and processed by the ICM are also subject to these SS-TAGs
SS-TAGs SPECIFIC TO PRODUCT LISTINGS:
Along with the above TAGs, the following work with the Product Listing Templates:
[[RS]]
how many Products where found by the current search that produced the listing (works with the
"Before" Templates only
[[LISTTITLE]]
the text passed by most "CustomListProducts?" PGIs as the title of the products found listing (works
with the "Before" Templates only
[[DISCOUNTTEXT]]
text that denotes any discount for any logged-in Customer
[[PRICE]]
the current Price for the product. this includes any processed discounts
[[BOOKCOST]]
the product's "BOOK_COST"
[[WHOLESALE]]
the product's "WHOLESALE"
[[PRICECOLOR]]
defaults to the word "BLACK". If the calculated Price of a product does not equal the Inventory
record's Price, then this is set to the word "RED"
[[SPECSHEETHREF]]
this is set to the complete URL for the Spec-Sheet for this product
("HTTP://address/pgi-ProductSpec?Part#"). if "[INVENTORY]AltWWWspectshee"
contains a URL, that is used instead.
[[PARTNO]]
the product's Part Code
[[DESCRIPTION]]
the product's Description.
[[ASSOPRODS]]
if this product has "Associated Auto-Loads", then the following text is displayed with the following link:
"(Associated Products)"
"HTTP://address/pgi-ListAssociatedProducts?Part#"
[[VENDOR]]
the product's Vendor Name
[[PICTURE]]
this is replaced with the following Image reference:
<IMG SRC="[INVENTORY]wwwPICTURL" Alt=" INVENTORY]PART CODE"
width="100" Border=0>
[[PICTUREHREF]]
this is the exact data as entered into the " INVENTORY]wwwPICTURL" Inventory field.
[[THUMBNAIL]]
this is replaced with the following Image reference:
<IMG SRC="[INVENTORY]wwwThumbNail" Alt=" INVENTORY]PART CODE"
width="100" Border=0>
[[THUMBREF]]
this is the exact data as entered into the "[INVENTORY]wwwThumbNail " Inventory field.
[[ADDTOORDER]]
this is replaced with a complete HTML Form that displays a single button to add this product to the
current Order Request. the image used for that button is "GRAPHICS/MyAddToOrder.GIF", and can be
replaced with any image you desire.
[[SHORTTEXT]]
replaced with: [INVENTORY]ICMinvtShrtTxt
[[MFG]]
the product's Manu Name
[[CATEGORY]]
the product's Category name
[[RETAIL]]
the product's Retail price
[[WEIGHT]]
the product's weight (un-formatted)
[[SIZE]]
the product's Size
[[SPECIALINSTRUCTIONS]]
replaced with the Inventory record's "Special Instructions", only if "ALERT USER" is checked
[[SessionID]]
the current Session ID cookie
[[ONHAND]]
the current ON HAND figure if greater than zero, else the word "None" is displayed
[[UOM]]
the product's unit-of-measure
[[SERIALNO]]
the product's Serial# (Inventory record field)
[[MODELNO]]
the product's Model#
[[COLOR]]
the product's Color
[[MEMO]]
the product's Default Memo
[[RPNAME]]
the product's shorter Description used by Receipt Printers
[[KEYWORD]]
the product's Keyword field (not the WWWKEYWORDS sub-listing)
[[DISTRICODE]]
the product's Distributor Code
[[SUBCAT]]
the product's Sub-Category name
[[THEDATE]]
the product's "TheDate" field
[[WWWCAT1]]
the product's WWW Cat_1 field
[[WWWCAT2]]
the product's WWW Cat_2 field
[[WWWCAT3]]
the product's WWW Cat_3 field
[[WWWCAT4]]
the product's WWW Cat_4 field
[[UserField1]]
the product's UserField1 field
[[UserField2]]
the product's UserField2 field
[[UserField3]]
the product's UserField3 field
[[UserField4]]
the product's UserField4 field
[[ADDITIONALINFO]]
the text in the "[INVENTORY]WWWspecURL" field
[[WWWTEXTBLOCK]]
the product's ICM page "Text Block". Any "Returns" are replaced with "<BR>".
[[PIF1]], [[PIF2]], [[PIF3]], [[PIF4]], [[PIF5]]
the product's various "PI" fields
[[PIF6]], [[PIF7]]
if checked, these are replaced with an "X", else nothing
[[FIELD:nn]]
this is replaced by any field specified by "nn". ie: "[[FIELD: 90]]" - this would be replaced with the
Sub-Category Code. ** caution should be used, as this could slow some listings down while
processing...
[[FIELD2:nn]]
this is the same as "[[FIELD:nn]]", except that it replaces the TAG with the associated "SpeedSearch"
field...
[[CUSTREQD]]
if no Customer is logged-on and this product requires one to be logged on before ordering, then the
following text is displayed: "Customer Log-On Required" (else nothing)
[[NEW-SIGN]]
if a product qualifies as new, the image from "/Graphics/New.GIF" is displayed
[[SPECIAL-SIGN]]
if a product is designated as "Special", the image from "/Graphics/Special.GIF" is displayed
[[INSTOCK-SIGN]]
if a product's ON HAND is greater than zero, the image from "/Graphics/InStock.GIF " is displayed
** "Signs" are only displayed if so denoted in ICM Preferences...
SS-TAGs SPECIFIC TO PRODUCT SPEC-SHEETS:
Along with the Static Page TAGs, the following are specific to the Product Spec-Sheet Templates:
[[CODE]]
the product's Part Code
[[CATCODE]]
the product's Category Code
[[subCATCODE]]
the product's Sub-Category Code
[[VENDCODE]]
the product's Vendor Code
[[MANUCODE]]
the product's MFR Code
[[NAME]]
the first 70 characters of the product's name
[[PICTURE]]
the complete Image reference to the URL found in the "[INVENTORY]wwwPICTURL" field.
ie: <IMG SRC=" INVENTORY]wwwPICTURL" Alt="[INVENTORY]PART CODE" >
[[THUMBNAIL]]
just like the product's "[[PICTURE]]" TAG, except that the "[INVENTORY]wwwThumbNail" field is
used instead.
[[DESCRIPTION]]
this is the product's "[INVENTORY]WWW_TextBlock" field, with "Returns" replaced with "<BR>"
[[ADDITIONALINFO]]
if the product's "[INVENTORY]WWWspecURL" field contains a URL, then "Click HERE For More
Information" is displayed with that link in place.
[[SIGNS]]
this is replaced with any valid and pertinent "Sign" images
[[ALERT]]
if the product's "Special Instructions" is not blank and "Alert User" is checked, this information is
displayed.
[[ALERTtext]]
if the above is true, then this is replaced with "Please Note:"
[[PRICE]]
the product's Price (including any discounts)
[[RETAIL]]
the product's Retail price
[[SAVINGStext]]
replaced with "A Retail Savings Of:", if there is a Retail savings
[[SAVINGS]]
the difference between Retail and the calculated Price (formatted), or nothing if there are no savings...
[[ORDERINFO]]
this is replaced with any current Order information, or the words "No Current Order Started..."
[[ADDTOORDER]]
this is replaced with a complete HTML Form to add this product to the current Order Request:
[[ONHAND]]
the product's ON HAND figure if greater than zero, else the word "none"
[[BARCODE]]
an image of a barcode using the product's Part# (actually reads sometimes...)
[[MFGSPRODUCTS]]
a complete URL using "pgi-CustomListProducts?" to find other products of the same Manu Code as this
one
[[CAT1PRODUCTS]]
a complete URL using "pgi-CustomListProducts?" to find other products of the same Category Code as
this one
[[CAT2PRODUCTS]]
a complete URL using "pgi-CustomListProducts?" to find other products of the same Sub-Category
Code as this one
[[CAT3PRODUCTS]]
a complete URL using "pgi-CustomListProducts?" to find other products of the same Keyword as this
one (not WWWKeyWords Sub-Listing)
[[CUSTOMER]]
the Customer's name, if logged-on
[[FIELD:nn]]
this is replaced by any field specified by "nn". ie: "[[FIELD: 90]]" - this would be replaced with the
Sub-Category Code. ** caution should be used, as this could slow some listings down while
processing...
[[FIELD2:nn]]
this is the same as "[[FIELD:nn]]", except that it replaces the TAG with the associated "SpeedSearch"
field...
[[SKU-CHOOSER1]]
for qualified products, this replaces the "Add To Order" controls with an SKU set of pop-menus for
adding specific types of this product to an Order Request. You should reference the ICM Addendum
"599z10", page 3...
[[ALSOBOUGHT]]
is replaced with a series of the top five items bought at the same time as this product. it is displayed in
TABLE form:
[[RECOMMENDED]]
this will display a listing of this product's "Associated Auto-Loads" if they exist on that product's
record. the products can be ordered from this listing.
PGI CALLS AND FORM ACTION ITEMS:
On your WEB Pages, you will want to add "HREF" links or Form ACTION elements to items to
produce products lists. Here is a listing of the most common of these URLs:
pgi-CustomListProducts?
When called, this will produce a listing of products using the Product Listing specified in the ICM
Preferences.
syntax: pgi-CustomListProducts?list title,2,search-field, comparator, field-data
ie: pgi-CustomListProducts?Underware,2,16,=,WM
-"Underware" is the title at the top of the listing, and also replaces "[[LISTTITLE]]"
-"2" is always the next element (it means Inventory File)
-"16" is the field to search (see field# listing). In this case, it is the Category Code
-"=" means "is equal to". "<>" means "is not equal to"...
-"WM" is the data stored in the Category Code field to search for
pgi-CustomListProducts2?
Same as " pgi-CustomListProducts?", except that the Listing Type of "Pictures & Text" is used,
regardless of the ICM Preferences.
pgi- CustomListProducts3?
Same as " pgi-CustomListProducts?", except that the Listing Type of "User-Defined" is used, regardless
of the ICM Preferences.
pgi- CustomListProducts3a?
This works the same way as "pgi-CustomListProducts?", except that is uses a Product Listing Template
Set with a "2" after it:
Inventory Listing Before2
Inventory Listing During2
Inventory Listing After2
This gives you an extra Listing Template Set for use with specially designated products, that is different
than the normal Listing Template Set.
pgi- CustomListProducts4?
This works the same way as "pgi-CustomListProducts?", except that no Templates are used and the ICM
creates and displays an "Order Form" for the specified products:
The Browser simply enters the Quantities, and clicks ORDER to have these items added to the current
Order Request. ** Caution - This listing displays ALL found items at once, so keep your products
"found" to no more than about 30 or so...
pgi-CustomListProducts5?
This is similar to "pgi-CustomListProducts?", except that it accepts an additional first parameter to
designate a Product Listing Template Set. It works like "pgi-CustomListProducts3a?" above, except
that you specify the number that comes after the Templates (in "3a" above, "2" is forced).
ie: "pgi-CustomListProducts5?6,Pool Toys,2,90,=,Childs
In this example, the "6" that precedes the "List Title" of "Pool Toys" designates that the listing Template
Set Templates used should end in a "6":
Inventory Listing Before6
Inventory Listing During6
Inventory Listing After6
pgi- CustomListProducts6?
This is the "Random" product listing, and uses the " Random_Product_Selection.HTML" Template. It
also uses the same parameters as "pgi-CustomListProducts?". You should really read the ICM
Addendum "599n", page 6 for specific details on using this search and listing combo.
pgi- CustomListProducts7?
This search is similar to "pgi-CustomListProducts?", except that it has an additional first parameter and
uses the "Matrix" Template Set for product listing. You should really reference the ICM Addendum
"599z4", page 7 for more information on setting up and using this call...
pgi-CustomListProducts8?
This search is similar to "pgi-CustomListProducts7?", except that it has an additional second parameter.
This parameter signifies which Matrix "Template Set" to use. Because you can specify as many Matrix
Template Sets as you like, the actual names of the Matrix Template files used by this call were
shortened. Here is an example with an "Additive" Set# of "5":
Listing Before-Matrix5
Listing During-Matrix5
Listing After-Matrix5
Using a "Search" Field On Your WEB Page:
To put a "Search" field on your WEB Page, you can use either "[[KEYWORDSEARCH]]",
"[[KEYWORDSEARCH2]]", or make your own HTML Form. This will show you how to make your
own using the "pgi-KeywordSearch2" ACTION URL:
As with any HTML Form, there are fields involved. For this Search Form, the following fields are used:
DATA
The actual field displayed for the Browser to enter something into.
CONT
Usually a radio button to allow the Browser to select "Contains All" or "Contains Any". If this field
returns "or", then any products that contain any of the words entered will be returned. If "Contains" is
returned to the ICM, then any products containing ALL of the words is returned.
CATCODE
This is an optional "Category Code" to send along that will narrow the Browser's search to a specific
Category of products. This must contain a valid PIMS "Category Code".
SUBCATCODE
This is an optional "Sub-Category Code" to send along that will narrow the Browser's search to a
specific Sub-Category of products. This must contain a valid PIMS "Sub-Category Code".
** CATECODE and SUBCATCODE can not be used at the same time...
ADDITIVE
This can be a number to designate a Template Set, much in the same way as the "pgi-
CustomListProducts5?"
SEARCHMORE
This field can hold the same parameters as used in the "pgi-CustomListProducts?" to even further
narrow a specified Browser search (ie: "Duck Things,2,90,=,duck").
Here is an example:
<FORM NAME="AKWSform1" ACTION="pgi-KeyWordSearch2" METHOD="POST">
SEARCH:<br>
<INPUT NAME="DATA" TYPE="text" SIZE="50" VALUE="">
<BR>
<INPUT NAME="CONT" TYPE="radio" VALUE="Contains">Contains All
Keywords
<INPUT NAME="CONT" TYPE="radio" VALUE="Or" checked>Contains Any
Keywords
<INPUT NAME="ADDITIVE" TYPE="hidden" VALUE="">
<INPUT NAME="CATCODE" TYPE="hidden" VALUE="WM">
<INPUT NAME="SUBCATCODE" TYPE="hidden" VALUE="">
<INPUT NAME="ADDITIVE" TYPE="hidden" VALUE="6">
<INPUT NAME="SEARCHMORE" TYPE="hidden" VALUE="">
<BR>
<a href="javascript:document.AKWSform1.submit();
" onMouseOver="window.status='Perform Search';
return true" onMouseOut="window.status=''; return true">
Go Find Items...</a>
</FONT>
</FORM>
This would display something like this:
You don't have to use the "JavaScript" example to Submit, and can use any style of Form you desire.
Just make sure that all of the fields are named correctly. You can even make EVERYTHING "hidden",
and use this Form as a link to display very specific products if you like. If no "Additive" is specified,
then the normal User-Defined listing Template Set is used, or whatever is set as the Listing Type in ICM
Preferences.
There is a special Keyword Search that produces a Matrix listing. It is called "KeywordSearch5". It
works the same as "pgi-KeywordSearch2", except that it contains an additional field called
"COLUMNS". This is where you put the "width" of your Matrix listing. It also contains an
"ADDITIVE" field to allow you to specify a Matrix Template Set. The Templates are named the same
as they are for the "CustomListProducts8" call.
ADDITIONAL PGI CALLS OF INTEREST:
The following are some of the more popular PGI calls available:
pgi-RestartICMServing (Password Required)
This will stop the ICM from serving and then start it back up. This function is generally not suggested,
and should not be used by anyone with an ICM in EDC's ICM Server Farm. Nothing is returned by this
call.
pgi-BackupICM (Password Required)
This will cause the ICM to run the file backup for that day. This should never really need to be done,
because it should be done every night. Nothing is returned until the process is complete.
pgi-EchoON (Password Required)
This will turn "Echo" mode on. This will cause the ICM to send back all information sent to it by the
Browser. This is a diagnostic function, and should be turned off when you are finished.
pgi-EchoOFF (Password Required)
This will stop the ICM "Echo" mode.
pgi-ArchiveLog (Password Required)
This will copy the ICM log file called " ICM Web.log" to a folder called "Archives" inside of the
"LOGs" folder. Once copied over, it's name is changed to reflect the date and time of the LOG file and
a new Log file is created. This exists to allow for the archiving of large Log files...
pgi-Switch
This is a function call that will perform a "Location" change. The syntax is:
pgi-Switch?http://www.something.com
This can be used as a default "Index" page in the ICM.
pgi-Getversion
This will return the current Version# of the ICM running.
pgi-Secure (Password Required)
This will toggle the "Maintenance Mode" function on/off and assign the machine it is being called from
as the only machine that can tie in. Calling this once will turn it on, calling it again will turn it off...
pgi-GetLOG
This will return the current contents of the ICM's screen log.
pgi-GetSTATS (Password Required)
This returns a report showing the current number of connections and Orders run by the ICM. Adding a
parameter that equals the first day of any month will report on that specific month only:
pgi-GetSTATS?01/01/2002
pgi-GetSTATS411 (Password Required)
This will return very specific details about what is currently going on concerning ICM operation.
pgi-GetPasswords (Password Required)
This will return a listing of ICM Passwords and passworded URLs.
pgi-ReloadPIs (Password Required)
This will reload all ICM Preferences.
pgi-SiteIndex
This will return an "Index Tree" of all files and folders in the ICM's Root Directory.
pgi-Hello
This will return a "Welcome" and "Under Construction" message. It can be used as an initial "Home"
page for the ICM.
pgi-ControlPanel (Password Required)
This will give remote access to most of the ICM's Preferences.
pgi-ManuallyFetchOrderRequests (Password Required)
This will process any "Finalized" Order Requests and return them to the Browser as a PIMS record
import file. Use caution when using this function, as Data-Sync is a much better vehicle for this!
pgi-Say (Password Required)
This will "Speak" the parameter text using the ICM's speech processing function. The text should be in
lower case and written phonetically: pgi-Say?Hey, how ya doing!
pgi-SSLon (Password Required)
This will turn on SSL processing between the ICM and WebSTAR (making Secure Order Requests).
pgi-SSLoff (Password Required)
This will turn SSL processing between the ICM and WebSTAR off, and the ICM will display Order
Requests "un-secure". This should only be used if WebSTAR has stopped function and Order Requests
still need to be displayed.
pgi-DSsend (Password Required)
This will instruct the ICM's Data-Sync to SEND records manually at that time.
pgi-DSfetch (Password Required)
This will instruct the ICM's Data-Sync to FETCH records manually at that time.
pgi-DSsendOnlyON (Password Required)
This will instruct the ICM to SEND Data-Sync records only, and not FETCH anything.
pgi-DSsendOnlyOFF (Password Required)
This will turn that function off.
pgi-GetBUlog (Password Required)
This will return information about the last 10 ICM record back-ups.
pgi-NoShowOnWEB (Password Required)
This will take a Part# as a parameter and flag that item as "Not OK" to show on WEB.
pgi-NoShowOnWEB?12345
pgi-ShowOnWEB (Password Required)
This will take a Part# as a parameter and flag that item as "OK" to show on WEB.
pgi-ShowOnWEB?12345
pgi-GetOnHand (Password Required)
This will take a Part# as a parameter and return the current ON-HAND figure.
pgi-GetOnHand?12345
pgi-SetOnHand (Password Required)
This will take a Part# and ON-HAND figure as parameters and set that item's ON-HAND.
pgi-SetOnHand?12345,100
INVENTORY FIELD NUMBERS (Indexed Only, Most Popular):
Please only use "Indexed" fields to search with, or your ICM product listings will be too slow...
FIELD# NAME TYPE LENGTH INDEXED?
69 ASSO_CODE Alpha 20 Yes
16 *CATE CODE Alpha 10 Yes
135 CantInvoice Boolean 0 Yes
10 CATEGORY Alpha 30 Yes
109 CNinDate Date 0 Yes
110 CNorigLoc Alpha 4 Yes
108 CNoutDate Date 0 Yes
87 CREATE_DATE Date 0 Yes
2 DESCRIPTION Alpha 70 Yes
48 DISCON_FLAG Boolean 0 Yes
83 DIST_CODE Alpha 20 Yes
94 HOLDING Real 0 Yes
222 ICMskuCODE Alpha 80 Yes
126 InvoiceItemSel Boolean 0 Yes
137 IsComponent Boolean 0 Yes
65 JOB_CODE Alpha 20 Yes
60 *KEYWORD Alpha 10 Yes
22 LAST MOVED Date 0 Yes
61 LOCATION Alpha 2 Yes
57 *MANU_CODE Alpha 10 Yes
224 MHsearchCode Alpha 20 Yes
30 *MODEL NO Alpha 20 Yes
59 MOD_DATE Date 0 Yes
172 NumericAccess Long Integer 0 Yes
124 OHmodDate Date 0 Yes
1 *PART CODE Alpha 20 Yes
214 *PIF1 Alpha 20 Yes
36 PRICE_LIST_FLAG Boolean 0 Yes
184 Rental_Item Boolean 0 Yes
21 REORDER Real 0 Yes
53 ROL_EXCLUDE Boolean 0 Yes
103 Shelf_Dog_Trk Boolean 0 Yes
90 *SUB_CAT_CODE Alpha 10 Yes
136 TheDate Date 0 Yes
12 *VENDOR CODE Alpha 10 Yes
171 Wholegood Boolean 0 Yes
157 *WWWcat_1 Alpha 10 Yes
158 *WWWcat_2 Alpha 10 Yes
159 *WWWcat_3 Alpha 10 Yes
160 *WWWcat_4 Alpha 10 Yes
199 *WWWnewOnWEB Boolean 0 Yes
161 *WWWspecial Boolean 0 Yes
198 WWW_List_OK Boolean 0 Yes
Related docs
