home *** CD-ROM | disk | FTP | other *** search
/ terabyteunlimited.com / 2014.06.terabyteunlimited.com.tar / terabyteunlimited.com / EXTRIT.ZIP / EXTRACT.HLP < prev    next >
INI File  |  2003-08-06  |  15KB  |  369 lines
  1. [General Help]
  2. ~General Information:~
  3.  
  4.  ~Start Up~
  5.  The following command line options are available:
  6.    -i~InputFile~  Input Text File Name~*~
  7.    -s~SpecFile~   Specification File Name~*~
  8.    -o~OutFile~    Output File Name~*~
  9.    X:\Path      Path to the options file
  10.  
  11.  ~*~ Option only takes effect if all file names are given.
  12.  
  13.  You also can 
  14.  
  15.  ~Exporting~
  16.  The Export function will save the data in standard ASCII delimited text
  17.  format.  When you import this data into your spreadsheet/database you'll
  18.  need to choose this format.  The default file extension is .ASC
  19.  
  20.  ~ESC~
  21.  will always take you back one level (except exiting the program) without
  22.  saving any changes.
  23.  
  24.  ~Alt-H~
  25.  will usually display a help screen specific to the area you are in.
  26.  
  27.  ~Tab/Shift-Tab~
  28.  moves you from one section of a dialog box to another.
  29.  
  30.  ~Cursor Keys~ (includes Page Up/Page Down/Home/End)
  31.  will move any highlight bars, text, or cursor.  In addition if you use the
  32.  Ctrl key with the left or right cursor keys you will move more than one
  33.  space at a time.
  34.  
  35.  ~Scroll Lock~
  36.  locks the highlight bar to a fixed position moving the text instead of the
  37.  cursor/bar.  It is not used in any of the dialog boxes.
  38.  
  39.  If You have selected an input file you may use the following keys:
  40.  
  41.  ~Alt-A~ Define a new area.
  42.  ~Alt-C~ Allows you to edit conditions for an area.
  43.  ~Alt-E~ Use to edit to Add, Delete, or Change a field or area.
  44.  ~Alt-G~ Go to a specific line number.
  45.  ~ALT-M~ Display a pop up menu.
  46.  ~ALT-N~ New Specification File.  (Clears Current Settings)
  47.  ~ALT-O~ Select the order of the exported fields.
  48.  
  49.  ~DETAIL INFORMATION~
  50.  
  51. [Include][Area]
  52. [Include][Conditions]
  53. [Include][Edit]
  54. [Include][Menu]
  55. [Include][Order Fields]
  56.  
  57. [Area]
  58.  ~Alt-A~
  59.  Define a new area.  An area is a section of the report file that can be
  60.  identified as being either a Header, Detail, or Footer.
  61.  
  62.  Pressing the Alt-A key displays a highlight bar. Move this bar to the
  63.  beginning of the area you want to define and press ~enter~.
  64.  
  65.  Move the bar up/down to select up to 10 lines that represent the area you
  66.  are defining and press ~enter~.  Note: you can press ~Alt-S~ to switch the
  67.  anchor point.
  68.  
  69.  A dialog box will appear will the following sections:
  70.  
  71.    ~NAME:~
  72.  
  73.      Enter up to 25 characters to represent this area.
  74.  
  75.    ~TYPE:~
  76.  
  77.      Header - Headers are usually sections that contain information that
  78.               precedes multiple detail, header, or footer lines.  In other
  79.               words, each detail, (sub)header, or footer line that follows
  80.               this header "belongs" to this header.  One to Many.
  81.  
  82.      Detail - Detail lines are the lines that usually contain the detail data
  83.               and therefore are usually one to two lines high.  Each
  84.               individual "detail" line on an invoice would be an example.
  85.               If you are going to choose only one "TYPE" choose this one.
  86.               One to One.
  87.  
  88.      Footer - Footers are opposite of headers.  Detail, header, or (sub)footer
  89.               lines that precede this footer have this footer appended.
  90.               Many to One.
  91.  
  92.  Press ~enter~ to accept your choice.  You then move on to defining the
  93.  individual fields.
  94.  
  95. [Include][Fields]
  96. [Conditions]
  97.  ~Alt-C~ Allows you to edit conditions for an area.  Press Alt-C to display
  98.  a dialog box of available areas.  Select the area by highlighting it and
  99.  pressing ~enter~.  Note: The Fields list will be blank since fields don't
  100.  apply.
  101.  
  102.  After selecting the area another dialog box is displayed showing the current
  103.  conditions defined.
  104.  
  105.  ~To add a new condition~ simply type in the condition on the top line.  If
  106.  you don't know the field name press ~Alt-L~ while the cursor is located
  107.  in the first box to display a list of fields.
  108.  
  109.  The second box is the comparison type.  It can be =, >=, <=, =>, =<,
  110.  >, <, or <>.  Notice that <> is the same as saying not equal.
  111.  
  112.  The third box holds the compare value.  It's max length is the same as the
  113.  length of the defined field or the box itself.  Note that if a fields
  114.  attribute is "Time/Date" then a blank and a 0 are different whereas with
  115.  numeric they are the same.
  116.  
  117.  The forth and last box is the connector type.  It can be AND, OR, &, or
  118.  |.  To see how they are used to connect comparisons, heres an example:
  119.  
  120.   FA                       =   1                                    AND
  121.   FB                       =   1                                    AND
  122.  
  123.   evaluates to: FA=1 AND FB=1
  124.  
  125.   FA                       =   1                                    OR
  126.   FB                       =   1                                    AND
  127.  
  128.   evaluates to: FA=1 OR FB=1
  129.  
  130.   FA                       =   1                                    AND
  131.   FB                       =   1                                    OR
  132.   FC                       =   1                                    AND
  133.  
  134.   evaluates to: (FA=1 AND FB=1) OR FC=1
  135.  
  136.   FA                       =   1                                    AND
  137.   FB                       =   1                                    |
  138.   FC                       =   1                                    AND
  139.  
  140.   evaluates to: FA=1 AND (FB=1 OR FC=1)
  141.  
  142.   FA                       =   1                                    AND
  143.   FB                       =   1                                    AND
  144.   FC                       =   1                                    OR
  145.   FD                       =   1                                    AND
  146.   FE                       =   1                                    AND
  147.  
  148.   evaluates to: ((FA=1 AND FB=1 AND FC=1) OR FD=1) AND FE=1
  149.  
  150.   FB                       =   1                                    AND
  151.   FC                       =   1                                    OR
  152.   FD                       =   1                                    &
  153.   FE                       =   1                                    AND
  154.  
  155.   evaluates to: ((FB=1 AND FC=1) OR (FD=1 AND FE=1)
  156.  
  157.   FA                       =   1                                    AND
  158.   FB                       =   1                                    AND
  159.   FC                       =   1                                    |
  160.   FD                       =   1                                    AND
  161.   FE                       =   1                                    AND
  162.  
  163.   evaluates to: FA=1 AND FB=1 AND (FC=1 OR FD=1) AND FE=1
  164.  
  165.   FA                       =   1                                    OR
  166.   FB                       =   1                                    OR
  167.   FC                       =   1                                    &
  168.   FD                       =   1                                    OR
  169.   FE                       =   1                                    OR
  170.  
  171.   evaluates to: FA=1 OR FB=1 OR (FC=1 AND FD=1) OR FE=1
  172.  
  173.   FA                       =   1                                    OR
  174.   FB                       =   1                                    OR
  175.   FC                       =   1                                    AND
  176.   FD                       =   1                                    OR
  177.   FE                       =   1                                    OR
  178.  
  179.   evaluates to: ((FA=1 OR FB=1 OR FC=1) AND FD=1) OR FE=1
  180.  
  181.  ~To modify an existing condition~, Tab to the large box and select the
  182.  condition to modify.  To modify it's contents press enter, make changes and
  183.  press enter again to accept the changes.  To delete it simply press the
  184.  ~Delete~ key.  To move the condition to another location in the box use the
  185.  ~Ctrl~ key along with the up/down cursor keys to drag the condition to the
  186.  new location.
  187.  
  188. [Edit]
  189.  ~Alt-E~
  190.  Allows you to edit conditions for an area.  Press Alt-E to display a dialog
  191.  box.
  192.  
  193. [Include][EditSelect]
  194.  To Choose an area or field, highlight it and press enter.
  195.  
  196. [Include][Fields]
  197. [Fields]
  198.  When you first enter the area to add new fields the block cursor will be
  199.  located in the upper left corner of the area, when you are editing a field
  200.  the cursor will be located on the field and in "paint" mode.  Move the
  201.  cursor to the beginning of the field you want to define and press ~enter~.
  202.  
  203.  Now "paint" the field by moving the cursor left or right, then press ~enter~
  204.  when done. ~Note:~ you may press ~Alt-S~ to switch the anchor point.  You
  205.  may also move the screen up or down by turning on your scroll lock key.
  206.  
  207.  A dialog box will appear will the following sections:
  208.  
  209.    ~NAME:~
  210.  
  211.      Enter up to 25 characters to represent this field.  For numeric fields
  212.      include a .# in the field name to specify the precision.
  213.  
  214.    ~TYPE:~
  215.  
  216.      Condition  - Check this box if you are going to use this field to select
  217.                   conditions for the area.  Note: you will need at least one
  218.                   condition per area as it is used to identify the area.
  219.  
  220.      Data       - Check this box if this field will be exported.
  221.  
  222.      Reverse    - This is only used by numeric fields on export.  If this
  223.                   box is checked then the numeric field is multiplied by
  224.                   -1.
  225.  
  226.      Non Repeat - Some fields may seem like a type of header but is actually 
  227.                   a detail line with some fields that don't repeat on every
  228.                   line.  If this applies to this field, be sure to enable 
  229.                   this option.
  230.  
  231.      Ident      - Short for Identification.  This is a special type of
  232.                   Condition field that can identify a area even if that
  233.                   area doesn't match all of the conditions.  This enables
  234.                   Extract It to suppress detail lines that belong to a
  235.                   header that did not meet the selection criteria.  Note,
  236.                   all Ident fields are connected with AND when the (special)
  237.                   test is made.  Also note, Footers are kept active even
  238.                   if it applies to the suppressed area; they won't be 
  239.                   exported because the detail lines are suppressed.
  240.                   This option is only used with Header areas.
  241.  
  242.    ~ATTRIBUTES:~
  243.  
  244.      Any         - The field is of type string.  Any characters.
  245.  
  246.      Numeric     - The field is numeric.  Any non-numeric characters are
  247.                    ignored.
  248.  
  249.      Time/Date   - Use this type for Date and Time fields.
  250.                      Date formats include:
  251.                        MMDDYY, MM/DD/YY, MM.DD.YY, etc...
  252.                        mmmmmm DD, YY, mmmmmm DD YYYY, etc...
  253.                        DD mmmm YY, DD mmmmm YYYY, etc...
  254.                        MMYY, MM/YY, etc...
  255.                        if YY<10 then year 2000 assumed.
  256.  
  257.                      Time formats include:
  258.                        HHMMSS, HH:MM:SS, etc...
  259.                        HHMM, HH:MM, etc...
  260.                        am is assumed unless p, pm, etc... is found.
  261.  
  262.      City/St/Zip - Use this type for Address Lines.  This causes the field to
  263.                    be exported as multiple fields (3).  You can also use the
  264.                    zip as a condition.  If you enter a condition as a number
  265.                    the zip field will be used otherwise it will be treated
  266.                    as a normal string field.  Note: Foreign zips are not
  267.                    supported.
  268.  
  269.      Name        - Use this type for Names.  This will cause the field to be
  270.                    exported as multiple fields (4), consisting of Sir Name,
  271.                    First Name, Middle Name, Last Name.  If the last name 
  272.                    contains spaces, part of that name will be included with 
  273.                    the middle name.
  274.  
  275.  Press ~enter~ to accept your input.  It returns you the area ready to define
  276.  another field.  Press ~ESC~ when you want to stop.
  277.  
  278. [AreaFieldSelection]
  279.  This Dialog Box is used to select either an Area or Field.  If the Field box
  280.  is empty then you can only select an area, likewise, if the Area box is
  281.  empty then you can only select a field.
  282.  
  283. [Include][EditSelect]
  284. [EditSelect]
  285.  When you choose the option to edit an area or field the Area box will be
  286.  filled with all the area names available and the field box will contain the
  287.  field names of all fields in the currently selected area.
  288.  
  289.  Depending in which box you are in you can press either the ~INS~ or ~DEL~
  290.  key to add or delete an area or field respectively.
  291.  
  292. [Menu]
  293.  ~Alt-M~ Display a pop up menu.  The menu has the following options:
  294.  
  295.    ~Select Input File:~
  296.  
  297.       Use this option to select the ASCII text file/report you want to
  298.       extract the data from.
  299.  
  300.    ~Select Specification File:~
  301.  
  302.       The Spec file is the file you saved which contains the Areas, Fields,
  303.       and Conditions you previously defined.
  304.  
  305.    ~Save Specification File:~
  306.  
  307.       Save the defined Areas, Fields, and Conditions.
  308.  
  309.    ~Export Data Fields:~
  310.  
  311.       This saves the extracted data to a file in standard ASCII delimited
  312.       text format.  To set the order of fields use ~ALT-O~.
  313.  
  314.    ~Options:~
  315.  
  316.       Allows you to choose your own colors and other options.
  317.  
  318.    ~Quit:~
  319.  
  320.        Removes the pop up menu.
  321.  
  322. [InsideOptions]
  323.   ~Export Zip As String~
  324.   Normally the zip is saved as a nine number numeric field, this options
  325.   allows you to have the zip output as a string.
  326.  
  327.   ~Export Time/Date as Numeric~
  328.   Normally Time and Date fields are output as a string.  This option allows
  329.   you to have the Time and Date fields saved as numeric.  Dates are saved
  330.   as YYYYMMDD and Time as XXXXXX.
  331.  
  332.   ~Suppress Repeating Headers~ and ~Suppress Repeating Footers~
  333.   If you exporting the data to be imported into a spreadsheet then you
  334.   probably don't want the header and footer information repeated on every
  335.   line.  This options allows you do just that, but if you're exporting
  336.   for a database then both of these options MUST be OFF (not checked).
  337.   Note: Footers will only be suppressed until that footer is again used.
  338.  
  339.   ~Export Field Names~
  340.   If enabled, this option will output the field names of the first data
  341.   record that will be exported.  In other words the field names become
  342.   the first record and will only contain the field names that compose the
  343.   first ~data~ record.
  344.  
  345.   ~Export Headers w/o Detail~
  346.   Usually if there are no detail records no records are exported.  If
  347.   you would like to export a "short" record with header/footer information
  348.   only, then enable this option.  Usually you would use this when exporting
  349.   for a spreadsheet rather then a database.  Note if the first record output
  350.   does not have any detail fields and ~Export Field Names~ is enabled then
  351.   the field names will be missing for the detail fields.
  352.  
  353.   ~Colors~
  354.   Choose which color you want to change and press ~TAB~.
  355.  
  356. [Order Fields]
  357.  ~ALT-O~
  358.  Order Fields.  This option allows you to choose the order the fields are
  359.  exported within each of the Areas.  To change the order, first highlight
  360.  the Area then press tab to move to the Field box.  Then highlight the
  361.  field you want to move and "drag" it to where you want it by holding down
  362.  the CTRL key while moving the up and down arrows.
  363.  
  364.  Although this option allows you to choose the order of the fields within
  365.  each Area, Header fields will always precede Detail and Footer fields and
  366.  Footer fields will always be last.
  367.  
  368. []
  369.