Ellucian Ethos Writer

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

# Project Name - ELLUCIAN ETHOS WRITER

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

# Description - Write a payload to the Ellucian Ethos APIs.
              # While the credentials are inline, you can upload a config file to the environment and read the values from config to enable the recipe to be portable across environments.
              # To use this with a Salesforce connector, add a SF connector to an environment, uncomment the SF, and run this recipe under the environment.

# Industry - Higher Ed
# Business Process - Graduate Reporting

# Systems - Aeries, Salesforce
# Connectors - 
# Data Flows - Single Direction
# Connection Type - API to API

# Data Models
## Aeries 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 Aeries & Salesforce credentials in your Environment before running this recipe
  # Aeries Setup - https://help.lingk.io/en/articles/304-http-connector-setup-guide
  # Salesforce Setup - https://help.lingk.io/en/articles/267-salesforce-connector-setup-guide

###### Start - Ethos Writer connectors ######

-
    name: insertEthosAcademicProgram
    type: ethosWriter
    properties:
      path: /api/academic-levels
      dataModelVersion: 6

###### End - Ethos Writer connectors ######

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

-
    name: ethosAcademicProgramsAPIGet
    type: ethosReader
    properties:
      path: /api/academic-levels
      dataModelVersion: 6
# note: this payload can be dynamically constructed in SQL as well

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

###### Start - JSON connectors ######

-
    name: payload
    type: json
    properties:
        jsonObject: >
          [
            {"code":"LQ","description":"Test Level","id":"84ffd152-8b58-4296-8638-e076170697b1","metadata":[],"title":"Test"}
          ]

###### End - JSON 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 ***********************************************************************************************

- statement: INSERT payload INTO insertEthosAcademicProgram

- statement: refresh ethosAcademicProgramsAPIGet
  - statement: (getApplicants) => select * from ethosAcademicProgramsAPIGet

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