Documents and Attachments 57 Chapter 7: Dbamp Stored Procedure Reference

CData Software, Inc. DBAmp SQL Server Integration with Salesforce.com Version 5.1.6 Copyright © 2021 CData Software, Inc. All rights reserved. Table of Contents <a href="#7_0">Acknowledgments........................................................................... 7 </a><a href="#8_0">Chapter 1: Installation/Upgrading ................................................. 8 </a><a href="#8_1">Upgrading an existing installation.........................................................8 </a><a href="#9_0">Prerequistes .......................................................................................9 </a><a href="#9_1">Running the DBAmp installation file......................................................9 </a><a href="#9_2">Configure the DBAmp provider option</a><a href="#9_2">s</a><a href="#9_2">.</a><a href="#9_2">................................................9 </a><a href="#10_0">Connecting DBAmp to SQL Serve</a><a href="#10_0">r</a><a href="#10_0">.</a><a href="#10_0">....................................................</a><a href="#10_0">.</a><a href="#10_0">1</a><a href="#10_0">0 </a><a href="#11_0">Verifying the linked server ................................................................</a><a href="#11_0">.</a><a href="#11_0">1</a><a href="#11_0">1 </a><a href="#11_1">Install the DBAmp Stored Procedure</a><a href="#11_1">s</a><a href="#11_1">.</a><a href="#11_1">...............................................</a><a href="#11_1">.</a><a href="#11_1">1</a><a href="#11_1">1 </a><a href="#11_2">Running the DBAmp Configuration Program.......................................</a><a href="#11_2">.</a><a href="#11_2">1</a><a href="#11_2">1 </a><a href="#12_0">Setting up the DBAmp Work Directory...............................................</a><a href="#12_0">.</a><a href="#12_0">1</a><a href="#12_0">2 </a><a href="#13_0">Enabling xp_cmdshell for DBAmp......................................................</a><a href="#13_0">.</a><a href="#13_0">1</a><a href="#13_0">3 </a><a href="#13_1">Pointing DBAmp to your Salesforce Sandbox Instanc</a><a href="#13_1">e</a><a href="#13_1">.</a><a href="#13_1">.......................</a><a href="#13_1">.</a><a href="#13_1">1</a><a href="#13_1">3 </a><a href="#14_0">Chapter 2: Using DBAMP as a Linked Server ................................ 14 </a><a href="#14_1">Four Part Object Names ...................................................................</a><a href="#14_1">.</a><a href="#14_1">1</a><a href="#14_1">4 </a><a href="#14_2">SQL versus SOQ</a><a href="#14_2">L</a><a href="#14_2">.</a><a href="#14_2">............................................................................</a><a href="#14_2">.</a><a href="#14_2">1</a><a href="#14_2">4 </a><a href="#14_3">Using the four part object name and SQ</a><a href="#14_3">L</a><a href="#14_3">.</a><a href="#14_3">.........................................</a><a href="#14_3">.</a><a href="#14_3">1</a><a href="#14_3">4 </a><a href="#15_0">Using OPENQUERY and SOQ</a><a href="#15_0">L</a><a href="#15_0">.</a><a href="#15_0">..........................................................</a><a href="#15_0">.</a><a href="#15_0">1</a><a href="#15_0">5 </a><a href="#17_0">Inserting rows using SQL..................................................................</a><a href="#17_0">.</a><a href="#17_0">1</a><a href="#17_0">7 </a><a href="#18_0">Updating and Deleting rows using SQ</a><a href="#18_0">L</a><a href="#18_0">.</a><a href="#18_0">.............................................</a><a href="#18_0">.</a><a href="#18_0">1</a><a href="#18_0">8 </a><a href="#19_0">Joining Salesforce.com Tables...........................................................</a><a href="#19_0">.</a><a href="#19_0">1</a><a href="#19_0">9 </a><a href="#19_1">Analyzing Performance when Joining Tables ......................................</a><a href="#19_1">.</a><a href="#19_1">1</a><a href="#19_1">9 </a><a href="#21_0">Using BIT datatype with DBAmp .......................................................</a><a href="#21_0">.</a><a href="#21_0">2</a><a href="#21_0">1 </a><a href="#21_1">Using Dates with DBAmp..................................................................</a><a href="#21_1">.</a><a href="#21_1">2</a><a href="#21_1">1 </a><a href="#22_0">Using DBAmp System Tables (sys_sf tables</a><a href="#22_0">)</a><a href="#22_0">.</a><a href="#22_0">.....................................</a><a href="#22_0">.</a><a href="#22_0">2</a><a href="#22_0">2 </a><a href="#23_0">Using DBAmp System Views .............................................................</a><a href="#23_0">.</a><a href="#23_0">2</a><a href="#23_0">3 </a><a href="#25_0">Using Count() with salesforce.com objects.........................................</a><a href="#25_0">.</a><a href="#25_0">2</a><a href="#25_0">5 </a><a href="#25_1">Using DBAmp to convert currency amounts to a default currency........</a><a href="#25_1">.</a><a href="#25_1">2</a><a href="#25_1">5 </a><a href="#26_0">Using DBAmp to return translated values for picklist</a><a href="#26_0">s</a><a href="#26_0">.</a><a href="#26_0">........................</a><a href="#26_0">.</a><a href="#26_0">2</a><a href="#26_0">6 </a><a href="#26_1">Retrieving Archived and Deleted records ...........................................</a><a href="#26_1">.</a><a href="#26_1">2</a><a href="#26_1">6 </a><a href="#26_2">Using Column Subset views ..............................................................</a><a href="#26_2">.</a><a href="#26_2">2</a><a href="#26_2">6 </a><a href="#27_0">DBAmp and Salesforce API call Count</a><a href="#27_0">s</a><a href="#27_0">.</a><a href="#27_0">.............................................</a><a href="#27_0">.</a><a href="#27_0">2</a><a href="#27_0">7 </a><a href="#28_0">Big Objects Support .........................................................................</a><a href="#28_0">.</a><a href="#28_0">2</a><a href="#28_0">8 </a>2 <a href="#30_0">Platform Events Suppor</a><a href="#30_0">t</a><a href="#30_0">.</a><a href="#30_0">..................................................................</a><a href="#30_0">.</a><a href="#30_0">3</a><a href="#30_0">0 </a><a href="#0_0">Chapter 3: Making Local Copies of Salesforce Dat</a><a href="#0_0">a</a><a href="#0_0">.</a><a href="#0_0">..................... 31 </a><a href="#0_1">How SF_Mirror work</a><a href="#0_1">s</a><a href="#0_1">.</a><a href="#0_1">......................................................................</a><a href="#0_1">.</a><a href="#0_1">3</a><a href="#0_1">1 </a><a href="#0_2">How to run the SF_Mirror proc to make a local copy ..........................</a><a href="#0_2">.</a><a href="#0_2">3</a><a href="#0_2">2 </a><a href="#0_3">Viewing the job histor</a><a href="#0_3">y</a><a href="#0_3">.</a><a href="#0_3">....................................................................</a><a href="#0_3">.</a><a href="#0_3">3</a><a href="#0_3">3 </a><a href="#0_4">Mirroring all Salesforce Object</a><a href="#0_4">s</a><a href="#0_4">.</a><a href="#0_4">........................................................</a><a href="#0_4">.</a><a href="#0_4">3</a><a href="#0_4">3 </a><a href="#0_5">How to run the SF_MirrorAll proc to replicate all object</a><a href="#0_5">s</a><a href="#0_5">.</a><a href="#0_5">....................</a><a href="#0_5">.</a><a href="#0_5">3</a><a href="#0_5">3 </a><a href="#0_6">Copying only the rows that have changed .........................................</a><a href="#0_6">.</a><a href="#0_6">3</a><a href="#0_6">4 </a><a href="#0_7">Including Archived and Deleted rows in the local copy........................</a><a href="#0_7">.</a><a href="#0_7">3</a><a href="#0_7">4 </a><a href="#0_8">How to run the SF_Mirror proc without using xp_cmdshell..................</a><a href="#0_8">.</a><a href="#0_8">3</a><a href="#0_8">4 </a><a href="#0_9">Best Practices Incorporated into SF_Mirror ........................................</a><a href="#0_9">.</a><a href="#0_9">3</a><a href="#0_9">5 </a><a href="#0_10">Using the DBAmpTableOptions Table ................................................</a><a href="#0_10">.</a><a href="#0_10">3</a><a href="#0_10">5 </a><a href="#0_11">Making Local Copies with a Subset of Columns ..................................</a><a href="#0_11">.</a><a href="#0_11">3</a><a href="#0_11">7 </a><a href="#0_12">Making Local Copies as Temporal Table</a><a href="#0_12">s</a><a href="#0_12">.</a><a href="#0_12">..........................................</a><a href="#0_12">.</a><a href="#0_12">3</a><a href="#0_12">8 </a><a href="#0_0">Chapter 4: Bulk Insert, Upsert, Delete and Update into Salesforce using </a><a href="#0_0">SF_TableLoader............................................................................. 41 </a><a href="#0_13">Differences between SF_BulkOps and SF_TableLoader .......................</a><a href="#0_13">.</a><a href="#0_13">4</a><a href="#0_13">1 </a><a href="#0_14">Why SF_TableLoader over SF_BulkOps</a><a href="#0_14">?</a><a href="#0_14">.</a><a href="#0_14">...........................................</a><a href="#0_14">.</a><a href="#0_14">4</a><a href="#0_14">1 </a><a href="#0_15">Checking the Column Names of the Input Table.................................</a><a href="#0_15">.</a><a href="#0_15">4</a><a href="#0_15">2 </a><a href="#0_1">Using External Ids as Foreign Keys....................................................</a><a href="#0_1">.</a><a href="#0_1">4</a><a href="#0_1">3 </a><a href="#0_16">Understanding the Error Colum</a><a href="#0_16">n</a><a href="#0_16">.</a><a href="#0_16">......................................................</a><a href="#0_16">.</a><a href="#0_16">4</a><a href="#0_16">3 </a><a href="#0_3">Bulk Inserting rows into Salesforce....................................................</a><a href="#0_3">.</a><a href="#0_3">4</a><a href="#0_3">4 </a><a href="#0_17">Bulk Upserting rows into Salesforce...................................................</a><a href="#0_17">.</a><a href="#0_17">4</a><a href="#0_17">4 </a><a href="#0_18">Bulk Updating rows into Salesforce ...................................................</a><a href="#0_18">.</a><a href="#0_18">4</a><a href="#0_18">4 </a><a href="#0_19">Bulk Deleting rows from Salesforce ...................................................</a><a href="#0_19">.</a><a href="#0_19">4</a><a href="#0_19">5 </a><a href="#0_20">Bulk HardDeleting rows from Salesforce ............................................</a><a href="#0_20">.</a><a href="#0_20">4</a><a href="#0_20">5 </a><a href="#0_21">Bulk UnDeleting rows from Salesforce ...............................................</a><a href="#0_21">.</a><a href="#0_21">4</a><a href="#0_21">5 </a><a href="#0_22">Controlling the batch size with SF_TableLoader..................................</a><a href="#0_22">.</a><a href="#0_22">4</a><a href="#0_22">5 </a><a href="#0_23">Understanding a Sort Column when using SF_TableLoade</a><a href="#0_23">r</a><a href="#0_23">.</a><a href="#0_23">................</a><a href="#0_23">.</a><a href="#0_23">4</a><a href="#0_23">6 </a><a href="#0_24">How to run the SF_TableLoader proc ................................................</a><a href="#0_24">.</a><a href="#0_24">4</a><a href="#0_24">6 </a><a href="#0_25">How to run the SF_TableLoader proc without using xp_cmdshell ........</a><a href="#0_25">.</a><a href="#0_25">4</a><a href="#0_25">7 </a><a href="#0_0">SF_TableLoader Sample Recipe ........................................................</a><a href="#0_0">.</a><a href="#0_0">4</a><a href="#0_0">9 </a><a href="#0_26">Understanding SF_TableLoader failure</a><a href="#0_26">s</a><a href="#0_26">.</a><a href="#0_26">............................................</a><a href="#0_26">.</a><a href="#0_26">5</a><a href="#0_26">0 </a><a href="#0_27">Using Optional SOAP Header</a><a href="#0_27">s</a><a href="#0_27">.</a><a href="#0_27">..........................................................</a><a href="#0_27">.</a><a href="#0_27">5</a><a href="#0_27">0 </a><a href="#0_28">Converting Leads with SF_TableLoader .............................................</a><a href="#0_28">.</a><a href="#0_28">5</a><a href="#0_28">1 </a>3 <a href="#0_29">Using IgnoreFailures Option with SF_TableLoade</a><a href="#0_29">r</a><a href="#0_29">.</a><a href="#0_29">.............................</a><a href="#0_29">.</a><a href="#0_29">5</a><a href="#0_29">3 </a><a href="#0_30">Using AssignmentRuleId Option with SF_TableLoader ........................</a><a href="#0_30">.</a><a href="#0_30">5</a><a href="#0_30">3 </a><a href="#0_0">Chapter 5: Using SSIS with DBAm</a><a href="#0_0">p</a><a href="#0_0">.</a><a href="#0_0">............................................. 55 </a><a href="#0_31">Using the linked server as an SSIS Sourc</a><a href="#0_31">e</a><a href="#0_31">.</a><a href="#0_31">........................................</a><a href="#0_31">.</a><a href="#0_31">5</a><a href="#0_31">5 </a><a href="#0_32">Pushing Data to Salesforce.com using SSIS .......................................</a><a href="#0_32">.</a><a href="#0_32">5</a><a href="#0_32">5 </a><a href="#0_0">Chapter 6: Uploading files into Content, Documents and Attachments</a><a href="#0_0"> </a><a href="#0_0">57 </a><a href="#0_33">Chapter 7: DBAmp Stored Procedure Reference .......................... 62 </a><a href="#0_34">SF_BulkOps .....................................................................................</a><a href="#0_34">.</a><a href="#0_34">6</a><a href="#0_34">2 </a><a href="#0_0">SF_TableLoade</a><a href="#0_0">r</a><a href="#0_0">.</a><a href="#0_0">..............................................................................</a><a href="#0_0">.</a><a href="#0_0">6</a><a href="#0_0">7 </a><a href="#0_0">SF_BulkSOQL...................................................................................</a><a href="#0_0">.</a><a href="#0_0">7</a><a href="#0_0">5 </a><a href="#0_0">SF_BulkSOQL_Refresh......................................................................</a><a href="#0_0">.</a><a href="#0_0">8</a><a href="#0_0">0 </a><a href="#0_0">SF_CreateKeys.................................................................................</a><a href="#0_0">.</a><a href="#0_0">8</a><a href="#0_0">2 </a><a href="#0_0">SF_DownloadBlobs...........................................................................</a><a href="#0_0">.</a><a href="#0_0">8</a><a href="#0_0">3 </a><a href="#0_0">SF_DropKey</a><a href="#0_0">s</a><a href="#0_0">.</a><a href="#0_0">..................................................................................</a><a href="#0_0">.</a><a href="#0_0">8</a><a href="#0_0">5 </a><a href="#0_0">SF_Generate....................................................................................</a><a href="#0_0">.</a><a href="#0_0">8</a><a href="#0_0">6 </a><a href="#0_0">SF_Mirror ........................................................................................</a><a href="#0_0">.</a><a href="#0_0">8</a><a href="#0_0">7 </a><a href="#0_0">SF_MirrorAl</a><a href="#0_0">l</a><a href="#0_0">.</a><a href="#0_0">....................................................................................</a><a href="#0_0">.</a><a href="#0_0">9</a><a href="#0_0">2 </a><a href="#0_0">SF_Refres</a><a href="#0_0">h</a><a href="#0_0">.</a><a href="#0_0">.....................................................................................</a><a href="#0_0">.</a><a href="#0_0">9</a><a href="#0_0">4 </a><a href="#0_0">SF_RefreshIAD ................................................................................</a><a href="#0_0">.</a><a href="#0_0">9</a><a href="#0_0">6 </a><a href="#0_0">SF_RefreshAll ..................................................................................</a><a href="#0_0">.</a><a href="#0_0">9</a><a href="#0_0">8 </a><a href="#0_0">SF_Replicat</a><a href="#0_0">e</a><a href="#0_0">.</a><a href="#0_0">.................................................................................</a><a href="#0_0">.</a><a href="#0_0">1</a><a href="#0_0">00 </a><a href="#0_0">SF_ReplicateAll ..............................................................................</a><a href="#0_0">.</a><a href="#0_0">1</a><a href="#0_0">02 </a><a href="#0_0">SF_ReplicateIAD ............................................................................</a><a href="#0_0">.</a><a href="#0_0">1</a><a href="#0_0">04 </a><a href="#0_0">SF_MigrateBuilde</a><a href="#0_0">r</a><a href="#0_0">.</a><a href="#0_0">.........................................................................</a><a href="#0_0">.</a><a href="#0_0">1</a><a href="#0_0">06 </a><a href="#0_33">SF_MigrateGraphM</a><a href="#0_33">L</a><a href="#0_33">.</a><a href="#0_33">......................................................................</a><a href="#0_33">.</a><a href="#0_33">1</a><a href="#0_33">09 </a><a href="#0_0">Chapter 8: Using the DBAmp Configuration Program................. 111 </a><a href="#0_35">Options Page of the DBAmp Configuration Program .........................</a><a href="#0_35">.</a><a href="#0_35">1</a><a href="#0_35">11 </a><a href="#0_36">Registry Settings Page of the DBAmp Configuration Progra</a><a href="#0_36">m</a><a href="#0_36">.</a><a href="#0_36">...........</a><a href="#0_36">.</a><a href="#0_36">1</a><a href="#0_36">13 </a><a href="#0_0">Chapter 9: Retrieving Salesforce Metadata ................................ 118 </a><a href="#0_37">How to run the SF_Metadata proc...................................................</a><a href="#0_37">.</a><a href="#0_37">1</a><a href="#0_37">18 </a><a href="#0_18">Using the LIST and RETRIEVE operation</a><a href="#0_18">s</a><a href="#0_18">.</a><a href="#0_18">.......................................</a><a href="#0_18">.</a><a href="#0_18">1</a><a href="#0_18">18 </a><a href="#0_38">Requirements for the input table.....................................................</a><a href="#0_38">.</a><a href="#0_38">1</a><a href="#0_38">19 </a><a href="#0_0">Example: Retrieve Dependent Picklist Information ...........................</a><a href="#0_0">.</a><a href="#0_0">1</a><a href="#0_0">21 </a><a href="#0_39">Example: Retrieve Field Description</a><a href="#0_39">s</a><a href="#0_39">.</a><a href="#0_39">..............................................</a><a href="#0_39">.</a><a href="#0_39">1</a><a href="#0_39">22 </a><a href="#0_0">Chapter 10: Using DBAmp Performance Package....................... 124 </a>4 <a href="#0_40">Installing the DBAmp Performance Package.....................................</a><a href="#0_40">.</a><a href="#0_40">1</a><a href="#0_40">24 </a><a href="#0_41">Using the DBAmp_Log Table...........................................................</a><a href="#0_41">.</a><a href="#0_41">1</a><a href="#0_41">26 </a><a href="#0_0">Using the Performance Views..........................................................</a><a href="#0_0">.</a><a href="#0_0">1</a><a href="#0_0">27 </a><a href="#0_42">DBAmp_Replicate_Perf view ...........................................................</a><a href="#0_42">.</a><a href="#0_42">1</a><a href="#0_42">27 </a><a href="#0_43">DBAmp_Refresh_Perf view .............................................................</a><a href="#0_43">.</a><a href="#0_43">1</a><a href="#0_43">28 </a><a href="#0_44">DBAmp_TableLoader_Perf view ......................................................</a><a href="#0_44">.</a><a href="#0_44">1</a><a href="#0_44">29 </a><a href="#0_0">Enabling the Performance Trace .....................................................</a><a href="#0_0">.</a><a href="#0_0">1</a><a href="#0_0">30 </a><a href="#0_0">Chapter 11: MigrateAm</a><a href="#0_0">p</a><a href="#0_0">.</a><a href="#0_0">............................................................ 131 </a><a href="#0_45">What is MigrateAmp? .....................................................................</a><a href="#0_45">.</a><a href="#0_45">1</a><a href="#0_45">31 </a><a href="#0_46">Installing MigrateAmp ....................................................................</a><a href="#0_46">.</a><a href="#0_46">1</a><a href="#0_46">31 </a><a href="#0_47">MigrateAmp Approache</a><a href="#0_47">s</a><a href="#0_47">.</a><a href="#0_47">................................................................</a><a href="#0_47">.</a><a href="#0_47">1</a><a href="#0_47">32 </a><a href="#0_48">Understanding MigrateAmp Concepts ..............................................</a><a href="#0_48">.</a><a href="#0_48">1</a><a href="#0_48">32 </a><a href="#0_49">MigrateAmp Workflo</a><a href="#0_49">w</a><a href="#0_49">.</a><a href="#0_49">...................................................................</a><a href="#0_49">.</a><a href="#0_49">1</a><a href="#0_49">36 </a><a href="#0_50">MigrateAmp Architecture ................................................................</a><a href="#0_50">.</a><a href="#0_50">1</a><a href="#0_50">37 </a><a href="#0_0">Chapter 12: Using MigrateAm</a><a href="#0_0">p</a><a href="#0_0">.</a><a href="#0_0">.................................................. 140 </a><a href="#0_51">Using the SF_MigrateBuilder Stored Procedures ...............................</a><a href="#0_51">.</a><a href="#0_51">1</a><a href="#0_51">40 </a><a href="#0_0">Running SF_MigrateBuilder in User Interface ...................................</a><a href="#0_0">.</a><a href="#0_0">1</a><a href="#0_0">41 </a><a href="#0_52">Running SF_MigrateBuilder in SQL Management Studi</a><a href="#0_52">o</a><a href="#0_52">.</a><a href="#0_52">...................</a><a href="#0_52">.</a><a href="#0_52">1</a><a href="#0_52">44 </a><a href="#0_0">Replicating the Source org data ......................................................</a><a href="#0_0">.</a><a href="#0_0">1</a><a href="#0_0">46 </a><a href="#0_53">Loading the Target org data ...........................................................</a><a href="#0_53">.</a><a href="#0_53">1</a><a href="#0_53">46 </a><a href="#0_54">Resetting the Target org data if needed ..........................................</a><a href="#0_54">.</a><a href="#0_54">1</a><a href="#0_54">46 </a><a href="#0_55">An in-depth look at the SF_MigrateBuilder Parameters .....................</a><a href="#0_55">.</a><a href="#0_55">1</a><a href="#0_55">47 </a><a href="#0_0">Passing Parameters to _Load Stored Procedure ...............................</a><a href="#0_0">.</a><a href="#0_0">1</a><a href="#0_0">50 </a><a href="#0_56">Migrating Salesforce CRM Content...................................................</a><a href="#0_56">.</a><a href="#0_56">1</a><a href="#0_56">50 </a><a href="#0_57">Migrating Salesforce Knowledge......................................................</a><a href="#0_57">.</a><a href="#0_57">1</a><a href="#0_57">51 </a><a href="#0_58">Migrating Single Salesforce Knowledge Article Type .........................</a><a href="#0_58">.</a><a href="#0_58">1</a><a href="#0_58">52 </a><a href="#0_59">Migrating Multiple Salesforce Knowledge Article Types .....................</a><a href="#0_59">.</a><a href="#0_59">1</a><a href="#0_59">53 </a><a href="#0_60">Associating Knowledge Articles with Cases.......................................</a><a href="#0_60">.</a><a href="#0_60">1</a><a href="#0_60">54 </a><a href="#0_61">Frequently Asked Questions............................................................</a><a href="#0_61">.</a><a href="#0_61">1</a><a href="#0_61">54 </a>

Documents and Attachments 57 Chapter 7: Dbamp Stored Procedure Reference

Details

Download

Copyright

We respect the copyrights and intellectual property rights of all users. All uploaded documents are either original works of the uploader or authorized works of the rightful owners.

Support