Skip to content
Developerhome
Product homepage
X3

Prerequisites

  Less than to read

What do I need to use Sage X3 Builder?

To use Sage X3 Builder, you need to download and unzip the Sage X3 Builder Developer Studio minimum version 48.0.53.

Before, make sure you have the following prerequisites installed in your machine to use X3 Builder:

Microsoft VS Code

Microsoft VS Code is the IDE Sage supports to build your APIs and Mobile Automation pages. Make sure it’s installed in the developer environment of your choosing.

Note: The use of any other Typescript IDE is at your own risk. The documentation that follows applies to the use of VS Code as your IDE.

Node.js and nvm

Sage X3 Builder uses Node.js. To find out the version of Node.js supported by the current Sage X3 Builder developer Studio release, open the .nvmrc file included in the Developer’s Studio root directory.

The exact version of Node.Js mentioned in the .nvmrc file must be used when generating, building, and using your applications.

To help with the control of which version of Node.js used with VS Code, Sage recommends the use of nvm (on Linux) and nvm-windows (on Windows). To install nvm, follow the following steps:

  • Download and install nvm (if you're using Linux) or nvm-windows (if you're using Windows). Install it.
    • Note: On Windows, nvm-windows is sensitive to directory paths that contain spaces. Make sure you install nvm-windows (and Node.js) on a neutral, non-user directory that does not contain any spaces.
  • In VS Code, open a terminal and type:
    • nvm install [version] where [version] is the Node.js version specified in the .nvmrc file.
    • nvm use [version] where [version] is the Node.js version specified in the .nvmrc file.
    • Note: This installs the supported Node.js version in the directory you have specified during the setup of nvm or through the nvm configuration files.

X3 Services Developer Studio

To use Sage X3 Builder Developer studio, Sage X3 Services Developer Studio version 48.0.53 minimum should be installed.

To see how to install Sage X3 Services, check the corresponding documentation.

Setup Sage X3 Builder Developer Studio

To setup Sage X3 Builder Developer Studio, you need to setup the solution and/or endpoint in Sage X3 with the correct settings for Sage X3 Services URL and database connection. You can do this in the Services section in the Solution or Endpoints administration function.

After, you need to edit xtrem-config.yml with the right information to connect to the X3 instance. To do this, open the Developer’s Studio root directory in VS Code. Then, open the VS Code terminal and run the following command:

  • On Windows: npm run clean:install:win
  • On Unix (e.g. WSL): npm run clean:install:unix
  • Note: You maybe prompted to update other components of the Dev Pack at the end of the install script. You can simply run the commands indicated to update the indicated components.

Open the xtrem-config.yml configuration file and populate the settings to connect to X3:

  • driver:tedious (SQL Server) or oracle (Oracle DBs)
  • hostname: The Oracle or SQL Server hostname. For SQL Server, this can contain the server, instance and port in the following format: <server>\\<instance><port>
  • port: If a port is required, enter it here. For SQL Server, the default port is usually 1433. For Oracle, the default port can be ommited in the connection string.
  • stringdatabase: The Oracle or SQL Server database name.
  • user: Specififies the SQL Server account to connect to the database.
  • password: Specifies the SQL Server account password to connect to the database.
  • folderName: The name of the X3 folder to connect to.
  • reference: The name of its reference folder. Typically, this is X3.
  • defaultLanguage: Use the language code from X3 to specify the default language to be used for GraphQL queries.
  • url: Specifies the Sage X3 URL to use for GraphQL mutation. This should normally be http://[server]/xtrem/mutation where [server] is the IP address or hostname of the Sage X3 Web Server. If Sage X3 Web Server is not hosted in port 80, the port also needs to be specified.
  • secret: The X3 Services secret key defined in the Syracuse administration global settings located in Administration > Global settings.

You may also add the following section to change the default port where your applications will listen through when you start and test your developments:

    server:
        port: [The port you would like to use, e.g. 8241]