Ellucian Ethos Reader

#   _____           _              _____        __      
#  |  __ \         (_)            |_   _|      / _|     
#  | |__) |___  ___ _ _ __   ___    | |  _ __ | |_ ___  
#  |  _  // _ \/ __| | '_ \ / _ \   | | | '_ \|  _/ _ \ 
#  | | \ \  __/ (__| | |_) |  __/  _| |_| | | | || (_) |
#  |_|  \_\___|\___|_| .__/ \___| |_____|_| |_|_| \___/ 
#                    | |                                
#                    |_|

# Project Name - ELLUCIAN ETHOS READER

# Recipe URL - https://app.lingk.io/a/10932/tf/17511

# Description - This recipe does not write any data is used to demonstrate simple Ellucian Ethos data reader

# Industry - Higher Ed
# Business Process - Graduate Reporting

# Systems - Ethos
# Connectors - Ethos
# Data Flows - Single Direction
# Connection Type - API

# Data Models
## Ethos Models Used:
#1. Academic-Levels

# Add Recipe notes / Change log information here!

#    _____                            _                 
#   / ____|                          | |                
#  | |     ___  _ __  _ __   ___  ___| |_ ___  _ __ ___ 
#  | |    / _ \| '_ \| '_ \ / _ \/ __| __/ _ \| '__/ __|
#  | |___| (_) | | | | | | |  __/ (__| || (_) | |  \__ \
#   \_____\___/|_| |_|_| |_|\___|\___|\__\___/|_|  |___/
#

# CONNECTORS specify what data will be pulled into the in-memory database during processing

connectors:

# Configure Ethos credentials in your Environment before running this recipe
  # Ethos Setup - https://help.lingk.io/en/articles/292-ellucian-ethos-connector-setup-guide

###### Start - Ethos Reader connectors ######

-
    name: ethosAcademicLevelsAPIGet
    type: ethosReader
    properties:
      path: /api/academic-levels
      dataModelVersion: 6
      # maxRecords: 100 # don't read all data

###### End - Ethos Reader connectors ######

#    _____ _        _                            _       
#   / ____| |      | |                          | |      
#  | (___ | |_ __ _| |_ ___ _ __ ___   ___ _ __ | |_ ___ 
#   \___ \| __/ _` | __/ _ \ '_ ` _ \ / _ \ '_ \| __/ __|
#   ____) | || (_| | ||  __/ | | | | |  __/ | | | |_\__ \
#  |_____/ \__\__,_|\__\___|_| |_| |_|\___|_| |_|\__|___/

# STATEMENTS specify how the data should be processed while in memory

statements:

#******************************************************************** D I S C L A I M E R ***********************************************************************************************
#                                                                                                                                                                                       * 
# Note that in an effort to keep recipes optimized for DPH (Data Processing Hours), print statements should be commented out after development has concluded for a recipe.              *
# For more information on DPH optimization, please visit the following help article - https://help.lingk.io/en/articles/212-minimizing-data-processing-hours-on-the-lingk-platform      *
#                                                                                                                                                                                       * 
#******************************************************************** D I S C L A I M E R ***********************************************************************************************

# this statement reads data from Ethos Proxy APIs into an in-memory staging table
  - statement: (getPrograms) => select * from ethosAcademicLevelsAPIGet
  # this statement prints the table for debug purposes. Production doesn't need it.
  #- statement: print getPrograms

# Add more statements to convert, join, aggregrate, transform, and integrate your data