Java API for Cache Auto-population

Overview

1. Cache Build.
   

   Build cache with NOW option

   Build cache with ONCE option

2. Cache Rules.
   

   Add Rules

   Delete Rules

   Update Rules

Example

1. Cache Build.

   1. Build cache with NOW option

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

      1. Build cache with ONCE option
         

         /**
         * method to add ONCE build schedule for cache in Scheduler Manager.
         * @param cubeName: Name of the cube.
         * @param folderName: Name of the folder containing cube, 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(cubeName, folderName, onceDateTime, userinfo);

         
         

2. Cache Rules.

   1. Add Rules
      

      /**
      * method to add rules in cache build.
      * @param cubeName: Name of the cube.
      * @param folderName: Name of the folder containing cube, use “” for root folder.
      * third parameter in method "addCachePopulationRules" is boolean which is to specify whether to build cache on cube build.
      * @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(cubeName, folderName, true, filters, userInfo); 

      
      

   2. Delete Rules
      

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

   3. Update Rules
      

      /**
      * method to update rules in cache build.
      * @param cubeName: Name of the cube.
      * @param folderName: Name of the folder containing cube, use “” for root folder.
      * third parameter in method "addCachePopulationRules" is boolean which is to specify whether to build cache on cube build.
      * @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(cubeName, folderName, false, filters, userInfo); 

      
      

Sample Code

/*Method to Cache Build over Cube*/
public static void cubeCacheBuildNow(SchedulerManager schedulerManager, UserInfo userInfo) {
schedulerManager.buildCubeCacheNow("CubeName", "CubeFolderName", userInfo);
}
/*Method to Schedule Cache Build over Cube
 *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("CubeName", "CubeFolder", "MM/DD/YYYY 00:00", userInfo);
       }