Aeries Sections and Programs SIS Reader to Salesforce

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

# Project Name - AERIES SECTIONS AND PROGRAMS SIS READER TO SALESFORCE

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

# Description - This recipe retrieves Aeries Sections & Programs and writes back to Salesforce
              # This recipe reads sections and program data from the Aeires SIS (K-12). You need the Aeries-Cert for the API calls. You can use the demo cert from their documentation. 
              # 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. Sections
#2. Programs

## Salesforce Objects Used:
#1. Contact

# 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 - Aeries Reader connectors ######

# Aeries sections
-
    name: aeriesSections
    type: httpReader
    properties:
      url: https://demo.aeries.net/aeries/api/v3/schools/994/sections
      headers: Accept=application%2Fjson%2C%20text%2Fhtml%2C%20application%2Fxhtml%2Bxml%2C%20%2A%2F%2A&AERIES-CERT=<YOUR-AERIES-CERT>
      httpMethod: GET

# Aires Programs
-
    name: aeriesPrograms
    type: httpReader
    properties:
      url: https://demo.aeries.net/aeries/api/v3/schools/994/students/99400001/programs
      headers: Accept=application%2Fjson%2C%20text%2Fhtml%2C%20application%2Fxhtml%2Bxml%2C%20%2A%2F%2A&AERIES-CERT=<YOUR-AERIES-CERT>
      httpMethod: GET
# NOTE: You can use the data in table (from statements) as parameters (see ParameterizedBy property) to make multiple API calls at once
#      url: https://demo.aeries.net/aeries/api/v3/schools/{{var.schoolId}}/students/{{var.studentId}}/programs

###### End - Aeries Reader connectors ######

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

# salesforce reader - replace SOQL
# extend schema for fields that a values may be null in the query
# NOTE: the SF password is combination of password + security key (no spaces)

-
    name: contactReader
    type: salesforceReader
    properties:
      useBearerToken: true
      isSandbox: false
      query: SELECT Id, FirstName, LastName, Email FROM Contact
    schema: #optional - use to ensure that a nullable fields always shows up in a query
      fields:
        - name: Email
          type: String

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

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

# NOTE: You can can have multiple Salesforce readers and writers!

# salesforce writer - replace credentials and sfObject name
#-
#    name: sfWriter
#    type: salesforceBulkWriter
#    properties:
#       onError: continue
#      useBearerToken: true
#      isSandbox: false
#      sfObject: Contact

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

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

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

statements:

# You can use plain old SQL to process the data
- statement: |
    (sections) =>
      select *
      from aeriesSections

#******************************************************************** 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: print sections

- statement: |
    (sectionsCount) =>
      select count(*)
      from aeriesSections
# - statement: print sectionsCount

- statement: |
    (allPrograms) =>
      select *
      from aeriesPrograms
# - statement: print allPrograms

- statement: |
    (programsCount) =>
      select count(*)
      from aeriesPrograms
# - statement: print programsCount

# this demonstrates how you can access ExtendedProperties
- statement: |
    (programsExtendedProperties) =>
      select StudentID, ProgramCode, explode (ExtendedProperties) as Properties
      from aeriesPrograms
# - statement: print programsExtendedProperties

# Salesforce Reader

# - statement: print contactReader

- statement: |
    (contactReaderCount) =>
      select count(*)
      from contactReader
# - statement: print contactReaderCount

###### Start - Insert Contacts ######

# next steps insert data into Salesforce from Aeries
# map aires fields to SF field
# then insert

#- statement: |
#     (newData) => select AIRES_FIELD SALESFORCE_FIELD__c
#     from aires_data
#     where ...

#- statement: insert newData into sfWriter

###### End - Insert Contacts ######

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