Clarify when the automated configuration/import script should be used

Change-Id: I837d2b87728f13b552e9a13547467b5680789ca8

Documentation/AutomatedVistAConfiguration.rst

@@ -6,6 +6,13 @@ been automated. The automated import and configuration scripts are configured
 and prepared during the setup of the VistA repository after selecting the
 TEST_VISTA_FRESH_ option.
 
+First, the ImportRG script executes the script described in
+`Generate Import Files`_.
+
+Next, it executes scripts that mirror the steps for the Caché and GTM importing
+process that can be found at ImportCache_ and ImportGT.M_. The ImportRG script
+will introduce the same codebase into the database as the the manual processes.
+
 To execute the automated import and configuration via the command line, execute
 the following steps from a gitbash (Windows) or linux shell:
 
@@ -16,11 +23,6 @@ the following steps from a gitbash (Windows) or linux shell:
   $ cmake -P Testing/Setup/ImportRG.cmake
 
 
-Note: The manual steps for the Caché and GTM importing process can be found at
-ImportCache_ and ImportGT.M_. The ImportRG script runs files that mirror these
-scripts and will introduce the same codebase into the database.
-
-
 Automated VistA Setup
 =====================
 
@@ -35,6 +37,7 @@ ImportRG script, three additional setup scripts are executed automatically:
    ClinicSetup.py                  Sets up a clinic for appointment scheduling
 =============================  ================================================================
 
+.. _`Generate Import Files`: PrepareMComponents.rst#generate_import_files
 .. _TEST_VISTA_FRESH: SetupTestingEnvironment.rst#test_vista_fresh-and-test_vista_setup
 .. _ImportCache: ImportCache.rst#retrieving-the-code-from-git-and-importing-into-cach
 .. _ImportGT.M: ImportGTM.rst#retrieving-the-code-from-git-and-importing-into-gtm

Documentation/ObtainingVistAMCode.rst

@@ -5,7 +5,7 @@ Obtaining the VistA-M Source Code
     :class: usertype
 
 We need to retrieve the VistA-M source code (MUMPS code) that will be used to
-populate Caché or GTM  and generally construct the local VistA environment.
+populate Caché or GTM and generally construct the local VistA environment.
 Begin by bringing up a Git Bash terminal from the installed Git system.
 
 .. parsed-literal::
@@ -66,3 +66,29 @@ repository code and "cd" into that directory. Enter the commands
   $ :usertype:`cd VistA-M`
 
 to make a local clone of the remote repository.
+
+
+Modify Source Files
+-------------------
+
+The following step is only required for InterSystems Caché Single-User or small
+license count licenses:
+
+Edit `ZU.m`_,  located in /Packages/Kernel/Routines/, and comment out the code
+followed by JOBCHK tag by placing a semi-colon (;) right after JOBCHK tag.
+
+.. parsed-literal::
+
+  JOBCHK :usertype:`;` I $$AVJ^%ZOSV()<3 W $C(7),!!,"\*\* TROUBLE \*\* - \*\* CALL IRM NOW! \*\*" G H
+
+Similarly, edit `ZUONT.m`_, also located in /Packages/Kernel/Routines/, and comment out the following code.
+
+.. parsed-literal::
+
+   :usertype:`;` I $$AVJ^%ZOSV()<3 W $C(7),!!,"\*\* TROUBLE \*\* - \*\* CALL IRM NOW! \*\*" G HALT
+
+Note: If somehow ZU.m does not exist, it is OK to just make change to ZUONT.m.
+
+
+.. _ZUONT.m: http://code.osehra.org/gitweb?p=VistA-M.git;a=blob;f=Packages/Kernel/Routines/ZUONT.m
+.. _ZU.m: http://code.osehra.org/gitweb?p=VistA-M.git;a=blob;f=Packages/Kernel/Routines/ZU.m

Documentation/PrepareMComponents.rst

@@ -7,24 +7,6 @@ Prepare M source for Import into instance
 To acquire the VistA-M source tree, follow the instructions in
 ObtainingVistAMCode_
 
-The following step is only required for InterSystems Caché Single-User or small
-license count licenses:
-
-Edit `ZU.m`_,  located in /Packages/Kernel/Routines/, and comment out the code
-followed by JOBCHK tag by placing a semi-colon (;) right after JOBCHK tag.
-
-.. parsed-literal::
-
-  JOBCHK :usertype:`;` I $$AVJ^%ZOSV()<3 W $C(7),!!,"\*\* TROUBLE \*\* - \*\* CALL IRM NOW! \*\*" G H
-
-Similarly, edit `ZUONT.m`_, also located in /Packages/Kernel/Routines/, and comment out the following code.
-
-.. parsed-literal::
-
-   :usertype:`;` I $$AVJ^%ZOSV()<3 W $C(7),!!,"\*\* TROUBLE \*\* - \*\* CALL IRM NOW! \*\*" G HALT
-
-Note: If somehow ZU.m does not exist, it is OK to just make change to ZUONT.m.
-
 Within the VistA-M source tree, there is a Packages folder which contains all of
 the VistA M components divided by package name. Inside each package directory
 lies a 'Routines' directory and a 'Globals' directory. The 'Routines' directory
@@ -53,7 +35,5 @@ the extension \'.zwr\' and write the file location of those globals in a file
 called 'globals.lst'. This 'globals.lst' will be read by the OSEHRA ZGI routine
 during a later import step.
 
-.. _ZUONT.m: http://code.osehra.org/gitweb?p=VistA-M.git;a=blob;f=Packages/Kernel/Routines/ZUONT.m
-.. _ZU.m: http://code.osehra.org/gitweb?p=VistA-M.git;a=blob;f=Packages/Kernel/Routines/ZU.m
 .. _`VistA Testing Source Repository`: http://code.osehra.org/VistA.git
 .. _`ObtainingVistAMCode`: ObtainingVistAMCode.rst

Documentation/README.rst

@@ -51,11 +51,10 @@ other auxiliary programs:
   * ObtainingTestingCode_
 
 If the VistA instance to be generate is going to be imported from the OSEHRA
-VistA-M repository, see the two following files for instructions on obtaining
-and preparing the M code for import:
+VistA-M repository, see the following file for instructions on obtaining and
+preparing the M code for import:
 
  * ObtainingVistAMCode_
- * PrepareMComponents_
 
 For the next sections, follow the instructions based upon which type of
 MUMPS database will be utilized for the VistA installation:
@@ -75,8 +74,13 @@ Caché
 
         * InstallCacheDat_
 
-        Alternatively, for the instructions to import the MUMPS code from the
-        OSEHRA VistA-M Repository into a Caché instance, see:
+        Alternatively, it is possible to import the MUMPS code from the OSEHRA
+        VistA-M Repository into a Caché instance. To use OSEHRA's automated
+        import and configuration scripts, see:
+
+        * AutomatedVistAConfiguration_
+
+        Instructions for the manual import process are found here:
 
         * ImportCache_
 
@@ -91,7 +95,12 @@ GT.M
 
   * InstallGTM_
 
-  And to import the OSEHRA VistA-M code into the GT.M environment, see
+  To use OSEHRA's automated import and configuration scripts to import the
+  OSEHRA VistA-M code into the GT.M environment, see:
+
+  * AutomatedVistAConfiguration_
+
+  Instructions for the manual import process are found here:
 
   * ImportGTM_
 
@@ -110,12 +119,6 @@ OSEHRA Dashboard, for more information see:
 
   * ReviewingResults_
 
-The import and simple configuration of the M components of VistA has been
-automated. See the following file for the information needed to set up this
-utility.
-
-  * AutomatedVistAConfiguration_
-
 For initialization and setup of an imported VistA instance (general setup and
 adding a user)  without using the OSEHRA Utilities, see:
 
@@ -196,7 +199,6 @@ directory and includes:
 .. _AddingTests: AddingTests.rst
 .. _ReviewingResults: ReviewingResults.rst
 .. _AutomatedVistAConfiguration: AutomatedVistAConfiguration.rst
-.. _PrepareMComponents: PrepareMComponents.rst
 .. _Initialization: Initialization.rst
 .. _Vagrant: http://www.vagrantup.com
 .. _Overview: Install/Vagrant.rst

Documentation/generateViViaNAndDox.rst

@@ -85,33 +85,33 @@ OSEHRA VistA
 ++++++++++++
 
 If the desired version of VistA to generate ViViaN and the Dox pages from is
-the OSEHRA version, clone https://github.com/OSEHRA/VistA-M and follow the
-instructions from `PrepareMComponents`_. Next, follow the instructions below
-based upon which type of MUMPS database will be utilized for the VistA
-installation:
+the OSEHRA version, see ObtainingVistAMCode_ to obtain the source code. Next,
+follow the instructions below based upon which type of MUMPS database will be
+utilized for the VistA installation:
 
 Caché
 ~~~~~
 If necessary, OSEHRA has compiled a set of instructions on how to install the
 Caché instance: InstallCache_.
 
 To import the MUMPS code from the OSEHRA VistA-M Repository into a Caché
-instance, see ImportCache_.
+instance, see `Automated VistA Configuration`_.
 
 Instructions for additional configuration of the Caché environment can be
 found here: ConfigureCache_.
 
 GT.M
 ~~~~
-To import the OSEHRA VistA-M code into the GT.M environment, see ImportGTM_.
+To import the OSEHRA VistA-M code into the GT.M environment, see
+`Automated VistA Configuration`_.
 
 Other VistA
 +++++++++++
 
 To generate ViViaN and the DOX pages with a different VistA setup, such as a
 FOIA release or release from another vendor, the routines and globals will need
 to be placed into the structure of the VistA-M repository. See
-`Prepare M Repository`_ for instructions on how to populate the VistA-M
+`Populate M Repository`_ for instructions on how to populate the VistA-M
 repository from an installed MUMPS environment.
 
 
@@ -443,12 +443,10 @@ favorite web browser.
 
 .. _WampServer: http://www.wampserver.com/en/
 .. _ICR: http://foia-vista.osehra.org/VistA_Integration_Agreement
-.. _`Prepare M Repository`: ./populateMRepo.rst
-.. _`PrepareMComponents`: PrepareMComponents.rst
+.. _`Populate M Repository`: ./populateMRepo.rst
 .. _InstallCache: InstallCache.rst
-.. _ImportCache: ImportCache.rst
 .. _ConfigureCache: ConfigureCache.rst
-.. _ImportGTM: ImportGTM.rst
+.. _`Automated VistA Configuration`: AutomatedVistAConfiguration.rst
 .. _`M Routine Analyzer`: https://github.com/jasonli2000/rgivistatools/tree/fileman_json
 .. _`google_code_prettify`: https://github.com/google/code-prettify
 .. _xlrd: https://pypi.python.org/pypi/xlrd