adding msi so you don't have to build to use MLSFileTrimmer.exe

[eq/.git] / doc / install.txt

diff --git a/doc/install.txt b/doc/install.txt
index 4521caabe09dbc98bf5eb13daaf2e4c16a683d35..284da64769fb3f82c4b75359c8535312ebed196b 100644 (file)
--- a/doc/install.txt
+++ b/doc/install.txt
@@ -13,10 +13,18 @@ Getting and Installing
 Downloading
 
    Can be downloaded from:
-   https://eq.pippins.net/eq.tar
+   https://eq.pippins.net/eq.zip
 
    It can also be obtained via the GIT revision control system by pulling from here:
-   http://git.pippins.net/eq/
+   http://git.pippins.net/eq/.git
+
+Dependencies
+
+   phpgroupware
+   mysql
+   apache (or equivalent webserver)
+   MLS data dumps (required fields shown below)
+   Python 2.6 or .Net 3.5 (for trimming MLS data dumps)
 
 Installing
 
@@ -29,40 +37,51 @@ Installing
       need to assign this app to the users you want to have be able to use it.
       Enable it for each user by going to Site Admin -> User Accounts -> <username> -> edit
       Make sure the "eq" application has a checkmark next to it under "Permissions this user has"
-   4) Edit the LOCAL CONFIGURATION section of eq/inc/class.eq.inc.php
-      Make sure you update the path locations for your specific:
-      upload_target_path & script_path
-   5) Edit the GLOBALS section of the eq/bin/import_ward_data script and fix the permissions
-   6) Edit the GLOBALS section of the eq/bin/parse_ward_data script and fix the permissions
-   7) Try to run eq/bin/import_ward_data & parse_ward_data scripts from the commandline
+   4) Copy the setup/db_config to setup/db_config.local and change the values in .local appropriately. 
+      Check for syntax errors by running eq/bin/check_config_syntax
+   5) Copy the setup/eq_config to setup/eq_config.local and change the values in .local appropriately.
+      Make sure you update the path locations for your specific installation locations: 
+      upload_target_path & application_path
+      Check for syntax errors by running eq/bin/check_config_syntax
+   6) Try to run eq/bin/import_ward_data & parse_ward_data scripts from the commandline
       to check for any missing perl library dependencies and mysql connection. 
       Just run them without command line args.
       Install the right perl modules until the scripts run without any errors.
-   8) A graphical representation of the mysql schema used by this application can 
+   7) A graphical representation of the mysql schema used by this application can 
       be found here: eq/sql/eq.jpg
-   9) Click on the Admin tool in the EQ app to import your initial set of ward data
+   8) Run mls/mlstrimmer.py or MLSFileTrimmer.exe to trim down the csv files and combine them
+      into a zip file.  If you run mls/mlstrimmer.py, you'll need to point it to 
+      mls/windowsGUI/MLSFileTrimmer/MLSRequiredFields.xml.  If you choose to not use 
+      EQ\ Prospective\ Elders.mls or Home\ Teacher\ per\ Companionship.mls, you'll need to 
+      remove them from MLSRequiredFields.xml (probably best to just comment them out in case you
+      decide to use them later)
+   8) Click on the Admin tool in the EQ app to import your initial set of ward data
       obtained from MLS into the EQ application.
-  10) Click on the Admin tool and update the EQ Presidency Table appropriately.
+   9) Click on the Admin tool and update the EQ Presidency Table appropriately.
       The most important thing at this point is to get your district leaders added 
       for each district you have in your quorum.
-  11) I highly recommend installing phpmyadmin to view/edit/debug mysql tables related to this tool.
+  10) I highly recommend installing phpmyadmin to view/edit/debug mysql tables related to this tool.
 
 Requirements
 
    The following csv files must be obtained from MLS (or a stripped down version
    of each csv with the fields indicated must be manually created). These files
-   should be placed in 1 .zip file and uplodaed to the application via the Admin
+   should be placed in 1 .zip file and uploaded to the application via the Admin
    section of the EQ Tools application.
 
    Membership.csv:
      Preferred Name
-     Phone 1
+     Household Phone
      Indiv ID
      HofH ID
      Street 1
      Street 2
      Birth
      Full Name
+     Priesthood
+     HH Position
+     Household E-mail
+     Individual E-mail
     
    Hometeaching.csv:
      Home Teacher 1
@@ -70,6 +89,8 @@ Requirements
      Comp ID
      HT District
      Household
+     Quorum
+     Supervisor
        
    Organization.csv:
      Indiv ID
@@ -79,3 +100,11 @@ Requirements
      Org Seq
      Sustained
    
+   EQ Prospective Elders.csv  
+      Optional file that lists the prospective elders for which  the EQ has stewardship.
+      Use this file if you want them listed in the PPI/attendence/etc lists
+      import mls/EQ\ Prospective\ Elders.mls as a new report into MLS to create the csv file.
+
+   Home Teacher per Companionship.csv  (optional file that lists home teaching stats - use all fields)
+     import mls/Home\ Teacher\ per\ Companionship.mls as a new report into MLS to create the csv file.
+