clemprod Documentation

clemprod - Provides services for Clementine Product Id Master Database
CLEMPROD is an application that provides tracking of Clementine
products.  A master file containing nothing but Product Id can
be generated from a list of Clementine ISIS image files or the
image list can be used as the master.  The master can then be used
for for numerous operations.

The Product Id is extracted from the file name, so a specific format
of the file is required to be provided by the user.  All Clementine
files must be of the (minimal) form:

 lubxxxxy.zzz

 where xxxx represents a Product Number
          y represents a Product Letter
  and   zzz represents an orbit number

File pathes are striped as well as extraneous filename extensions.

The TAE MATCH parameter is provided to the user for use in a PDF that
calls this application.  The results of each operation will be returned
to the PDF via this parameter.  See secondary level help for the ACTION
and MATCH parameters for more details on how this parameter is used.

Programmer: Kris Becker

Name of master Product Id
database

NONE

A list of Clementine files from
which to extract Product Ids

--

Name of file that contains a
list of Clementine files

--

Specifies that action to perform
on the database.
CREATE - generates new master
         file
UPDATE - Adds new products to
         master
SEARCH - search master for
         specified products
DELETE - delete products from
         master

"SEARCH"

This is an output TAE parameter
that indicates the result of
ACTION=SEARCH.  If MATCH = 0,
then the search failed.
MATCH > 0 indicates all products
were found in the master file

LOCAL1

ADDITIONAL NOTES:

Parm	Description
MASTER	Specifies the name of the Clementine Product Id master database file. Be wary of create options as CLEMPROD does not support a situation that creates a new file over an existing one. See the TAE ACTION parameter for more details on how the master file is affected.
FROM	This allows the user to provide a list of products that will be applied to the requested action. This one of two methods that allow the user to specify Clementine Product Ids. See the TAE FROMFILE parameter for the second method. Note that Clementine Product Ids are assummed to be contained in the names that are provided in these values. For example, the file /work1/tbecker/122/lub5304o.122.cub.l1 will extract the Product Id as LUB5304O.122. Note that all Product Ids are case insensitive and thus represented as uppercase characters. It is an error if values are given in this parameter and in the FROMFILE parameter. Only one can be used for any given action.
FROMFILE	This allows the user to provide a file that contains a list of products that will be applied to the requested action. This one of two methods that allow the user to specify Clementine Product Ids. See the TAE FROM parameter for the second method. This parameter must be used for lists of products with more than 50 entries. Note that Clementine Product Ids are assummed to be contained in the names that are provided in these values. For example, the file /work1/tbecker/122/lub5304o.122.cub.l1 will extract the Product Id as LUB5304O.122. Note that all Product Ids are case insensitive and thus represented as uppercase characters. It is an error if values are given in this parameter and in the FROM parameter. Only one can be used for any given action.
ACTION	This parameter specifies the action to be performed on the master database file. For ACTION=CREATE, the file given in the MASTER parameter is create. If it already exists, the contents of the file are lost. Product Ids provided in either FROM or FROMFILE are then inserted in this file. For ACTION=UPDATE, the file given in the MASTER parameter is opened for writing. All Product Ids given in the FROM or FROMFILE parameter is appended to the database. Note that no checking of redundant products is done. For ACTION=SEARCH, the file given in the MASTER parameter is opened for reading. The values provided in the FROM or FROMFILE are check for existance in the master database. If one of the products does not exist, the search is deamed unsuccessful and MATCH returns 0, otherwise MATCH returns the number of Products that were searched for and found to exist in the master. For ACTION=DELETE, the file given in the MASTER parameter is opened for reading and writing. A search is preformed using the values provided in FROM or FROMFILE and each occurrance is removed from the master file.
MATCH	This parameter is a TAE NAME parameter that returns the result of a given action to a calling PDF. If ACTION=SEARCH, MATCH will indicate the success of the search. MATCH=0 indicates the search failed for one or more of the products that were searched for. MATCH > 0 indicates the number of products that where searched for and found to exist in the master database. For all other operations, MATCH returns a count of Products in the master database.