Skip to content

Sage 300 Setup

Sage 300 (formerly Accpac) is an on-premises Windows ERP. superglue reads and writes Sage 300 data through the Sage 300 Web API, which runs on the client’s own IIS web server. That server is usually reachable only inside the client’s network, so superglue reaches it through the Secure Gateway. The agent works with General Ledger, Accounts Receivable, Accounts Payable, Order Entry, Purchase Orders, Inventory Control, and other modules this way.

This guide walks you through the setup. Most of the time goes to the steps that the client’s IT and Sage administrator must do.

  • No inbound firewall rules. The gateway opens one outbound encrypted connection to superglue. The Web API is not exposed to the internet.
  • Runs as one Sage 300 user. Every request runs as the Sage 300 user that you enter in superglue. The agent can only see and change what that user’s security groups allow.
  • One company per connection. The company database ID is part of the connection URL. Each company needs its own connection.
  • Approval before writes. The agent reads freely. In the default Ask for permission mode, it asks before it creates, changes, deletes, or posts data.

The client’s IT and Sage administrator do these steps. They are made on the client’s servers and in Sage 300 Administrative Services, so the agent cannot do them in its own browser.

  • The Sage 300 Web API. The Web API is installed only when Web Screens were selected during the Sage 300 installation. Ask IT to confirm that it runs and to give you its address, for example sage300.example.com.
  • A machine for the gateway. A Windows or Linux machine on the client’s network that can reach the Web API server. It can be the Web API server itself.
  • Outbound internet access. The gateway machine must reach superglue over port 443. No inbound port is needed.
  • A dedicated Sage 300 user. Ask the Sage administrator to create a Sage 300 application user for superglue. A Windows user does not work. Do not use the ADMIN user, which the Web API blocks by default.
  • Web API access for that user. In Administrative Services, the administrator adds the user to a security group that has the Sage 300 Web API authorization for each module in scope. Give the user only the modules the project needs.
  • The company database ID. The ID of each Sage 300 company that the project needs, for example SAMLTD for the Sage sample company.
  1. Ask the agent to connect Sage 300

    1. Start a session from the task, or click New session.
    2. Tell the agent: “Connect the client’s Sage 300 Web API.” Give the Web API address and the company database ID if you have them.
  2. Set up the gateway on the client’s network

    1. The agent shows the gateway setup in the chat, with the gateway name and a target for the Web API server. Check the target address. To change a value, tell the agent. It shows a new setup.
    2. On the gateway machine, install the gateway:
      • Windows: select Download for Windows, open superglue-gateway-windows.exe, paste the one-time code, and select Connect. Windows asks once for administrator rights.
      • Linux: turn on Install with a command and run the Linux terminal command.
    3. Keep the chat open. The setup shows when the gateway is connected and whether it reaches the Web API server. The agent then continues.

    The code and the install command contain a secret. Use them only on the gateway machine.

  3. Enter the Sage 300 user

    1. The agent creates the connection with the gateway and the Web API address, and opens the secure connection form.
    2. Enter the name and password of the Sage 300 user. The values go directly to the connection. They do not appear in the chat.
  4. Test the connection

    1. Tell the agent: “List five customers from Sage 300 Accounts Receivable.”
    2. If you get customers back, the setup works.

If the Web API is not installed, there are two other ways:

  • The company database. Each Sage 300 company is its own database. When the database runs on Microsoft SQL Server, superglue can read it through the gateway. The client’s database administrator creates a SQL Server login for superglue with read access to each company database. If SQL Server runs as a named instance, it must listen on a fixed TCP port, because the gateway forwards one TCP port only.
  • File exports. Ask the client to export the data from Sage 300, for example as Excel or CSV files, and attach them in the chat. Exports are a copy at one point in time, and superglue cannot write back from them.
  • Page size. The Web API returns at most the number of records set on the server, 100 by default. The agent reads large lists page by page.
  • One record per write. Each create, change, or delete handles one record. Large loads take one request per record.
  • Detail lines on changes. When the agent changes a document with lines, it reads the document first and sends every line again. Sage 300 removes lines that a change does not include.
  • Queries. The Web API supports filters and paging, but not sorting or field selection.
  • Licenses. Web API sessions use Sage 300 concurrent user licenses. The agent keeps few requests open at the same time.
  • First request after a pause. IIS stops the Web API after about 20 minutes without use by default, so the next request is slow. The client’s IT can change this in the IIS settings of the Web API.

To remove access right away, do one of these steps:

  • In Administrative Services, remove the superglue user from its security groups, or delete the user.
  • In superglue, open the Sage 300 connection on the Connections page. Under Secure Gateway in its advanced settings, select Remove gateway. This disconnects the gateway and deletes the API keys that you select.

To remove the gateway from the machine, follow Uninstall the gateway.

You can delete the Sage 300 connection in its connection panel on the Connections page.

Sage 300 Construction and Real Estate has its own setup in superglue. It differs from Sage 300 in these ways:

  • No Web API. The data is in Actian Zen (Pervasive) files, with one data folder per company.
  • Gateway on a Sage machine. The gateway must run on a Windows machine where Sage 300 CRE is installed, with the script runner turned on. The Timberline Data ODBC driver comes only with the Sage 300 CRE installation.
  • Security in Sage. The client’s Sage administrator creates a Sage user for superglue in Security Administration, with ODBC read access to the tables in scope and no ODBC write access.
  • Hidden records. When record security is active, records that the user cannot see are left out with no error. The agent compares related data to find such gaps.

To start, tell the agent: “Connect the client’s Sage 300 CRE server.”

The user name or the password is wrong. Sage 300 user names are uppercase. Passwords are uppercase too, unless the client turned on the increased password complexity option. Try the values in uppercase first.

Yes. The Web API has process actions, for example to post invoices or to create GL batches. The agent asks for your approval before each one. Try them in a test company first.

How do I connect several Sage 300 companies?

Section titled “How do I connect several Sage 300 companies?”

Add one connection for each company and name it after the company. The connections can use the same gateway.

What do DBLinkError and SessionError mean?

Section titled “What do DBLinkError and SessionError mean?”

These errors come from a broken Web API installation on the client’s server, not from superglue. Ask the client’s IT to check the Sage 300 Web API installation.