Create Inbound Integration Setting
Administrators can create inbound integration settings so developers can create and edit records in Nimble AMS.
Create Inbound Integration Setting
- In the tab bar, click App Launcher, or in Salesforce Classic, click Nimble AMS, Staff View, Button, All Tabs.
- Click Integration Settings.
Click New.
In
Record Type
, selectInbound Data
.- In
Name
, enter the name the developer uses to identify the integration to execute. - In
Description
, enter a description you can reference to understand the purpose of the integration setting. In
Authentication Key
, enter a secure authentication key.We recommend using a unique 256-bit WEP authentication key for each integration setting. You can generate a random key, using a random key generator such as Random Key Generator (external).
- In
Sharing Mode
, select:With Sharing
—Query executes based on the executing user's security permissionsWithout Sharing
—Query executes without regard for the executing user's security permissions
If you need to insert records using complex query logic, in
Class
, enter the name of the Apex class that implements the IIntegrationInboundDataProcessor interface.If more complex logic is needed than is possible within a single SOQL query, an Apex class can be created to do the more complex query logic. Creating an Apex class requires development effort.
Status
is populated.In Inbound Object Name, enter the API name of the object to update when the Nimble Fuse API is called.
In Inbound Batch Size, enter the batch size to use for the integration setting. This value controls the number of records that can be processed with one call to the integration setting.
Since the maximum value is 10,000 records, we recommend starting with 5,000 records.
In Inbound Salesforce External Id Field, enter the API name of the
External ID
field that will be used on the Inbound Object to uniquely identify the record. This can be the external app’s unique identifier but it must be unique within the Inbound Object.If you want to record log detail for the integration setting, in
Logging Level
, select the log detail level. More information about the level of detail stored can be found on the Understanding Logging Level page.Click Save.
Create Integration Inbound Settings
An integration inbound setting must be created for each field a developer passes to the Nimble Fuse API. The integration inbound setting creates the mapping between the external app's name for a field and the Nimble AMS name for a field.
- In the tab bar, click App Launcher, or in Salesforce Classic, click Nimble AMS, Staff View, Button, All Tabs.
- Click Integration Settings.
- Select a list view—like All Inbound Integrations—and click Go!
- Click the name of the integration setting to which you want to add an integration inbound setting.
From the Integration Inbound Settings related list, click New Integration Inbound Setting.
Integration Setting is populated.
In
Integration Field Name
, enter the field name from JSON data that will be passed into the integration setting from the external app.In
Salesforce Field Name
, enter the API name of the Nimble AMS field to populate when the developer executes the integration setting.If the integration setting populates a lookup or master-detail relationship field, in
Salesforce Lookup External Field Name
, enter the API name of theExternal ID
field on the parent object within the master-detail/lookup relationship.The lookup field is used to provide foreign key external ID references.