Salesforce

Description

This is a really simple dashboard showing how to use the Salesforce API to query for data using SOQL (Salesforce Object Query Language). It displays summed up accounts, contacts and opportunities using the SOQL count function.

How do I import and configure this dashboard?

1. Ensure you're using SquaredUp DS v5.4 or above.

   Already a SquaredUp customer?

   Get the latest version of SquaredUp DS for SCOM

   New to SquaredUp?

   Try it for free

2. A Salesforce Admin needs to create a new Connected App in Salesforce with the following settings:
   • "Enable OAuth Settings" - activated
   • A callback URL in the format
     https://your-squaredup-server-url/SquaredUp/ext-core-webapi/callback/SalesforceNote: The last part of the URL has to be Salesforce, because it needs to be identical with the name of the provider you're going to create for the tiles in this dashboard.
   • Granted OAuth scopes:
     • Manage user data via APIs (api)
     • Perform requests at any time (refresh_token, offline_access)
   • IP restrictions:
     Change the IP Relaxation setting to Relax IP restrictions in the Edit Policies area.
     Alternatively, you can whitelist the IP address for your SquaredUp server in the Profiles admin area.
3. Create a Web API provider to connect to your Salesforce environment with the following settings:

   Type	OAuth
   Name	Salesforce Note: The name is case-sensitive and must be entered exactly like given here for the tiles to recognize the provider automatically. If you name it differently, you will need to select the provider manually for each tile on the dashboard.
   Grant type	Authorization code
   Base URL	The base URL to your Salesforce environment in the format https://your-salesforce-org.my.salesforce.com/services/data/v52.0/
   Ignore invalid SSL	Off
   Send authorization with query	Off
   Authorization URL	https://login.salesforce.com/services/oauth2/authorize
   Token URL	https://login.salesforce.com/services/oauth2/token
   Client ID and secret	The Consumer Key of the Connected App you're using for SquaredUp DS. You can find it in Salesforce, in the App Manager area of the Connected App. Note: 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 click Perform Authorization again.
   Client secret	The Consumer Secret of your Connected App you're using for SquaredUp DS. You can find it in Salesforce, in the App Manager area of the Connected App.
   Authorization scope	api offline_access

   How to create a Web API provider

   1. In SquaredUp DS navigate to the right-hand menu ☰ > system > Integrations

   2. Under Integrations click on Web API and choose either Simple, Basic Auth or OAuth depending on the API you are using.
      About the different types of Integrations and Web API providers

      Simple	No authentication, basic authentication (username and password in a header) or Windows authentication (configured automatically to use the application pool identity account).
      Basic auth	Basic authentication. Your specified username and password will be Base64 encoded automatically.
      OAuth	Token-based authentication according to the OAuth 2.0 standard. Many APIs use OAuth 2.0 for authorization, and will require an OAuth provider to include the additional information about how to authorize against the service.

      Note: When adding an OAuth provider you may get an message that the provider is not authorized if some of the provider configuration is incorrect (for example the username, password, secret etc), or if you use a proxy it could be that the proxy is not configured. See How to configure SquaredUp DS to use a proxy.
   3. Complete the provider fields, using your API provider's online documentation as a guide.

      ignore invalid ssl: Turn the on/off switch to on if you are using a self-signed certificate.

      default headers headers sent with all requests using this provider, for example the API token in the format the API requires.

      url parameters url parameters sent with all requests using this provider. For example, a query parameter that is always used can be added here in the provider to save adding it to every dashboard configuration.

   4. You are now ready to use this provider in a Web API tile (see How to use the Web API tile).

4. Download and import this dashboard pack.

   How to import a dashboard pack

   1. Download the dashboard pack zip file for the dashboard pack you wish to import.

      There may be additional steps before or after the import to get the dashboard working in your environment.

   2. In DS for SCOM go to the top right hand menu ☰ > Import Dashboard Packs and drag the zip file into the Manual Import box.
      

   3. The dashboard pack is imported and if the pack contains top-level dashboards, these will automatically appear in the navigation bar, usually in a folder called 'Community Dashboards' for dashboard packs from the SquaredUp Community. If the dashboard pack also contains perspectives (see Working with perspectives), then you'll see these when you drilldown to the relevant object.
   4. Carry out any additional steps required to make the dashboard work in your environment. These steps will be described on the download page for each dashboard. For example, you may need to create the correctly named Web API provider, create a PowerShell profile, or edit tile collections.
   5. Edit the imported dashboard as required.

5. Each tile has a Salesforce SOQL query in the Headers & Data panel. Change the query to a query that works for your Salesforce environment:
   1. Edit the tiles by clicking the Edit button.
   2. Open the Headers & Data panel.
   3. Paste your query in the Data section.
      Examples for generic queries you can use:
      Copy

      SELECT Name FROM Account

      Copy

      SELECT Name, Owner.Name FROM Account

      Copy

      SELECT Count(Name) FROM Contacts

6. Publish the dashboard.

   How to publish a dashboard

   A newly created dashboard will not be visible to others until it is published.

   Only admins can publish dashboards, unless you have been given author permissions to a Team Folder see Team Folders

   If you made changes to an existing dashboard, the changes will only be visible to others after you published the dashboard again.

   You can identify a dashboard that has not been published yet or has unpublished changes by the unpublished button at the top:

   When you click on the unpublished button, you'll have two options:

   • Publish will make the dashboard or changes visible to others.
     Note: A newly created dashboard will appear on the menu where you created it. To move the dashboard to a different place on the navigation bar see How to edit the Navigation Bar.
   • Discard will delete your draft dashboard if it has never been published or, if you made changes to an already published dashboard, discard the changes.

   Publishing dashboards to different audiences

   Find out how to publish dashboards to a subset of users using Team Folders or visible to anyone even unlicensed users with Open Access (Sharing Dashboards with anyone - Open Access).

Was this article helpful?