Configuring the Web API

The Salesforce Web API in Syntelate XA is controlled by configuration settings. You need to edit some of those settings to create a connection between Syntelate XA and your Salesforce instance.

Follow the instructions below.

AppSettings Group

  1. In your preferred Windows file system viewer, such as Explorer, open your Syntelate XA file directory.

  2. Navigate to the Salesforce subdirectory. You see a WebAPI subdirectory.

  3. Enter the WebAPI subdirectory.

  4. Find and open the file named Web.config, using a text editor such as Notepad.

  5. Find the <appSettings> group. It defines a number of configuration keys.

  6. Edit the values of the following keys:

Copy 
<add key="InstanceURI" value="" /> <!-- The absolute URL to your Salesforce instance. -->
<add key="SalesforceCannotUpdateFields" value="contact.NAME" /> <!-- The table fields in Salesforce that must not be updated by Syntelate XA. -->
<add key="PicklistUpdateJobStartTime" value="08:55" /> <!-- Specify the time when you need Salesforce to run the Update Picklists job. -->
<add key="PicklistUpdateJobRefreshTimerSeconds" value="864000" /> <!-- Specify how frequently you want Salesforce to run the Update Picklist job. For example, 864000 seconds is 24 hours. -->

ConnectionStrings Group

  1. Find the group <connectionStrings>.

  2. Edit as shown:

Copy 
<connectionStrings>
    <add name="synXaDatabase" connectionString="Data Source=YourDatabaseServerName;User ID=UsernameForAccessingYourDatabaseServer;Initial Catalog=NameOfYourSyntelateXADatabase;Password=PasswordForYourDatabaseServer" providerName="System.Data.SqlClient" />
    <!-- edit the connectionString value according to your Syntelate XA server and database details. -->
</connectionStrings>

  1. Save and close Web.config.

You have completed the configuration of the Salesforce Web API in your Syntelate XA instance.

What Next?

You need to edit your Syntelate XA universe. Follow the instructions at Configuring the Universe.