Attribute

SchemaMap (smp)

Purpose

Specifies either the name or the absolute path and name of the configuration file where the map of the Salesforce data model is written. The driver looks for this file when connecting to a Salesforce instance. If the file does not exist, the driver creates one.

Valid Values

string

where:

string

is either the name or the absolute path and name (including the .config extension) of the configuration file. For example, if SchemaMap is set to a value of:

  • ABC, the driver either creates or looks for the configuration file ABC in the working directory of your application.

  • C:\\Users\\Default\\AppData\\Local\\Progress\\DataDirect\\SForce_Schema\\abc@defcorp.com.config, the driver either creates or looks for the configuration file 'abc@defcorp.com.config' in the directory 'C:\Users\Default\AppData\Local\Progress\DataDirect\SForce_Schema'.

Example

As the following examples show, escapes are needed when specifying SchemaMap for a data source but are not used when specifying SchemaMap in a DriverManager connection URL.

DriverManger example

jdbc:datadirect:sforce://login.salesforce.com;User=abc@defcorp;Password=secret;
SecurityToken=XaBARTsLZReM4Px47qPLOS;
SchemaMap=C:\Users\Default\AppData\Local\Progress\DataDirect\
SForce_Schema\abc@defcorp.com.config

DataSource example

SForceDataSource ds = new SForceDataSource();
ds.setDescription("My Salesforce DataSource");
ds.setServerName("login.salesforce.com");
ds.setUser("abc@defcorp.com");
ds.setPassword("secret");
ds.setSecurityToken("XaBARTsLZReM4Px47qPLOS");
ds.setSchemaMap("C:\\Users\\Default\\AppData\\Local\\Progress
              \\DataDirect\\SForce_Schema\\abc@defcorp.com.config")

Notes

  • If using OAuth 2.0 authentication, a value for the SchemaMap property must be specified for every connection.
  • When connecting to a Salesforce instance, the driver looks for the schema map configuration file.
  • If the configuration file does not exist, the driver creates the schema map configuration file using the name and location you have provided.
  • If you do not provide a name and location for the configuration file, the driver creates it using default values.
  • The driver uses the path specified in this connection property to store additional internal files.
  • You can refresh the internal files related to an existing view of your data by using the SQL extension Refresh Map. Refresh Map runs a discovery against your native data and updates your internal files accordingly.

Default Value

The default is determined by the environment. The driver attempts to create the files in a subdirectory of the first available directory in the following order:

  • Windows
    • DD_HOME environment variable
    • LOCALAPPDATA environment variable
    • APPDATA environment variable
    • User’s home directory
  • For UNIX/Linux
    • DD_HOME environment variable
    • User’s home directory

For both Windows and UNIX/Linux, the file path takes the following format:

<available_location>/progress/datadirect/SForce_Schema/<user_name>.config