Reveal is a data visualization solution provided by Infragistics and can be paired with the CData API Server to build dynamic dashboards from live SAP SuccessFactors data. The CData API Server generates an OData API for SAP SuccessFactors, which is natively consumable in Reveal. In this article, we walk through connecting to SAP SuccessFactors in API Server and connecting to the API Server from Infragistics Reveal to create a simple dashboard.
Connect to SAP SuccessFactors from API Server
CData API Server uses a straightforward, point-and-click interface to connect to data sources and generate APIs.
- Open API Server and click Settings -> Connection -> Add Connection
π Adding a connection
- Select "SAP SuccessFactors"
π Selecting a Connector (Salesforce is shown).
- Enter the necessary authentication properties to connect to SAP SuccessFactors.
You can authenticate to SAP Success Factors using Basic authentication or OAuth with SAML assertion.
Basic Authentication
You must provide values for the following properties to successfully authenticate to SAP Success Factors. Note that the provider will reuse the session opened by SAP Success Factors using cookies. Which means that your credentials will be used only on the first request to open the session. After that, cookies returned from SAP Success Factors will be used for authentication.
- Url: set this to the URL of the server hosting Success Factors. Some of the servers are listed in the SAP support documentation (external link).
- User: set this to the username of your account.
- Password: set this to the password of your account.
- CompanyId: set this to the unique identifier of your company.
OAuth Authentication
You must provide values for the following properties, which will be used to get the access token.
- Url: set this to the URL of the server hosting Success Factors. Some of the servers are listed in the SAP support documentation (external link).
- User: set this to the username of your account.
- CompanyId: set this to the unique identifier of your company.
- OAuthClientId: set this to the API Key that was generated in API Center.
- OAuthClientSecret: the X.509 private key used to sign SAML assertion. The private key can be found in the certificate you downloaded in Registering your OAuth Client Application.
- InitiateOAuth: set this to GETANDREFRESH.
π Configuring a connection (Salesforce is shown).
Add SAP SuccessFactors Resource Definitions in API Server
After connecting to SAP SuccessFactors, create Resources, which represent API endpoints for SAP SuccessFactors data.
- Click Settings -> Resources -> Add Resource
π Adding a new resource
- Select the SAP SuccessFactors connection
π Selecting a connection (Salesforce is shown)
- Select the table you wish to retrieve and click Next
π Selecting a Table (Salesforce is shown)
- (Optional) Edit the resource to select specific fields and more
- Save the settings
Add an API Server User
Create a User to connect to SAP SuccessFactors from Reveal through API Server.
- Click Settings -> Users
- Click Add
- Configure a User with access to the SAP SuccessFactors Connection and Resource(s)
π Creating a new user
π API Server users
(Optional) Configure Cross-Origin Resource Sharing (CORS)
When accessing and connecting to multiple different domains from an application such as Ajax, there is a possibility of violating the limitations of cross-site scripting. In that case, configure the CORS settings in Settings -> Server.
- Enable cross-origin resource sharing (CORS): ON
- Allow all domains without '*': ON
- Access-Control-Allow-Methods: GET, PUT, POST, OPTIONS
- Access-Control-Allow-Headers: Authorization
Save the changes to the settings.
π Configuring CORS settings
Create a Dashboard in Reveal
With the API Server configured, we can visualize SAP SuccessFactors data in Reveal.
- Log into Reveal and click Dashboards -> New
π Adding a new dashboard
- Click Data Source -> OData Feed
π Adding a new OData data source
- Specify the API Server API endpoint URL, for example: https://serverurl/api.rsc
π Configuring the OData URL
- Select Generic Credentials and specify the API Server username and authentication token
π Configuring the credentials
- Select the entity you wish to visualize
π Selecting an entity to visualize (Salesforce is shown.)
- Select fields and choose a chart type
π Visualizing data in Reveal (Salesforce is shown.)
More Information & Free Trial
At this point, you have created a simple dashboard from live SAP SuccessFactors data. For more information on creating OData feeds from SAP SuccessFactors (and more than 150 other sources), visit the API Server page. Download a free, 30-day trial and start working live SAP SuccessFactors data in tools that consume OData APIs.