Reference Documentation
Dashboard
Links
Links are a specific sync configuration between a SAP source RIO and a target table or SObject. The links section displays the list of links created by the user. From the dashboard, you can create a new link or view the list of existing links created by the user.
Sync Events
Sync Events are the logged records of prior syncs that have been performed. The Sync Events section displays the total counts of successful and failed sync events and records, and lets you view the detailed records of the sync events.
Detail
Under Data Source in the link details, the source table should display the CID if one was selected when creating the link.
Link Source Table
When creating a new link and selecting the Source Table (RIO) from SAP, you may also select a CID version of the RIO. The CID will be shown as part of the Table name and in the Description.
Link Settings Configuration
| Setting | Description |
|---|---|
| Enabled | Enable or disable the connector. |
| Testing Mode | Testing mode will run the Sync process without updating the target SObjects in Salesforce. |
| Link Label | Label for the link. |
| Batch Size Limit | Limit each request to the number of records specified. |
| Link API Name | The unique name for this link. |
| Logging And Retention | |
| Record Snapshot Logging Level | The logging level for record snapshots. One of: None, Errors/Warnings, Errors Only, or All |
| Record Snapshot Retention Duration (in days) | The number of days to retain record snapshots. |
| Sync Event Retention Duration (in days) | The number of days to retain sync events. |
| Batch Retention Duration (in days) | The number of days to retain batch results. |
| Automated Replays | |
| Automated Replays | Enable or disable attempts to replay failed syncs automatically. |
| Maximum Number of Automated Replay Attempts | The maximum number of times to attempt an automated replay. |
| Parallel Processing | |
| Enable Parallel Processing | Enable or disable parallel processing. |
| Maximum Number of Concurrent Parallel Workers | The maximum worker threads to use for parallel processing. |
| Fingerprinting | |
| Enable Fingerprinting | Enable or disable fingerprinting. |
| Full Runs | |
| Enable Full Runs | Enable or disable Full Runs. When the Full Run Always setting is enabled for the Link in Settings, the "Date From" field set in the Data Source will be ignored. Users will see the following banner message on the Link Dashboard Sync page: "Full Run Override: This Link is configured to ignore delta sync behavior and fetch all records." |
enosix Data Source Configuration
| Setting | Description |
|---|---|
| Named Credential | The named credential to use to connect to SAP. |
| Sync RIO "Date From" Field | The RIO field to use to filter the start date of the sync. This field is only used when doing a Run Now and when a sync has been successfully run before. It populates the last successful run date and only pulls data that has changed in SAP from that date or after. If a Run Now is performed and there is no successful run prior to it, the run will be treated as a Full Run / Initial Load. |
| Sync RIO "Initial Load" Field | The RIO field to use to designate this should be a full sync. This field is only used if the sync is forced to be a full load or has not been run successfully before. |
| Minimum Date From | Allows the user to specify a date and time to be used as the minimum "Date From" date. This replaces X_INITIALLOAD and causes the HTTP request body to contain the minimum "Date From" date in place of the X that signifies an initial load. If a last successful run date is available and a minimum "Date From" date is set, then the sync run process will choose whichever date is most current. |
| SAP Timezone Offset (in hours) | Allows the user to specify an offset from UTC that should be used when sending the "Date From" value to SAP, i.e. if your SAP instance should be sent the "Date From" in UTC-4, set this field to -4.0. |
| CID | The Customizing ID to use for the sync runs (e.g. BO). The Customizing ID identifies a specific version of a RIO. |
| SAP Language Code | Override the SAP language code to use for the connection (e.g. DE, EN, or ES). If field is left blank, the default language assigned in SAP will be set. |
| SAP Client | Override the SAP client to use for the connection. If field is left blank, the default client assigned in SAP will be set. |
| Callout Logging Class | The custom Salesforce class that implements Callable to use for logging. |
| Filter Class | The Filter Class option allows a user to enter the name of a custom-built Apex callable filter class. The purpose of the filter class is to help customize syncs by providing additional search context data. These filter classes help refine sync results through building parameters into the request body, which allows the user to "filter" results. See Filter Class Feature for examples. |
| Max Pages | The Max Pages indicates the maximum number of pages that will be synced in a single run. This can be used to break up larger syncs that may exceed Salesforce Governor Limits on their own. |
| Start Page | The Start Page can be used in conjunction with Max Pages to do a partial run of a large sync. For instance: a sync that would take 30 pages could be run in 3 chunks by settings Max Pages to 10, and Start Page to 1, 11, and 21 successively. |
Trigger Conditions (Scheduling)
You can schedule a sync job to happen on a specific interval or immediately after another sync job completes. There can only be one trigger condition per sync job. From here, you can configure a daily, hourly, or minute count interval, or specify a CRON expression for more detailed schedules.
Salesforce Data Target Adapter Settings
Upsert Field
The identifier field to use when checking if a record exists. If this field is not set, the connector will use the Id field of the target object.
Ignore Unchanged
This setting allows the connector to check for and skip records that match the values in the Salesforce database.
Multi-Select Picklists
This setting will replace the existing values with the incoming values. If this setting is not set, the connector will merge the incoming values with the existing values.
Transformations
The transformation page allows you to map the fields from the source to the target. Fields must be mapped to be included in the sync.
Source Schema
The source schema shows the fields available in the SAP system. You can choose to Browse Source Schema to map a new source field to a target field.
The Source Schema will include the following:
- Field:
- SAP field name
- Friendly name
- Field description
- Recent Values:
- Will display example recent values if the link has been ran previously
- Data Type:
- string(field length)
- decimal(numbers before decimal, numbers after decimal)
- date
- Actions:
- Link to start mapping that field
Target Schema
The target schema shows the fields available in the Salesforce system. You can choose to Browse Target Schema to map a new target field to a source field. Each field will have the Salesforce name, label, and data type.
Mappings
Mappings are the connections between the source and target fields. From the main Transformation page, you can see the mappings that have been created, activate or deactivate mappings, edit a mapping, edit a filter on a mapping, or delete mappings.
Creating or editing mappings
When creating or editing mappings, you choose a source field and a target field. You can also choose to write null values to the target field, or to skip writing null values from the source field.
If the destination is a list or related SObject, you can choose to append or replace the items. For more fine-grained control, you can switch to the advanced mode and write a custom selector for what position to insert the value.
Results
The results page shows the results from prior sync executions. Clicking on All Runs leads to a table with the results of all the syncs that have been run. Last Run will take you directly to the results of the last sync that was run.
Relationship Mapping
When mapping records using a relationships filter to keep data linked between Salesforce and an External System (SAP), by default fields that have no matching records will be ignored. To keep those fields, check the “Override default behavior: clear field if no related record is found.” checkbox on the lookup relationship mapping.
Link splits
Configuring a link split allows you to split the data from a single source link into multiple targets. You can do this by setting up a secondary link that you pass the source data to. The secondary link will then be run with the data from the first link.
Filtering
You can filter the data that is passed to the secondary link by using a filter on the mapping. The filter will be applied to the data before it is passed to the secondary link.
Inner List
You can pass the data from a list field to the secondary link. The data from the list will be passed to the secondary link as a list of records. The secondary link will then be run for each record in the list.
Target
Target lets you specify the destination link for the data. You can choose from a list of links that are already configured or create a new link.