API: Salesforce – OSKAR

This requires Admin or Data Admin privileges for implementation.

Please Note: If you do not have the correct privileges to access Data Hub you will receive the following upon your login attempt. If you get this message and think it is an error please see your organization's iDashboards Administrator for assistance as Support is unable to give you access.

This outlines the process required to create an API connection to Salesforce. This process will flow from: initializing the API connection, to creating a job in the ETL tool that transfers that API data into a database table/data source, to adding a chart connected to that data source.

PLEASE NOTE:

Not all versions of Salesforce allow for API connections. Group, Starter, and Professional tier editions of Salesforce do not have full API access. In order for Data Hub to access Salesforce, your account must be Enterprise tier or higher.

Connecting the Salesforce API - Creating a new Data Set

Creating a new Chart - Troubleshoot Tips

Connecting the Salesforce API

Begin by logging into iDashboards Data Hub and from the System menu select API Accounts.

You will see a screen that shows you the API Accounts options as well as any existing API connections you may have configured. Click Add Account.

Now select Salesforce and Log in.

It will then bring up the Add Account window.

Open a separate browser window:

Login to salesforce.com
Expand Apps in the left hand navigation
Select App Manager
From the upper right hand corner select New Connected App
Use the settings:
- Access and manage your data (api)
- Allow access to your unique identifier (openid)
- Perform requests on your behalf at any time (refresh_token, offline_access)
- Include Standard Claims - Checked
- Connected App Name: iDashboards Data Hub (or other descriptive name)
- API Name: Will automatically populate after completing Connected App Name
- Contact Email: Your email address
- The other Basic Information options are not required, but can be useful.
- Enable OAuth Settings: Checked
- Callback URL: Use the Redirect URL value from the Add Account box in Data Hub
- Selected OAuth Scopes:
  - Require Secret for Web Server Flow: Checked
  - Include ID Token: Checked
Save the app, you should be taken to the page to view your newly created app.
Copy the Consumer Key and paste it into the Client ID field in the Add Account box in Data Hub.
Click to reveal the Consumer Secret, Copy it and paste it into the Client Secret field in the Add Account box in the Data Hub, click Next.

You should see another Add Account box.

Once you click on Log In, it will bring up another windows asking to Log in to Salesforce.

Then click Allow to allow access from Salesforce.

After giving it access you will see.

You will now see the newly created Salesforce option available in Data Hub.

Creating a New Data Set

You have completed adding your Salesforce API connection. You are ready to create a new data set in the ETL job. First create a New Data Set

Select Cloud API and choose Salesforce

The next window will ask you what kind of Query Type you would like to use. (Lead object and select the 3 columns listed below)

Then, click Save. In the new window,you can confirm your data.

Click Save and name the new data set. Click Save again.

Your new Data Set will now be available in Data Hub.

Create a New ETL Job

Select New ETL job to add the data from the data Set into a database table. Drag an E task from the left onto the canvas. Hover over the Extract Data task and click on the gear icon (or double click the E box). Select your Data Set and click Open.

Click Save. Add a Load task and link the Extract to the Load. Then configure the Load task to save the data to a table in your database.

Click Create a Target Table from Input. Select Schema: dbo

Name the table and click Create

Verify your details in the next window and click Save

Now you can begin building out your ETL job. Create a simple job that moves the data from the data set into a database table of your choosing with just an Extract task and Load task. Once that is done, click Save or Save As.

Once the job has been run to create the table and it has added the data to the data store target table you selected, you now have an available data source that contains your Salesforce data and you are ready to build a chart from this data in the User application.

Creating a New Chart

Log into iDashboards, select Chart then (+) to Create a new chart. Find the data source you added and select it. Now choose the table you created in the ETL job and click Next.