Skip to main content

Installing the Design API

  • Updated

BackPrevious Topic  Next TopicNext

Installing the Design API

Both Designer and Server include the full Design API packages. Designer includes a single threaded Design API, while Server includes a multithreaded Design API. You can also download and install the independent Design API and Server Design API packages on your local machine, then you can program with them without having to install any other Logi Report products. This topic describes how you can install the Design API using different methods.

This topic contains the following sections:

Installing the Design API by Designer

When you install Designer, you install the Design API at the same time. After installation, you have the following components in <designer_install_root>\lib:

  • JREngine.jar
  • report.jar
  • sac-1.3.jar
  • log4j-core-2.17.1.jar and log4j-api-2.17.1.jar (for the Logi Report logging system)

Critical icon In the second week of December 2021, a Log4j vulnerability was announced that may affect some customers using our products. Resolving/mitigating this issue is a high priority! We will continue to issue information to help you with this vulnerability. For more information, select this link: Statement on Log4j and Log4Net Vulnerabilities.

You can get the classes for the Design API classes in the archive files: report.jar and JREngine.jar. You need to take the following steps before you can compile and run the program.

  1. Set the classpath environment variable. Append the following string to your class path that starts the Design API (make sure that the path of JREngine.jar is before that of report.jar):

    <designer_install_root>\lib\JREngine.jar;<designer_install_root>\lib\report.jar;<designer_install_root>\lib\log4j-core-2.17.1.jar;<designer_install_root>\lib\log4j-api-2.17.1.jar;<designer_install_root>\lib\sac-1.3.jar;

  2. Add the jar files for your DBMS JDBC drivers.
  3. Set the -Dreporthome parameter to be the same as the root path of Designer.
  4. Register the Design API licensed user and license key in your source code.

Installing the Design API by Server

When you install Server, you install the Server Design API at the same time. After installation, you have the following components in <server_install_root>\lib:

  • JREngine.jar
  • JREServlets.jar
  • sac-1.3.jar
  • log4j-core-2.17.1.jar and log4j-api-2.17.1.jar (for the Logi Report logging system)

You can get the classes for the Server Design API classes in the archive files: JRESServlets.jar and JREngine.jar. You need to take the following steps before you can compile and run the program.

  1. Set the classpath environment variable. Append the following string to your class path that starts the Server Design API:

    <server_install_root>\lib\JRESServlets.jar;<server_install_root>\lib\JREngine.jar;<server_install_root>\lib\log4j-core-2.17.1.jar;<server_install_root>\lib\log4j-api-2.17.1.jar;<server_install_root>\lib\sac-1.3.jar;

  2. Add the jar files for our DBMS JDBC drivers.
  3. Set the -Dreporthome parameter to be the same as the root path of Server.
  4. Register the Server Design API licensed user and license key in your source code.

Installing Independent Design API

To install independent Design API, get the installation file, then run the file and follow the prompts to install. For more product information, including new purchases and upgrades, contact US Sales or UK Sales.

After you install the Design API by running the installation file, you need to take the following steps before you can compile and run the program.

  1. Set the classpath environment variable. Append the following string to your class path that starts the Design API:

    <designAPI_install_root>\lib\designAPI.jar;<designAPI_install_root>\lib\log4j-core-2.17.1.jar;<designAPI_install_root>\lib\log4j-api-2.17.1.jar;<designAPI_install_root>\lib\sac-1.3.jar;<designAPI_install_root>\lib\hsqldb-This image notes any new content for version 18.3 of the product. For more information please see the Release Notes or Enhancements topics.2.6.1.jar

  2. Set the -Dreporthome parameter to be the same as the root path of the Design API.

Installing Independent Server Design API

To install independent Server Design API, get the installation file, then run the file and follow the prompts to install. For more product information, including new purchases and upgrades, contact US Sales or UK Sales.

Note icon We do not recommend using these libraries, instead we recommend you use the Design API libraries included in Server.

After you have install the Server Design API by running the installation file, you need to take the following steps before you can compile and run the program.

  1. Set the classpath environment variable. Append the following string to your class path that starts the Server Design API:

    <svrdesignAPI_install_root>\lib\serverDesignAPI.jar;<svrdesignAPI_install_root>\lib\log4j-core-2.17.1.jar;<svrdesignAPI_install_root>\lib\log4j-api-2.17.1.jar;<svrdesignAPI_install_root>\lib\sac-1.3.jar;<svrdesignAPI_install_root>\lib\hsqldb-This image notes any new content for version 18.3 of the product. For more information please see the Release Notes or Enhancements topics.2.6.1.jar

  2. Set the -Dreporthome parameter to be the same as the root path of the Server Design API.

BackPrevious Topic  Next TopicNext