Contributed by LA CaTS
Objectives:
To create a funding module that is only accessible to funding admins. The landing page should list all the existing funding opportunities provided by funding organizations with a link to the Download Documents page, where funding admins can view a complete list of ‘Application’ or ‘Pre-Application/LOI’ documents uploaded by applicants for the selected opportunity and/or download the documents of choice.
Terminology
Funding admins – users with access to the funding module.
Funding organizations – Organizations created in SPARC Catalog Manager that offer funding opportunities as services.
Funding statuses – statuses that should only be checked by funding organizations. Current statuses include:
Application Accepted |
Deadline Missed (Application)* |
Application Rejected* |
Application Submitted |
Pre-Application/LOI Accepted |
Deadline Missed (Pre-Application/LOI)* |
Pre-Application/LOI Rejected* |
Pre-Application/LOI Submitted |
* indicates finished statuses
Features:
1. Click on the “SPARCFunding” button in top navigation bar.
2. A complete list of funding opportunities (i.e., services provided by all funding organizations) is displayed. Selection ‘Download Documents’ in the Action column for desired opportunity.
Funding Opportunities Page details:
Available columns: Opportunity (SPARC service name), Program (service SPARC program home), Created (when the service was created in SPARC) and Action (download documents).
All columns but Action are sortable. List is sorted by created date in descending order on page load.
3. On the Document Download page for the selected service (opportunity).
-Tabs: Pre-application/Letter of Intent and Application
Default selection is Pre-application/Letter of Intent
-Document table – per document per row; sortable (default sorting by SRID)
Columns are:
SRID
Primary PI (Last, First name)
Institution (Abbrev.)
Protocol Short Title – links to Admin Edit page
Document – click to download
Uploaded – document uploaded datetime
SSR Status
Actions - links to Dashboard Protocol page and Admin Edit page.
All columns except Protocol Short Title and Document are sortable.
4. Funding Admins can make any status changes in Admin Edit for SSRs associated with the funding organizations.
Configuration changes:
Settings:
New
use_funding_module - it is set to false by default; to use this module, change the value to true in the settings table.
funding_admins - an array of ldap_uid, see #1 below.
funding_org_ids - array of organization ids under the Funding Opportunities, see #2 below.
***** The module is disabled by default. To use the Funding Module, set the use_funding_module setting to true, and update the funding_admins and funding_org_ids settings ******
Update
finished_statuses (#4) - add "loi_missed_deadline", "loi_rejected", "app_missed_deadline", "app_rejected" to the array.
navbar_links – add a key-value pair for ‘SPARCFunding’
e.g., "sparc_funding" => ["SPARCFunding", "http://localhost:3000/funding"]
Permissible Values:
add new status for each of the funding statuses (#3)
add new document_types (#5) Add ‘funding admins’ to the settings table
1. Add ‘funding admins’ to the settings table[1]
Funding module is only accessible for users who have been granted the “funding admin” rights. Non-funding admins will not have access to the module in the navigation bar.
2. Create the ‘Funding Organizations’ in SPARC Catalog Manager
First, create a new provider for ‘Funding Opportunities,’ then create programs, such as Pilot Grants, Visiting Scholars, Community Scholars, … etc. For convenience, we called these programs the ‘funding organizations’[2]. Split/Notify must be check at the funding organization level.
3. Add the following new statuses[3] – permissible_values, default = 0 and category = ‘status’ [rake task]
key | value |
---|---|
app_accepted | Application Accepted |
app_rejected | Application Rejected |
app_submitted | Application Submitted |
app_missed_deadline | Deadline Missed (Application) |
loi_missed_deadline | Deadline Missed (Pre-Application/LOI) |
loi_accepted | Pre-Application/LOI Accepted |
loi_rejected | Pre-Application/LOI Rejected |
loi_submitted | Pre-Application/LOI Submitted |
4. Add the following statuses to the ‘finished_statuses’ array in the settings table
app_rejected, app_missed_deadline, loi_rejected, loi_missed_deadline
5. Add new Document Types[4] to permissible_values table [rake task]
Pre-application/Letter of Intents
Application
To turn the funding module on, do the following after migration/deployment.1. bundle exec rake data:initialize_funding_related_permissible_values2. Update settings table- funding_admins: as needed (array of ldap_uid; e.g., ["ldap_uid2", "ldap_uid2"])- funding_org_ids: as needed (array of organization.id; e.g., [100, 101, 102])- finished_statuses (one time only):app_rejected, app_missed_deadline, loi_rejected, loi_missed_deadline*set the statuses as “available” so they display in SPARC and Catalog*- navbar_links (one time only):3. Add "sparc_funding" => ["SPARCFunding", "http://localhost:3000/funding"]Notes (after rake the task #1 above):1. The new funding related statuses will only be available to new/future organizations. If you want to add an existing organization as a funding organization, you will have to manually add those statuses to the editable_statuses and available_statuses database tables for the organizations in order to see them in Available Statuses in Catalog Manager when the User Default Statuses checkbox is unchecked.2. The added setting.funding_org_ids has to be the organization id that directly owns the services/funding opportunities, AND split/notify needs to be set at the organization level in Catalog Manager. |