reporting
forecasting
dashboard
multi
sustain
Reporting /Preview & Share
Forecasting /Preview & Share
Dashboard /Preview & Share
Multi /Preview & Share

Setting up the integration for the first time

To connect Karbon to Spotlight

‍

  1. Within Karbon, open the Settings option, then click Connected Apps.
  2. Click the Manage button alongside Spotlight Reporting.

‍

  1. This shows the token that you’ll use to connect Spotlight and Karbon. To copy the token to your clipboard, click Copy.
  1. Open Spotlight Reporting and log in.

    Note: To be able to complete the connection, you will need to log in as an Admin user. If you don’t have the Admin user role, please check with an Admin user who will be able to update your user role or set up the integration on your behalf.

  2. Open Practice Settings, then choose Integrations.
  1. Click into the box, and paste in the connection key you copied from within Karbon.

‍

  1. To complete the connection, click Connect.

‍

Once the connection is successful, a message appears to confirm. You can now proceed to the next step.

To add the connection to a task

‍

  1. Open Karbon, and access the work item for which you want to create a Spotlight report.
  2. In the Tasks tab, from the bottom of the window click Add Step, then click Integration.
  1. Select Create Spotlight Report, then click Add.
  1. There will be a short delay while this connection is made. You can click into the task to view the progress. Once the message ‘Spotlight Reporting (API Integration) added an Integration Message’ appears, you’re ready to create your Spotlight report.
  2. To create your Spotlight report, click Report.

To connect to a Spotlight organisation

‍

Note: If your Karbon data can be automatically matched to one of your Spotlight organisations, the organisation automatically opens and you can skip this section. 

‍

If the organisation wasn’t automatically found, you can select the organisation from the drop-down list, then click Select. If you don’t yet have the organisation in Spotlight, you can choose to create a new one. For details about how to set up an organisation, please refer to our Help Centre.

To output your report to Karbon

‍

Once you access the organisation, you can then prepare your Spotlight report as normal, making any changes required to the report or data. 

‍

  1. Once you’re ready to send the report to Karbon, from the Customise Layout, Preview, or Complete tabs, click Publish to Karbon.
  1. To confirm that you want to continue, click Upload report.
  2. Once the process is complete, a message appears to confirm this is done and you can click the link within the message to return to Karbon.

‍

Your report is now available in the Documents tab of the Karbon work item.

Producing your regular Spotlight report
‍

To open your Spotlight report from Karbon

‍

  1. Within the work item where you want to add your Spotlight report, open the Tasks tab.

    Note: If you’ve already added a connection to the relevant Spotlight organisation for this work item, this appears as a task called Create Spotlight Report.  Click Report or, if you’ve previously used this connection to begin your Spotlight report, click Continue Building Report, then continue from step 5.
    ‍
  2. In the Tasks tab, from the bottom of the window click Add Step, then click Integration.
  3. Select Create Spotlight Report, then click Add.

    There will be a short delay while this connection is made. You can click into the task to view the progress. Once the message ‘Spotlight Reporting (API Integration) added an Integration Message’ appears, you’re ready to create your Spotlight report.

  4. To create your Spotlight report, click Report.
  5. If your Karbon data can be automatically matched to one of your Spotlight organisations, the organisation automatically opens.

    If the organisation wasn’t automatically found, you can select the organisation from the drop-down list, then click Select. If you don’t yet have the organisation in Spotlight, you can choose to create a new one. For details about how to set up an organisation, please refer to our Help Centre.

To output your report to Karbon

‍

Once you access the organisation, you can then prepare your Spotlight report as normal, making any changes required to the report or data. 

‍

Once you’re ready to send the report to Karbon, from the Customise Layout, Preview, or Complete tabs, click Publish to Karbon. Once the process is complete, a message appears to confirm this is done and you can click the link within the message to return to Karbon. 

‍

Your report is now available in the Documents tab of the Karbon work item.

‍

Frequently asked questions

‍

For details of troubleshooting and common questions regarding the integration, please refer to our Frequently asked questions article.

‍

Back to top

Still need help?