home *** CD-ROM | disk | FTP | other *** search
/ High Voltage Shareware / high1.zip / high1 / DIR3 / JSFILD22.ZIP / JSFIELD.TXT < prev    next >
Text File  |  1993-10-06  |  10KB  |  296 lines
  1. JSFIELD Utility Program Documentation
  2. (Ver 2.2)
  3.  
  4. Author: Johnathan Mark Smith
  5.  
  6.  
  7. THE OLD DISCLAIMER
  8.  
  9.   This software and manual are sold "as is" and without warranties
  10.   as to performance or merchant ability or any other warranties
  11.   whether expressed or implied. Because of the various hardware and
  12.   software environments into which this program may be put, no
  13.   warranty of fitness for a particular purpose is offered.
  14.  
  15.   The user must assume the entire risk of using and evaluating this
  16.   program. Any liability of  Johnathan Mark Smith Technology will be
  17.   limited exclusively to product replacement or refund of purchase
  18.   price. If you find these terms unacceptable, do not use this
  19.   product.
  20.  
  21. Introduction
  22.  
  23.  
  24.     programmers are frequently asked to extract and format
  25.  data for the PC.  It is not enough for the programmer simply to 
  26. pull off the records of interest to the user.  Usually, the records must be
  27. formatted to create a set of fields appropriate for "importing"
  28. into the PC worksheet.  In a typical company, hundreds of man-hours
  29. are spent each year in creating the small ad-hoc programs required
  30. to generate such data.
  31.  
  32.  The JSFIELD utility greatly simplifies the task of manipulating
  33.  data for use in a PC environment.  JSFIELD provides the following
  34.  features:
  35.  
  36.  1.  Selective extraction of fields from an input record
  37.  
  38.  2.  Data output in either delimited ASCII or non-delimited ASCII
  39.      format.
  40.  
  41.  3.  Selectable column position ordering of extracted fields.
  42.  
  43.  4.  Ability to write the same input data into multiple output
  44.      fields.
  45.  
  46.  5.  Record selection capability based on record field contents.
  47.  
  48.  6.  Optional output record count limit parameter.
  49.  
  50.  7.  Formatting of string field with quote marks and numeric
  51.      fields with explicit zeros.
  52.  
  53.  8.  Suppression of unwanted characters within selected fields.
  54.  
  55.  9.  Creation of constant string output fields.
  56.  
  57. 10.  Conversion data from EBCDIC to ASCII format.
  58.  
  59.  
  60.  
  61.  
  62.     The JSFIELD program must be provided with control information 
  63. to govern its execution. This information is read from a control file. 
  64. The control file is a standard PC text file that can be created 
  65. with any ASCII text editor.
  66.  
  67.  To run JSFIELD type at the prompt: JSFIELD [options] <Control file name> .
  68.  
  69.  THE CONTROL FILE
  70.  ----------------
  71.  
  72.  The first line of the control file identifies the input file name.
  73.  
  74.  The second line of the control file identifies the output file name.
  75.  
  76.  Subsequent lines of the file provide field extraction control information.
  77.  Each field exaction control line contains the type of field ,starting byte
  78.  position of the field, length of the field and a mask if needed.
  79.  
  80.  The following sample control file illustrates how control
  81.  information is provided to the JSFIELD program.
  82.  
  83.  Contents of a sample JSFIELD control file, JSFIELD.CTL:
  84.  
  85. C:\DATA\STC.TXT
  86. C:\DATA\only100.TXT
  87. c,2,4,<>,John
  88. n,10,1,=,1
  89. C,5,3
  90. N,24,7,<,10000
  91.  
  92.  
  93.  
  94. The input file name is C:\DATA\STC.TXT.
  95.  
  96. The output file name is C:\DATA\LESS100.TXT.
  97.  
  98. The first field extract control record (c,2,4,<>,John) indicates that
  99. the data to be extract is a string field(characters to be surrounded by
  100. quotes) will be extracted from byte position 2 and The logical length
  101. of the field is 4 characters. The selection data indicate that the input
  102. record will be discarded if the field value is equal to John.
  103.  
  104. The second field extract control record (n,10,1,=,1) indicates that the
  105. data to be extract is a numeric field and it will be extracted from
  106. byte position 10 and the logical length of the field is 1 character.
  107. The selection data indicate that the input record will be discarded
  108. if the field value is not equal to 1.
  109.  
  110. The field extract control record (C,5,3) indicates that the data to be
  111. extract is a string. The leading and trailing spaces will be removed because
  112. you used a Upper case 'C' character. The field will be extracted from
  113. byte position 5 and the logical length of the field is 3 characters
  114. long.
  115.  
  116. The field extract control record (N,24,7,<,10000) indicates that the data to
  117. be extract is a numeric field and it will removed leading zeros because
  118. you used a upper case 'N' character. The field will be extracted from
  119. byte position 25 and the logical length of the field is 7 characters long.
  120. If the field is not less then 10,000 the input record will be discarded.
  121.  
  122.  
  123. JSFIELD Output field type codes
  124. -------------------------------
  125.  
  126.   The following are valid codes for designating output field types:
  127.  
  128. STRING FIELDS
  129. -------------
  130. 1) c (Lower case)   String field. (Surrounded by quotes).
  131.  
  132. 2) C (Upper case)   String field. (Surrounded by quotes, Leading and
  133.                     trailing spaces will be removed).
  134.  
  135. 3) u (Lower case)   String field. This will convert the string to
  136.                     all uppercase. (Surrounded by quotes).
  137.  
  138. 4) U (Upper case)   String field. This will convert the string to
  139.                     all uppercase. (Surrounded by quotes, Leading and
  140.                     trailing spaces will be removed).
  141.  
  142. 5) l (Lower case)   String field. This will convert the string to
  143.                     all lowercase. (Surrounded by quotes).
  144.  
  145. 6) L (Upper case)   String field. This will convert the string to
  146.                     all lowercase. (Surrounded by quotes, Leading and
  147.                     trailing spaces will be removed).
  148.  
  149. NUMERIC FIELDS
  150. --------------
  151. 1) n (Lower case)   Numeric field (Leading and trailing spaces will
  152.                     be removed).
  153.  
  154. 2) N (Upper case)   Numeric field (Leading and trailing spaces will
  155.                     be removed. also Leading zeros will be removed).
  156.  
  157.  
  158. JSFIELD Output file mask code
  159. _____________________________
  160.  
  161.   The following are valid codes for designating output field mask:
  162.  
  163. 1) <>               Take all record not equal to the value of the
  164.                     data field.
  165.  
  166. 2) <                Take all record less then the value of the data
  167.                     field.
  168.  
  169. 3) >                Take all record greater then the value of the
  170.                     data field.
  171.  
  172. 4) =                Take all record equal to the value of the data field.
  173.  
  174.  
  175.  
  176.  
  177. OPTIONS
  178. -------
  179. 1) -bz   This option will tell the utility that the input file is not
  180.          CRLF and the record length is z long, also make the output file
  181.          without CRLF.
  182.  
  183. 2) -Bz   This option will tell the utility that the input file is not
  184.          CRLF and the record length is z long, also this will add CRLF
  185.          to the output file.
  186.  
  187. 3) -ez   This option will tell the utility that the input file is EBCDIC
  188.          and the record length is z long, also make the output file ASCII
  189.          without CRLF.
  190.  
  191. 4) -Ez   This option will tell the utility that the input file is EBCDIC
  192.          and the record length is z long, also the output file will
  193.          be ASCII with CRLF..
  194.  
  195. 5) -A    This option will tell the utility that the input file is CRLF
  196.          but don't make the output CRLF.
  197.  
  198. 6) -d    This will tell the utility to make the output file delimited.
  199.  
  200. 7) -a    In some system a delimiter after the last field on the record
  201.          will be needed. This option will insert a delimiter after the
  202.          last field on each record.
  203.  
  204. 8) -nz   This option will tell the utility to only extract z number of
  205.          record(s).
  206.  
  207. 9) -s    This option will put the utility into fast and stealth mode.
  208.          fast and stealth mode will surpress the graph that shows on
  209.          the screen when JSFIELD is executed and the counters will
  210.          only be displayed at program termination. The advantage
  211.          of using this option is that the utility will run
  212.          MUCH, MUCH FASTER.
  213.          (Try It !)
  214.  
  215.  
  216.  
  217.  
  218. Registration
  219.  
  220.   I will keep improving the program if I know enough people are
  221.   finding it useful.
  222.  
  223.   My registration policy is very flexible. The nominal fee are listed
  224.   in the file REGISTER.TXT. If you don't feel you will get your money
  225.   worth of use out of JSFIELD, send whatever it is worth to you.
  226.  
  227.   If you are impoverished and can't afford to pay anything,
  228.   enclose a stamped self-addressed envelope
  229.   and I will send you a registration.
  230.  
  231.   This is not freeware or public domain. Shareware is simply a means
  232.   of marketing commercial software. You are required to register if
  233.   you intend to use this program after a reasonable trial period.
  234.  
  235.   When registering, please tell me the version number you have 
  236.   and where you obtained your copy of JSFIELD.
  237.  
  238.   See REGISTER.TXT for details.
  239.  
  240.   JSFIELD should be registered for the maximum number of copies that
  241.   can be used simultaneously at your site. Site fees for commercial
  242.   users can be negotiated.
  243.  
  244.   If you register for the full fee, and enclose a Shipping and
  245.   Handling fee of $3 I will send you the latest versions of JSFIELD and
  246.   Some Free Demo's.  if you decide to use it after a trial period. I will 
  247.   also send other File related shareware programs.
  248.  
  249.  
  250. Registered version features
  251.  
  252. * CUSTOM DEFAULT SETTINGS
  253.  
  254. * DISCOUNTS ON SHAREWARE
  255.  
  256.  
  257.  
  258.  
  259. Program Abort
  260.  
  261.     Hitting Control-C (or Control-Break) will terminate the program
  262.     immediately. 
  263.  
  264.  
  265. Distribution
  266.  
  267.     Permission is hereby given to copy and distribute this program
  268.     as long as no more than $5 is charged. It must be made clear to
  269.     the buyer that this is only a handling charge and not a
  270.     registration fee. You must include all files in their original
  271.     unmodified form when distributing this program. .
  272.  
  273.     Permission to distribute may be revoked by the Johnathan Mark Smith 
  274.     at any time for any reason.
  275.  
  276.     YOU MUST NOT DISTRIBUTE ANY COPY WHICH HAS BEEN BRANDED WITH
  277.     A REGISTRATION CODE. 
  278.  
  279. All trademarks used in this document are the property of their
  280. owners.
  281.  
  282.         -Johnathan Mark Smith-
  283.  
  284.  
  285. Questions or suggestions regarding JSFIELD should be directed to the author
  286. at the following address:
  287.  
  288.     Johnathan Mark Smith
  289.     2039 85 STREET
  290.     BROOKLYN, NY 11214
  291.  
  292.     Telephone: 718-373-3886
  293.  
  294.  
  295.  
  296.