FTP_Bat README.TXT

Contents:
1.  What is FTP?
2.  What is FTP_Bat?
3.  What are the system requirements?
4.  What should I do before installing the program?
5.  How do I install FTP_Bat?
6.  How do I uninstall it?
7.  What's included in the Evaluation copy?
8.  What are the predefined FTP scripts?
9.  How do I delete the predefined FTP scripts?
10. I have questions and comments.  Who to contact?
11. And yet more Frequently Asked Questions (FAQ) ...

Please see the software license and terms on the FTP_Bat
Main Form's Help 'About...' menu option.

______________________________________________________
1.  What is FTP?

FTP (File Transfer Protocol) is a UNIX standard command set that allows
you to quickly upload or download files to or from a remote computer,
whether the remote computer is a LAN or shared server running under UNIX,
Microsoft NT, Novell, IBM MVS, or whatever.  You direct FTP's actions
with FTP commands that can be entered directly into the FTP window or
entered via an externally stored file and submitted as an FTP script.
See FTP_Bat help file for a complete list and description of the
FTP Commands.

Microsoft 95, 98 and NT come are delivered with a program named FTP.EXE,
which performs the standard file transfer functions, in addition to 
allowing you to launch DOS or Windows jobs directly from the FTP window.


______________________________________________________
2.  What is FTP_Bat?

FTP_Bat is a program that stores and manages your FTP upload and download
scripts.

FTP_Bat allows you to:

  Run FTP jobs via point and click,

  Create your own custom job scripts using the full power and command set
   of your PC's FTP program,

  Use meaningful names for the remote computer (FTP site) and FTP jobs,

  Build your FTP script at the time you run the job, allowing you to select
   User ID, change path and file names, etc.,

  Prompt for password. Your confidential passwords need not be stored in
   the FTP script,

  Define and use your own alias replacement values and user prompts,
   simplifying creation and maintenance of your job script while greatly
   increasing their power and flexibility,

  Run uploads or downloads unattended if desired, using your job scheduler,

  Customize the results of the FTP job, such as printing the document
   or using your text editor or graphics program to immediately display
   the download file. Most FTP executable programs allow you to embed
   DOS commands directly in the FTP script.

FTP_Bat is an FTP script generator for existing FTP executable programs,
and will not run "stand-alone." This allows you to use whichever FTP executable
that best meets your need, giving you full access to its' command set.


______________________________________________________
3.  What is required to install and run the program?

    FTP_Bat is a 32-bit program.  To install and run the program, you need:

    - Windows 95, 98 or NT,

    - 1 MB Hard disk space,

    - An FTP executable that can process FTP scripts.
      FTP_Bat defaults to the Windows 95 or NT FTP.EXE when you run the
      program for the first time, but you can change the executable from
      within FTP_Bat if you wish.


______________________________________________________
4.  What should I do before installing the program?

    FTP_Bat should work fine as delivered, but you may want to verify
    that your FTP executable works with your windows configuration
    and TCP/IP connection.

    1.  Start your FTP executable.
        If you are using Microsoft-supplied program, type

        "FTP.EXE"

        in the Task bar's Start 'Run...' menu option and click OK.

        If you receive the message
        'Cannot find the file FTP.EXE (or one of its components)...',
        - Find the file folder that contains your FTP executable:
          Click on the 'Find'|'Files or folders...' Start menu option, type
          "FTP"
          in the 'Named:' text box, and click 'Find now'.

        - If no files are found, reinstall FTP.EXE from your Windows disk,

        - Type "<FolderName>\FTP.EXE" from the Start 'Run...' menu option.

    2.  Type 'open ftp.microsoft.com' after receiving the ftp> prompt
        in the FTP window.

        If the connection is successful, FTP_Bat should run without a hitch.
        However, if you receive the message

        'Unknown host' or some such,

        - Start your web browser and try again.

        - If you get the same message, contact your Internet Service Provider
          for assistance on running FTP.EXE within their environment.

    3.  Type 'quit' after the ftp> prompt to close the FTP window.


______________________________________________________
5.  How do I install FTP_Bat?

    1.  Open Windows Explorer.

    2.  Create a new folder and copy FTP_Bat.ZIP into this folder.

    3.  Extract the contents of FTP_Bat.ZIP into the new folder.
        You can use WinZip, PKZip, or any ZIP file tool.

    4.  Create a Shortcut and drag it to your desktop.
        - Right-click on FTP_Bat.exe from Windows Explorer,
        - Click 'Create Shortcut' menu option,
        - Rename the new shortcut, and
        - Drag the shortcut to your desktop.


______________________________________________________
6.  How do I uninstall it?

    FTP_Bat does not create any Registry entries or scatter any DLLs
    or any other files around your hard disk.
    To uninstall, simply delete the FTP_Bat folder and all it's contents.
    Then manually delete the shortcut you created.


______________________________________________________
7.  What's included in the Evaluation copy?

    The shareware evaluation copy contains everything in the licensed copy,
    and more!  Included at no cost is the annoying nag notice asking you to
    get a licensed copy.

    Your may
    1.  Evaluate this software for 90 days without charge,
    2.  Give exact copies of the original evaluation version to anyone, and
    3.  Distribute the evaluation version of the software and documentation
        in its unmodified form via electronic meansSee the program's Help
        'About...' menu option for the license and payment terms.

______________________________________________________
8.  What are the predefined FTP scripts?

    FTP_Bat includes several FTP job scripts to get you started and to serve as
    a guide in setting up your own jobs.  While the samples are probably not
    as useful as your own, they do show you how the pieces fit together.

    Certain of the scripts assume that you are running specific
    software, such as MS_Access, or that you have defined file associations
    for .TXT and .GIF files.  No harm will be done if you run the jobs and
    do not have Access or if you do not have the file associations defined,
    as long as you don't get offended by the error message.

    To run the sample jobs, you can just click 'Run' and see what happens.
    A better approach, at least initially, would be to click 'Edit Scripts'
    to see what is being sent to the FTP Executable.  The script contains
    the alias replacement values that were assigned when creating the script,
    and is easier to understand than looking at the detail script with the
    embedded aliases.


______________________________________________________
9.  How do I delete the predefined FTP scripts?
    You can delete the samples after you experiment with them.  Deleting the
    FTP ID will remove the FTP ID, along with all related jobs.

    You can also delete the aliases specific to the script if you do not want
    to use them on your own scripts.

    NOTE: Do not delete all of the predefined scripts until you have entered
    at least one of your own.  Upon deleting the last FTP ID, FTP_Bat will
    recreate the sample scripts ("they're back...").


______________________________________________________
10. I have questions and comments.  Who to contact?

    Forward any problems, comments or suggestions to

    ftpbatty@aol.com.

    We will get back with you as soon as possible.


______________________________________________________
11. And yet more Frequently Asked Questions (FAQ) ...

______________________
Q: Why would I want to use FTP_Bat rather than one of the FTP programs that
   allows me to more easily poke around the FTP site?

A: For one time downloads, or when you want to explore what's available
   on an FTP site, the other widely-available programs are probably a
   better fit.  FTP_Bat is more useful when you need to run recurring
   uploads or downloads, a facility not widely available in the other
   products.  Further, FTP_Bat allows you to perform a whole bunch of
   custom processes in one stream, such as downloading several files
   and opening them sequentially in your text or graphics editor.

______________________
Q: Why does FTP_Bat use external FTP programs rather than building the
   capability directly into the program?

A: The external FTP programs, such as Microsoft's FTP.EXE, are built to
   work with different versions of Windows, using different releases
   of winsock, etc.  Using an external FTP reduces the dependence with
   the operating system and its' components, better assuring that future
   changes don't result in a busted process.


______________________
Q: FTP_Bat uses FTP commands to make things happen.  Does this mean I need
   to learn more cryptic computereze?

A: FTP commands are rather intuitive, and are completely documented in the
   help system.  Several examples, though rather trivial, are included with
   the program, and can be cloned to do what you really need done.

   Using the FTP commands delivered with your Operating system's FTP program
   or its replacement allows you to truly customize your processes, rather
   than being tied to the predefined functionality of the all-in-one
   FTP programs that are available.


______________________
Q: Why would I use aliases when I can directly type in the value I need?

A: Using aliases
   - lets you create FTP scripts that prompt for replacement values each
     time you run the job.  This greatly enhances the power and
     flexibility of your scripts,

   - allows you to define long or frequently used strings.

     Example 1: the FTP site public directory name is 50-characters long.
     Creating an alias (i.e., 'Pub') will greatly shorten the size of your
     scripts, and simplify future changes.

     Example 2: you want your output to always go to the same folder.
     Define the folder as an alias and include the alias name in your 
     script.  If you decide later to move all downloads to a different
     folder, you only need to change the replacement value, and all
     scripts will use this new folder.

______________________
Q: I use a lot of aliases. Evaluating the script can be difficult, requiring
   me to swap back and forth between the script detail and alias page.
   Is there an easier way to see how the script will be translated?

A: Your script detail page can become rather cryptic if you use a bunch of aliases.
   You can easily see what the final result will look like by clicking the
   main form's 'Edit script' button rather than going through the Setup form.
   After reviewing the fully evaluated script that is displayed, you can click
   'Cancel' to return to the main form, or 'Run' to launch the FTP script.

   Reminder: changes you make in the 'Edit script' form are used in the current
   run only, and are not saved.  Permanent changes must be made on the Setup form.

______________________
Q: Our company uses the UNIX version of PeopleSoft payroll.
   The Payroll department runs a standard set of 25 reports after each
   payroll.  The UNIX reports, stored in '/stage/ps/output',
   are are always assigned the same name, thus over-writing the last
   pay period's reports.
   
   How can we archive the pay period reports to the 'm:\reports' folder
   on our Windows NT server, using the unique 3-character 'Pay Run ID'
   that is used for each payroll cycle as the file extension?
   This would allow us to save each week's report separately rather
   than having them overlay each other.

A: Such archiving can be done quite simply.
   1.  Add an FTP ID for the UNIX machine on which the reports live,
   2.  Create an alias, such as 'ext' with a replacement value of
       ':Enter pay run ID',
   3.  Add a Job Name for the FTP ID, such as 'Standard Reports',
   4.  Create the detail script to look something like:

       cd /stage/ps/output
       lcd m:\reports
       get report1.txt report1.<ext>
       get report2.txt report2.<ext>
       ...
       get report25.txt report25.<ext>

       You will be prompted with 'Enter pay run ID' when you run the job.
       The value you enter will be applied to each report.

   As an alternative, you could use one of the many date functions
   available as the extension.  Thus,

   get report1.txt report1.<date,#Y>

   will save the file as report1.365 if you ran it on December 31.
   See '<Date,qualifiers>' Help for other date options.

______________________
Q: Our company runs Oracle Financial applications on UNIX.
   Oracle reports are run through the Oracle concurrent manager,
   which assigns a unique internal request number to each report.
   Reports are stored in the '/prod/oracle/output' directory of
   the UNIX server using the user ID (in upper case) and the
   concurrent manager request number (such as, MYUSERID.12345).
   How can I create a job that will pull down this file and display it?

A: Again, aliases to the rescue. Just follow these steps:
   1.  Add an FTP ID for the UNIX server such as 'Oracle Financials',
   2.  Add a Job Name for the FTP ID, such as 'Production Report',
   3.  Create the detail script to look something like:

       lcd c:\temp
       get /prod/oracle/output/<USERID>.<:Enter concurrent process ID>
       ! notepad <USERID>.<:Enter concurrent process ID>

       You will be prompted with 'Enter concurrent process ID'
       when you run the job.  If you enter 12345, and 'myid' is selected
       on the main form's 'User ID' combo box, the following will be
       sent to your FTP engine:

       lcd c:\temp
       get /prod/oracle/output/MYID.12345
       ! notepad MYID.12345
       

       Note the following:
       - The output file has the same name as the download file in this
         example.  You can name the output file anything you want
         by entering the destination name in the get statement, such as

         lcd c:\temp
         get /prod/oracle/output/<USERID>.<:Enter concurrent process ID> my.txt
         ! notepad my.txt
         
       - using all caps for <USERID> will force the FTP script value
         to capital letters, regardless of its case on the main menu 'User ID'
         combo box (where it gets the replacement value).

       - a prompt alias was created on the fly.  This is fine if you do not
         anticipate using that alias in any other script.
         However, if you wanted a like script to download Log files, or files
         written to a different directory, or whatever, it may be better
         to create an alias on the alias page, such as Alias name 'ID' with a
         replacement value of <:Enter concurrent process ID>.  Then you could
         rewrite the script to:

         lcd c:\temp
         get /prod/oracle/output/<USERID>.<ID>
         ! notepad\<USERID>.<ID>

       - the last line of the script will open the downloaded file in notepad 
         (the ! character is the MS FTP.EXE designation for a DOS command).
         You can eliminate 'notepad ' if you have an Windows file extension
         association already set up.  This is not likely if the <ID> changes
         with each run.  However, if the returned file was 'my.txt',
         then '! my.txt' would open my.txt in your editor.


______________________
Q: I have an FTP_Bat job that is similar to another that I want to create.
   How can I copy it?

A: You can cut and paste from an existing Job Name.
   Go to the Script Detail page on the Setup form.  Then
   1.  Select the script you want to copy
       (set Upload/Download radio button, FTP ID and Job Name),
   2.  Click on FTP Commands memo box,
   3.  Select (highlight) all text in FTP Commands memo box.
   4.  Right click the mouse and select 'Copy',
   5.  Click on Job Name,
   6.  Right click and select 'Add',
   7.  Type your new Job Name,
   8.  Click on FTP Commands,
   9.  Right click on mouse and select 'Paste'.
   You can now change the command as needed.

______________________
Q: I do a lot of software development on our mainframe.
   How can FTP_Bat help?

A: FTP_Bat will allow you to combine the best tools from
   both environments.  For example, if you prefer your
   PC editor to that on the remote system, and you are writing
   a program on the remote computer that creates a report,
   you can create an upload FTP_Bat script to upload your
   program, and a download FTP_Bat script to download
   and display your report.
   Then,
   1.  Use upload script to send your program to the mainframe.
   2.  Compile your program.
       - If successful, go to step 3,
       - else change program on your PC editor, and go to step 1.
   3.  Run report program on mainframe.
   4.  Use download script to receive and display your report.
       - If satisfactory, take the rest of the day off,
       - else change program on your PC editor, and go to step 1.
       
   As you can see above, FTP_Bat can be used as a simple tool to
   toggle between the two environments, allowing you to use the
   best tools to get the job done.
