A Smart Object of type Remote or of type SalesForce Object is a locally-cached copy of an external data set. It is a read-only operation that refreshes the cache at specified intervals. (To update remote records, use a Rule-based integration.)

​

When you declare that a Smart Object is of type Remote or of type SalesForce Object, an additional option appears in the object's menu icon: Manage Remote Get. You'll use that option to configure access to the external data.

 

To configure access to an external data source:

1. Go to Gear Menu > Smart Objects Management
2. Select a Remote object, or SalesForce object.
3. Under the object's gear icon, choose Manage Remote Get.

Settings

• General
  
  • Auth Type - No Auth, Basic Auth (username/password), API Key (key/value pair).
    or API Query String (authentication data is passed as part of the URL)
  • URL - The URL to which the http GET is directed. This URL should return a list of data records.
    Fields from entries returned in the list are then mapped to records that are stored locally.
  • Method - Hardcoded to an http GET.
    (Cache refresh is read-only, so http PUT and POST are not supported).  
  • Date Format - Epoch, ISO8601, or the format defined for the user who is accessing the data
  • Content Type - json, XML, or form-urlencoded
  • Cache Duration (in hours) - The number of hours for which the cache is valid.
    When that time period expires, remote data is fetched again to refresh the cache.
  • Incremental Refresh - Choose this option if only new and update records are returned by the GET.
    Otherwise, the current data set is replaced by the data set that comes back.
  • On Error Return Cached Data - If an error occurs during data transmission,
    revert to the previously-cached data. 
     
• Sample Response
  Provide a sample of the data that comes back in response
  to the http request, which will be a collection of name/value pairs.
  Pulpstream identifies the data elements contained in that sample.
   
• Map Normal Response
  Map the data items contained in a normal response to fields defined for the Smart Object.
  (To map fields, drag the arrow icons from fields on the left to fields on the right.)
  

Note:
The response may well consist of a complex hierarchy of data. For example, Client records may have a "contact information" section, with street address, email address, and phone number. For Pulpstream, perhaps all you need is the email address. So you would map that field value to your locally-cached records, and ignore the other fields in that segment.