Connecting to Xero Accounting

Connecting to Xero

To access Xero’s REST API from Sisense, you must provide valid Oauth Xero credentials through a connection string. After you receive your credentials from Xero, you can create the connection string and provide Sisense with it to connect to your data.

To create the connection string:

1. Open the lib directory for the connector. This is the default path: C:\Program Files\CData\CData JDBC Driver for <Driver Name> 2019\lib.

2. Double-click the jar file in the lib directory.

   

   Alternatively, to open the jar file from the command line, enter the following command in the command prompt (change the driver name to your driver): cd C:\Program Files\CData\CData JDBC Driver for <Driver Name> 2019\lib. Press Enter and then enter the following command (change the driver name to your driver): “C:\Program Files\Sisense\infra\jre\bin\java.exe" -jar cdata.jdbc.<Driver Name>.jar.

   Press Enter again.

   For example:

   

   The Connection String Builder opens.

3. Click in the Value column of the Initiate OAuth property and select GETANDREFRESH .

   

4. Click Test Connection .

5. A browser window opens where you need to log in to your application in order to grant access. (Each application will display a different window and messages.)

   Close the Authorization Successful! message that opens.

6. Go back to the Connection String Builder dialog and click OK in the Test Connection Successful message to close it.

7. Click Copy to Clipboard to obtain the connection string.

For a short video of the process, see below (the video uses the Box driver as an example).

The driver uses embedded credentials which originate from a OAuth App embedded into the driver. The embedded credentials provide full functionality, so you do not have to create an OAuth App.

You need to follow the above instructions only once, to retrieve the Access and Refresh tokens. Once the tokens have been retrieved, the driver will be refreshing them in the background when they expire, with no further involvement from you.

Adding Xero Tables to your ElastiCube

1. Open Sisense.

   For a non-local installation, open Sisense on the hosted cloud environment.

2. In the Data page, open an ElastiCube or create a new ElastiCube .

3. In the Model Editor, click . The Add Data dialog box is displayed.

   

4. Click Generic JDBC to open the JDBC settings.

   

5. In Connection String , paste the string you obtained above. When you do so, the string is appended with some _persist properties. The following is an example of the connection string as it looks in Sisense:

   jdbc:box:Initiate OAuth="GETANDREFRESH";_persist_oauthexpiresin=3199;_persist_token_timestamp=1561893244662;_persist_oauthaccesstoken=mswNfVDVpnBZc3pkQQja7WRHNebbaGZL;_persist_oauthrefreshtoken=ybofHX3Vrd7C8cPhE5ZysVxFiUmkJSiw2htjPL0nKDBgpqjcyGP6Am7KNaDzqhZz;

6. In JDBC JARs Folder , enter the name of the directory where the Xero JAR file is located.

7. In Driver's Class Name , enter the following class name: cdata.jdbc.xero.XeroDriver.

8. Leave the User Name and Password blank.

9. Click Next . A list of tables in the database are displayed. All tables and views associated with the database will appear in a new window.

10. From the Tables list, select the relevant table or view you want to work with. You can click next to the relevant table or click Preview to see a preview of the data inside it.

11. (Optional) Click + to customize the data you want to import with SQL. See Importing Data with Custom Queries for more information.

12. After you have selected all the relevant tables, click Done . The tables are added to your data model.

For a short video of the process, see below (the video uses the Box driver as an example).

Additional Resources

For the full documentation set for the Xero connector, click here .

For connection string options, click here .

For information on the Xero data model, click here .

Limitations

XERO API

To access the AgedPayablesByContact and AgedRecievablesByContact tables, you need to specify a particular ContactID, the unique ID of the Contacts table, in the SELECT query using a WHERE clause. This allows you to retrieve data for a specific contact. These are limitations of the Xero API, as these reports are specific to each contact. Here’s an example:

SELECT due, paid, total FROM AgedPayablesByContact WHERE ContactID='xyz'
SELECT duedate, reference FROM AgedRecievablesByContact WHERE ContactID='1234'

Due to this limitation, you cannot build an ElastiCube with these tables without custom SQL.

Daily Limit

There is a daily limit of 5000 API calls against a single Xero organisation in a rolling 24-hour period.

In addition to the daily limit, a single access token can only be used up to 60 times in a rolling 60-second period.

Encountering a Rate Limit

If you encounter a rate limit, the Xero API will return an HTTP 503 (Service Unavailable) error, with the following message: “oauth_problem=rate limit exceeded”.

Token Limitations

• If you connected to Xero data by following the steps in Connecting to Xero (above), then you are using a Public App for connection. In a Publish App, each access token will only last for 30 minutes. If you want longer access to the organization, you need to re-authorize your application every 30 minutes.
• To re-authorize , repeat the steps in Connecting to Xero (above) in the Connection String Builder dialog. Repeat this process each time the token expires. For further details, click here .
• To avoid having to re-authenticateevery 30 minutes, you need to connect to Xero by registering a Private App. There you will need to provide the OAuth-related credentials (OAuthAccessToken, OAuthClientId and OAuthClientSecret) along with a digital certificate.

  1. Click here for instructions on creating a Private/Public Key Pair with the Certificate Generator tool. Run the tool, tell it where to export the public and private keys, and generate them. To learn more on creating the digital certification, see in the ‘Authentication with a Private Application’ section here .

  2. Create a new application in the Xero Developer Portal and upload the public key. It will give you a Consumer Key and Consumer Secret.

  3. Open the Connection String Builder dialog. Set the Certificate options so that they use the new certificate. Set the OAuthAccessToken property. Set the Consumer Key and Consumer Secret you received above in the OauthClinetId and OauthClientSecret properties.

  4. Click Test Connection in the dialog. This will generate a connection string that will not expire after 30 minutes.