Ellucian Ethos to Salesforce EDA ( Academic Programs)

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

# Project Name -  ELLUCIAN ETHOS TO SALEFORCE EDA ( ACADEMIC PROGRAMS )

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

# Description - This recipe pulls academic program data from Ellucian Ethos to Salesforce EDA.

# 1. Pulls academic programs from ethos.
# 2. Insert/Update academic programs in SF account object where record type = 'Academic Program'.
# 3. Set "University" account AS ParentId in Account object.

# Industry - Higher Ed
# Business Process - Graduate Reporting

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

# Data Models
## Ethos Models Used:
#1. academic-programs

## Salesforce Objects Used:
#1. RecordType
#2. Account

# Data Sets
# Academic Programs & Accounts

# Add Recipe notes / Change log information here!

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

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

connectors:

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

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

-
    name: ethosProgramDataReader
    type: ethosReader
    delayedRead: true
    properties:
      path: /api/academic-programs
      dataModelVersion: 15.1.0
    schema:
      fields:
        - name: 'id'
          type: 'string' 
        - name: 'title'
          type: 'string' 
        - name: 'code'
          type: 'string' 
        - name: 'description'
          type: 'string'
        - name: 'status'
          type: 'string'   
        - name: 'authorizing'
          type: 'object'
          objectSchema:
            name: objectSchemaSchema
            fields:
              - name: 'institution'
                type: 'object'
                objectSchema:
                  name: objectSchemaSchema
                  fields:
                    - name: 'id'
                      type: 'string'
        - name: 'academicLevel'
          type: 'object'
          objectSchema:
            name: objectSchemaSchema
            fields:
              - name: 'id'
                type: 'string'
        - name: 'programOwners'
          type: 'array'
          items:
            name: 'arrayElement'
            type: 'object'
            objectSchema:
              name: objectSchemaSchema
              fields:
                - name: 'id'
                  type: 'string'
        - name: 'sites'
          type: 'array'
          items:
            name: 'arrayElement'
            type: 'object'
            objectSchema:
              name: objectSchemaSchema
              fields:
                - name: 'id'
                  type: 'string'
        - name: 'credentials'
          type: 'array'
          items:
            name: 'arrayElement'
            type: 'object'
            objectSchema:
              name: objectSchemaSchema
              fields:
                - name: 'id'
                  type: 'string'
        - name: 'disciplines'
          type: 'array'
          items:
            name: 'arrayElement'
            type: 'object'
            objectSchema:
              name: objectSchemaSchema
              fields:
                - name: 'startOn'
                  type: 'string'
                - name: 'discipline'
                  type: 'object'
                  objectSchema:
                    name: objectSchemaSchema
                    fields:
                      - name: 'id'
                        type: 'string'

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

###### Start - Salesforce Reader connectors ######

- 
    name: sfProgramRecordType
    type: salesforceReader
    delayedRead: true
    properties: 
      useBearerToken: true
      isSandbox: false
      query: SELECT Id, Name, SobjectType From RecordType WHERE Name = 'Academic Program' AND SobjectType = 'Account'
    schema:
      fields:
        - name: 'Id'
          type: 'string'
        - name: 'Name'
          type: 'string' 
        - name: 'SobjectType'
          type: 'string'

-
    name: sfUniversityInfo
    type: salesforceReader
    delayedRead: true
    properties:
      useBearerToken: true
      query: 
        SELECT 
          Id,
          Name
        FROM Account
        WHERE Name = '{{env.vars.universityname}}'
        LIMIT 1
    schema:
      fields: 
        - name: 'Id'
          type: 'string'
        - name: 'Name'
          type: 'string'

- 
    name: sfAccountReader
    type: salesforceReader
    delayedRead: true
    properties: 
      useBearerToken: true
      query: SELECT Id, External_GUID__c, Name, Description FROM Account WHERE RecordType.Name = 'Academic Program' AND External_GUID__c != NULL
    schema:
      fields:
        - name: 'Id'
          type: 'string' 
        - name: 'Name'
          type: 'string' 
        - name: 'External_GUID__c'
          type: 'string' 
        - name: 'Description'
          type: 'string'

###### End - Salesforce Reader connectors ######

###### Start - Salesforce Writer connectors ######

-
    name: sfAccountWriter
    type: salesforceBulkWriter
    properties:
      onError: continue
      sfObject: Account   
      batchSize: 200
      useBearerToken: true

###### End - Salesforce Writer 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: REFRESH ethosProgramDataReader
  - statement: (ethosProgramDataReaderCount) => SELECT COUNT(*) FROM ethosProgramDataReader  
  #- statement: print ethosProgramDataReaderCount

# The 'ifnull' function retrieves the value of the second parameter in case the value of the first one is NULL, otherwise it will retrieve the current value of it
  # Data in ethosProgramDataReader contains different objects retrieved as an arrays, that's the reason on why some of the items selected in the query below specifies the element [0]
  # CASE function is used as a dictionary and depending on the value received as a STRING, is the new status value that will be retrieved now as a BOOLEAN
  - statement: |
        (ethosProgramInfo) => 
            SELECT
              id                                          `ethos_id`,
              title                                       `title`,
              code                                        `code`,
              description                                 `description`,
              authorizing.institution.id                  `institution_id`,
              sites[0].id                                 `site_id`,
              programOwners[0].id                         `programOwner_id`,
              ifnull(academicLevel.id, '')                `academicLevel_id`,
              credentials[0].id                           `credential_id`,
              disciplines[0].discipline.id                `discipline_id`,
              (CASE WHEN status = 'active' THEN  'true' ELSE 'false' END)
                                                          `status`

FROM ethosProgramDataReader

#- statement: print ethosProgramInfo
  - statement: (ethosProgramInfoCount) => SELECT COUNT(*) FROM ethosProgramInfo
  #- statement: print ethosProgramInfoCount

- statement: |
        (accountInformation) => 
            SELECT    
              ethos_id                               `External_GUID__c`,
              title                                  `Name`,              
              description                            `Description`
            FROM ethosProgramInfo

#- statement: print accountInformation
  - statement: (accountInformationCount) => SELECT COUNT(*) FROM accountInformation
  #- statement: print accountInformationCount

- statement: REFRESH sfUniversityInfo 
  #- statement: print sfUniversityInfo

- statement: REFRESH sfProgramRecordType 
  #- statement: print sfProgramRecordType

- statement: REFRESH sfAccountReader 
  - statement: (sfAccountReaderCount) => SELECT COUNT(*) FROM sfAccountReader  
  #- statement: print sfAccountReaderCount

#### Start - Insert Accounts ####

# The 'LEFT ANTI JOIN' function retrieves the rows from the first table (table after the FROM statement) that do not match with the rows on the second table (right table)
  - statement: |
        (accountInfoToInsert) => 
              SELECT 
                a.*,
                (SELECT Id FROM sfUniversityInfo)
                                                    `ParentId`,
                (SELECT srt.Id FROM sfProgramRecordType srt WHERE srt.SobjectType = 'Account')
                                                    `RecordTypeId`
              FROM accountInformation a
              LEFT ANTI JOIN sfAccountReader sf ON a.External_GUID__c = sf.`External_GUID__c`

- statement: (accountInfoToInsertCount) => SELECT count(*) FROM accountInfoToInsert  
  #- statement: print accountInfoToInsertCount

- statement: INSERT accountInfoToInsert INTO sfAccountWriter

#### End - Insert Accounts ####

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