Java API for Building Semantic model

Applies to: Kyvos Enterprise  Kyvos Cloud (SaaS on AWS) Kyvos AWS Marketplace

Kyvos Azure Marketplace   Kyvos GCP Marketplace Kyvos Single Node Installation (Kyvos SNI)

Overview

Process a semantic model object.

1. Process a semantic model with the NOW option

2. Process a semantic model with ONCE option

3. Cancel a semantic model job if currently running

4. Resume a semantic model job

5. Replace partitions

6. Data profile for the semantic model with the ONCE option

7. Data profile for the semantic model with the NOW option

Examples

1. Process a semantic model with the NOW option

   /** * method to build semantic model Object * @param sModelName: name of the semantoc model * @param folderName: name of the folder containing semantic model * @param buildType: type of the job , FULL or INCREMENTAL * @param additionalParams: JSONObject containing fields: userParams, replacePartition, consolidationType, buildSourceDatasets, * recommendationParamsJson, minimalAggregation, minimalAggregation, factDataPartitionSize, * factDataPartitionCount, incrementalJobProcessType * factDataPartitionCount, incrementalJobProcessType, buildConnectionName */ public void buildCubeNow(String cubeName, String folderName, String buildType, UserInfo userInfo, JSONObject additionalParams);

2. Process a semantic model with the ONCE option

   /** * method to process the semantic model Object * @param sModelName: name of the semantic model * @param folderName: name of the folder containing semantic model * @param buildType: type of the job, FULL or INCREMENTAL * @param additionalParams: JSONObject containing fields: userParams, onceDateTime, replacePartition, consolidationType, buildSourceDatasets, * recommendationParamsJson, minimalAggregation, minimalAggregation, factDataPartitionSize, * factDataPartitionCount, incrementalJobProcessType, buildConnectionName */ public void buildCubeOnce(String cubeName, String folderName, String buildType, UserInfo userInfo, JSONObject additionalParams);

3. Cancel semantic model job if currently running.

   /** * Method to add ONCE build schedule for the semantic model object * @param sModelName: name of the semantic model * @param folderName: name of the folder containing semantic model * @param buildType: type of the job, FULL or INCREMENTAL * @param onceDateTime: date time in format mm/dd/yyyy hh:mm * @param userInfo: Object of type UserInfo containing information about logged in user * @param incrementalJobProcessType: type of process: FACT_ADJUSTMENTS */ public void buildCubeOnce(String sModelName, String folderName, String buildType, String onceDateTime, UserInfo userInfo, String incrementalJobProcessType);

4. Resume semantic model build

5. Replace partitions.

6. Data profile for a semantic model with ONCE option

7. Data profile for a semantic model with the NOW option.

8. Parse connectionXML and set internal properties of DBConnection. 

9. Set a property in a DBConnection object.

10. Set a property in a DBConnection. It is useful when a value is encrypted.

Sample code