Previous Topic
Installing the Catalog API
This topic describes how you can install the Catalog API.
When you install Designer, you install the Catalog API at the same time. After installation, you have the following components in <install_root>\lib:
- report.jar
- JREngine.jar
- log4j-core-2.13.3.jar and log4j-api-2.13.3.jar (for the Logi Report logging system)
- sac-1.3.jar (for installing the Catalog API with the Design API)
- ...
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 Catalog API class in the archive file report.jar. You need to do the following steps before you can compile and run the program:
- Set the class path environment variable. Append the following string to your class path that starts the Catalog API (make sure that the path of JREngine.jar is before that of report.jar):
<install_root>\lib\JREngine.jar;<install_root>\lib\sac-1.3.jar;<install_root>\lib\report.jar;<install_root>\lib\log4j-core-2.13.3.jar;<install_root>\lib\log4j-api-2.13.3.jar - In your Java program you must set the licensed user and Design API license key.
DesignerUserInfo userInfo=new DesignerUserInfo("UID","Design API Key"); - Set the reporthome parameter equal to the root path of Designer. You can set this in your environment or with the -Dreporthome argument to your JVM.
Logi Report Server also includes the Catalog API. If you prefer to use the libraries from Server, include the jar file <server_install_root>\lib\JRESServlets.jar in your class path instead of report.jar. You then need to use the Server Design API license key rather than the Design API license key.