Skip to content

Commit

Permalink
Merge pull request #1055 from chathuranga-jayanath-99/update-sf-inbou…
Browse files Browse the repository at this point in the history
…nd-endpoint-reference

Update Salesforce Inbound Endpoint Reference Doc
  • Loading branch information
DinithiDiaz authored Oct 25, 2024
2 parents 4a4e993 + 29c75af commit e2bd3e9
Showing 1 changed file with 49 additions and 49 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -7,84 +7,84 @@ The following configurations allow you to configure Salesforce Inbound Endpoint
<th>Parameter</th>
<th>Description</th>
<th>Required</th>
<th>Possible Values</th>
<th>Example Values</th>
<th>Default Value</th>
</tr>
<tr>
<td>sequential</td>
<td>Whether the messages should be polled and injected sequentially.</td>
<td><code>interval</code></td>
<td>The polling interval for the Salesforce inbound endpoint.</td>
<td>Yes</td>
<td>true , false</td>
<td>TRUE</td>
</tr>
<tr>
<td>replay</td>
<td> Enabling this will read the event ID stored in the Registry DB or from the text file stored in the local machine.</td>
<td>Yes</td>
<td>enable or disable</td>
<td>false</td>
</tr>
<tr>
<td>packageVersion</td>
<td>The version of the Salesforce API.</td>
<td>Yes</td>
<td>37.0</td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>salesforceObject</td>
<td><code>connection.salesforce.salesforceObject</code></td>
<td>The name of the Push Topic or the Platform Event that is added to the Salesforce account.</td>
<td>Yes</td>
<td>/topic/Account</td>
<td><code>/topic/Account</code></td>
<td>-</td>
</tr>
<tr>
<td>loginEndpoint</td>
<td>The Endpoint of the Salesforce account.</td>
<td><code>connection.salesforce.packageVersion</code></td>
<td>The version of the Salesforce API.</td>
<td>Yes</td>
<td>https://login.salesforce.com</td>
<td>https://login.salesforce.com</td>
<td><code>37.0</code></td>
<td>-</td>
</tr>
<tr>
<td>userName</td>
<td>The username for accessing the Salesforce account.</td>
<td><code>connection.salesforce.userName</code></td>
<td>Salesforce login user name.</td>
<td>Yes</td>
<td>-</td>
<td>-</td>
</tr>
</tr>
<tr>
<td>password</td>
<td> The password provided here is a concatenation of the user password and the security token provided by Salesforce. For more information, see <a href="https://help.salesforce.com/articleView?id=user_security_token.htm&type=5">Information on creating a security token in Salesforce</a></td>
<td><code>connection.salesforce.password</code></td>
<td>Salesforce login password.</td>
<td>Yes</td>
<td>eitest123xxxxxxx</td>
<td><code>eitest123xxxxxxx</code></td>
<td>-</td>
</tr>
<tr>
<td>waitTime</td>
<td>The time to wait to connect to the Salesforce account.</td>
<td><code>connection.salesforce.loginEndpoint</code></td>
<td>The Endpoint of the Salesforce account.</td>
<td>Yes</td>
<td>5000</td>
<td>5 * 1000 ms</td>
</tr>
<td><code>https://login.salesforce.com</code></td>
<td><code>https://login.salesforce.com</code></td>
</tr>
<tr>
<td>connectionTimeout</td>
<td><code>connection.salesforce.soapApiVersion</code></td>
<td>The version of the Salesforce SOAP API.</td>
<td>No</td>
<td><code>22.0</code></td>
<td><code>22.0</code></td>
</tr>
<tr>
<td><code>connection.salesforce.connectionTimeout</code></td>
<td>The time to wait to connect to the client.</td>
<td>Yes</td>
<td>20000</td>
<td>20 * 1000 ms</td>
</tr>
<td>No</td>
<td><code>20000</code></td>
<td><code>20000</code></td>
</tr>
<tr>
<td>soapApiVersion</td>
<td>The version of the Salesforce SOAP API.</td>
<td>Yes</td>
<td>22.0</td>
<td><code>connection.salesforce.waitTime</code></td>
<td>The time to wait to connect to the Salesforce account.</td>
<td>No</td>
<td><code>5000</code></td>
<td><code>5000</code></td>
</tr>
<tr>
<td><code>connection.salesforce.replay</code></td>
<td>Enabling this will read the event ID stored in the Registry or from the text file provided via the event ID file path.</td>
<td>No</td>
<td>-</td>
<td><code>False</code></td>
</tr>
<tr>
<td>EventIDStoredFilePath</td>
<td>When replay is enabled, do not define any value for this property (i.e., keep it blank), to replay from the last event ID stored in the config Registry DB (property- name of the Salesforce object (follow the example below for more understanding) resource path - connector/salesforce/event). When replay is enabled, specify the directory path of a text file to start replaying from the event ID stored in it.</td>
<td><code>connection.salesforce.EventIDStoredFilePath</code></td>
<td>This field is visible only if replay is enabled. When enabled, specify the directory path of a text file to replay from the event ID stored in it, or leave it blank to replay from the last event ID stored in the config Registry DB.</td>
<td>No</td>
<td>/home/kasun/Documents/SalesForceConnector/a.txt</td>
<td><code>/home/kasun/Documents/SalesForceConnector/a.txt</code></td>
<td>-</td>
</tr>
</table>
</tr>
</table>

0 comments on commit e2bd3e9

Please sign in to comment.