Before you start

The Designer runs on your own machine, but it is not self-contained: on first start it downloads an engine, and every build downloads dependencies. This page is what has to be in place for that to work. Then go to Install the Designer.

Checklist

Item

Value

A working directory

a local folder with full write permissions, e.g. C:\AxonIvy\Workspace

Internet access

to the addresses below, directly or through a proxy

Local browser access

localhost:8080, where the Designer's own engine runs

Administrator rights

helpful, not required. Without them, environment variables go into your user variables instead, see 5 ยท Set the environment variables for Maven

The working directory

Keep your projects in a local folder with full write permissions, for example C:\AxonIvy\Workspace.

Addresses that must not be blocked

When the Designer starts for the first time it downloads an Axon Ivy Engine in the background, and the first build downloads the project's dependencies. A firewall or proxy must let these through:

Address

What for

https://marketplace.visualstudio.com/

VS Code extensions

https://market.axonivy.com/

Axon Ivy Market

https://maven.axonivy.com/

Axon Ivy artifacts and the engine download

https://adoptium.net/

Java (Eclipse Temurin)

https://dlcdn.apache.org/

the Maven download

https://repo.maven.apache.org/

Maven Central, where project dependencies come from

The engine then runs locally, and its web interface opens in a browser at localhost:8080. That local access must not be blocked either.

If your internet access goes through a proxy

Tip

Important

Coordinate with your IT department before you install. Two things are needed from them:

  • the proxy's host name and port, for Maven, see below

  • localhost and 127.0.0.1 on the proxy exclusion list, so the browser reaches the local engine directly instead of sending it to the proxy

Maven does not use the system's proxy settings. It has its own, in the file %USERPROFILE%\.m2\settings.xml. If the file does not exist, create it.

Note
What the proxy entry looks like

Replace the host name and port with the values from your IT department. <nonProxyHosts> keeps Maven's own requests to the local machine off the proxy.

Listing 15 %USERPROFILE%\.m2\settings.xml
<settings>
  <proxies>
    <proxy>
      <id>company-proxy</id>
      <active>true</active>
      <protocol>http</protocol>
      <host>proxy.example.com</host>
      <port>8080</port>
      <nonProxyHosts>localhost|127.0.0.1</nonProxyHosts>
    </proxy>
  </proxies>
</settings>

The full set of options is in Maven's proxy guide.

Next

Install the Designer.