Previous Topic
Making Preparations Before Using the Catalog API
Before you can use the Catalog API to perform tasks, you need to create a Designer object and then get a Catalog API instance. This topic describes how you can make the preparations for using the Catalog API.
This topic contains the following sections:
Creating a Designer Object
To create a Designer object, use the constructor Designer(String path, String name, DesignerUserInfo user) in the Design API. The constructor has three parameters: the catalog path, catalog name, and the user ID and license key provided by Logi Analytics. The path should be a valid path of an existing directory. The catalog name can be the name of an existing catalog when you want to open a catalog, or the name of a new catalog when you want to create a catalog. If you want to create a new catalog, the path should not already contain a catalog file.
To create the DesignerUserInfo instance, use the following constructor with the user ID and the Designer License Key or Server Designer License Key you receive when you purchase Report.
DesignerUserInfo userInfo=new DesignerUserInfo(Uid, key);
Back to topGetting a Catalog API Instance
To get a Catalog API instance, use the getCatalogAPI() method in the Design API. You need to first get an instance from Designer as follows:
Designer desg = new Designer(catalogPath, catalogName, userInfo);
CatalogAPI catalog = desg.getCatalogAPI();