Sage 50 UK Connection Details

Introduction

Connector Version

This documentation is based on version 25.0.9368 of the connector.

Get Started

Sage 50 UK Version Support

The connector models data in Sage 50 UK 2012 and above as relational tables. Note that for v28 and later, you must install the Sdata adapter prior to using Sage 50 UK driver. See the Sage 50 UK documentation for more information.

Establish a Connection

Before You Connect

For v28 and later, you must install the Sdata adapter prior to using Sage 50 UK driver. See the Sage 50 UK documentation for more information.

Connect to Sage 50 UK

The connector connects to Sage 50 UK data through the SData REST API included in the Sage 50 UK installation. SData allows access to local company datasets as well as datasets on network drives.

After Configuring the Sage SData Service, connect with the below steps, the URL property should be set to the address of the company dataset desired. To obtain the address, do the following:

1. If you have not already done so, open the Sage 50 UK software.
2. Select Tools > Internet Options.
3. Select the Sdatasettings tab.
4. Click Details next to the Sage 50 software application you want to connect to. A window opens containing a list of company names along with the addresses to their corresponding datasets.
5. Set the URL property to the value in the address field next to the company desired.

Authenticate to Sage 50 UK

The User and Password properties must be set to valid Sage 50 UK user credentials. These values are the same values used to log in to the Sage 50 UK software. To authenticate with HTTP digest to the SData service, set AuthScheme to Digest. Otherwise, Basic AuthScheme will be used.

• You are using UNC paths to the folder on the machine you are using as your SData provider.
• You set the SData service login rights to a user who has full rights over the network share or map drive.

Start the SData Service

The Sage 50 UK connector connects to Sage 50 UK via the Sage SData service (which is Sage's Web toolkit for connecting to Sage instances) that is built into the Sage 50 UK software. SData allows for remote access to Sage software applications. By default, Sage UK 2015 instances will have SData turned on and ready for use.

You can follow the steps below to verify that the SData service is started.

1. If you have not already done so, open Sage 50.
2. Navigate to Tools > Internet Options. The Internet Options window is displayed.
3. Select the Sdatasettings tab. A list is displayed of Sage software applications that are currently available.
4. To turn the SData service on for the application, select the On option.
5. If the SData Service Status does not read "SData is currently running", click the Advanced button.
6. In the dialog that is displayed, specify the Port Number desired when making the connection and click the Restart button.
7. If the Windows Firewall button is enabled, click this button to unblock the port. If you have any additional firewalls on the machine, ensure that they are configured to allow connections to be made on the specified port number.

Once you apply any changes, you can then establish a connection to your Sage 50 UK software.

Enable HTTPS Support

The Sage SData service provides secure and encrypted connections via HTTPS. Data confidentiality and the authenticity of the server are provided by digital certificates. If you do not have a certificate, use IIS to generate a self-signed certificate.

You can follow the steps below to configure the SData service to use a certificate; the connector will validate this certificate against the system trust store by default. If you generated a self-signed certificate, you can add the certificate to this certificate store or set SSLServerCert.

See Advanced Features for more information on configuring the connector for HTTPS.

Fulfill the Certificate Requirements

The certificate has the following requirements:

• The certificate must have a full valid trust chain.
• The common name (CN) for the certificate must match the machine/domain name where the SData service is running. To ensure that the CN is correct, generate the self-signed certificate on the machine where Sage 50 SData is running.
• The certificate must be added to the personal My certificate store for the Local Machine account.

Configure the SData Service for TLS/SSL

You can then configure the SData service to use the certificate:

1. Navigate to C:\Program Files (x86)\Common Files\Sage SData and open Sage.SData.Service.Config.UI.exe.

2. Click the Advanced button. The SData Configuration window is displayed.

3. Select the Enable HTTPS Access option and select the port desired.

4. If you have any firewalls on your machine, make sure the ports specified are not blocked.

5. Click the button next to the Certificate box.

6. In the resulting dialog, select the certificate. If you select a certificate and do not see the certificate name populated in the Certificate textbox, this is most likely due to missing extended properties within the certificate. The extended properties include thumbprint, thumbprint algorithm, key usage, and enhanced key usage.

   Use IIS to avoid this issue: IIS automatically populates these fields when generating a self-signed certificate.

7. Click OK to restart the server.

8. Verify that the Enable HTTPS option is selected in the SData configuration window.

Troubleshooting

If the SData configuration window is closed and reopened but the Enable HTTPS option is not enabled, this is most likely caused by the Sage.SData.Service.exe.config file not being updated properly. Follow the steps below to use the alternate configuration file below.

You will need the certificate thumbprint. Note that the thumbprint data includes spaces. The thumbprint data can be obtained using Windows services. You can also access the thumbprint in the SData configuration window:

1. If you have not already done so, open the Sage.SData.Service.Config.UI.exe application and open the advanced settings.
2. Click the button next to the Certificate box.
3. In the Windows security dialog, click "Click here to view certificate properties". The Certificate Details window is displayed.
4. On the Details tab, copy the value in the Thumbprint field.

Use this value in the CertificateLookupValue setting in the configuration file. For example:

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<configSections>
<sectionGroup name="applicationSettings" type="System.Configuration.ApplicationSettingsGroup, System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" >
<section name="Sage.SData.Service.Properties.Settings" type="System.Configuration.ClientSettingsSection, System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" requirePermission="false" />
<section name="Sage.Integration.Server.Properties.Settings" type="System.Configuration.ClientSettingsSection, System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" requirePermission="false" />
<section name="Sage.Common.Syndication.Properties.Settings" type="System.Configuration.ClientSettingsSection, System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" requirePermission="false" />
</sectionGroup>
</configSections>
<applicationSettings>
<Sage.SData.Service.Properties.Settings>
<setting name="DigestTimeout" serializeAs="String">
<value>12000000000</value>
</setting>
<setting name="EnableBasicAuthentication" serializeAs="String">
<value>True</value>
</setting>
<setting name="WebAppPath" serializeAs="String">
<value />
</setting>
<setting name="EnableSSL" serializeAs="String">
<value>True</value>
</setting>
<setting name="Port" serializeAs="String">
<value>443</value>
</setting>
</Sage.SData.Service.Properties.Settings>
<Sage.Integration.Server.Properties.Settings>
<setting name="EnableBroadcast" serializeAs="String">
<value>False</value>
</setting>
</Sage.Integration.Server.Properties.Settings>
<Sage.Common.Syndication.Properties.Settings>
<setting name="IPAddress" serializeAs="String">
<value />
</setting>
<setting name="Server" serializeAs="String">
<value>sdata</value>
</setting>
<setting name="EnableSSLPort" serializeAs="String">
<value>True</value>
</setting>
<setting name="Port" serializeAs="String">
<value>5493</value>
</setting>
<setting name="SettingsProviderType" serializeAs="String">
<value>Sage.Common.Syndication.ConfigurationSyndicationSettings, Sage.Common.Syndication</value>
</setting>
<setting name="PathPrefix" serializeAs="String">
<value />
</setting>
<setting name="DoNotUseRegistry" serializeAs="String">
<value>False</value>
</setting>
<setting name="EnableStandardPort" serializeAs="String">
<value>True</value>
</setting>
<setting name="SSLPort" serializeAs="String">
<value>5494</value>
</setting>
<setting name="CertificateLookupValue" serializeAs="String">
<value>ENTER YOUR CERTIFICATE THUMBPRINT HERE</value>
</setting>
<setting name="CertificateLookupType" serializeAs="String">
<value>Thumbprint</value>
</setting>
</Sage.Common.Syndication.Properties.Settings>
</applicationSettings>
</configuration>

Important Notes

Configuration Files and Their Paths

• All references to adding configuration files and their paths refer to files and locations on the Jitterbit agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.

Advanced Features

This section details a selection of advanced features of the Sage 50 UK connector.

User Defined Views

The connector supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views.

SSL Configuration

Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats. For further information, see the SSLServerCert property under "Connection String Options".

Proxy

To configure the connector using private agent proxy settings, select the Use Proxy Settings checkbox on the connection configuration screen.

Query Processing

The connector offloads as much of the SELECT statement processing as possible to Sage 50 UK and then processes the rest of the query in memory (client-side).

For further information, see Query Processing.

Log

For an overview of configuration settings that can be used to refine logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

User Defined Views

The Sage 50 UK connector supports the use of user defined views: user-defined virtual tables whose contents are decided by a preconfigured query. User defined views are useful in situations where you cannot directly control the query being issued to the driver; for example, when using the driver from Jitterbit.

Use a user defined view to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.

There are two ways to create user defined views:

• Create a JSON-formatted configuration file defining the views you want.
• DDL statements.

Define Views Using a Configuration File

User defined views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This user defined view configuration file is formatted so that each root element defines the name of a view, and includes a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM TradingAccounts WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Define Views Using DDL Statements

The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.

Create a View

To create a new view using DDL statements, provide the view name and query as follows:

CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;

If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews connection property.

Alter a View

To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:

ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

The view is then updated in the JSON configuration file.

Drop a View

To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.

DROP LOCAL VIEW [MyViewName]

This removes the view from the JSON configuration file. It can no longer be queried.

Schema for User Defined Views

In order to avoid a view's name clashing with an actual entity in the data model, user defined views are exposed in the UserViews schema by default. To change the name of the schema used for UserViews, reset the UserViewsSchemaName property.

Work with User Defined Views

For example, a SQL statement with a user defined view called UserViews.RCustomers only lists customers in Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

An example of a query to the driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resulting in the effective query to the source:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

That is a very simple example of a query to a user defined view that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.

SSL Configuration

Customize the SSL Configuration

To enable TLS, set the following:

• URL: Prefix the connection string with https://

With this configuration, the connector attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Data Model

The Sage 50 UK connector models Sage 50 UK entities in relational Tables and Views.

Tables

Tables describes the available tables.

Views

Views are tables that cannot be modified. Typically, read-only data are shown as views.

Tables

The connector models the data in Sage 50 UK as a list of tables in a relational database that can be queried using standard SQL statements.

Sage 50 UK Connector Tables

Commodities

Create, Update and Query Commodities (Products and Services) within Sage UK 50 Accounts.

Table Specific Information

The Commodities table allows you to select, insert, and update Commodities (Products and Services) within a Sage 50 UK company dataset.

Select

The Commodities table returns the products and services for a Sage 50 UK company dataset.

SELECT * FROM Commodities WHERE ProductCode LIKE 'ABC%'

Insert

To create a new Commodity record, the Description field is required.

INSERT INTO Commodities (ProductCode, Description, SupplierReference, CatalogueNumber, WebDescription, Cost)

VALUES ('MNP', 'MyNewProduct', 'UNI001', 'U143', 'My Web Description', 5.49)

Update

Any field that is not read-only can be updated.

UPDATE Commodities SET Description = 'My New Description' WHERE CommodityUUID = '8c47b43a-7115-7419-9679-7c72586e67d1'

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Contacts

Create, Update, Delete, and Query Contacts within Sage UK 50 Accounts.

Table Specific Information

The Contacts table allows you to select, insert, update, and delete contacts within a Sage 50 UK company dataset.

Select

The Contacts table returns the contacts contained within a Sage 50 UK company dataset.

SELECT * FROM Contacts WHERE TradingAccountReference = 'ABC123'

Insert

To create a new Contacts record, the TradingAccountReference and Type fields are required.

INSERT INTO Contacts (Title, FirstName, MiddleName, FamilyName, Suffix, TradingAccountReference, Type, PostalAddressAddress1, PostalAddressTownCity, PostalAddressStateRegion, PostalAddressZipPostCode, PostalAddressType, PostalAddressDescription, Phone1Text, Phone1Type, Phone2Text, Phone2Type, EmailAddress)

VALUES (True, 'Dr.', 'INSERT', 'ME', 'NOW', 'Jr.', 'CNTCTEST', 'Customer Delivery Contact', '123 Main St', 'Durham', 'NC', '12345', 'Shipping', 'NEW Description', '123-456-7890', 'Business Phone', '555-444-1111', 'Fax', 'test@cdata.com')

Update

Any field that is not read-only can be updated. Requirements exist for some fields of a Contact record:

• To update an existing postal address, PostalAddressUUID is required. Otherwise if postal address is null, specify the details and leave the UUID empty.
• To update an existing Phone1, Phone1UUID is required. Otherwise if Phone1 is empty, specify the details and leave the UUID empty.
• To update an existing Phone2, Phone2UUID is required. Otherwise if Phone2 is empty, specify the details and leave the UUID empty.
• To update an existing email address, EmailUUID is required. Otherwise if email is empty, specify the details and leave the UUID empty.

UPDATE Contacts SET EmailAddress = 'test@server.com', Phone1Text = '999-999-9999'
WHERE ContactUUID = '96df2e1e-72c6-4b52-b39a-eeb42c840f87' AND Phone1UUID = 'bd621624-f78e-4dec-abf3-b8b94d8fe7a3' AND EmailUUID = 'a3f6ff1b-a80b-4019-ae5e-b1fa1bb4044d'

Delete

Deleting a Contact record will also delete all postal addresses, phone numbers, and emails associated with the Contact.

DELETE FROM Contacts WHERE ContactUUID = '96df2e1e-72c6-4b52-b39a-eeb42c840f87'

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

PurchaseOrders

Create, Update, Delete, and Query PurchaseOrders within Sage UK 50 Accounts.

Table Specific Information

The PurchaseOrders table allows you to select, insert, update, and delete purchase orders within a Sage 50 UK company dataset.

Select

The PurchaseOrders table returns the purchase orders for a Sage 50 UK company dataset.

SELECT * FROM PurchaseOrders WHERE Date >= '1/1/2015' AND Date < '2/1/2015'

Insert

To create a new PurchaseOrder record, the TradingAccountUUID field is required.

Purchase Order Line Items are specified via an XML aggregate within the ItemsAggregate column. The columns that may be used in these aggregates are defined in the PurchaseOrderLineItems table.

The following example demonstrates how to insert a new PurchaseOrder with two line items:

INSERT INTO PurchaseOrders (TradingAccountUUID, DeliveryDate, PostalAddressName, PostalAddressType, PostalAddressAddress1, PostalAddressTownCity, PostalAddressStateRegion, ItemsAggregate)
VALUES ('b83c940f-9d2b-4a35-bf42-28bbe07ef994', '05/05/2015', 'Purchase Order Billing Address', 'Billing', '123 Main St', 'Chapel Hill', 'NC',
'<PurchaseOrderLineItems>
<Row><CommodityUUID>0a47b43d-7115-4863-9689-1a53123e67c8</CommodityUUID><Quantity>1</Quantity><ActualPrice>1.99</ActualPrice></Row>
<Row><CommodityUUID>586df2bb-7702-4228-b464-e8d509148547</CommodityUUID><Quantity>4</Quantity><ActualPrice>4.99</ActualPrice></Row>
</PurchaseOrderLineItems>')

Update

Any field that is not read-only can be updated.

When updating a PurchaseOrder record, PostalAddressUUID is required when updating a postal address. Note that purchase order line items cannot be updated nor deleted.

UPDATE PurchaseOrders SET PostalAddressZipPostCode = '12345'

WHERE PurchaseOrderUUID = '1b47b43a-7115-4863-9679-1a78636e67c1' AND PostalAddressUUID = '28915e09-b2a1-47e1-b193-741b32ba8ba0'

Delete

Deleting a PurchaseOrder record will also delete all line items and postal addresses associated with the PurchaseOrder.

DELETE FROM PurchaseOrders WHERE PurchaseOrderUUID = '1b47b43a-7115-4863-9679-1a78636e67c1'

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

SalesCredits

Query SalesCredits within Sage UK 50 Accounts.

Table Specific Information

The SalesCredits table allows you to select, insert, update, and delete sales credits within a Sage 50 UK company dataset.

Select

The SalesCredits table returns the sales credits for a Sage 50 UK company dataset.

SELECT * FROM SalesCredits WHERE Date >= '1/1/2015' AND Date < '2/1/2015'

Insert

To create a new SalesCredits record, the TradingAccountUUID field is required.

Sales Credit Line Items are specified via an XML aggregate within the ItemsAggregate column. The columns that may be used in these aggregates are defined in the SalesCreditLineItems table.

The following example demonstrates how to insert a new PurchaseOrder with two line items:

INSERT INTO SalesCredits (TradingAccountUUID, Type,  PostalAddress1Name, PostalAddress1Type, PostalAddress1Address1, PostalAddress1TownCity, PostalAddress1StateRegion, PostalAddress2Name, PostalAddress2Type, PostalAddress2Address1, PostalAddress2TownCity, PostalAddress2StateRegion, ItemsAggregate)
VALUES ('b83c940f-9d2b-4a35-bf42-28bbe07ef994', 'Product Credit Note',  'Sales Order Delivery Address', 'Shipping', '123 Main St', 'Chapel Hill', 'NC', 'Sales Order Billing Address', 'Billing', '987 Center Road', 'Chapel Hill', 'NC',
'<SalesCreditLineItems>
<Row><CommodityUUID>03ecf74f-0f08-4667-8a59-07e6338a8b32</CommodityUUID><Quantity>1</Quantity><ActualPrice>2.99</ActualPrice></Row>
<Row><CommodityUUID>0a47b43d-7115-4863-9689-1a53123e67c8</CommodityUUID><Quantity>2</Quantity><ActualPrice>3.99</ActualPrice></Row>
</SalesCreditLineItems>')

Update

Any field that is not read-only can be updated.

When updating a SalesCredits record, PostalAddress1UUID or PostalAddress2UUID are required when updating the respective postal address. Note that sales credit line items cannot be updated nor deleted.

UPDATE SalesCredits SET PostalAddress2ZipPostCode = '12345'

WHERE SalesCreditUUID = '392235af-f45a-4c43-a275-897130e4fdc4' AND PostalAddress2UUID = '28915e09-b2a1-47e1-b193-741b32ba8ba0'

Delete

Deleting a SalesCredit record will also delete all line items and postal addresses associated with the SalesCredit.

DELETE FROM SalesCredits WHERE SalesCreditUUID = '392235af-f45a-4c43-a275-897130e4fdc4'

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

SalesInvoices

Query SalesInvoices within Sage UK 50 Accounts.

Table Specific Information

The SalesInvoices table allows you to select, insert, update, and delete sales invoices within a Sage 50 UK company dataset.

Select

The SalesInvoices table returns the sales invoices for a Sage 50 UK company dataset.

SELECT * FROM SalesInvoices WHERE Date >= '1/1/2015' AND Date < '2/1/2015'

Insert

To create a new SalesInvoices record, the TradingAccountUUID field is required.

Sales Invoice Line Items are specified via an XML aggregate within the ItemsAggregate column. The columns that may be used in these aggregates are defined in the SalesInvoiceLineItems table.

The following example demonstrates how to insert a new SalesInvoice with two line items:

INSERT INTO SalesInvoices (TradingAccountUUID, Type, PostalAddress1Name, PostalAddress1Type, PostalAddress1Address1, PostalAddress1TownCity, PostalAddress1StateRegion, PostalAddress2Name, PostalAddress2Type, PostalAddress2Address1, PostalAddress2TownCity, PostalAddress2StateRegion, ItemsAggregate)
VALUES ('b83c940f-9d2b-4a35-bf42-28bbe07ef994', 'Product Invoice', 'Sales Order Delivery Address', 'Shipping', '123 Main St', 'Chapel Hill', 'NC', 'Sales Order Billing Address', 'Billing', '987 Center Road', 'Chapel Hill', 'NC', '<SalesInvoiceLineItems> <Row><CommodityUUID>03ecf74f-0f08-4667-8a59-07e6338a8b32</CommodityUUID><Quantity>2</Quantity><ActualPrice>2.99</ActualPrice></Row> <Row><CommodityUUID>0a47b43d-7115-4863-9689-1a53123e67c8</CommodityUUID><Quantity>1</Quantity><ActualPrice>4.99</ActualPrice></Row>
</SalesInvoiceLineItems>')

Update

Any field that is not read-only can be updated.

When updating a SalesInvoices record, PostalAddress1UUID and PostalAddress2UUID are required when updating a postal address (respectively). Note that sales invoice line items cannot be updated nor deleted.

UPDATE SalesInvoices SET PostalAddress2ZipPostCode = '12345'

WHERE SalesInvoiceUUID = '392235af-f45a-4c43-a275-897130e4fdc4' AND PostalAddress2UUID = '28915e09-b2a1-47e1-b193-741b32ba8ba0'

Delete

Deleting a SalesInvoice record will also delete all line items and postal addresses associated with the SalesInvoice.

DELETE FROM SalesInvoices WHERE SalesInvoiceUUID = '392235af-f45a-4c43-a275-897130e4fdc4'

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

SalesOrders

Create, Update, Delete, and Query SalesOrders within Sage UK 50 Accounts.

Table Specific Information

The SalesOrders table allows you to select, insert, update, and delete sales orders within a Sage 50 UK company dataset.

Select

The SalesOrders table returns the sales orders for a Sage 50 UK company dataset.

SELECT * FROM SalesOrders WHERE Date >= '1/1/2015' AND Date < '2/1/2015'

Insert

To create a new SalesOrder record, the TradingAccountUUID field is required.

Sales Order Line Items are specified via an XML aggregate within the ItemsAggregate column. The columns that may be used in these aggregates are defined in the SalesOrderLineItems table. Note: a CommodityUUID must be set when adding a SalesOrderLineItem, as only existing Commodities can be referenced (to create a new Commodity, the Commodities table can be used).

The following example demonstrates how to insert a new SalesOrder with two line items:

INSERT INTO SalesOrders (TradingAccountUUID, DueDate, PostalAddress1Name, PostalAddress1Type, PostalAddress1Address1, PostalAddress1TownCity, PostalAddress1StateRegion, ItemsAggregate)
VALUES ('b83c940f-9d2b-4a35-bf42-28bbe07ef994', True, '05/05/2015', 'Sales Order Delivery Address', 'Shipping', '123 Main St', 'Chapel Hill', 'NC',
'<SalesOrderLineItems>
<Row><CommodityUUID>0a47b43d-7115-4863-9689-1a53123e67c8</CommodityUUID><Quantity>1</Quantity><ActualPrice>1.99</ActualPrice></Row>
<Row><CommodityUUID>586df2bb-7702-4228-b464-e8d509148547</CommodityUUID><Quantity>4</Quantity><ActualPrice>4.99</ActualPrice></Row>
</SalesOrderLineItems>')

Update

Any field that is not read-only can be updated.

When updating a SalesOrder record, PostalAddress1UUID and PostalAddress2UUID are required when updating the respective postal address. Note that sales order line items cannot be updated nor deleted.

UPDATE SalesOrders SET PostalAddress1ZipPostCode = '12345'

WHERE SalesOrderUUID = '957af245-4678-4ca9-904a-162dcce87e5b' AND PostalAddress1UUID = '28915e09-b2a1-47e1-b193-741b32ba8ba0'

Delete

Deleting a SalesOrder record will also delete all line items and postal addresses associated with the SalesOrder.

DELETE FROM SalesOrders WHERE SalesOrderUUID = '957af245-4678-4ca9-904a-162dcce87e5b'

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

TradingAccounts

Create, Update, Delete, and Query TradingAccounts within Sage UK 50 Accounts.

Table Specific Information

The TradingAccounts table allows you to select, insert, and update trading accounts within a Sage 50 UK company dataset.

Select

The TradingAccounts table returns the trading account information for a Sage 50 UK company dataset.

SELECT * FROM TradingAccounts

Insert

To create a new Trading Account record, the Name and CustomerSupplierFlag fields are required.

INSERT INTO TradingAccounts (Name, CustomerSupplierFlag, OpenedDate, Website, FinanceBalance, FinanceLimit, Analysis1, Analysis2, Analysis3)

VALUES ('My Trading Account', 'Customer', '05/10/2015', 'www.cdata.com', 100.00, 1000.00, 'Trade', 'Jenkins', 'National')

Update

Any field that is not read-only can be updated.

UPDATE TradingAccounts SET Analysis3 = 'International' WHERE TradingAccountUUID = '90c7afb4-ad34-41a2-b71d-ef49cc489872'

Delete

DELETE FROM TradingAccounts WHERE TradingAccountUUID = '90c7afb4-ad34-41a2-b71d-ef49cc489872'

Note: When additional resources are tied to the account, the record is not deleted. However, the Sage API will still return an

OK response, signalling the record has been deleted. The actual error message can be viewed by attempting to delete the account within the software itself.

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

Sage 50 UK Connector Views

BankAccounts

Query BankAccounts within Sage UK 50 Accounts.

Table Specific Information

Select

The BankAccounts table returns the bank accounts for a Sage 50 UK company dataset.

SELECT * FROM BankAccounts

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

FinancialAccounts

Query Financial Accounts within Sage UK 50 Accounts.

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Interactions

Query Interactions within Sage UK 50 Accounts.

Table Specific Information

Select

The Interactions table returns the customer interaction information for a Sage 50 UK company dataset.

SELECT * FROM Interactions

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Prices

Query Prices within Sage UK 50 Accounts.

Table Specific Information

Select

The Prices table returns the product and services pricing information for a Sage 50 UK company dataset.

SELECT * FROM Prices WHERE Price < 10.00

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Projects

Query Projects within Sage UK 50 Accounts.

Table Specific Information

Select

The Projects table returns project information for a Sage 50 UK company dataset.

SELECT * FROM Projects

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

PurchaseOrderDeliveries

Query PurchaseOrderDeliveries within Sage UK 50 Accounts.

Table Specific Information

Select

The PurchaseOrderDeliveries table returns purchase order delivery information for a Sage 50 UK company dataset.

SELECT * FROM PurchaseOrderDeliveries

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

PurchaseOrderDeliveryLineItems

Query PurchaseOrderDeliveryLineItems within Sage UK 50 Accounts.

Table Specific Information

Select

The PurchaseOrderDeliveryLineItems table returns purchase order delivery line item information for a Sage 50 UK company dataset.

SELECT * FROM PurchaseOrderDeliveryLineItems WHERE GoodsReceivedNumber = '123'

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

PurchaseOrderLineItems

Query PurchaseOrderLines within Sage UK 50 Accounts.

Table Specific Information

Select

The PurchaseOrderLineItems table returns purchase order line item information for a Sage 50 UK company dataset.

SELECT * FROM PurchaseOrderLineItems WHERE PurchaseOrderNumber = 'PO123'

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Receipts

Query Receipts within Sage UK 50 Accounts.

Table Specific Information

Select

The Receipts table returns the receipt information for a Sage 50 UK company dataset.

SELECT * FROM Receipts

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

SalesCreditLineItems

Query SalesCreditLineItems within Sage UK 50 Accounts.

Table Specific Information

Select

The SalesCreditLineItems table returns sales credit line item information for a Sage 50 UK company dataset.

SELECT * FROM SalesCreditLineItems WHERE CreditNumber = 'CR123'

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

SalesInvoiceLineItems

Query SalesInvoiceLineItems within Sage UK 50 Accounts.

Table Specific Information

Select

The SalesInvoiceLineItems table returns sales invoice line item information for a Sage 50 UK company dataset.

SELECT * FROM SalesInvoiceLineItems WHERE InvoiceNumber = 'INV123'

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

SalesOrderDeliveries

Query SalesOrderDeliveries within Sage UK 50 Accounts.

Table Specific Information

Select

The SalesOrderDeliveries table returns sales order delivery information for a Sage 50 UK company dataset.

SELECT * FROM SalesOrderDeliveries

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

SalesOrderDeliveryLineItems

Query SalesOrderDeliveryLineItems within Sage UK 50 Accounts.

Table Specific Information

Select

The SalesOrderDeliveryLineItems table returns sales order delivery line item information for a Sage 50 UK company dataset.

SELECT * FROM SalesOrderDeliveryLineItems WHERE GoodsDespatchedNumber = '987'

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

SalesOrderLineItems

Query SalesOrderLineItems within Sage UK 50 Accounts.

Table Specific Information

Select

The SalesOrderLineItems table returns sales order line item information for a Sage 50 UK company dataset.

SELECT * FROM SalesOrderLineItems WHERE SalesOrderNumber = 'SO123'

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

TaxCodes

Query Tax Codes within Sage UK 50 Accounts.

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

TradingActivities

Query TradingActivities within Sage UK 50 Accounts.

Table Specific Information

Select

The TradingActivities table returns the trading activity information for a Sage 50 UK company dataset.

SELECT * FROM TradingActivities

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT/INSERT/UPDATE/DELETE operations with Sage 50 UK.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Sage 50 UK, along with an indication of whether the procedure succeeded or failed.

Sage 50 UK Connector Stored Procedures

ComputePrice

Computes the Price based on a trading account and a commodity provided.

Input

Result Set Columns

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Sage 50 UK:

• sys_catalogs: Lists the available databases.
• sys_schemas: Lists the available schemas.
• sys_tables: Lists the available tables and views.
• sys_tablecolumns: Describes the columns of the available tables and views.
• sys_procedures: Describes the available stored procedures.
• sys_procedureparameters: Describes stored procedure parameters.
• sys_keycolumns: Describes the primary and foreign keys.
• sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

• sys_connection_props: Returns information on the available connection properties.
• sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

• sys_identity: Returns information about batch operations or single updates.

sys_catalogs

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

SELECT * FROM sys_schemas

Columns

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

SELECT * FROM sys_tables

Columns

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the TradingAccounts table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='TradingAccounts'

Columns

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

SELECT * FROM sys_procedures

Columns

sys_procedureparameters

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the SelectEntries stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND Direction = 1 OR Direction = 2

To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND IncludeResultColumns='True'

Columns

Pseudo-Columns

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the TradingAccounts table:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='TradingAccounts'

Columns

sys_foreignkeys

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Columns

sys_primarykeys

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

SELECT * FROM sys_primarykeys

Columns

sys_indexes

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns

sys_connection_props

Returns information on the available connection properties and those set in the connection string.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

sys_sqlinfo

Describes the SELECT query processing that the connector can offload to the data source.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns

sys_identity

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

SELECT * FROM sys_identity

Columns

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

Advanced Configurations Properties

The advanced configurations properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure. Click the links for further details.

Authentication

SSL

Schema

Miscellaneous

Authentication

This section provides a complete list of authentication properties you can configure.

AuthScheme

The scheme used for authentication. Accepted entries are Basic, Digest, or None.

Possible Values

Basic, Digest, None

Data Type

string

Default Value

Basic

Remarks

Together with Password and User, this field is used to authenticate against the Sage 50 UK Accounts service. Basic is the default option.

• Basic: Set this to use HTTP Basic authentication.
• Digest: Set this to use HTTP Digest authentication.

URL

URL to the Sage 50 UK SData service. For example, http://MySite:5493/sdata/accounts50/GCRM/MyDatasetId/.

Data Type

string

Default Value

""

Remarks

URL to the Sage 50 UK SData service. For example, http://MySite:5493/sdata/accounts50/GCRM/MyDatasetId/.

The URL can be obtained directly from your Sage 50 UK Accounts software by navigating to Tools > Internet Options > SData Settings > Details (Next to Sage 50 UK Accounts). The address can then be copied for the company dataset desired.

User

Specifies the user ID of the authenticating Sage 50 UK user account.

Data Type

string

Default Value

""

Remarks

The authenticating server requires both User and Password to validate the user's identity.

Password

Specifies the password of the authenticating user account.

Data Type

string

Default Value

""

Remarks

The authenticating server requires both User and Password to validate the user's identity.

SSL

This section provides a complete list of SSL properties you can configure.

SSLServerCert

Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

If not specified, any certificate trusted by the machine is accepted.

Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Schema

This section provides a complete list of schema properties you can configure.

Location

Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.

Data Type

string

Default Value

%APPDATA%\Sage50UK Data Provider\Schema

Remarks

The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is %APPDATA%\Sage50UK Data Provider\Schema, where %APPDATA% is set to the user's configuration directory:

BrowsableSchemas

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Data Type

string

Default Value

""

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

Tables

Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC.

Data Type

string

Default Value

""

Remarks

Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.

If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Views

Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Data Type

string

Default Value

""

Remarks

Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.

If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Miscellaneous

This section provides a complete list of miscellaneous properties you can configure.

MaxRows

Specifies the maximum rows returned for queries without aggregation or GROUP BY.

Data Type

int

Default Value

-1

Remarks

This property sets an upper limit on the number of rows the connector returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.

When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Other

Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.

Data Type

string

Default Value

""

Remarks

This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in a semicolon-separated list.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

Pagesize

The maximum number of records per page the provider returns when requesting data from Sage 50 UK.

Data Type

int

Default Value

1000

Remarks

When processing a query, instead of requesting all of the queried data at once from Sage 50 UK, the connector can request the queried data in pieces called pages.

This connection property determines the maximum number of results that the connector requests per page.

Note that setting large page sizes may improve overall query execution time, but doing so causes the connector to use more memory when executing queries and risks triggering a timeout.

PseudoColumns

Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.

Data Type

string

Default Value

""

Remarks

This property allows you to define which pseudocolumns the connector exposes as table columns.

To specify individual pseudocolumns, use the following format: "Table1=Column1;Table1=Column2;Table2=Column3"

To include all pseudocolumns for all tables use: "*=*"

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

Data Type

int

Default Value

60

Remarks

This property controls the maximum time, in seconds, that the connector waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the connector cancels the operation and throws an exception.

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond the timeout value if each paging call completes within the timeout limit.

Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

UserDefinedViews

Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Data Type

string

Default Value

""

Remarks

This property allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the connector and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view. For example:

{
    "MyView": {
        "query": "SELECT * FROM TradingAccounts WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }

}

You can define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the connector.

Refer to User Defined Views for more information.