Sage 300 Connection

See the Connector Marketplace topic. Please request your administrator to start a trial or subscribe to the Premium Sage 300 connector.

Sage 300 is a comprehensive business management and ERP solution for enhanced operational efficiency.

This topic describes how to authenticate to Sage 300 and configure any necessary connection properties in the Sage 300 connection connector.

Prerequisites #

Before Authenticating #

Sage 300 requires some initial setup in order to communicate over the Sage 300 Web API.

The logged in user must have API access to one or all modules of the Sage300 instance.

In Sage300 a user is assigned a security group. A security group is a set of permissions for each module.

It is recommended that you use a different user other than the ADMIN user to access the API.

The ADMIN user has a couple of extra steps in order to gain access to the API. Follow the steps below in order to obtain access to the API.

Creating a User #

Skip this step if you have already created a new user or you would like to use an existing account.

• Open the Sage300 Desktop Application which is included in the installation of Sage300. Log in with the ADMIN account.

• Go to Administrative Services -> Users.

• Fill in the required information and click Add.

Setting up the Security Group #

• Open the Sage300 Desktop Application which is included in the installation of Sage300. Log in with the ADMIN account.

• Go to Administrative Services -> Security Groups.

• In the Application you will find all the modules of Sage300. The Group ID represents the security group you want to modify. Below you will find a list of permissions that you can check.

• (Optional)Create a new Security Group fill the Group ID, Group Description and check any of the permissions including the Sage 300 Web API permission. Lastly click Add (per each application required)

• Or select an existing Security Group you are going to assign to the User under Group ID and check the Sage 300 Web API permission in the end of permissions (per each application required).

Assigning a Security Group #

• Open the Sage300 Desktop Application which is included in the installation of Sage300. Log in with the ADMIN account.

• Go to Administrative Services -> User Authorization.

• Under User ID select your new/existing User.

• Now for each Application assign the Group ID which you created/modified

• Once the user access is done, ensure that they have access to the web API. Replace ‘server’ with your Sage300 instance URL.

Connecting to Sage 300 #

You can authenticate to Sage 300 using Basic authentication.

Basic Authentication #

You must provide values for the following properties to successfully authenticate to Sage 300. Note that the provider will reuse the session opened by Sage 300 using cookies.

This means that your credentials will be used only on the first request to open the session. After that, cookies returned from Sage 300 will be used for authentication.

• Url: Set this to the url of the server hosting Sage 300. Construct a URL for the Sage 300 Web API as follows: {protocol}://{host-application-path}/v{version}/{tenant}/

  Example: http://localhost/Sage300WebApi/v1.0/-/.

• User: Set this to the username of your account.

• Password: Set this to the password of your account.

Connection Configuration #

Each connection property available in the Sage 300 connector is explained below.

Connection Name #

The name of the connection to be created should be provided. This is the name that will display on the list of available connections.

URL #

Set the URL to the HTTP or HTTPS endpoint of your Sage 300 system.

Example: http://localhost/Sage300WebApi/v1.0/-/.

Construct a URL for the Sage 300 Web API as follows:

{protocol}://{host-application-path}/v{version}/{tenant}/ For example, http://localhost/Sage300WebApi/v1.0/-/

User #

The Sage 300 user account used to authenticate.

Password #

The password used to authenticate the user.

Company #

Determines the company.

Specify the company you wish to get data from. If not specified, the first company found on /Companies endpoint will be choosen.

Modules #

Comma separated list of modules.

Comma separated list of modules. (Use this connection property to have access only on the desired modules. This will improve performance of the metadata retrieved.)

Options: AP(Account Payable), AR(Account Receivable), BK(Banks), CS(Common Services), GL(General Ledger), IC(Inventory Control), OE(Order Entry), PO(Purchase Orders), TX(TaxTracking)

Enable SSL #

Option for creating the connection with SSL enabled.

Upload Keystore File #

Option to upload keystore file.

Advanced Configurations #

This section contains additional configuration parameters.

Include Custom Fields #

Determines if Custom Fields should be included as table columns or not.

To retrieve their values you can set IncludeCustomFields to true.

Doing so will list the custom fields created as table columns.

Add Configuration: Additional properties can be added using this option as key-value pairs.

After entering all the details, click on the TEST button.

If the connection service identification and authentication details are provided correctly, a success message stating “connection available” is generated.

Click on the CREATE button to save the changes.

If the details are incorrect or the server is down, you will get a message “Connection unavailable”.