Commit a3257474 authored by Chelsea Gille's avatar Chelsea Gille
Browse files

Update how-to.md

parent 78a62b46
Loading
Loading
Loading
Loading
+21 −4
Original line number Diff line number Diff line
## How to Guides
# How to Guides

### How to check the import status of Starfish ETL process?
## How to check the import status of Starfish ETL process?
NOTE: You will require admin privileges to get the required information.
* Navigate to the Prod or Test tenant as required
  * [Prod tenant](https://wisc.starfishsolutions.com/starfish-ops/)
@@ -9,7 +9,7 @@ NOTE: You will require admin privileges to get the required information.
* Navigate to the Import Status page: Left menu > Integrations > Import Status
* This page will show a list of imports along with their status and timestamps.

### How to connect to the Starfish EC2 instance?
## How to connect to the Starfish EC2 instance?
Follow the steps below:

**Download the `.pem` File**
@@ -23,7 +23,7 @@ Follow the steps below:
    * Select the `Actions` dropdown and click `Connect`.
    * Follow the instructions in the `SSH client` tab.

### How to perform periodic photos import?
## How to perform periodic photos import?
The Starfish ETL process performs an import process for photos at the start of every semester. 
Currently, we have set up the process to run on '01-15', '06-15', and '09-01'.

@@ -40,4 +40,21 @@ I have uploaded a new photos zip (<filename>.zip) to wisc@ftp1.starfishsolutions
Could you please let me know when they have completed processing?
```

## How to update Starfish SOAR terms?
Students who are elligble for SOAR related Starfish appointments are given a SOAR attribute. The Starfish ETL process relies on a configurable property for SOAR term codes to correctly identify which students are elligble for SOAR. Term codes are 4 digits, and in this case, are supplied by our Product Owner.

To update the SOAR term code(s), SSH into the Starfish EC2 instance and update the following application.yml file property with the new term code(s):
```yml
starfish:
  soarTerms: 1206
```

If multiple term codes must be included, separate the codes with a comma and a space:
```yml
starfish:
  soarTerms: 1206, 1212
```