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

Migrated how-to.md to...

Migrated how-to.md to https://git.doit.wisc.edu/finance/documentation/-/tree/master/starfish/Support.md because it is not meant to be public facing service documentation
parent a4a43082
Loading
Loading
Loading
Loading

Starfish/how-to.md

deleted100644 → 0
+0 −60
Original line number Diff line number Diff line
# How to Guides

## 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/)
  * [Test tenant](https://wisc-test.starfishsolutions.com/starfish-prod/)
* Navigate to the Starfish admin site: Left menu > Admin
* 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?
Follow the steps below:

**Download the `.pem` File**
* The `.pem` file required to SSH into the EC2 instance is located in Lastpass.
    * copy the contents and create a `starfish.pem` file locally.

**Connecting to the Starfish EC2 instance**
* login to the AWS account for Starfish: `Handfish`.
* Navigate to the EC2 service in us-east-2 (Ohio).
* Select the Starfish EC2 instance.
    * Select the `Actions` dropdown and click `Connect`.
    * Follow the instructions in the `SSH client` tab.

## 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'.

Once the photos have been uploaded to the EC2 instance,
the process will create a zip file and attempt to copy it to an SFTP server for Starfish to pick it up.

We need to email the Starfish support list to notify that the zip file is ready for import.
Email address: `starfishsupport@hobsons.com`
Subject: Import Photos In Prod Tenant (Month Year)
Body: 
```
Hello, 
I have uploaded a new photos zip (<filename>.zip) to wisc@ftp1.starfishsolutions.com:/upload/general/ to be processed in our Prod Tenant.
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
```