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

1. Cache Process.

   Process cache with NOW option

   Process cache with ONCE option

2. Cache Rules.

   Add Rules

   Delete Rules

   Update Rules

Example

1. Cache Process.

   1. Process cache with NOW option

      /**
      * method to build cache in Scheduler Manager.
      * @param sModelName: Name of the semantic model.
      * @param folderName: Name of the folder containing semantic model, use “” for root folder.
      * @param userInfo: Object of type UserInfo containing information about logged in user.
      */
      public void buildCubeCacheNow(sModelName, folderName, userinfo);

      1. Process cache with ONCE option

         /**
         * method to add the ONCE job schedule for cache in Scheduler Manager.
         * @param sModelName: Name of the semantic model.
         * @param folderName: Name of the folder containing semantic model, use “” for root folder.
         * @param onceDateTime: Date time in format mm/dd/yyyy hh:mm.
         * @param userInfo: Object of type UserInfo containing information about logged in user.
         */
         public void buildCubeCacheOnce(sModelName, folderName, onceDateTime, userinfo);

2. Cache Rules.

   1. Add Rules

      /**
      * method to add rules in cache build.
      * @param sModelName: Name of the semantic model.
      * @param folderName: Name of the folder containing semantic model, use “” for root folder.
      * third parameter in method "addCachePopulationRules" is boolean which is to specify whether to build cache on the semantic model job.
      * @param filters: Object of type Filters containing filter which needs to be added in cache rules.
      * @param userInfo: Object of type UserInfo containing information about logged in user.
      */
      public List<ResponseStatus> addCachePopulationRules(sModelName, folderName, true, filters, userInfo); 

   2. Delete Rules

      /**
      * method to delete all rules in cache build.
      * @param sModelName: Name of the semantic model.
      * @param folderName: Name of the folder containing semantic model, use “” for root folder.
      * @param userInfo: Object of type UserInfo containing information about logged in user.
      */
      public List<ResponseStatus> deleteCachePopulationRules(sModelName, folderName, userInfo); 

   3. Update Rules

      /**
      * method to update rules in cache build.
      * @param sModelName: Name of the semantic model.
      * @param folderName: Name of the folder containing semantic model, use “” for root folder.
      * third parameter in method "addCachePopulationRules" is boolean which is to specify whether to build cache on semantic model job.
      * @param filters: Object of type Filters containing filter which needs to be updated in cache rules.
      * @param userInfo: Object of type UserInfo containing information about logged in user.
      */
      public List<ResponseStatus> updateCachePopulationRules(sModelName, folderName, false, filters, userInfo); 

Sample Code

/*Method to Cache Build over semantic model*/
public static void cubeCacheBuildNow(SchedulerManager schedulerManager, UserInfo userInfo) {
schedulerManager.buildCubeCacheNow("sModelName", "SemanticmodelFolderName", userInfo);
}
/*Method to Schedule Cache Build over semantic model
 *Time format should be as of Kyvos, which can be seen on Kyvos Engine Page on Monitor Section
 */
public static void cubeCacheBuildOnce(SchedulerManager schedulerManager, UserInfo userInfo) {
schedulerManager.buildCubeCacheOnce("sModelName", "SemanticmodelFolder", "MM/DD/YYYY 00:00", userInfo);
       }