﻿*******************************************************************************
*                BioCTS for AN-2011 Command Line Interface                    *
*******************************************************************************

BioCTS for AN-2011 Command Line Interface (CLI) has 4 Modes of Operation:

  - Interactive: The user runs the CLI and provides Input and Output
                 information, as well as output options from within the CLI.
  - Single File: The user provides a file as input, an output directory, as
                 well as output options from the command prompt.
  - Batch File:  The user provides a directory as input, an output directory, 
                 as well as output options from the command prompt. This will
                 test all files within the input directory.
  - Recursive Batch File: The user provides a directory as input, an output
                          directory, as well as output options from the
                          command prompt. This will test all files within
                          the input directory, and all sub directories.

BioCTS for AN-2011 CLI Flags:

  -t  Generates a text log upon running.
  -x  Generates an XML log upon running.
  -r  Recursively searches directories for files to test.
  -f  Forces the creation of the output directory.
  -h  Displays help.
  -o  Sorts the log files into pass/fail directories.
  -c  Copies and sorts the input files into pass/fail directories.

CLI Syntax:
  AN2K11CL.exe <flags> <source directory> <destination directory>

Examples:

  Interactive:
    AN2K11CL.exe
      Follow the on screen instructions.

  Single File:
    Generate Text and XML Output:
      AN2K11CL.exe -x -t C:\Input\Test00.an2 C:\Output
    Generate XML Output Only:
      AN2K11CL.exe -x C:\Input\Test00.an2 C:\Output
    Generate Text Output Only:
      AN2K11CL.exe -t C:\Input\Test01.an2 C:\Output

  Batch File:
    Generate Text and XML Output:
      AN2K11CL.exe -x -t C:\Input C:\Output
    Generate XML Output Only:
      AN2K11CL.exe -x C:\Input C:\Output
    Generate Text Output Only:
      AN2K11CL.exe -t C:\Input C:\Output

  Recursive Batch File:
    Generate Text and XML Output:
      AN2K11CL.exe -x -t -r C:\Input C:\Output
    Generate XML Output Only:
      AN2K11CL.exe -x -r C:\Input C:\Output
    Generate Text Output Only:
      AN2K11CL.exe -t -r C:\Input C:\Output

Understanding the Log Outputs:
  The logs generated will follow a similar syntax for test assertion results.
  Anatomy of a Result: Each Result is made up of 4 components:
    - Name: A string representation of the test name.
    - Level: Parse, L1, L2, or L3
    - Message: Any additional information that was provided.
    - Result: Ok, Message, Warning, Error, CriticalError.

  XML Log:
    <Results>
      <Level>Parse</Level>
      <Message />
      <Results>Ok</Results>
      <Test>Data Present</Test>
    </Results>

  Text Log:
    Follows the syntax of:
      Level Name Message - Result
    Example:
      • Parse Data Present - Test Result = Ok