Blackboard Learn REST API Courses to SFTP file

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

# Project Name - BLACKBOARD LEARN REST API COURSES TO SFTP FILE

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

# Description - # This recipe reads all the courses from a Blackboard Learn instance through the Blackboard REST API and writes them to a file on an SFTP site. 
                # Paging of data and security is automatically handled.
                # To run this recipe, configure the Blackboard and SFTP connector in your environment, select your environment, and click "Run".

# Industry - Higher Ed
# Business Process - Graduate Reporting

# Systems - BlackBoard, SFTP
# Connectors - BlackBoard, SFTP
# Data Flows - Single Direction
# Connection Type - API to SFTP

# Data Models
## BlackBoard Models Used:
#1. Courses

# Add Recipe notes / Change log information here!

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

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

connectors:

# Configure SFTP credentials in your Environment before running this recipe
  # SFTP Setup - https://help.lingk.io/en/articles/296-sftp-setup-guide

###### Start - BlackBoard Reader connectors ######

-
    name: courses
    type: blackboardReader
    properties:
      path: /learn/api/public/v1/courses?limit=10

###### End - BlackBoard Reader connectors ######

###### Start - SFTP Writer connectors ######

-
    name: coursesWriter
    type: sftpWriter
    format: csv
    properties:
      path: /organizations/blackboard/export/courses_{{ func:date_format(func:current_datetime(), 'yyyy-MM-dd_HH-mm-ss') }}.csv

###### End - SFTP Writer connectors ######

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

# Configures the format of the file written to SFTP

writeFormats:
-
    name: csv
    type: delimited
    properties:
      quoteAllFields: true
      delimiter: ','
      header: true

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

# 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: (myCourses) => SELECT * FROM courses
  #- statement: print myCourses
  - statement: (myCoursesCount) => select count(*) from courses
  #- statement: print myCoursesCount

# Flatten Blackboard APIs into a tabular dataset  
  - statement: |
      (myCourses) => select 
              courseId,
              externalId,
              name,
              description,
              availability.available as available,
              availability.duration.type as durationType
            from courses
  #- statement: print myCourses

# output course memberships

#  - statement: REFRESH courseMemberships
#  - statement: (myCourseMemberships) => select * from courseMemberships
#  - statement: print myCourseMemberships

# Write file to SFTP
  - statement: insert myCourses into coursesWriter

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