implemented functionality for ht sandbox
[eq/.git] / doc / install.txt
1
2 3rd Counselor Installation Guide
3
4 Alan Pippin <apippin@pippins.net>
5
6    v1.0, 05 Jan 2008
7    
8    Steps for installing 3rd Counselor app
9    _________________________________________________________________
10    
11 Getting and Installing
12
13 Downloading
14
15    Can be downloaded from:
16    http://github.com/apippin/3rd/downloads
17
18    It can also be obtained via the GIT revision control system by pulling from here:
19    (ssh)               git@github.com:apippin/3rd.git
20    (http)              https://owenleonard@github.com/apippin/3rd.git
21    (git - read-only)   git://github.com/apippin/3rd.git
22
23 Dependencies
24
25    phpgroupware
26    mysql
27    apache (or equivalent webserver)
28    MLS data dumps (required fields shown below)
29    Python 2.6 or .Net 3.5 (for trimming MLS data dumps)
30
31 Installing
32
33    1) Download the tgz or zip file and extract it or GIT pull the archive into 
34       your base phpgroupware directory (like /usr/share/phpgroupware/).
35    2) Setup the mysql table structures for the 3rd Counselor application:
36       mysql -u <dbuser> -p <dbpass> < tc/sql/tc.sql
37    3) Point your browser to: http://www.yourdomain.com/phpgroupware/setup 
38       The setup prog will autodetect this application. From there you will 
39       need to assign this app to the users you want to have be able to use it.
40       Enable it for each user by going to Site Admin -> User Accounts -> <username> -> edit
41       Make sure the "tc" application has a checkmark next to it under "Permissions this user has"
42    4) Copy the setup/db_config to setup/db_config.local and change the values in .local appropriately. 
43       Check for syntax errors by running eq/bin/check_config_syntax
44    5) Copy the setup/tc_config to setup/tc_config.local and change the values in .local appropriately.
45       Make sure you update the path locations for your specific installation locations: 
46       upload_target_path & application_path
47       Check for syntax errors by running tc/bin/check_config_syntax
48    6) Try to run tc/bin/import_ward_data & parse_ward_data scripts from the commandline
49       to check for any missing perl library dependencies and mysql connection. 
50       Just run them without command line args.
51       Install the right perl modules until the scripts run without any errors.
52    7) A graphical representation of the mysql schema used by this application can 
53       be found here: tc/sql/tc.jpg
54    8) Run mls/mlstrimmer.py or MLSFileTrimmer.exe to trim down the csv files and combine them
55       into a zip file.  If you run mls/mlstrimmer.py, you'll need to point it to 
56       mls/windowsGUI/MLSFileTrimmer/MLSRequiredFields.xml.  If you choose to not use 
57       EQ\ Prospective\ Elders.mls or Home\ Teacher\ per\ Companionship.mls, you'll need to 
58       remove them from MLSRequiredFields.xml (probably best to just comment them out in case you
59       decide to use them later)
60    8) Click on the Admin tool in the 3rd Counselor app to import your initial set of ward data
61       obtained from MLS.
62    9) Click on the Admin tool and update the Presidency Table appropriately.
63       The most important thing at this point is to get your district leaders added 
64       for each district you have in your quorum.
65   10) I highly recommend installing phpmyadmin to view/edit/debug mysql tables related to this tool.
66   11) If you need to start with a clean slate and drop all the tc_ tables, you can do it this way:
67       mysql -u phpgroupware -pphpgroupware phpgroupware -e "show tables" | grep "tc_" | gawk '{print "drop table " $1 ";"}' | mysql -u phpgroupware -pphpgroupware phpgroupware
68
69 Requirements
70
71    The following csv files must be obtained from MLS (or a stripped down version
72    of each csv with the fields indicated must be manually created). These files
73    should be placed in 1 .zip file and uploaded to the application via the Admin
74    section of the application.
75
76    Membership.csv:
77      Preferred Name
78      Household Phone
79      Indiv ID
80      HofH ID
81      Street 1
82      Street 2
83      Full Name
84      Priesthood
85      HH Position
86      Household E-mail
87      Individual E-mail
88     
89    Hometeaching.csv:
90      Home Teacher 1
91      Home Teacher 2
92      Comp ID
93      HT District
94      Household
95      Quorum
96      Supervisor
97        
98    Organization.csv:
99      Indiv ID
100      Indiv Name
101      Organization
102      Position
103      Org Seq
104      Sustained
105    
106    Organization class per member.csv
107       File that contains information about which organization classes each member belongs to.
108       We use this to determine the prospective elders assigned to HP or EQ.
109       import mls/Organization\ class\ per\ member.mls as a new report into MLS to create the csv file.
110
111    Home Teacher per Companionship.csv  (optional file that lists home teaching stats - use all fields)
112      import mls/Home\ Teacher\ per\ Companionship.mls as a new report into MLS to create the csv file.
113