Canvas Users to Salesforce Contacts Writer

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

# Project Name - CANVAS USERS TO SALESFORCE CONTACTS WRITER

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

# Description - This recipe retrieves Canvas Users and writes back to Salesforce Contacts
              # This pattern can be extended to any Canvas endpoint or Salesforce object. Lingk handles all the details of the integration, you just worry about the data.
              # To get started: (a) Add a Canvas 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 - Canvas, Salesforce
# Connectors - Salesforce, Canvas
# Data Flows - Single Direction
# Connection Type - API to API

# Data Models
## Salesforce Models Used:
#1. Account
#1. Contact

## Canvas API
#1. users

# Add Recipe notes / Change log information here!

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

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

connectors:

# Configure Canvas & Salesforce credentials in your Environment before running this recipe
  # Canvas Setup - https://help.lingk.io/en/articles/263-canvas-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 - Canvas Reader connectors ######

-
    name: currentUsers
    type: canvasReader
    properties:
      path: /api/v1/accounts/1/users  #note: you can add query string providers to filter ( path: /api/v1/accounts/1/users?id=1234 )
    schema:
      fields:
        - name: id
          type: String
        - name: login_id
          type: String

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

# CANVAS PROCESSES
# 1. FIND EXISTING CANVAS USERS

#  - statement: print currentUsers
#  - 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 ####

- statement: |
          (newUsers) => SELECT 	
              (select Id from accountReader) 
                                                      AccountId,
              login_id                                Email,	
              ifnull(split(sortable_name,',')[1], '') FirstName,
              ifnull(split(sortable_name,',')[0], '') LastName,
              sis_user_id                             Lingk_External_Id__c
               FROM currentUsers 
                    LEFT ANTI JOIN  contactReader ON lcase(contactReader.Email) = lcase(currentUsers.login_id)

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

- statement: INSERT newUsers INTO contactWriter

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

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

# Pulls data that will be updated to Salesforce from Canvas making a join on the current Salesforce (currentUsers table) checking email and login Id are the same
  # lcase function returns str with all characters changed to lowercase.
  - statement: |
          (existingUsers) => SELECT 	
              contactReader.Id                        Id,
              login_id                                Email,	
              ifnull(split(sortable_name,',')[1], '') FirstName,
              ifnull(split(sortable_name,',')[0], '') LastName,
              sis_user_id                             Lingk_External_Id__c
               FROM currentUsers 
                    INNER JOIN  contactReader ON lcase(contactReader.Email) = lcase(currentUsers.login_id)

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

- statement: UPDATE existingUsers INTO contactWriter

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

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