Salesforce plugin

For more information about what this plugin does and the data streams it retrieves, see:

Index accounts and their owners from Salesforce and get access to data via SOQL (Salesforce Object Query Language) queries.

How to add the data source

To add a data source click on the + next to Data Sources on the left-hand menu in SquaredUp. Search for the data source and click on it to open the Configure data source page.

Configuring the data source

Display Name:
Enter a name for your data source. This helps you to identify this data source in the list of your data sources.
Connected App Consumer Key:
The Consumer Key of the Connected App you're using. You can find it in Salesforce, in the App Manager area of the Connected App. If you need help creating a Connected App, please refer to the Salesforce documentation: Salesforce: Create a Connected App
When creating a new Connected App in Salesforce, it can take 20-30 minutes before the Consumer Key becomes active for API usage. This may cause the provider to fail to authorize. If this happens, wait 10 minutes and then try again.
Connected App Consumer Secret:
The Consumer Secret of your Connected App. You can find it in Salesforce, in the App Manager area of the Connected App.
Authentication Method:
Select how to authenticate the plugin connection. Choose from the following:
- Single Sign-On: Click the Sign in button to directly login with your Salesforce credentials. A new tab opens directing you to the Salesforce login page.
- Username & Password: Enter the Username and Password for your Salesforce account. The user must have access to the data in Salesforce that you want to use in SquaredUp.
  Accounts with multi-factor authentication enabled are not supported.
Import Accounts:
Select this check box if you want to import account records. The following fields display, which can be used to specify the imported records:
- Filter: If you don't want to import all the records, enter a SOQL filter using "API Names".
- Additional Fields: Specify any custom additional account fields that you wish to include in account objects. Additional account fields must be provided in a comma-separated list. You can add any fields here that you use in Salesforce, for example: Domain__c.
Import Contacts:
Select this check box if you want to import Contact records. The following fields display, which can be used to specify the imported records:
- Filter: If you don't want to import all the records, enter a SOQL filter using "API Names".
- Additional Fields: Specify any custom additional account fields that you wish to include in account objects. Additional account fields must be provided in a comma-separated list. You can add any fields here that you use in Salesforce, for example: Domain__c.
Import Leads:
Select this check box if you want to import lead records. The following fields display, which can be used to specify the imported records:
- Filter: If you don't want to import all the records, enter a SOQL filter using "API Names".
- Additional Fields: Specify any custom additional account fields that you wish to include in account objects. Additional account fields must be provided in a comma-separated list. You can add any fields here that you use in Salesforce, for example: Domain__c.
Import Reports:
Select this check box if you want to import report records. The Filter field displays, which can be used to specify the names of any report folders to filter which reports are imported.
Import Users:
Select this check box if you want to import user records. The following fields display, which can be used to specify the imported records:
- Filter: If you don't want to import all the records, enter a SOQL filter using "API Names".
- Additional Fields: Specify any custom additional user fields that you wish to include in user objects. Additional user fields must be provided in a comma-separated list. You can add any fields here that you use in Salesforce, for example: CompanyName.
Custom Import:
Select to import any other record type. The Import Template field displays, which you can use to enter a JSON template for the records.

Optionally, select whether you would like to restrict access to this data source instance. By default, restricted access is set to off.

The term data source here really means data source instance. For example, a user may configure two instances of the AWS data source, one for their development environment and one for production. In that case, each data source instance has its own access control settings.

By default, Restrict access to this data source is set to off. The data source can be viewed, edited and administered by anyone. If you would like to control who has access to this data source, switch Restrict access to this data source to on.

Use the Restrict access to this data source dropdown to control who has access to the workspace:

By default, the user setting the permissions for the data source will be given Full Control and the Everyone group will be given Link to workspace permissions.
Tailor access to the data source, as required, by selecting individual users or user groups from the dropdown and giving them Link to workspace or Full Control permissions.
If the user is not available from the dropdown, you are able to invite them to the data source by typing in their email address and then clicking Add. The new user will then receive an email inviting them to create an account on SquaredUp. Once the account has been created, they will gain access to the organization.
At least one user or group must be given Full Control.
Admin users can edit the configuration, modify the Access Control List (ACL) and delete the data source, regardless of the ACL chosen.

Access Level:

Link to workspace	User can link the data source to any workspace they have at least Editor permissions for. Data from the data source can then be viewed by anyone with any access to the workspace. User can share the data source data with anyone they want. User cannot configure the data source in any way, or delete it.
Full Control	User can change the data source configuration, ACL, and delete the data source.

See Access control for more information.

Click Test and add to validate the data source configuration.
- Testing passed – a success message will be displayed and then the configuration will be saved.
- Testing passed with warnings – warnings will be listed and potential fixes suggested. You can still use the data source with warnings. Select Save with warnings if you believe that you can still use the data source as required with the warnings listed. Alternatively, address the issues listed and then select Rerun tests to validate the data source configuration again. If the validation now passes, click Save.
- Testing Failed – errors will be listed and potential fixes suggested. You cannot use the data source with errors. You are able to select Save with errors if you believe that a system outside of SquaredUp is causing the error that you need to fix. Alternatively, address the issues listed and then select Rerun tests to validate the data source configuration again. If the validation now passes, click Save.
You can edit any data source configurations at any time from Settings > Data Sources.
You can also add a data source from Settings > Data Sources > Add data source, but sample dashboards are not added when using this method.

Using the Salesforce data streams

Data streams standardize data from all the different shapes and formats your tools use into a straightforward tabular format. While creating a tile you can tweak data streams by grouping or aggregating specific columns. Depending on the kind of data, SquaredUp will automatically suggest how to visualize the result, for example as a table or line graph.

Data streams can be either global or scoped:

Global data streams are unscoped and return information of a general nature (e.g. "Get the current number of unused hosts").
A scoped data stream gets information relevant to the specific set objects supplied in the tile scope (e.g. "Get the current session count for these hosts").

See Data Streams for more information.

Data streams

The following data streams are installed with this plugin.

The Opportunities data stream is configurable and by default retrieves all of your Salesforce opportunities (deals in progress).

In the tile editor, filter by the Salesforce data source, select Opportunities from the data stream list and then click Next.
Query:
1. Use the following fields to filter the opportunities retrieved from Salesforce:
  - Filter by Opportunity Stages: Specify one or more opportunity stages.
  - Filter by Opportunity Types: Specify one or more opportunity types.
  - Filter by Opportunity Dates: Specify a date time field.
2. Select a Calendar Type:
  Select which timeframe format to use for the retrieved data. This affects the months used to display data on the Timeframe tab. Choose from the following:
  - Calendar Dates: Uses the default dashboard timeframe.
  - Fiscal Dates: Converts the dashboard calendar to the your fiscal calendar

The Record Details data stream retrieves your Salesforce records.

In the tile editor, filter by the Salesforce data source, select Record Details from the data stream list and then click Next.
Select the objects that you want to query.

The Salesforce data source allows you to set up configurable data streams for any kind of SOQL query. This data stream is available in a Scoped and Global version.

If you need help using SOQL, please refer to the Salesforce documentation: Salesforce: Salesforce Object Query Language (SOQL).

In the tile editor, filter by the Salesforce data source, select Custom SOQL Query from the data stream list and then click Next.
Select the objects that you want to query.
Query:
Enter a SOQL query.
A mustache parameter is a dynamic value, the actual value will be inserted to replace the field in curly braces. For example, {{timeframe.start}} will insert the start time based on the timeframe configured within the tile, or {{name}} will insert the name of the object(s) in scope.
This data stream supplies scoped objects individually for mustache parameters. When there are multiple objects in scope this data source will send the query multiple times, once for each object. The results are then displayed together, for example in a single table.
You can use properties of objects and write them in between curly braces e.g {{name}} to use them as mustache parameters. Whenever you use mustache parameters, you need to use a scope of objects that contain the property you're referencing.
For example, if objects of type "host" have a property called name, you can use {{name}}. This will resolve {{name}} to the value of the name property of the different "host" objects used in the scope.

The Tasks data stream is configurable and by default retrieves all of your Salesforce tasks (to-do lists).

In the tile editor, filter by the Salesforce data source, select Tasks from the data stream list and then click Next.
Query:
1. Use the following fields to filter the opportunities retrieved from Salesforce:
  - Filter by Task Types: Specify one or more task types.
  - Filter by Task Priorities: Specify one or more priorities.
  - Filter by Task Dates: Specify a date time field.
2. Select a Calendar Type:
  Select which timeframe format to use for the retrieved data. This affects the months used to display data on the Timeframe tab. Choose from the following:
  - Calendar Dates: Uses the default dashboard timeframe.
  - Fiscal Dates: Converts the dashboard calendar to the your fiscal calendar.

Was this article helpful?

Have more questions or facing an issue?

Submit a ticket