Salesforce (SFDC) Database - Import - Cloud

Talend Cloud Data Catalog Bridges

author
Talend Documentation Team
EnrichVersion
Cloud
EnrichProdName
Talend Cloud
EnrichPlatform
Talend Data Catalog

Bridge Specifications

Vendor Salesforce
Tool Name Database
Tool Version Summer '17
Tool Web Site http://www.salesforce.com/
Supported Methodology [Relational Database] Data Store (Physical Data Model) via REST API
Data Profiling
Remote Repository Browsing for Model Selection
Multi-Model Harvesting
Incremental Harvesting

SPECIFICATIONS
Tool: Salesforce / Database version Summer '17 via REST API
See http://www.salesforce.com/
Metadata: [Relational Database] Data Store (Physical Data Model)
Component: SalesForceObjects version 11.0.0

OVERVIEW
This bridge authenticates the consumer and retrieves available physical metadata (e.g., Tables). Utilizing the username-password authentication flow that assumes the consumer already has the user's credentials.

REQUIREMENTS
In the event that users will be submitting Salesforce Documents, certain security settings must be configured to allow this access on Standard Objects and Custom Objects.
To configure permissions:
- Within Salesforce, click on Setup and then click on Manage Users
- Under the Manage Users tree click on Profiles
- Once the Profiles appear on the right, select which Profile you want to edit and click on the Edit link next to the corresponding profile

Standard Objects: Ensure that the "Documents" section has the Read permissions selected.
Custom Objects: Ensure that the Read permissions selected for each custom objects.

FREQUENTLY ASKED QUESTIONS
n/a

LIMITATIONS
Refer to the current general known limitations at http://metaintegration.com/Products/MIMB/MIMBKnownLimitations.html or bundled in Documentation/ReadMe/MIMBKnownLimitations.html
Field called "Description" in third column is ommitted by Salesforce API, consequently will not appear under any of the Profiles.

SUPPORT
Provide a trouble shooting package with:
- the debug log (can be set in the UI or in conf/conf.properties with MIR_LOG_LEVEL=6)
- the metadata backup if available (can be set in the Miscellaneous parameter with option -backup)

When you do not have username-password authentication parameter values but have an access token and your Salesforce instance URL you can specify them using the Miscellaneous parameter (see its description for details). In this case, you still need to fill all mandatory parameters with some text that will be ignored.


Bridge Parameters

Parameter Name Description Type Values Default Scope
Instance/My Domain URL The Salesforce login endpoint URL.
By default (when the value is empty) it is https://login.salesforce.com.
You can use your company' instance URL (such as https://na30.salesforce.com) or My Domain URL (such as https://myCompanyName.my.salesforce.com/).
STRING      
User The username of the user that the connected app is imitating. STRING     Mandatory
Password The password of the user that the connected app is imitating.
The security token is an automatically generated key that must be added to the end of the password to log in to Salesforce from an untrusted network.Concatenate the password and token when passing the request for authentication.
https://help.salesforce.com/articleView?id=remoteaccess_oauth_username_password_flow.htm&;type=5
PASSWORD     Mandatory
Consumer Key The Consumer Key from the connected app definition.
The connected app's consumer key, which you can find on the connected app's Manage Connected Apps page or from the connected app's definition.
https://help.salesforce.com/articleView?id=remoteaccess_oauth_username_password_flow.htm&;type=5
STRING     Mandatory
Consumer Secret The Consumer Secret from the connected app definition.
The connected app's consumer secret, which you can find on the connected app's Manage Connected Apps page or from the connected app's definition.
https://help.salesforce.com/articleView?id=remoteaccess_oauth_username_password_flow.htm&;type=5
PASSWORD     Mandatory
Objects List of object names, like 'object1, object2'.
An empty list means that all available objects.
You can specify object names as a wieldcard pattern, e.g.
'topic?'

'*topic*'

'topic_?,*topic*'.
REPOSITORY_SUBSET      
Miscellaneous INTRODUCTION
Specify miscellaneous options starting with a dash and optionally followed by parameters, e.g.
-connection.cast MyDatabase1="SQL Server"
Some options can be used multiple times if applicable, e.g.
-connection.rename NewConnection1=OldConnection1 -connection.rename NewConnection2=OldConnection2;
As the list of options can become a long string, it is possible to load it from a file which must be located in ${MODEL_BRIDGE_HOME}\data\MIMB\parameters and have the extension .txt. In such case, all options must be defined within that file as the only value of this parameter, e.g.
ETL/Miscellaneous.txt

JAVA ENVIRONMENT OPTIONS
-m <Java Memory's maximum size>
1G by default on 64bits JRE or as set in conf/conf.properties, e.g.
-m 8G
-m 8000M

-j <Java Runtime Environment command line options>
This option must be the last one in the Miscellaneous parameter as all the text after -j is passed "as is" to the JRE, e.g.
-j -Dname=value -Xms1G
The following option must be set when a proxy is used to access internet (this is critical to access https://repo.maven.apache.org/maven2/ (and exceptionally a few other tool sites) in order to download the necessary third party software libraries.
-j -Dhttp.proxyHost=127.0.0.1 -Dhttp.proxyPort=3128 -Dhttps.proxyHost=127.0.0.1 -Dhttps.proxyPort=3128 -Dhttp.proxyUser=user -Dhttp.proxyPassword=pass -Dhttps.proxyUser=user -Dhttps.proxyPassword=pass

-jre <Java Runtime Environment full path name>
It can be an absolute path to javaw.exe on Windows or a link/script path on Linux, e.g.
-jre "c:\Program Files\Java\jre1.8.0_211\bin\javaw.exe"

-v <Environment variable value>
None by default, e.g.
-v var1=value1 -v var2="value2 with spaces"

MODEL IMPORT OPTIONS
-model.name <model name>
Override the model name, e.g.
-model.name "My Model Name"

-prescript <script name>
The script must be located in the bin directory, and have .bat or .sh extension.
The script path must not include any parent directory symbol (..).
The script should return exit code 0 to indicate success, or another value to indicate failure.
For example:
-prescript "script.bat arg1 arg2"

-cache.clear
Clears the cache before the import, and therefore will run a full import without incremental harvesting.
Warning: this is a system option managed by the application calling the bridge and should not be set by users.

-backup <directory>
Full path of an empty directory to save the metadata input files for further troubleshooting.

DATA CONNECTION OPTIONS
Data Connections are produced by the import bridges typically from ETL/DI and BI tools to refer to the source and target data stores they use. These data connections are then used by metadata management tools to connect them (metadata stitching) to their actual data stores (e.g. databases, file system, etc.) in order to produce the full end to end data flow lineage and impact analysis. The name of each data connection is unique by import model. The data connection names used within DI/BI design tools are used when possible, otherwise connection names are generated to be short but meaningful such as the database / schema name, the file system path, or Uniform Resource Identifier (URI). The following options allows to manipulate connections. These options replaces the legacy options -c, -cd, and -cs.

-connection.cast ConnectionName=ConnectionType
Casts a generic database connection (e.g. ODBC/JDBC) to a precise database type (e.g. ORACLE) for SQL Parsing, e.g.
-connection.cast "My Database"="SQL SERVER".
The list of supported data store connection types includes:
ACCESS
CASSANDRA
DB2
DENODO
HIVE
MYSQL
NETEZZA
ORACLE
POSTGRESQL
PRESTO
REDSHIFT
SALESFORCE
SAP HANA
SNOWFLAKE
SQL SERVER
SYBASE
TERADATA
VECTORWISE
VERTICA

-connection.rename OldConnection=NewConnection
Renames an existing connection to a new name, e.g.
-connection.rename OldConnectionName=NewConnectionName
Multiple existing database connections can be renamed and merged into one new database connection, e.g.
-connection.rename MySchema1=MyDatabase -connection.rename MySchema2=MyDatabase

-connection.split oldConnection.Schema1=newConnection
Splits a database connection into one or multiple database connections.
A single database connection can be split into one connection per schema, e.g.
-connection.split MyDatabase
All database connections can be split into one connection per schema, e.g.
-connection.split *
A database connection can be explicitly split creating a new database connection by appending a schema name to a database, e.g.
-connection.split MyDatabase.schema1=MySchema1

-connection.map DestinationPath=SourcePath
Maps a source path to destination path. This is useful for file system connections when different paths points to the same object (directory or file).
On Hadoop, a process can write into a CSV file specified with the HDFS full path, but another process reads from a HIVE table implemented (external) by the same file specified using a relative path with default file name and extension, e.g.
-connection.map hdfs://host:8020/users/user1/folder/file.csv=/user1/folder
On Linux, a given directory (or file) like /data can be referred to by multiple symbolic links like /users/john and /users/paul, e.g.
-connection.map /users/John=/data -connection.map /users/paul=/data
On Windows, a given directory like C:\data can be referred to by multiple network drives like M: and N:, e.g.
-connection.map M:\=C:\data -connection.map N:\=C:\data

-pppd
Create the connections and connection data sets in DI/ETL design models. This feature should only be used when intending to export to another DI/ETL tool.

SALESFORCE OPTIONS
-access_token
the Salesforce access token. It is a 'long' case-sensitive alphanumeric key that is used FOR temporary (minutes or hours) access Salesforce. When an access token expires, attempts to use it fail. In Salesforce terms, the access token is a session ID (SID), much like a session cookie on other systems. It must be protected against misuse.
-instance_url your Salesforce insatance URL (e.g. -instance_url https://na73.salesforce.com)
STRING      

 

Bridge Mapping

Mapping information is not available