Skip to content

Commit c165209

Browse files
authored
Update README.md (#670)
* Update README.md * Adds more to readme
1 parent e3ab895 commit c165209

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,9 @@ To seed data:
4747
1. `docker-compose exec web bash`
4848
2. `PARTNER={parter} bundle exec rake db:seed:essential`
4949

50+
**_Note:_** For new devs you may need to add their `Author` and `Admin` records manually. Alternatively, you can comment out the `MockUniversityDirectory` line
51+
in `config/initializers/autoload_constants.rb` for the development environment. Then proceed to the admin and author routes to automatically create the records with LDAP.
52+
5053
You're good to go from here! Any changes made in the project files on your local machine will automatically be updated in the container. Run `make restart` to restart the puma server if changes do not appear in the web browser. Remember to check the Makefile for more commands. If you are running a shell in the web container, you can run all of the rails commands you would normally use for development: ie `rspec, rails restart, rails c, etc.`
5154

5255
## Testing
@@ -61,7 +64,7 @@ You're good to go from here! Any changes made in the project files on your loca
6164
1. `RAILS_ENV=test PARTNER=milsch bundle exec rspec --tag milsch`
6265
1. `RAILS_ENV=test PARTNER=honors bundle exec rspec --tag honors`
6366

64-
Additionally, there are some component tests that run against Penn State's LDAP directory service: rspec --tag ldap. Ldap tests are excluded because they require connecting to the University LDAP server and should only be run occasionally. When in development or testing, you must edit the development.rb or test.rb file in config/environments and change MockUniversityDirectory to LdapUniversityDirectory to test a true ldap call.
67+
Additionally, there are some component tests that run against Penn State's LDAP directory service: rspec --tag ldap. Ldap tests are excluded because they require connecting to the University LDAP server and should only be run occasionally. When in development or testing, you must edit the `config/initializers/autoload_constants.rb` file and comment out the `MockUniversityDirectory` lines for the development and test environments to allow a true ldap call.
6568

6669
## Deployment instructions
6770

@@ -73,7 +76,7 @@ To initiate a production deploy, create a new release. Then, merge the automatic
7376

7477
## LionPATH Integration
7578

76-
Student program and committee information is imported daily from LionPATH. The integration runs on a cron job that kicks off at 3am. There are five tables/resources updated in ETDA by this daily import: Submission, Program, CommitteeMember, CommitteeRole. The import works in the following order:
79+
Student program and committee information is imported daily from LionPATH. The integration runs on a cron job that kicks off at 3am. There are 4 tables/resources updated in ETDA by this daily import: Submission, Program, CommitteeMember, CommitteeRole. The import works in the following order:
7780

7881
1. Committee Roles for The Graduate School's Dissertation submissions are imported. This updates the CommitteeRole table with changes and/or new committee roles. These roles exactly reflect the roles in LionPATH and are different from Master's Thesis roles.
7982

@@ -88,3 +91,9 @@ The LionPATH integration uses sftp to pull CSV dumps of the Committee Roles, Stu
8891
Committee Roles: PE_SR_G_ETD_ACT_COMROLES
8992
Student Program Information: PE_SR_G_ETD_STDNT_PLAN_PRC
9093
Committees: PE_SR_G_ETD_COMMITTEE_PRC
94+
95+
After each run of this import, `Submission` and `CommitteeMember` records imported from LionPATH are checked to see if they should be deleted. Any `Submission` still at the collecting program information stage that has not been updated by LionPATH in the last two days will be deleted. Any `CommitteeMember` that is not external to PSU, not a program head, not associated with a `Submission` beyond the final submission review stage, and hasn't been updated by LionPATH in two days will also be deleted. There is a failsafe that stops the deletion if more than 10% of records are being deleted.
96+
97+
## Graduate School Fee
98+
99+
Master's Thesis and Dissertation submissions require a fee to be paid in the Graduate School's systems before students can proceed with submission of their final submission. The eTD system checks this via a webservice endpoint in the Graduate School's systems and blocks users from proceeding if the fee is not paid. This functionality is turned off in development and QA environments. The logic to determine if the code is running in one of these environments can be found in `config/environment.rb`.

0 commit comments

Comments
 (0)