Blackboard Users to Salesforce Contacts Writer

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

# Project Name - BLACKBOARD USERS TO SALESFORCE CONTACTS WRITER

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

# Description - This recipe retrieves Blackboard Users and writes back to Salesforce Contacts
              # This pattern can be extended to any Blackboard endpoint or Salesforce object. Lingk handles all the details of the integration, you just worry about the data.
              # To get started: (a) Add a Blackboard connector and (b) add a Salesforce connector to an environment. Select the environment and run.
              # Note: You can comment out the INSERT and UPDATE statements for a "safe" run.

# Industry - Higher Ed
# Business Process - Graduate Reporting

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

# Data Models
## Salesforce
#1. Account
#2. Contact

## Blackboard API
#1. Users

# Add Recipe notes / Change log information here!

## New development - (Sprint ) 
# updated with style guide model
# updated with comment pattern

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

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

connectors:

# Configure Blackboard & Salesforce credentials in your Environment before running this recipe
  # Blackboard Setup - https://help.lingk.io/en/articles/299-blackboard-learn-connector-setup-guide
  # Salesforce Setup - https://help.lingk.io/en/articles/267-salesforce-connector-setup-guide

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

## Use SOQL to read and filter data from Salesforce
- 
    name: accountReader
    type: salesforceReader
    properties: 
      useBearerToken: true
      isSandbox: false
      query: SELECT Id, Name FROM Account WHERE Name = 'Data Entry'
    schema:
      fields:
        - name: Id
          type: String    
        - name: Name
          type: String

- 
    name: contactReader
    type: salesforceReader
    properties: 
      useBearerToken: true
      isSandbox: true
      query: SELECT Id, Name, FirstName, LastName, Email FROM Contact
    schema:
      fields:
        - name: Id
          type: String    
        - name: Name
          type: String 
        - name: FirstName
          type: String  
        - name: LastName
          type: String 
        - name: Email
          type: String

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

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

# specify one per object type
- 
    name: contactWriter
    type: salesforceBulkWriter
    properties: 
      onError: continue
      useBearerToken: true
      isSandbox: true
      sfObject: Contact
      # batchSize: 50 # default 10000
      # upsert: true # default false - requires external Id in sfObject

###### End - Salesforce Writer connectors ######

###### Start - Blackboard Reader connectors ######

-
    name: currentUsers
    type: blackboardReader
    properties:
      path: /learn/api/public/v1/users

###### Start - Blackboard 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 ***********************************************************************************************

# BLACKBOARD PROCESSES
# 1. FIND EXISTING BLACKBOARD USERS

#  - statement: print currentUsers

- statement: (oneUser) => SELECT * FROM currentUsers WHERE contact is not null LIMIT 1
  - statement: (currentUserCount) => SELECT count(*) FROM currentUsers

# 2. COMPARE CURRENT USERS VERSUS REGISTRANTS TO GET A LIST OF NEW USERS

# Integration Process Step: Data mapping and transformation

# Integration Process Step: Prepping upsert datasets (one for insert and one for update)

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

#Pulls oneUser data from Blackboard joining Salesforce Application table (contactReader) checking contact eamils are not the same
   # 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: |
          (newUsers) => SELECT 	
              (select Id from accountReader) 
                                                      AccountId,
              oneUser.contact.email                   Email,	
              oneUser.name.given                      FirstName,
              oneUser.name.family                     LastName,
              oneUser.externalId                      Lingk_External_Id__c
               FROM oneUser 
                    LEFT ANTI JOIN  contactReader ON lcase(contactReader.Email) = lcase(oneUser.contact.email)

#  - statement: print newUsers
#  - statement: (newUsersCount) => select count(*) from newUsers  
#  - statement: print newUsersCount

- statement: INSERT newUsers INTO contactWriter

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

#### Start - Update Contacts ####

- statement: |
          (existingUsers) => SELECT 	
              contactReader.Id                        Id,
              oneUser.contact.email                   Email,	
              oneUser.name.given                      FirstName,
              oneUser.name.family                     LastName,
              oneUser.externalId                      Lingk_External_Id__c
               FROM oneUser 
                    INNER JOIN  contactReader ON lcase(contactReader.Email) = lcase(oneUser.contact.email)

#  - statement: print existingUsers
#  - statement: (existingUsersCount) => select count(*) from existingUsers  
#  - statement: print existingUsersCount

- statement: (results, errors) => UPDATE existingUsers INTO contactWriter

#### End - Update Contacts ####

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