Upload
lamhanh
View
372
Download
10
Embed Size (px)
Citation preview
Simba Salesforce Adapter for SAP Data Services
Installation and Configuration Guide
Simba Technologies Inc.
Version 14.2.7
March 13, 2017
Copyright © 2017 Simba Technologies Inc. All Rights Reserved.
Information in this document is subject to change without notice. Companies, names and data used in examples herein are fictitious unless otherwise noted. No part of this publication, or the software it describes, may be reproduced, transmitted, transcribed, stored in a retrieval system, decompiled, disassembled, reverse-engineered, or translated into any language in any form by any means for any purpose without the express written permission of Simba Technologies Inc.
Trademarks
Simba, the Simba logo, SimbaEngine, and Simba Technologies are registered trademarks of Simba Technologies Inc. in Canada, United States and/or other countries. All other trademarks and/or servicemarks are the property of their respective owners.
Contact Us
Simba Technologies Inc.938 West 8th AvenueVancouver, BC CanadaV5Z 1E5
Tel: +1 (604) 633-0008
Fax: +1 (604) 633-0004
www.simba.com
www.simba.com 2
Installation and Configuration Guide
Table of Contents
About the Simba Salesforce Adapter for SAP Data Services 6
System Requirements 7SAP Data Services 7Job Server 7
Installing the Adapter 8Installing the Adapter on Windows 8Installing the Adapter on Linux 9Installing the Adapter on Solaris 10
Configuring the Adapter 11Creating an Adapter Instance 11Starting, Stopping, or Removing an Adapter Instance 14Creating an Adapter Datastore 15
Using the Adapter in SAP Data Services Designer 20Importing Metadata 20Viewing Table Metadata 21Deleting Imported Metadata 21Using Salesforce.com Metadata in Data Flows 22Using Boolean Conditionals in Queries 25Tuning Operations by Configuring Batch Sizes 25Using Changed Data Capture 26
Upgrading the Adapter 30Reconfiguring Adapter Instances and Datastores 30Differences in Salesforce API Support 31
Contact Us 84
Third-Party Trademarks 85
Third-Party Licenses 86
www.simba.com 3
Installation and Configuration Guide
About This Guide
PurposeThe Simba Salesforce Adapter for SAP Data Services Installation and Configuration Guide explains how to install and configure the Simba Salesforce Adapter for SAP Data Services in your SAP Data Services system so that you can use the adapter to work with data from Salesforce.com. This guide also includes detailed information about the adapter options and object parameters that you can configure when using the adapter in SAP Data Services Designer, as well as information about how the adapter handles Salesforce.com data types and Changed Data Capture (CDC).
AudienceThe guide is intended for end users of the Simba Salesforce Adapter for SAP Data Services, as well as administrators and developers implementing the adapter.
Knowledge PrerequisitesTo use the Simba Salesforce Adapter for SAP Data Services, the following knowledge is helpful:
l Ability to use SAP Data Services l Ability to use the data store that the adapter is accessing l An understanding of the role of adapters in enabling SAP Data Services to
connect to and integrate data l Knowledge about Changed Data Capture (CDC) l Experience with systems administration and integration l Ability to use SQL query statements
Document ConventionsItalics are used when referring to book and document titles.
Bold is used in procedures for graphical user interface elements that a user clicks and text that a user types.
Monospace font indicates commands, source code or contents of text files.
www.simba.com 4
Installation and Configuration Guide
Note:
A text box with a pencil icon indicates a short note appended to a paragraph.
Important:
A text box with an exclamation mark indicates an important comment related to the preceding paragraph.
www.simba.com 5
Installation and Configuration Guide
About the Simba Salesforce Adapter for SAP Data Services
The Simba Salesforce Adapter for SAP Data Services integrates directly with existing SAP Data Services systems and enables connections between Data Services and Salesforce.com. Using the adapter, you can import metadata from Salesforce.com and then work with that metadata when designing data flows in SAP Data Services Designer. You can also use the Changed Data Capture (CDC) feature in Data Services to keep imported data up-to-date with the data source.
Setting up the Simba Salesforce Adapter for SAP Data Services involves completing the following tasks, which are explained in this guide:
1. Installing the adapter on a Job Server 2. Creating and starting an adapter instance in the Administrator 3. Creating an adapter datastore in the Designer
For detailed information about SAP Data Services, see the official SAP Data Services documentation on the SAP Help Portal: https://help.sap.com/viewer/p/SAP_DATA_SERVICES.
www.simba.com 6
Installation and Configuration Guide About the Simba Salesforce Adapter forSAP Data Services
System Requirements
The Simba Salesforce Adapter for SAP Data Services needs to be installed on a machine that is hosting a Job Server for your SAP Data Services system. The machine on which you are installing the adapter must meet the following requirements.
SAP Data ServicesThe Simba Salesforce Adapter for SAP Data Services requires the following:
l SAP Data Services 4.2 Service Pack 5 Patch Level 3 or later l SAP JVM 1.8 or later
For information about how to install and configure SAP JVM 1.8 to work with SAP Data Services, see SAP Note 2275588. To search for SAP Notes, go to the "SAP Note & Knowledge Base Article Search" page: https://support.sap.com/notes.
Job ServerThe Job Server on which you plan to install the Simba Salesforce Adapter for SAP Data Services must be configured to manage adapters. For information about installing and configuring a Job Server, see the SAP Data Services Installation Guide on the SAP Help Portal: https://help.sap.com/viewer/p/SAP_DATA_SERVICES.
The host machine for the Job Server must be running one of the following operating systems:
l Windows Server 2008, 2008 R2, 2012, or 2012 R2 (64-bit AMD/Intel) l SUSE Linux SLES 11 (64-bit AMD/Intel) l SUSE RedHat EL 5 or 6 (64-bit AMD/Intel) l IBM AIX 6.1 or 7.1 (POWER) l Solaris 10 or 11 (SPARC)
www.simba.com 7
Installation and Configuration Guide System Requirements
Installing the Adapter
Install the Simba Salesforce Adapter for SAP Data Services on a machine that is hosting a Job Server for your SAP Data Services system.
The adapter is delivered as a ZIP file containing multiple subfolders. Each subfolder contains the version of the adapter that supports the platform indicated by the subfolder name.
The adapter is installed to the [LINK_DIR]\adapters\jars directory (or [LINK_DIR]/adapters/jars for non-Windows platforms), where [LINK_DIR] is the root directory for SAP Data Services. The default value of [LINK_DIR] is chosen when SAP Data Services is installed.
Important:
If you are replacing an existing installation of a Salesforce adapter, be aware that there are differences in Salesforce API support and that additional configuration steps are required after the installation process. For more information, see Upgrading the Adapter on page 30.
Installing the Adapter on WindowsThe Windows version of the Simba Salesforce Adapter for SAP Data Services is available as an MSI installer named SimbaSalesforceAdapterforSAPDataServices_[Version].[Build].msi, where [Version] and [Build] are the version number and build number of the adapter.
To install the adapter on a Windows machine:
1. Double-click SimbaSalesforceAdapterforSAPDataServices_[Version].[Build].msi to run the installer.
2. Click Next. 3. Select the check box to accept the terms of the License Agreement if you agree,
and then click Next. 4. Click Typical. 5. Click Install. 6. When the installation completes, click Finish. 7. If you received a license file through email, then copy the file to the [LINK_
DIR]\adapters\jars directory, where [LINK_DIR] is the root directory for SAP Data Services. The name of the license file is
www.simba.com 8
Installation and Configuration Guide Installing the Adapter
SimbaSalesforceAdapterforSAPDataServices.lic. You must have Administrator privileges when changing the contents of the directory.
8. If you installed the adapter on a hard drive that is not the C: drive, you must do the following to enable the Data Services Management Console to detect the adapter: a. Copy the Install_simbasalesforceadapter.xml file from the
installation package to the [DS_COMMON_DIR]\adapters\install directory, where [DS_COMMON_DIR] is the common configuration directory for the SAP Data Services system. The default location of [DS_COMMON_DIR] is chosen when SAP Data Services is installed.
b. Copy the Templates_simbasalesforceadapter.xml file from the installation package to the [DS_COMMON_DIR]\adapters\config\templates directory.
Installing the Adapter on LinuxThe Linux version of the Simba Salesforce Adapter for SAP Data Services is available as a tarball package named SimbaSalesforceAdapterforSAPDataServices_[Version].[Build].tar, where [Version] and [Build] are the version number and build number of the adapter. The tarball package contains a shell script named SimbaSalesforceAdapterforSAPDataServices_[Version].[Build].sh.
Important:
The Linux installer must be run by the user that installed SAP Data Services. The Linux installer assumes that [LINK_DIR] is defined.
To install the adapter on a Linux machine:
1. Extract the shell script from the SimbaSalesforceAdapterforSAPDataServices_[Version].[Build].tar tarball package.
2. Run the following command to make sure that the SimbaSalesforceAdapterforSAPDataServices_[Version].[Build].sh file is executable:
chmod +x SimbaSalesforceAdapterforSAPDataServices_[Version].[Build].sh
3. Run the SimbaSalesforceAdapterforSAPDataServices_[Version].[Build].sh script.
4. If you received a license file through email, then copy the file to the [LINK_DIR]/adapters/jars directory, where [LINK_DIR] is the root directory for SAP Data Services. The name of the license file is
www.simba.com 9
Installation and Configuration Guide Installing the Adapter
SimbaSalesforceAdapterforSAPDataServices.lic. You must have Administrator privileges when changing the contents of the directory.
Installing the Adapter on SolarisThe Solaris version of the Simba Salesforce Adapter for SAP Data Services is available as a tarball package named SimbaSalesforceAdapterforSAPDataServices_[Version].[Build].tar, where [Version] and [Build] are the version number and build number of the adapter. The tarball package contains the following files, where [LibVersion] is the version number of the library:
l force-wsc-[LibVersion].jar l gson-[LibVersion].jar l partner-[LibVersion].jar l SimbaSalesforceAdapter.jar
To install the adapter on a Solaris machine:
1. On the host machine for the Job Server, verify if the [LINK_DIR]/adapters/jars folder already exists, where [LINK_DIR] is the root directory for SAP Data Services. If not, then create the folder.
2. Extract the .jar files from the tarball package into the [LINK_DIR]/adapters/jars folder.
3. If you received a license file through email, then copy the file to the [LINK_DIR]/adapters/jars directory. The name of the license file is SimbaSalesforceAdapterforSAPDataServices.lic. You must have Administrator privileges when changing the contents of the directory.
www.simba.com 10
Installation and Configuration Guide Installing the Adapter
Configuring the Adapter
To configure the Simba Salesforce Adapter for SAP Data Services for use in SAP Data Services Designer, create and start an adapter instance through the Administrator on the Data Services Management Console, and then create an adapter datastore in the Designer.
Creating an Adapter InstanceYou need to create an instance of the Simba Salesforce Adapter for SAP Data Services in order to make it available in your Data Services system.
To create an adapter instance:
1. Go to the Administrator on the Data Services Management Console. 2. On the navigation pane on the left, expand Adapter Instances and then select
the Job Server on which you installed the Simba Salesforce Adapter for SAP Data Services.
3. Click the Adapter Configuration tab, then click Add, and then click SimbaSalesforceAdapter.
Note:
If you do not see the SimbaSalesforceAdapter option and the adapter is installed on a Windows machine, verify whether the adapter is installed on the C: drive. If it is not, then make sure that the necessary XML files have been copied into the common configuration directory for the SAP Data Services system. For more information, see Installing the Adapter on Windows on page 8.
4. Use the options in the Adapter Instance Startup configuration area to configure the adapter. For information about each configuration option, see Adapter Instance Startup Configuration Options on page 12.
Important:
You must provide a value in the Adapter Instance Name field.
5. Optionally, in the Run-time Configuration For Salesforce Adapter area, configure the logging behavior in the adapter by selecting a setting from the Log Level drop-down list. For more information, see Adapter Instance Run-Time Configuration Options on page 13.
6. To save your settings and create the adapter instance, click Apply.
You can now start the adapter instance to make it available for use in the Designer.
www.simba.com 11
Installation and Configuration Guide Configuring the Adapter
Adapter Instance Startup Configuration OptionsThe following table lists and describes the configuration options that are applied to an adapter instance when the instance is initially started. The options are listed in the top-down order in which they appear in the Data Services Management Console.
Option Description
Adapter Instance Name
A unique name for the adapter instance.
Important:
You must provide a value in this field.
Access Server Host The host name or IP address of the Access Server, which is used to support real-time jobs.
Access Server Port The number of the port that the Access Server uses to listen for real-time job requests.
Use SSL Protocol When this option is set to true, communication between the adapter and the Job Server is encrypted using the SSL (Secure Sockets Layer) protocol.
When this option is set to false, SSL encryption is not used.
Character Set Select the character set to and from which you want to convert text characters in the data.
Metadata Character Set
Select the character set to and from which you want to convert text characters in the metadata.
Adapter Retry Count The maximum number of times that Data Services attempts to restart the adapter instance if the instance stops working.
Adapter Retry Interval The amount of time in milliseconds that Data Services waits between each retry attempt.
Classpath The value to use for the -classpath Java parameter.
www.simba.com 12
Installation and Configuration Guide Configuring the Adapter
Option Description
Autostart When this option is set to true, the adapter instance starts automatically when Data Services starts.
When this option is set to false, the adapter instance does not start automatically.
Trace Mode When this option is set to true, the tracing functionality in the adapter includes a high level of detail in the logs.
When this option is set to false, the tracing functionality includes only a minimal amount of information in the logs.
Additional Java Launcher Options
A string of Java options to be applied when Data Services launches the Java process hosting the adapter. For example, you can modify the amount of memory allocated to the adapter by configuring Java Launcher options.
Adapter Type Name The name of the adapter on which the instance is based.
Note:
This option cannot be modified.
Adapter Version The version number of the adapter on which the instance is based.
Note:
This option cannot be modified.
Adapter Class The fully qualified class name of the adapter on which the instance is based.
Note:
This option cannot be modified.
Adapter Instance Run-Time Configuration OptionsThe Simba Salesforce Adapter for SAP Data Services provides a logging functionality to help with troubleshooting issues. Configure logging behavior by setting the Log
www.simba.com 13
Installation and Configuration Guide Configuring the Adapter
Level option, which is applied to the adapter instance during runtime.
Important:
Only enable logging long enough to capture an issue. Logging decreases performance and can consume a large quantity of disk space.
The adapter allows you to set the amount of detail included in log files. The following table lists the logging levels provided by the Simba Salesforce Adapter for SAP Data Services, in order from least verbose to most verbose.
Logging Level Description
OFF Disables all logging output generated by the adapter.
FATAL Logs very severe error events that lead the adapter to abort.
ERROR Logs error events that might allow the adapter to continue running.
WARNING Logs events that might result in an error if action is not taken.
INFO Logs general information that describes the progress of the adapter.
DEBUG Logs detailed information that is useful for debugging the adapter.
TRACE Logs all adapter activity.
The logs produced by the Simba Salesforce Adapter for SAP Data Services appear in the trace and error log files of the adapter instance. To access the trace and error log files, go to the Adapter Instances area of the Administrator, then click the Adapter Instance Status tab, and then click the Trace and Error links located in the same row as the adapter instance.
Starting, Stopping, or Removing an Adapter InstanceYou must start the adapter instance in order to make it available in the Designer.
www.simba.com 14
Installation and Configuration Guide Configuring the Adapter
To start an adapter instance:
1. In the Adapter Instances area of the Administrator, click the Adapter Instance Status tab.
2. Select the check box beside the name of the adapter instance that you want to start, and then click Start.
3. Refresh the Adapter Instance Status tab and verify that the status of the adapter is "Started".
Important:
If the Designer is already running, then you need to restart the program before the adapter becomes available.
To stop an adapter instance:
1. In the Adapter Instances area of the Administrator, click the Adapter Instance Status tab.
2. Select the check box beside the name of the adapter instance that you want to stop, and then click Shutdown.
3. Refresh the Adapter Instance Status tab and verify that the status of the adapter is "Shutdown".
To remove an adapter instance:
1. Stop the adapter instance. 2. In the Adapter Instances area of the Administrator, click the Adapter
Configuration tab. 3. Select the check box beside the name of the adapter instance that you want to
remove, and then click Remove.
Creating an Adapter DatastoreCreate an adapter datastore for the Simba Salesforce Adapter for SAP Data Services so that you can use the adapter to work with Salesforce.com metadata in the Designer.
To create an adapter datastore:
1. Start SAP Data Services Designer. 2. In the Local Object Library pane located in the lower-left part of the screen, click
the Datastores tab, then right-click inside the pane, and then click New. 3. Use the options in the Create New Datastore dialog box to configure your
adapter datastore:
www.simba.com 15
Installation and Configuration Guide Configuring the Adapter
a. In the Datastore Name field, type a unique name for your adapter datastore.
b. From the Datastore Type drop-down list, select Adapter. c. From the Job Server drop-down list, select the Job Server on which the
Simba Salesforce Adapter for SAP Data Services is installed and running. d. From the Adapter Instance Name drop-down list, select the Simba
Salesforce Adapter for SAP Data Services instance that you created. e. To configure advanced options for the datastore, click Advanced to
expand the options pane. For more information, see Advanced Options on page 16.
Important:
You must provide values in the Username and Password fields.
4. To save your settings and create the datastore, click OK.
The datastore appears in the Local Object Library pane. You can now use the Simba Salesforce Adapter for SAP Data Services to access metadata from Salesforce.com.
Advanced OptionsThe following table lists and describes the advanced options that you can configure for an adapter datastore. The options are listed in the top-down order in which they appear in the Advanced Options pane of the Create New Datastore dialog box or Edit Datastore dialog box.
Option Description
CDC Enable When this option is set to true, Changed Data Capture (CDC) is enabled and the adapter datastore tracks changes that have occurred in the data source since the data was last imported in Data Services. Tables that you import using this datastore cannot be used as target objects.
When this option is set to false, CDC is disabled.
Username Your user name for accessing Salesforce.com.
Password Your password for accessing Salesforce.com.
www.simba.com 16
Installation and Configuration Guide Configuring the Adapter
Option Description
Token Your security token for accessing Salesforce.com. For information about how to obtain a security token, see "Reset Your Security Token" in the Salesforce documentation: https://help.salesforce.com/apex/HTViewHelpDoc?id=user_security_token.htm.
Note:
Some connections require a security token, while others do not. Only provide a security token if your connection fails without it.
Web Service End Point
The authentication m_endpoint URL. If you do not specify an endpoint, the default value https://www.salesforce.com/services/Soap/u/37.0 is used.
Batch Size The maximum number of rows that a query returns at a time.
The maximum value is 2000 rows.
Bulk API Batch Size The maximum number of rows that can be sent to Salesforce.com in one bulk API call.
The maximum value is 10000 rows.
Metadata Resilience When set to yes, the adapter is resilient to metadata errors and does not return error messages if it detects missing columns or tables while running a job or operation. For more information, see Metadata Resilience on page 18.
When set to no, the adapter returns error messages if it detects missing columns or tables while running a job or operation.
www.simba.com 17
Installation and Configuration Guide Configuring the Adapter
Option Description
Default Base64Binary Field Length
The maximum length of Base64Binary field data passed in from Salesforce.com.
The maximum value is 5120000. Any data beyond this length is truncated.
ID Column Required When this option is set to true, the adapter requires every result set to include an ID column, and returns an error if there is no ID column.
When this option is set to false, ID columns are not required in result sets.
Retry Number The maximum number of times that the adapter retries a failed API call.
Proxy Host The IP address or host name of the proxy server.
Proxy Port The number of the port that the proxy server uses to listen for client connections.
Proxy Password Your password for accessing the proxy server.
Proxy User Name Your user name for accessing the proxy server.
Disable CDC Deleted Records
When this option is set to yes, the adapter does not retrieve deleted records during CDC operations.
When this option is set to no, the adapter retrieves deleted records during CDC operations.
Disable CDC Upserted Records
When this option is set to yes, the adapter does not retrieve inserted and updated records during CDC operations.
When this option is set to no, the adapter retrieves inserted or updated records during CDC operations.
Metadata Resilience
You can prevent the adapter from returning error messages in some cases where it detects missing columns or tables by setting the Metadata Resilience option to yes.
www.simba.com 18
Installation and Configuration Guide Configuring the Adapter
When metadata resilience is enabled, the adapter does not return error messages if it encounters the following scenarios while sending data to Salesforce.com:
l A table no longer exists, so the adapter does not make any changes in Salesforce.com.
l A column no longer exists, so the adapter does not send a value for that column to Salesforce.com.
Note:
The following metadata resilience functionality is expected to be available in a later version of the driver.
When metadata resilience is enabled, the adapter does not return error messages if it encounters the following scenarios while reading data from a source:
l A table no longer exists, so the adapter returns no records from the query. l A field that is currently used in a data flow no longer exists, so the adapter returns
a NULL value for every row of that field to Data Services. l A field that is currently used in a WHERE clause no longer exists, so the adapter
interprets the part of the WHERE clause containing that field as FALSE.
For example, if the WHERE clause is WHERE ColumnA = A or ColumnB = B and ColumnB no longer exists, then the adapter interprets the clause as WHERE Column A = A.
www.simba.com 19
Installation and Configuration Guide Configuring the Adapter
Using the Adapter in SAP Data Services Designer
After you create an adapter datastore for the Simba Salesforce Adapter for SAP Data Services, you can import metadata from Salesforce.com and use it in your data flows.
Importing MetadataUse the adapter datastore to import the Salesforce.com metadata that you want to use in your data flows. You can browse for metadata to import, or specify the name of a table to import.
To import metadata by browsing:
1. In the Local Object Library pane located in the lower-left part of the screen, click the Datastores tab, and then double-click your adapter datastore.
The Datastore Explorer lists the tables that are available through your Salesforce.com connection.
2. To view information about a table, expand the table and then expand any of the following folders as needed:
l Referenced By: This folder contains the tables that reference the selected table. It is not available if the selected table is not referenced by other tables.
l References: This folder contains the tables that the selected table references. It is not available if the selected table does not reference other tables.
l Columns: This folder contains the columns that are part of the selected table.
3. Choose one: l To import the metadata of a specific table, right-click the table and then
click Import. l To import the metadata of all the tables that belong to a folder, right-click
the folder and then click Import.
In the Local Object Library pane, the imported metadata appears as tables nested under the adapter datastore.
To import metadata by name:
1. In the Local Object Library pane located in the lower-left part of the screen, click the Datastores tab.
2. Right-click your adapter datastore and then click Import By Name.
www.simba.com 20
Installation and Configuration Guide Using the Adapter in SAP Data ServicesDesigner
3. In the Table Name field, type the table name of the metadata that you want to import, and then click OK.
In the Local Object Library pane, the imported metadata appears as tables nested under the adapter datastore.
The DI_PICKLIST_VALUES TableA picklist is a Salesforce.com field type that contains a numbered list of values from which one value can be selected. The Simba Salesforce Adapter for SAP Data Services represents picklists using a virtual table named DI_PICKLIST_VALUES, which contains all the picklists in your Salesforce.com data source. To use picklist values in your data flows, use the adapter to import the DI_PICKLIST_VALUES table.
Important:
The DI_PICKLIST_TABLE does not appear when you browse a CDC-enabled datastore.
Viewing Table MetadataAfter you import a table into your datastore, you can open it to view information such as the attributes that apply to the table and the columns that the table contains.
To view table metadata:
1. In the Local Object Library pane located in the lower-left part of the screen, click the Datastores tab, then expand the adapter datastore and the Tables node, and then double-click the table for which you want to view the metadata.
2. In the Table Metadata pane, browse through the tabs as needed to view information about the table.
For detailed information about the attributes that appear in the Table Metadata pane, see the SAP Data Services Reference Guide on the SAP Help Portal: https://help.sap.com/viewer/p/SAP_DATA_SERVICES.
Deleting Imported MetadataYou can delete imported metadata from your adapter datastore.
To delete imported metadata:
1. In the Local Object Library pane located in the lower-left part of the screen, click the Datastores tab, and then expand the adapter datastore and the Tables node.
www.simba.com 21
Installation and Configuration Guide Using the Adapter in SAP Data ServicesDesigner
2. Right-click the table containing the metadata that you want to delete, and then click Delete. When prompted for confirmation, click Yes.
Using Salesforce.com Metadata in Data FlowsAfter installing and configuring the Simba Salesforce Adapter for SAP Data Services, creating a datastore for the adapter, and importing the metadata, you can work with Salesforce.com metadata in SAP Data Services Designer and use the metadata as a target or a source in your data flows. For detailed information about using the Designer and creating data flows, see the SAP Data Services Designer Guide on the SAP Help Portal: https://help.sap.com/viewer/p/SAP_DATA_SERVICES.
The following tables describe the data type mappings, adapter source parameters, and adapter target parameters that are supported for Salesforce data.
Data TypesThe Simba Salesforce Adapter for SAP Data Services supports many common data formats, converting them between Salesforce data types and Data Services data types.
The following table lists the supported data type mappings.
Salesforce Primitive Type Data Services Type
Base64 VarChar (base64-encoded)
Boolean VarChar (as "true" or "false")
Currency Double
Date Date
Date/Time (timestamp) DateTime
Double Double
Int Integer
Time Double
String VarChar
www.simba.com 22
Installation and Configuration Guide Using the Adapter in SAP Data ServicesDesigner
Adapter Source ParametersThe following table lists and describes the parameters you can configure in a metadata table that is imported by the Simba Salesforce Adapter for SAP Data Services and used as a source in a data flow. The parameters are listed in the top-down order in which they appear in the Adapter Source tab in the Source Table Editor.
Parameter Description
Check-Point Column
Do not specify a value in this field. In the Simba Salesforce Adapter for SAP Data Services, this parameter is used in back-end processes only, and the value cannot be modified.
CDC Start Date A start date to use for CDC operations. Type a date using the format yyyy.mm.dd 24h:mm:ss. For example, 2015.12.31 18:30:00
A CDC read starts from this date if the date is within the Salesforce.com retention period and either of these conditions are met:
l The date is further in the past than the current check-point date.
l Or, there is no check-point date.
Note:
This parameter is applicable only when CDC is enabled. Also, Salesforce.com does not take seconds into account for getUpdated() and getDeleted() requests because the Salesforce API truncates dateTime values. For more information, see "Polling for Changes" in the Salesforce.com documentation: https://www.salesforce.com/developer/docs/api/Content/polling_for_changes.htm.
Fetch Deleted Records
When this parameter is set to yes, queries to the Salesforce API are executed with QueryAll() functionality. For more information, see "QueryAll" in the Force.com REST API Developer Guide: https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_queryall.htm.
When set to no, queries are executed normally.
www.simba.com 23
Installation and Configuration Guide Using the Adapter in SAP Data ServicesDesigner
Adapter Target ParametersThe following table lists and describes the parameters you can configure in metadata that is imported by the Simba Salesforce Adapter for SAP Data Services and used as a target in a data flow. The parameters are listed in the top-down order in which they appear in the Adapter Target tab in the Target Table Editor.
Parameter Description
Loader Batch Size The maximum number of rows at a time that SAP Data Services can send to the Simba Salesforce Adapter for SAP Data Services.
When this value is set to 0, SAP Data Services sends every row to the adapter at the same time.
Note:
It is recommended that you do not set this value higher than the Bulk API Batch Size value specified in the datastore. For information about using this option to tune for large loads, see Tuning Operations by Configuring Batch Sizes on page 25.
Auto Correct Load When this parameter is set to yes, the adapter uses an UPSERT operation when loading data into the target. For example, if you insert a row that already exists in the target, then the adapter updates the existing row instead of inserting a duplicate row.
When this parameter is set to no, the adapter uses INSERT instead of UPSERT. For example, if you insert a row that already exists in the target, then the adapter inserts a new (duplicate) row.
Important:
You must specify a column name in the External ID Column parameter before the Auto Correct Load parameter can be used, because UPSERT statements in Salesforce require a field that is set up as an external ID.
www.simba.com 24
Installation and Configuration Guide Using the Adapter in SAP Data ServicesDesigner
Parameter Description
External ID Column The name of a Salesforce column that is set up as an external ID. To verify if a column is an external ID, check the Description field of that column.
External ID is a column attribute that you can specify in Salesforce. For more information, see "What is an external ID?" in the Salesforce documentation: https://help.salesforce.com/apex/HTViewHelpDoc?id=faq_import_general_what_is_an_external.htm.
Important:
You must specify a column name in the External ID Column parameter before the Auto Correct Load parameter can be used, because UPSERT statements in Salesforce require a field that is set up as an external ID.
Using Boolean Conditionals in QueriesIn the Designer, when you write a query that has a WHERE clause containing a Boolean value, the value must be specified as 1 or 0 instead of true or false.
The following is an example of a WHERE clause that checks for fields where the value of bool_c is true:
WHERE bool_c = 1
The following is an example of a WHERE clause that checks for fields where the value of bool_c is false:
WHERE bool_c = 0
If you use true or false instead, the query does not run.
Tuning Operations by Configuring Batch SizesThe Salesforce API allows you to specify the maximum number of rows that can be sent in a single Bulk API request. The Bulk API Batch Size datastore option specifies the number of rows at a time that the Simba Salesforce Adapter for SAP Data Services can send to Salesforce.com, and the Loader Batch Size adapter target parameter
www.simba.com 25
Installation and Configuration Guide Using the Adapter in SAP Data ServicesDesigner
specifies the number of rows at a time that SAP Data Services can send to the target table. You can configure these options to tune operations that involve rows containing large amounts of data.
It is recommended that you do not set the Loader Batch Size parameter in the target table to a value that is greater than the Bulk API Batch Size datastore option. Doing so might cause the Simba Salesforce Adapter for SAP Data Services to handle operations less efficiently.
Example: Configuring Batch Sizes to Optimize Adapter PerformanceFor example, if Loader Batch Size is set to 7500, Bulk API Batch Size is set to 5000, and SAP Data Services is sending 15000 rows, then the following occurs:
l Data Services sends a batch of 7500 rows to the adapter, causing the adapter to send a batch of 5000 rows and then a second batch of 2500 rows to Salesforce.com.
l Then, Data Services sends a second batch of 7500 rows to the adapter, again causing the adapter to send a batch of 5000 rows and then a second batch of 2500 rows to Salesforce.com.
In this scenario, the adapter uses a total of 4 API calls to send 15000 rows.
Setting these batch size options properly can optimize how the Simba Salesforce Adapter for SAP Data Services handles operations. For example, if Loader Batch Size and Bulk API Batch Size are both set to 5000 and SAP Data Services is sending 15000 rows, then the following occurs:
l Data Services sends a batch of 5000 rows to the adapter, causing the adapter to send a batch of 5000 rows to Salesforce.com.
l This same operation repeats twice.
In this scenario, the adapter uses only 3 API calls to send 15000 rows.
Using Changed Data CaptureChanged Data Capture (CDC) is an SAP Data Services feature that tracks and reports the changes that have occurred in your data source since the last time you imported data from it and enables you to update the relevant targets in your data flows by applying those changes. To enable this feature, set the CDC Enable option to true in your adapter datastore.
www.simba.com 26
Installation and Configuration Guide Using the Adapter in SAP Data ServicesDesigner
When you import a table using a datastore that has CDC enabled, the Simba Salesforce Adapter for SAP Data Services generates the following three columns in the imported table:
l DI_OPERATION_TYPE: This column contains the type of change that was made to the data (INSERT, UPDATE, or DELETE).
l DI_SEQUENCE_NUMBER: This column contains the sequence number. For example, a changed data record with sequence number 3 would be the third change that was made during the CDC time interval.
l SFDC_TIMESTAMP: This column contains the timestamp from Salesforce.com indicating when the change occurred.
Important:
When CDC is enabled, the tables in the datastore cannot be used as target objects in data flows.
Setting a Start Date for Changed Data CaptureNormally, a CDC operation reads every change in the data source that has occurred within the Salesforce.com retention period. To avoid redundancy and optimize the process, you can enable check-points or use the date specified in the CDC Start Date source object parameter.
Check-points mark the date of your last CDC read so that the next CDC operation only reads changes that have occurred after that date. Each check-point is associated with a subscription name, which identifies the user that executed the CDC operation. Subscription names enable the data source to contain multiple unique check-points and to support cases where multiple users are executing CDC operations on the same data. To enable check points, on the CDC Options tab of a source object, select the Enable Check-Point check box and type a name in the CDC Subscription Name field.
Alternatively, you can specify a start date using the CDC Start Date parameter available on the Adapter Source tab of a source object. CDC reads start from this date if the date occurs within the Salesforce.com retention period and either of the following conditions are met:
l The start date occurs after the check-point date. l Or, there is no check-point date available.
Otherwise, CDC reads start from the check-point date.
www.simba.com 27
Installation and Configuration Guide Using the Adapter in SAP Data ServicesDesigner
Designing a Data Flow with Changed Data CaptureThe following procedure describes one method of using CDC. For more information about CDC, see the SAP Data Services Designer Guide on the SAP Help Portal: https://help.sap.com/viewer/p/SAP_DATA_SERVICES.
To design a data flow with Changed Data Capture:
1. In the Advanced Options pane for your adapter datastore, set the CDC Enable option to true.
2. Use the adapter datastore to import the table that you want to check for changes. 3. Create a data flow that uses the CDC-enabled table as the source object, and
then connect the source to a Query transform. 4. Double-click the Query transform and then map the columns from the CDC table
to the Query transform by selecting all the nodes in the Schema In pane and dragging them into the Schema Out pane.
5. In the data flow, double-click the source object, then click the CDC Options tab, and then configure the following options: a. In the CDC Subscription Name field, type a unique name for identifying a
checkpoint. b. To enable check-points so that CDC operations start from the date of the
last read instead of reading every change in the Salesforce.com retention period, select the Enable Check-Point check box.
Important:
Do not select the Get Before-Image For Each Update Row check box. This feature is not supported in Salesforce.com data sources.
6. Click the Adapter Source tab and then configure the following options: a. In the Check-Point Column field, type a name for the column that contains
check-point timestamps. b. In the CDC Start Date field, type a start date for your CDC request using
the format yyyy.mm.dd 24h:mm:ss. For example, 2015.12.31 18:30:00.
Note:
Salesforce.com does not take seconds into account for getUpdated() and getDeleted() requests because the Salesforce API truncates dateTime values. For more information, see "Polling for Changes" in the Salesforce.com documentation: https://www.salesforce.com/developer/docs/api/Content/polling_for_changes.htm.
www.simba.com 28
Installation and Configuration Guide Using the Adapter in SAP Data ServicesDesigner
c. To include records that have been deleted from the data source in your CDC results, set the Disable CDC Deleted Records option to no.
7. In the data flow, add a Map_CDC_Operation transform and then connect the Query transform to it.
8. Double-click the Map_CDC_Operation transform, and then verify that the Sequencing column is set to DI_SEQUENCE_NUMBER and the Row Operation column is set to DI_OPERATION_TYPE.
9. In the data flow, add the table to which you want to apply the changes tracked by CDC, then set the table as the target object, and then connect the Map_CDC_Operation transform to the target.
When you run the job that contains this data flow, the CDC-enabled source object retrieves the changes that have been made to the table in the database, and then these changes are applied to the target object.
Operation Mapping in CDCA CDC operation returns a record for each individual change made in the Salesforce.com data. For example, if a row has been inserted in the Salesforce.com data source, then the CDC operation returns an INSERT record in Data Services.
When multiple changes occur to the same row in the data source and the final change is a DELETE operation, CDC represents these changes by returning only a single DELETE record in Data Services.
When a row is inserted and then updated, CDC returns an INSERT record and an UPDATE record, but both records shows the results of updating the row. The records do not show the state of the row between the INSERT and UPDATE operations.
www.simba.com 29
Installation and Configuration Guide Using the Adapter in SAP Data ServicesDesigner
Upgrading the Adapter
If you replace an existing installation of a Salesforce adapter with another one, be aware that there are differences in Salesforce API support and that additional configuration steps are required. These differences apply if you are doing either of the following:
l Upgrading from the SAP Data Services Adapter for Salesforce.com to the Simba Salesforce Adapter for SAP Data Services.
l Or, upgrading from an earlier version of the Simba Salesforce Adapter for SAP Data Services to a later version.
Reconfiguring Adapter Instances and DatastoresIf you replace an existing installation of a Salesforce adapter with another one, you must recreate the adapter instances and change the web service end point used by the adapter datastores.
To reconfigure the adapter instances and datastores:
1. Note the names of any existing adapter instances, and then shut down and remove each one. For detailed instructions, see Starting, Stopping, or Removing an Adapter Instance on page 14.
2. Create adapter instances with the names noted in step 1 and then start the new adapters.
3. In SAP Data Services Designer, do the following for each Simba Salesforce adapter datastore: a. Right-click the datastore and select Edit. b. In the Web Service End Point field, change the value to
https://login.salesforce.com/services/Soap/u/[APIVersion], where [APIVersion] is the Salesforce API version that the adapter uses:
Simba Salesforce Adapter Version API Version
14.2.4 33.0
14.2.5 35.0
14.2.6 36.0
14.2.7 37.0
www.simba.com 30
Installation and Configuration Guide Upgrading the Adapter
c. Click OK.
Differences in Salesforce API SupportThe SAP Data Services Adapter for Salesforce.com supports a different Salesforce API version compared to the Simba Salesforce Adapter for SAP Data Services, and different releases of the Simba Salesforce Adapter for SAP Data Services all support different Salesforce API versions as well. The fields that are available when you browse your metadata in the Datastore Explorer vary depending on the Salesforce API version that the adapter is using, so it is recommended that you refer to the following tables to verify how your metadata is affected when you change from one adapter to another.
SAP Data Services Adapter for Salesforce.com version 4.2 uses Salesforce API 21. The following table lists the Salesforce API version that is used in each version of the Simba Salesforce Adapter for SAP Data Services.
Simba Salesforce Adapter Version API Version
14.2.4 33
14.2.5 35
14.2.6 36
14.2.7 37
The following tables outline some of the metadata field differences between the Salesforce API versions that are used in the SAP Data Services Adapter for Salesforce.com and the Simba Salesforce Adapter for SAP Data Services:
l API Version 21 vs. 33 on page 31 l API Version 33 vs. 35 on page 43 l API Version 35 vs. 36 on page 68 l API Version 36 vs. 37 on page 73
API Version 21 vs. 33SAP Data Services Adapter for Salesforce.com version 4.2 uses Salesforce API 21, while Simba Salesforce Adapter for SAP Data Services 14.2.4 uses Salesforce API 33.
www.simba.com 31
Installation and Configuration Guide Upgrading the Adapter
Required Fields that were Removed between Version 21 and 33
The following table lists some of the fields that were required (non-nullable) in Salesforce API 21, but are no longer used in Salesforce API 33. The fields are organized based on the tables in which they were available.
Table Name Field Name
CustomConsoleComponent Developer Name
IsWidthFixed
IsHeightFixed
IsHidden
IsPopoutDIsabled
MasterLabel
PushTopic NotifyForOperations
User UserPreferencesDisableAutoSubForFeeds
UserPreferencesOptOutOfTouch
Fields that Became Required between Version 21 and 33
The following table lists some of the required (non-nullable) fields that are used in Salesforce API 33 but not in Salesforce API 21. The fields are organized based on the tables in which they are available.
Table Name Field Name
ActionLinkGroupTemplate Category
DeveloperName
ExecutionsAllowed
IsPublished
MasterLabel
www.simba.com 32
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
ActionLinkTemplate ActionLinkGroupTemplateId
ActionUrl
IsConfirmationRequired
IsGroupDefault
LabelKey
LinkType
Method
Position
UserVisibility
Announcement ExpirationDate
FeedItemId
ApexPage IsAvailableInTouch
IsConfirmationTokenRequired
AuthProvider DeveloperName
FriendlyName
OptionsIncludeOrgIdInId
OptionsSendAccessTokenInHeader OptionsSendClientCredentialsInHeader
ProviderType
CollaborationGroup IsArchived
IsAutoArchiveDisabled
CollaborationGroupRecord CollaborationGroupId
RecordId
www.simba.com 33
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
ContentDistribution ContentVersionId
Name
OwnerId
PreferencesAllowOriginalDownload
PreferencesAllowPDFDownload
PreferencesAllowViewInBrowser
PreferencesExpires
PreferencesLinkLatestVersion
PreferencesNotifyOnVisit
PreferencesNotifyRndtnComplete
PreferencesPasswordRequired
ContentVersion ContentLocation
IsMajorVersion
Origin
CorsWhitelistEntry DeveloperName
MasterLabel
UrlPattern
CustomConsoleComponent
DeveloperName
IsHeightFixed
IsHidden
IsPopoutDisabled
IsWidthFixed
MasterLabel
www.simba.com 34
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
DuplicateRecordItem DuplicateRecordSetId
RecordId
DuplicateRecordSet DuplicateRuleId
EmailDomainKey Domain
DomainMatch
IsActive
Selector
EventRelation EventId
RelationId
ExternalDataUserAuth ExternalDataSourceId
FieldPermissions Field
ParentId
PermissionsEdit
PermissionsRead
SobjectType
ListViewChart AggregateType
ChartType
DeveloperName
MasterLabel
OwnerId
SobjectType
Macro Name
OwnerId
www.simba.com 35
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
MacroShare AccessLevel
ParentId
UserOrGroupId
MobileDeviceRegistrar DeveloperName
MasterLabel
Provider
ObjectPermissions ParentId
PermissionsCreate
PermissionsDelete
PermissionsEdit
PermissionsModifyAllRecords
PermissionsRead
PermissionsViewAllRecords
SobjectType
Order OwnerId
www.simba.com 36
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
PermissionSet PermissionsAllowUniversalSearch
PermissionsAllowViewKnowledge
PermissionsAssignPermissionSets
PermissionsAssignTopics
PermissionsChatterForSharePoint
PermissionsConfigCustomRecs
PermissionsConnectOrgToEnvironmentHub
PermissionsCreateCustomizeFilters
PermissionsCreateTopics
PermissionsCreateWorkBadgeDefinition
PermissionsCustomMobileAppsAccess
PermissionsDeleteTopics
PermissionsEditTopics
PermissionsForceTwoFactor
PermissionsGovernNetworks
PermissionsIdentityConnect
PermissionsIdentityEnabled
PermissionsManageCustomPermissions
PermissionsManageExchangeConfig
PermissionsManageInternalUsers
PermissionsManageIpAddresses
PermissionsManageLoginAccessPolicies
PermissionsManagePasswordPolicies
PermissionsManageProfilesPermissionsets
PermissionsManageRoles
www.simba.com 37
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
PermissionsManageSearchPromotionRules
PermissionsManageSharing
PermissionsManageTwoFactor
PermissionsManageUnlistedGroups
PermissionsMergeTopics
PermissionsSalesConsole
PermissionsShareInternalArticles
PermissionsTwoFactorApi
PermissionsViewAllUsers
PermissionsViewEventLogFiles
PermissionsViewHelpLink
PermissionsWorkDotComUserPerm
PermissionSetLicenseAssign
AssigneeId
PermissionSetLicenseId
PushTopic NotifyForOperationCreate
NotifyForOperationDelete
NotifyForOperationUndelete
NotifyForOperationUpdate
SearchPromotionRule Query
SetupEntityAccess ParentId
SetupEntityId
StreamingChannel Name
OwnerId
www.simba.com 38
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
StreamingChannelShare AccessLevel
ParentId
UserOrGroupId
Topic Name
TopicAssignment EntityId
TopicId
www.simba.com 39
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
User EmailPreferencesAutoBcc
EmailPreferencesAutoBccStayInTouch
EmailPreferencesStayInTouchReminder
UserPermissionsChatterAnswersUser
UserPermissionsSupportUser
UserPermissionsWorkDotComUserFeature
UserPreferencesDisableAllFeedsEmail
UserPreferencesDisableBookmarkEmail
UserPreferencesDisableChangeCommentEmail
UserPreferencesDisableEndorsementEmail
UserPreferencesDisableFeedbackEmail
UserPreferencesDisableFileShareNotificationsForApi
UserPreferencesDisableFollowersEmail
UserPreferencesDisableLaterCommentEmail
UserPreferencesDisableLikeEmail
UserPreferencesDisableMentionsPostEmail
UserPreferencesDisableMessageEmail UserPreferencesDisableProfilePostEmail
UserPreferencesDisableRewardEmail
UserPreferencesDisableSharePostEmail
UserPreferencesDisableWorkEmail
UserPreferencesDisCommentAfterLikeEmail
UserPreferencesDisMentionsCommentEmail
UserPreferencesDisProfPostCommentEmail
www.simba.com 40
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
UserPreferencesEnableAutoSubForFeeds
UserPreferencesHideChatterOnboardingSplash
UserPreferencesHideS1BrowserUI
UserPreferencesHideSecondChatterOnboardingSplash
UserPreferencesOptOutOfTouch
UserPreferencesProcessAssistantCollapsed
UserPreferencesShowCityToExternalUsers
UserPreferencesShowCityToGuestUsers
UserPreferencesShowCountryToExternalUsers
UserPreferencesShowCountryToGuestUsers
UserPreferencesShowEmailToExternalUsers
UserPreferencesShowFaxToExternalUsers
UserPreferencesShowManagerToExternalUsers
UserPreferencesShowMobilePhoneToExternalUsers
UserPreferencesShowPostalCodeToExternalUsers
UserPreferencesShowPostalCodeToGuestUsers
UserPreferencesShowProfilePicToGuestUsers
UserPreferencesShowStateToExternalUsers
UserPreferencesShowStateToGuestUsers
UserPreferencesShowStreetAddressToExternalUsers
UserPreferencesShowTitleToExternalUsers
UserPreferencesShowTitleToGuestUsers
UserPreferencesShowWorkPhoneToExternalUsers
www.simba.com 41
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
UserPackageLicense PackageLicenseId
UserId
UserShare UserAccessLevel
UserId
UserOrGroupId
WorkAccess AccessType
OwnerId
ParentId
WorkAccessShare AccessLevel
ParentId
UserOrGroupId
WorkBadge DefinitionId
RecipientId
SourceId
WorkBadgeDefinition Description
ImageUrl
IsActive
IsCompanyWide
IsLimitPerUser
Name
OwnerId
www.simba.com 42
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
WorkBadgeDefinitionShare AccessLevel
ParentId
UserOrGroupId
WorkThanks GiverId
Message
OwnerId
WorkThanksShare AccessLevel
ParentId
UserOrGroupId
API Version 33 vs. 35Simba Salesforce Adapter for SAP Data Services 14.2.4 uses Salesforce API 33, while version 14.2.5 of the adapter uses Salesforce API 35.
Required Fields that were Removed between Version 33 and 35
The following table lists some of the fields that were required (non-nullable) in Salesforce API 33, but are no longer used in Salesforce API 35. The fields are organized based on the tables in which they were available.
Table Name Field Name
DataType Name
Namespace
NamespacePrefix
ServiceId
EntityDefinition IsCreatable
IsDeletable
PlatformAction ActionTargetUrl
www.simba.com 43
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
ServiceFieldDataType DataTypeId
DurableId
Id
FieldDefinitionid
ServiceId
Fields that Became Required between Version 33 and 35
The following table lists some of the required (non-nullable) fields that are used in Salesforce API 35 but not in Salesforce API 33. The fields are organized based on the tables in which they are available.
Table Name Field Name
Account BillingGeocodeAccuracy
ShippingGeocodeAccuracy
AccountFeed IsRichText
ActionLinkGroupTemplate Label
ActivityHistory ActivitySubtype
www.simba.com 44
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
ApexEmailNotification CreatedById
CreatedDate
Id
IsDeleted
LastModifiedById
LastModifiedDate
SystemModstamp
UserId
AppMenuItem IsAccessible
IsVisible
UserSortOrder
AssetFeed IsRichText
AttachedContentDocument ExternalDataSourceType
SharingOption
AuthSession LoginGeoId
CampaignFeed IsRichText
CampaignMember Name
CaseFeed IsRichText
CollaborationGroupFeed IsRichText
CombinedAttachment ExternalDataSourceType
SharingOption
www.simba.com 45
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
Contact MailingGeocodeAccuracy
OtherGeocodeAccuracy
ContactFeed IsRichText
ContentDocument SharingOption
ContentDocumentFeed IsRichText
ContentFolder Id
IsDeleted
Name
CreatedDate
CreatedById
LastModifiedDate
LastModifiedById
SystemModstamp
ParentContentFolderId
ContentFolderItem CreatedById
www.simba.com 46
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
ContentFolderItem (continued) CreatedDate
ContentSize
FileExtension
FileType
Id
IsDeleted
IsFolder
LastModifiedById
LastModifiedDate
ParentContentFolderId
SystemModstamp
Title
ContentFolderMember ChildRecordId
CreatedById
CreatedDate
Id
IsDeleted
LastModifiedById
LastModifiedDate
ParentContentFolderId
ContentVersion SharingOption
TextPreview
Contract BillingGeocodeAccuracy
ShippingGeocodeAccuracy
www.simba.com 47
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
ContractFeed IsRichText
Dashboard FolderName
DashboardComponentFeed IsRichText
DashboardFeed IsRichText
DataType ContextServiceDataTypeId
ContextWsdlDataTypeId
DeveloperName
DurableId
Id
IsComplex
Name
Namespace
NamespacePrefix
ServiceId
DuplicateRule IsActive
EmailTemplate EntityType
UiType
www.simba.com 48
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
EntityDefinition DetailUrl
EditDefinitionUrl
EditUrl
HelpSettingPageName
HelpSettingPageUrl
IsCustomSetting
IsDeprecatedAndHidden
IsEverCreatable
IsEverDeletable
IsEverUpdatable
IsFeedEnabled
IsIdEnabled
IsLayoutable
EntityDefinition (continued) IsReplicateable
IsRetrieveable
IsSearchLayoutable
IsSearchable
IsTriggerable
LastModifiedById
LastModifiedDate
NewUrl
PublisherId
RecordTypesSupported
RunningUserEntityAccessId
www.simba.com 49
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
EntityParticle ByteLength
DataType
DefaultValueFormula
DeveloperName
Digits
DurableId
EntityDefinitionId
ExtraTypeInfo
FieldDefinitionId
Id
InlineHelpText
IsApiFilterable
IsApiGroupable
IsApiSortable
IsAutonumber
IsCalculated
IsCaseSensitive
www.simba.com 50
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
EntityParticle (continued) IsCompactLayoutable
IsCreatable
IsDefaultedOnCreate
IsDependentPicklist
IsDeprecatedAndHidden
IsDisplayLocationInDecimal
IsEncrypted
IsFieldHistoryTracked
IsHighScaleNumber
IsHtmlFormatted
IsIdLookup
IsLayoutable
IsNameField
IsNamePointing
IsNillable
IsPermissionable
IsUnique
IsUpdatable
IsWriteRequiresMasterRead
IsWorkflowFilterable
Label
Length
Mask
MaskType
MasterLabel
www.simba.com 51
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
Name
NamespacePrefix
Precision
QualifiedApiName
EntityParticle (continued) ReferenceTargetField
ReferenceTo
RelationshipName
RelationshipOrder
Scale
ServiceDataTypeId
ValueTypeId
Event EventSubtype
EventFeed IsRichText
ExternalDataSource IsWritable
FeedComment LastEditDate
LastEditById
Revision
FeedItem IsRichText
LastEditDate
LastEditById
Revision
www.simba.com 52
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
FeedRevision Action
CreatedById
CreatedDate
EditedAttribute
FeedEntityId
Id
IsDeleted
IsValueRichText
Revision
SystemModstamp
FeedRevision (continued) Value
www.simba.com 53
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
FieldDefinition ControllingFieldDefinitionId
ExtraTypeInfo
IsApiFilterable
IsApiGroupable
IsApiSortable
IsCalculated
IsFieldHistoryTracked
IsHighScaleNumber
IsHtmlFormatted
IsIndexed
IsListFilterable
IsListSortable
IsListVisible
IsNameField
IsNillable
LastModifiedDate
Length
Precision
ReferenceTargetField
ReferenceTo
RelationshipName
RunningUserFieldAccessId
Scale
ValueTypeId
www.simba.com 54
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
FlowInterview Guid
FolderedContentDocument ContentDocumentId
ContentSize
FolderedContentDocument (continued)
CreatedById
CreatedDate
FileExtension
FileType
Id
IsDeleted
IsFolder
LastModifiedById
LastModifiedDate
ParentContentFolderId
SystemModstamp
Title
Lead GeocodeAccuracy
LeadFeed IsRichText
www.simba.com 55
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
LoginGeo City
Country
CountryIso
CreatedById
CreatedDate
Id
IsDeleted
LastModifiedById
LastModifiedDate
Latitude
LoginTime
Longitude
PostalCode
Subdivision
LoginGeo (continued) SystemModstamp
LoginHistory AuthenticationServiceId
LoginGeoId
LookedUpFromActivity ActivitySubtype
www.simba.com 56
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
MacroInstruction CreatedById
CreatedDate
Id
IsDeleted
LastModifiedById
LastModifiedDate
MacroId
Name
Operation
SortOrder
SystemModstamp
Target
Value
ValueRecord
NamedCredential CalloutOptionsAllowMergeFieldsInBody
CalloutOptionsAllowMergeFieldsInHeader
CalloutOptionsGenerateAuthorizationheader
OpenActivity ActivitySubtype
Opportunity HasOpenActivity
HasOverdueTask
OpportunityFeed IsRichText
Order BillingGeocodeAccuracy
Order (continued) ShippingGeocodeAccuracy
www.simba.com 57
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
OrderFeed IsRichText
Organization GeocodeAccuracy
OwnedContentDocument ExternalDataSourceType
PermissionSet PermissionsBulkMacrosAllowed
PermissionsChatterEditOwnPost
PermissionsChatterEditOwnRecordPost
PermissionsManageSandboxes
PermissionsSelectFilesFromSalesforce
PermissionsSubmitMacrosAllowed
PermissionSetLicense MaximumPermissionsBulkMacrosAllowed
MaximumPermissionsChatterEditOwnPost
MaximumPermissionsChatterEditOwnRecordPost
MaximumPermissionsManageSandboxes
MaximumPermissionsSelectFilesFromSalesforce
MaximumPermissionsSubmitMacrosAllowed
www.simba.com 58
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
PicklistValueInfo DurableId
EntityParticleId
Id
IsActive
IsDefaultValue
Label
ValidFor
Value
PlatformAction ActionTarget
Section
PlatformCachePartition CreatedById
CreatedDate
Description
DeveloperName
Id
IsDefaultPartition
IsDeleted
Language
LastModifiedById
LastModifiedDate
MasterLabel
NamespacePrefix
SystemModstamp
www.simba.com 59
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
PlatformCachePartitionType AllocatedCapacity
AllocatedPurchaseCapacity
CacheType
CreatedById
CreatedDate
Id
IsDeleted
LastModifiedById
LastModifiedDate
PlatformCachePartitionId
SystemModstamp
ProcessInstanceHistory ProcessNodId
Product2Feed IsRichText
Profile PermissionsBulkMacrosAllowed
PermissionsChatterEditOwnPost
Profile (continued) PermissionsChatterEditOwnRecordPost
PermissionsManageSandboxes
PermissionsSelectFilesFromSalesforce
PermissionsSubmitMacrosAllowed
www.simba.com 60
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
Publisher DurableId
Id
IsSalesforce
MajorVersion
MinorVersion
Name
NamespacePrefix
RelationshipDomain ChildSobjectId
DurableId
FieldId
Id
IsCascadeDelete
IsDeprecatedAndHidden
IsRestrictedDelete
JunctionIdListName
ParentSobjectId
RelationshipInfoId
RelationshipName
RelationshipInfo ChildSobjectId
DurableId
FieldId
Id
IsCascadeDelete
IsDeprecatedAndHidden
www.simba.com 61
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
RelationshipInfo (continued) IsRestrictedDelete
JunctionIdListName
Report FolderName
ReportFeed IsRichText
SearchLayout ButtonsDisplayed
DurableId
EntityDefinitionid
FieldsDisplayed
Id
Label
LastModifiedById
LastModifiedDate
LayoutType
www.simba.com 62
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
SecureAgentsCluster CreatedById
CreatedDate
Description
DeveloperName
Id
IsDeleted
Language
LastModifiedById
LastModifiedDate
MasterLabel
SystemModstamp
ServiceFieldDataType DataTypeId
DurableId
FieldDefinitionId
ServiceFieldDataType (continued)
Id
ServiceId
SetupAuditTrail DelegateUser
SignupRequest Edition
PreferredLanguage
ResolvedTemplateId
ShouldConnectToEnvHub
SignupRequestFeed IsRichText
Site OptionsAllowGuestSupportApi
www.simba.com 63
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
SiteFeed IsRichText
SolutionFeed IsRichText
SOSDeployment OptionsIsSessionRecordingEnabled
RecordingStorageBucket
RecordingStorageType
SOSSessionFeed IsRichText
Task TaskSubtype
TaskFeed IsRichText
TopicFeed IsRichText
User GeocodeAccuracy
UserPreferencesCacheDiagnostics
UserPreferencesShowEmailToGuestUsers
UserPreferencesShowFaxToGuestUsers
UserPreferencesShowManagerToGuestUsers
UserPreferencesShowMobilePhoneToGuestUsers
UserPreferencesShowStreetAddressToGuestUsers
User (continued) UserPreferencesShowWorkPhoneToGuestUsers
www.simba.com 64
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
UserAppMenuCustomization ApplicationId
CreatedById
CreatedDate
Id
IsDeleted
LastModifiedById
LastModifiedDate
OwnerId
SortOrder
SystemModstamp
UserAppMenuCustomizationShare
AccessLevel
Id
IsDeleted
LastModifiedById
LastModifiedDate
ParentId
RowCause
UserOrGroupId
www.simba.com 65
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
UserAppMenuItem ApplicationId
AppMenuItemId
Description
IconUrl
Id
InfoUrl
IsUsingAdminAuthorization
IsVisible
Label
UserAppMenuItem (continued) LogoUrl
MobileStartUrl
Name
SortOrder
StartUrl
Type
UserSortOrder
www.simba.com 66
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
UserEntityAccess DurableId
EntityDefinitionId
Id
IsActivateable
IsCreatable
IsDeletable
IsEditable
IsFlsUpdatable
IsMergeable
IsReadable
IsUndeletable
IsUpdatable
UserId
UserFeed IsRichText
UserFieldAccess DurableId
EntityDefinitionid
FieldDefinitionId
Id
IsAccessible
IsCreatable
IsUpdatable
UserFieldAccess (continued) UserId
UserProvAccount IsKnownLink
www.simba.com 67
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
WorkBadgeDefinitionFeed IsRichText
WorkThanks FeedItemId
API Version 35 vs. 36Simba Salesforce Adapter for SAP Data Services 14.2.5 uses Salesforce API 35, while version 14.2.6 of the adapter uses Salesforce API 36.
Required Fields that were Removed between Version 35 and 36
The following table lists some of the fields that were required (non-nullable) in Salesforce API 35, but are no longer used in Salesforce API 36. The fields are organized based on the tables in which they were available.
Table Name Field Name
ExternalDataSource ApiKey
FeedItem ContentData
ContentFileName
ContentDescriptionServiceId
ContentType
ContentSize
Fields that Became Required between Version 35 and 36
The following table lists some of the required (non-nullable) fields that are used in Salesforce API 36 but not in Salesforce API 35. The fields are organized based on the tables in which they are available.
Table Name Field Name
Announcement IsArchived
www.simba.com 68
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
ApexTestSuite Id
IsDeleted
CreatedDate
CreatedById
LastModifiedDate
LastModifiedById
SystemModstamp
TestSuiteName
Asset ParentId
RootAssetId
AuthProvider PluginId
CustomMetadataTypeRecord
www.simba.com 69
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
CampaignMember Salutation
FirstName
LastName
Title
Street
City
State
PostalCode
Country
Phone
Fax
MobilePhone
Description
DoNotCall
HasOptedOutOfEmail
HasOptedOutOfFax
LeadSource
CompanyOrAccount
Type
LeadOrContactId
LeadOrContactOwnerId
CaseStatus ApiName
CollaborationGroup IsBroadcast
www.simba.com 70
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
ContractStatus ApiName
DataStatistics Id
ExternalId
StatType
UserId
Type
StatValue
ExternalDataSource Protocol
FeedAttachment Id
FeedEntityId
Type
RecordId
Title
Value
IsDeleted
FlexQueueItem Id
FlexQueueItemId
JobType
AsyncApexJobId
JobPosition
LeadStatus ApiName
OpportunityStage ApiName
Organization NamespacePrefix
www.simba.com 71
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
PartnerRole ApiName
PermissionSet PermissionsImportCustomObjects
PermissionsManagePvtRptsAndDashbds
PermissionSetLicense MaximumPermissionsImportCustomObjects
MaximumPermissionsManagePvtRptsAndDashbds
Profile PermissionsImportCustomObjects
PermissionsManagePvtRptsAndDashbds
SignupRequest SignupSource
SolutionStatus ApiName
TaskPriority ApiName
TaskStatus ApiName
TestSuiteMembership Id
IsDeleted
CreatedDate
CreatedById
LastModifiedDate
LastModifiedById
SystemModstamp
ApexTestSuiteId
ApexClassId
User BannerPhotoUrl
IsProfilePhotoActive
www.simba.com 72
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
VerificationHistory Id
IsDeleted
CreatedDate
CreatedById
LastModifiedDate
LastModifiedById
SystemModstamp
EventGroup
VerificationTime
VerificationMethod
UserId
Activity
Status
LoginHistoryId
SourceIp
LoginGeoId
Remarks
ResourceId
Policy
WorkBadgeDefinition IsRewardBadge
API Version 36 vs. 37Simba Salesforce Adapter for SAP Data Services 14.2.6 uses Salesforce API 36, while version 14.2.7 of the adapter uses Salesforce API 37.
www.simba.com 73
Installation and Configuration Guide Upgrading the Adapter
Required Fields that were Removed between Version 36 and 37
The following fields were required (non-nullable) in Salesforce API 36, but are no longer used in Salesforce API 37:
l ContentData l ContentFileName l ContentDescription l ContentType l ContentSize
These fields were available in the following tables:
l AccountFeed l AssetFeed l CampaignFeed l CollabrationGroupFeed l ContactFeed l ContentDocumentFeed l ContractFeed l DashboardComponentFeed l DashboardFeed l EventFeed l LeadFeed l OpportunityFeed l OrderFeed l OrderItemFeed l Product2Feed
l ProfileSkillEndorsementFeed l ProfileSkillFeed l ProfileSkillUserFeed l ReportFeed l SOSSessionFeed l SiteFeed l SocialPostFeed l SolutionFeed l TaskFeed l TopicFeed l UserFeed l WorkBadgeDefinitionFeed l WorkOrdersFeed l WorkOrderLineItemFeed
Fields that Became Required between Version 36 and 37
The following table lists some of the required (non-nullable) fields that are used in Salesforce API 37 but not in Salesforce API 36. The fields are organized based on the tables in which they are available.
Table Name Field Name
ActivityHistory AlternateDetailId
www.simba.com 74
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
ApexPageInfo ApexPageId
ApiVersion
Description
DurableId
Id
IsAvailableInTouch
MasterLabel
Name
NameSpacePrefix
ApexTestQueueItem TestRunResultId
ApexTestResult ApexTestRunResultId
RunTime
www.simba.com 75
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
ApexTestResultLimits ApexTestResultId
AsyncCalls
Callouts
Cpu
CreatedById
CreatedDate
Dml
DmlRows
Id
IsDeleted
LastModifiedById
LastModifiedDate
LimitContext
LimitExceptions
MobilePush
QueryRows
SystemModstamp
Soql
Sosl
www.simba.com 76
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
ApexTestRunResult AsyncApexJobId
ClassesCompleted
ClassesEnqueued
CreatedById
CreatedDate
EndTIme
Id
IsAllTests
IsDeleted
JobName
LastModifiedById
LastModifiedDate
MethodsCompleted
MethodsEnqueued
MethodsFailed
Source
StartTime
Status
SystemModstamp
TestTime
UserId
www.simba.com 77
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
AuraDefinitionBundleInfo ApiVersion
AuraDefinitionBundleId
DeveloperName
DurableId
Id
NamespacePrefix
AuraDefinitionInfo AuraDefinitionBundleInfoId
AuraDefinitionId
DefType
DeveloperName
DurableId
Format
Id
LastModifiedDate
NamespacePrefix
Source
AuthSession IsCurrent
BackgroundOperationResult
CreatedById
CreatedDate
Data
Id
Message
MessageType
ParentId
www.simba.com 78
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
CollaborationGroup MediumPhotoUrl
Community IsPublished
DashboardComponent CustomReportId
DataAssessmentFieldMetric
CreatedById
CreatedDate
DataAssessmentMetricId
FieldName
Id
IsDeleted
LastModifiedById
LastModifiedDate
Name
NumMatchedBlanks
NumMatchedDifferent
NumMatchedInSync
NumUnmatchedBlanks
SystemModstamp
www.simba.com 79
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
DataAssessmentMetric CreatedById
CreatedDate
Id
IsDeleted
LastModifiedById
LastModifiedDate
Name
NumDuplicates
NumMatched
NumMatchedDifferent
NumProcessed
NumTotal
NumUnmatched
SystemModstamp
www.simba.com 80
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
DataAssessmentValueMetric
CreatedById
CreatedDate
DataAssessmentFieldMetricId
FieldValue
Id
IsDeleted
LastModifiedById
LastModifiedDate
Name
SystemModstamp
ValueCount
EmailMessage RelatedToId
EmailMessageRelation CreatedById
CreatedDate
EmailMessageId
Id
IsDeleted
RelationAddress
RelationId
RelationObjectType
RelationType
SystemModstamp
EntityDefinition IsMruEnabled
IsProcessEnabled
www.simba.com 81
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
FeedComment SystemModstamp
FeedItem Status
LoginHistory CipherSuite
CountryIso
TlsProtocol
OpenActivity AlternateDetailId
Organization IsReadOnly
Period FullyQualifiedLabel
PermissionSet PermissionsCanApproveFeedPost
PermissionsChatterComposeUiCodesnippet
PermissionsDelegatedTwoFactor
PermissionsModerateNetworkUsers
PermissionsViewDataAssessment
PermissionsSetLicense MaximumPermissionsCanApproveFeedPost
MaximumPermissionsChatterComposeUiCodesnippet
MaximumPermissionsDelegatedTwoFactor
MaximumPermissionsModeraetNetworkUsers
MaximumPermissionsViewDataAssessment
PlatformAction RelatedListRecordId
www.simba.com 82
Installation and Configuration Guide Upgrading the Adapter
Table Name Field Name
Profile PermissionsCanApproveFeedPost
PermissionsChatterComposeUiCodesnippet
PermissionsDelegatedTwoFactor
PermissionsModerateNetworkUsers
PermissionsViewDataAssessment
RelationshipDomain JunctionIdListNames
RelationshipInfo JunectionIdListNames
User MediumPhotoUrl
UserPreferencesHideEndUserOnboardingAssistantModal
UserPreferencesHideLightningMigrationModal
UserPreferencesHideSfxWelcomeMat
UserPrerencesHideBiggerPhotoCallout
UserPreferencesPreviewLightning
UserProvisioningRequest ParentId
RetryCount
WorkOrder BusinessHoursId
IsClosed
RootWorkOrderId
WorkOrderLineItem RootWorkOrderLineItemId
www.simba.com 83
Installation and Configuration Guide Upgrading the Adapter
Contact Us
If you have difficulty using the adapter, please contact our Technical Support staff. We welcome your questions, comments, and feature requests.
Note:
To help us assist you, prior to contacting Technical Support please prepare a detailed summary of the client and server environment including operating system version, patch level, and configuration.
You can contact Technical Support via the Magnitude Support Community at http://magnitudesoftware.com/online-support/.
You can also follow us on Twitter @SimbaTech and @Mag_SW
www.simba.com 84
Installation and Configuration Guide Contact Us
Third-Party Trademarks
IBM and AIX are trademarks or registered trademarks of IBM Corporation or its subsidiaries in Canada, United States, and/or other countries.
Linux is the registered trademark of Linus Torvalds in Canada, United States and/or other countries.
Microsoft, Windows, Windows Server, and the Windows start button are trademarks or registered trademarks of Microsoft Corporation or its subsidiaries in Canada, United States and/or other countries.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.
Red Hat, and Red Hat Enterprise Linux are trademarks or registered trademarks of Red Hat, Inc. or its subsidiaries in Canada, United States and/or other countries.
Salesforce and Salesforce.com are trademarks or registered trademarks of Salesforce.com, Inc. or its subsidiaries in Canada, the United States and/or other countries.
SAP is the trademark or registered trademark of SAP SE in Germany and in several other countries.
Solaris is a registered trademark of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.
SUSE is a trademark or registered trademark of SUSE LLC or its subsidiaries in Canada, United States and/or other countries.
All other trademarks are trademarks of their respective owners.
www.simba.com 85
Installation and Configuration Guide Third-Party Trademarks
Third-Party Licenses
The licenses for the third-party libraries that are included in this product are listed below.
Force.com Partner API License
Copyright (c) 2013, salesforce.com, inc.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Force.com Web Service Connector License
Copyright (c) 2013, salesforce.com, inc.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
www.simba.com 86
Installation and Configuration Guide Third-Party Licenses
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of salesforce.com, inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Apache License, Version 2.0
The following notice is included in compliance with the Apache License, Version 2.0 and is applicable to all software licensed under the Apache License, Version 2.0.
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or
www.simba.com 87
Installation and Configuration Guide Third-Party Licenses
otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare
www.simba.com 88
Installation and Configuration Guide Third-Party Licenses
Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
(a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
www.simba.com 89
Installation and Configuration Guide Third-Party Licenses
You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following boilerplate notice,
www.simba.com 90
Installation and Configuration Guide Third-Party Licenses
with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
This product includes software that is licensed under the Apache License, Version 2.0 (listed below):
Apache Commons LoggingCopyright © 2001-2014 The Apache Software Foundation
Apache HttpComponents ClientCopyright © 1999-2012 The Apache Software Foundation
Apache HttpComponents CoreCopyright © 1999-2012 The Apache Software Foundation
Google GSONCopyright © 2008-2011 Google, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
www.simba.com 91
Installation and Configuration Guide Third-Party Licenses