The LIMS/SM Utilities Collection (VS0067)


			LIMSSM_BATCHINPUT.DOC

	****************************************************************
		
	NOTE:	The following has been supplied to the DECUS library
		by Digital Equipment Corporation.  This software has
		been supplied as is, with no expressed or implied 
		commitment to maintain, update, or support it or
		its use.  By supplying this, DEC and the author(s) 
		of the following are not responsible for damage,
		consequential or inconsequential, which may result
		from its use.

	*****************************************************************

---------------------------------------------------------------------------

 PURPOSE:  The purpose of this document is to describe how to use the
           limssm_batchinput program.

---------------------------------------------------------------------------

This program is composed of several different kinds of files, they are:

	LIMSSM_BATCHINPUT.FOR
	---------------------

	    This is the only source code file that need be compiled
	and linked by LIMSSM_BATCHINPUT.BLD in order to produce a 
	working executable.  The source code file LIMSSM_BATCHINPUT.FOR
	contains nine different modules that are called at various times
	during the execution of the program.

	
	LIMSSM_BATCHDEF.INC
	-------------------

	    This is the include file for LIMSSM_BATCHINPUT.FOR.  This
	file contains all of the records and equivalence definitions
	needed by the program.  This file must be in the same directory
	as the source code file when the source code is compiled.


	LIMSSM_BATCHINPUT.BLD
	---------------------

	    This file is run when a working executable is needed.  The
	file first compiles LIMSSM_BATCHINPUT.FOR and then links it
	to produce a working executable.


	PURPOSE OF PROGRAM
	------------------

	    This program was designed and written with the purpose of
	aiding the user in constructing a batch sample login external
	data file.  This program will construct all of the neccessary
	records for a group of samples that you would like logged into
	LIMS/SM.
	    The program is run by issuing the following command from
	DCL;  $ run limssm_batchinput
	
	The program first prompts the user for the subject ID.  This is 
	the subject ID associated with the group of samples that are about 
	to be logged in.  The remaining prompts ask the user to supply the 
	necessary sample, aliquot and test information.  When the program is 
	ended a data file called SYS$LOGIN:LIMSSM_BATCHINPUT.DAT is created.  
	This file contains all of the information entered by the user.  This
	file could now be used in conjuction with the LIMS/SM batch sample 
	login function to log the samples into LIMS/SM.  If at any time
	the user wishes to prematurely terminate the program enter
	CTRL-Y, this will cause the data file not to be saved and will
	bring the user back to DCL or the LIMS/SM  menu system.  For each
	new subject ID the user should start and stop the program.

	DATA ENTRY
	----------

	In respone to each query enter in the necessary information.
	If the field is an optional field and you do not wish to supply
	data for it enter return and leave the field blank.  If the
	field is a required field you will not be allowed to leave the
	field blank.


	ERRORS DURING DATA ENTRY
	------------------------

	    If information has been entered incorrectly and the user is
	still running the program the user may use the CTRL-C key to
	go back and change an incorrect entry.  Each time the CTRL-C
	key is pressed the user goes back one field.  Depending on where
	you are in the program the user may go back serveral fields or
	just to the last field.


	DATE FIELD ENTRY
	----------------	

	    When entering information into the date field enter
	in the number of days either in the past or the future from the
	current date to obtain the date that you want.  For example if
	you want the sample due date to be 30 days from now enter in the
	number 30.  A date thirty days from now will be displayed on the
	screen.  If you want to use the current date enter 0.  If you
	want to use a time in the past enter a negative number.  For
	example if you want a date 30 days ago enter -30 at the prompt. 
	The delta time cannot exceed 9999 or -9999 days.
	    

	INFORMATIONAL MESSAGE DURATION
	------------------------------

	In the include file LIMSSM_BATCHDEF.INC is the definition of
	the variable WAIT_TIME.  It is currently set to display a message
	for 2.8 seconds.  If you wish to adjust the duration of messages
	flashed to the screen edit the include file and change the value
	of the variable.  The source code must then be recompiled and
	relinked.
		  

	ERROR CHECKING
	--------------

	The program checks every field to make sure that the length of a
	field has not been exceeded.  If a field must be numeric that is
	checked.  If a field has a finite set of answers then
	only those responses are accepted.  If a field has an incorrect
	entry and it is checked for, an error message will be diplayed 
	and the user will be given another chance to enter the data
	correctly.  If a field cannot be left blank the user will be
	prevented from continuing on unitl the field has a value entered
	for it.

Click on FTP to download from the FTP archives.
[FTP]