Real-time Integration


Overcast provides a method for integrating with external systems in a real-time manner – as a synchronous, blocking HTTP request. When a user clicks a button, Overcast can call out to the external system to execute an API and return the results for display to the user. This method is usually used when an integration is needed for an external system with a Force.com application or Salesforce user interface. Since it is specific to an API and use case and needs to be customized as per your business requirement, you will need to write some Apex code.  

Real-time Integration enables the mixed replication/real-time architecture that reduces integration complexity & risks significantly. Real-time integrations are used both by the Overcast Components, and further use cases, including the following: 

 

 

For more details on how you can create your very own Real-time Integration Scenario, refer to the steps on the page Step 2 - Create your first Real-Time Integration Scenario

 

Concepts

Real-time Data Viewer

 

The Real-Time Data Viewer is a tool that shows the entire API/Table on one screen and displays the data results (3) based on the filter criteria or the input (2) that you have provided when selecting the Execute Scenario button(1). Vigience recommends using this tool for your application testing and debugging of your Real-Time Scenarios. 

 

Create a Component

 

An Overcast Component is a single complete application which is based on highly configurable, metadata based framework with minimal coding required from the user. The metadata is information provided from the Overcast Real-time Apex class, which is generated for a scenario. Click here to know more about Creating an Overcast Component. 

 

SAP System Info/Backend API

When creating the Real-time Scenario, choosing an SAP BAPI/RFC or an SAP Table/View would be required since SAP is the backend system. Based on Business Requirements, a BAPI/RFC/Table/View can be chosen to Read data from the backend system. If the Business Requirement depends upon the need to Write/Update data to the backend system, the checkbox Commit Work can be enabled to provide the right interface parameters to the API via the HTTP Request. Executing this request to retrieve a response at the UI using Overcast Real-time Scenario is quite similar to executing the API at the backend. If there is any error message reported by the backend system as a result of this execution, the same could be displayed to the user on the User Interface.  

Suggestions for writing Request/Response code can be found in the topic below on Real-time Integration Class. 

 

Real-time Integration Class

 

Real-time integrations are performed by calling the backend system from Apex. Overcast provides an Integration Class per backend API that can be used to read or write data.  

Integration Scenarios of the Real-time Integration type are defined similarly to Integration Scenarios of the Data Synchronization type. However, upon activation, there is no Integration Object generated. Instead, there is an Integration Class generated. This class has the same name as that of the Real-time Scenario just created, and thus can be used to interact with the backend API or table natively from within Salesforce.  

 

The working of the Real-time Integration Class can also be tested by copying and modifying the code snippet (under the “Run a Scenario” title displayed under “Integration Class”) to the Developer Console (in the Debug | Open Execute Anonymous Window). Real-Time Integration Class with its request and response mechanism is a powerful tool for displaying certain information that needs to be shown as up-to-date to the user. This makes it useful in other scenario types, such as Data Synchronization and Real-Time via Salesforce Connect.

 

Named Credential

Salesforce allows a user to connect to an external system using their own username and password by creating a mapping of the user to a data source. This is done using named credentials mapping or external data source mapping. Click here for Salesforce Help Documentation on Named Credentials. Overcast supports the use of Salesforce Named Credential for real-time scenarios, which can be defined in the Connection String. To learn more about how to create a per-user authentication in a real-time scenario, click here for more information.