Information  

Link to the complete Destiny One integration setup at the ServiceNow portal.

Ethos IP's From Article #000044039:

INBOUND RULE
HTTPS   52.55.21.93/32    Ellucian Ethos Test
HTTPS   34.197.131.165/32   Ellucian Ethos Test

Ethos IP's from PDF/Documentation: 

INBOUND RULE
HTTPS  52.0.163.27/32   Ellucian Ethos
HTTPS  50.16.144.60/32   Ellucian Ethos

To access the Ethos documentation

  1. Login to the Ellucian Hub
  2. Navigate to "Resources"
  3. Click "Ethos" under "Documentation"
  4. Click the "Integration" Drop Down
  5. Select Configure
  6. Select "Connect Colleague to Ethos Integration"
  7. To the right, select the blue icon that
  8. resembles a paper with an arrow pointing right
  9. Click "Select Topic and Subtopics"

Web API Information

API URL - In this instance, we are using the TEST eTranscripts API Site

Example API URL: https://etrans-test<yourdomain>.edu/ColleagueApi

If you're using a non-standard port, be sure to include the port in the URL

Example non-standard API URL: https://etrans-test<yourdomain>.edu:<PORT>/ColleagueApi

Colleague Side Initial Setup

1.  VAL -> CORE ->  PRIVACY.CODES

  • Insert a line and add: 
    • Code: I  Description: IT Services Min Entry: I
  • Save All
  • Go to SVM -> pull up your admins Colleague record and add the (I)T privacy code. This is necessary to access the user created.

2. UT-VAL -> ORG.ROLE.TYPES

  • Insert a line and add: 
    • Code: ETH  Description: Ethos   Min Entry: ETH
  • Save All

2. Create record in BIO/ADR (ethos_ema_admin)
     BIO -> Emaadmin Proxy Ethos <ENTER> -> Add

  • Privacy Code (toward the bottom): (I)T Services
  • Save All
  • ADR should auto-pull up
  • Address: College Address
  • Modifier: Attn: IT Services
  • Cty/St/Zp <your address info>
  • Email Address: ll-sysadmin@<yourdomain>.edu

 *** Tip *** note down the person ID; you'll
need it for several more forms

3. SOD record (ETHOS_EMA_ADMIN)

  • Name: ETHOS EMA ADMIN
  • Opers Equiv: Yes
  • UI: WEB  CORE-WBMAIN  7200
  • SCD: DMI_REG_USER
  • Save All
  • DRUS record (ethos_ema_admin)
  • username: ethos_ema_admin
  • Opers Equiv: ETHOS_EMA_ADMIN
  • Save All

5. SOD -> ETHOS_EMA_ADMIN

  • Add ID to Org Entity ID Field
  • Save All

6. ORGR - > Ethos_ema_admin

  • Purpose: For use with Ethos. Do not change modify delete
  • Start Date: today
  • Type: Ethos
  • Save All

7. MRPR - > Ethos_ema_admin

  • In an empty field, type "..." <ENTER>
  • In the bottom right hand corner, click
  • "Select All" -> Click "Open"
  • Save All

8. AROR -> <ETHOS_EMA_ADMIN ID>

  • Add "Ethos_ema_admin" with a start date of today
  • Save All

9. CCDF -> <ETHOS_EMA_ADMIN ID>
Set the password to something difficult. You will be typing this password in twice, and it's a service account with the keys to the kingdom. Make the password 20+ characters, with upper case, lowercase, special characters and numbers.

 Note down this password in a password vault
 

AWS Security Group Setup

1. Login to the AWS console
2. Navigate to "EC2"
3. Find your test API server and select it
e.g. test-etranscripts
4. Select the "Security" tab towards the bottom
5. Select the "<yourcollege>_etranstest_sg" or similar
Security Group
6. Edit security group
7. Add the IP's noted at the top for INBOUND

INBOUND RULE
HTTPS   52.55.21.93/32    Ellucian Ethos Test
HTTPS   34.197.131.165/32   Ellucian Ethos Test

 *** Tip *** Be sure to add the description
This makes it easier to view when sorting
by the description field

 Save the changes made to the security group

Ethos Cloud Integration Setup

You're done with the initial setup! Later will be
the Ellucian Messaging Service and Adapter along with
CDIP/CINC et al.

  1. Login to the Ellucian Hub
  2. Navigate to "Tools" -> "Ethos Integration"
  3. Ensure you're in the correct environment
    • In the top right, look for <your college> - Test
    • If it is not the test env, click the gear in the top right
    • Select the appropriate env
    • For this, it should be <college>###test or something of the sort.
  4. Select "Add Application"
  5. Select "From Catalog" and Continue
  6. Application Name: Colleague-Test-BaseAPI
    • Description: Base Ellucian Colleague API
    • Click Next
       
  7. Select Catalog Application
    • Scroll down and select "Ellucian Colleague"
    • Base URI: <your test API server>
    • Base QAPI URI: <blank>
    • username: ethos_ema_admin (DRUS username for admin)
    • password: <password>
    • Next
      • Note: if you are having issues and getting connection errors, ensure ALL of the steps above have been completed. If you're not using LDAP for test, check the DRUS record and ensure the Authentication Scheme is "DEFAULT" and save all  If you can't spot the issue, feel free to reach out or put in a SO ticket
  8. Subscriptions: none/next
  9. Finish!
  10. Test the ability to read data:
    • In "Applications" select "Colleague-Test-BaseAPI"
    • Select "Owned Resources" (should be 301)
    • Locate "academic-levels"
    • Click the 3 dots to the right and select "Health Details"
    • Should come back healthy. If not, review the EDHS data scans and resolve any data issues.