{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Applies to","type":"text","marks":[{"type":"strong"}]},{"text":": ","type":"text"},{"type":"emoji","attrs":{"id":"atlassian-check_mark","text":":check_mark:","shortName":":check_mark:"}},{"text":" Kyvos Enterprise ","type":"text"},{"type":"emoji","attrs":{"id":"atlassian-check_mark","text":":check_mark:","shortName":":check_mark:"}},{"text":" Kyvos Cloud (SaaS on AWS) ","type":"text"},{"type":"emoji","attrs":{"id":"atlassian-check_mark","text":":check_mark:","shortName":":check_mark:"}},{"text":" Kyvos AWS Marketplace","type":"text"}]},{"type":"paragraph","content":[{"type":"emoji","attrs":{"id":"atlassian-check_mark","text":":check_mark:","shortName":":check_mark:"}},{"text":" Kyvos Azure Marketplace ","type":"text"},{"type":"emoji","attrs":{"id":"atlassian-check_mark","text":":check_mark:","shortName":":check_mark:"}},{"text":" Kyvos GCP Marketplace ","type":"text"},{"type":"emoji","attrs":{"id":"atlassian-check_mark","text":":check_mark:","shortName":":check_mark:"}},{"text":" Kyvos Single Node Installation (Kyvos SNI)","type":"text"}]},{"type":"rule"},{"type":"paragraph","content":[{"text":"Here are some sample codes to help you use REST and Java APIs for working with Kyvos entities. ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Adding new user group in Kyvos","type":"text"},{"text":" ","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"java"},"content":[{"text":"/**Method to add new group in Kyvos*/\n\tpublic static void addGroup(String groupName) throws UnsupportedEncodingException {\n\t\tUserGroup group = new UserGroup();\n\t\tgroup.setGroupName(groupName);\n\t\tgroup.setUserGroupId(groupName);\n\t\tgroup.setDescription(\"test Group\");\n\t\tgroup.setRole(\"0\");\n\t\tgroup.setGroupType(UserAuthType.NATIVE);\n\t\tgroup.setUserIds(new String[]{\"\"});\n\t\tSystem.out.println(group.getXML());\n\t\t\n\t\tString params = \"groupXML=\"+URLEncoder.encode(group.getXML(), java.nio.charset.StandardCharsets.UTF_8.toString());\n\t\tRESTClient.sendRequest(\"group\", params, \"POST\");","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Updating user group in Kyvos","type":"text"},{"text":" ","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"java"},"content":[{"text":"/**Method to update a group in Kyvos*/\n\tpublic static void updateGroup(String groupName) throws UnsupportedEncodingException {\n\t\tString groupXML = RESTClient.sendRequest(\"group/\"+groupName+\"?addResponseTag=false\", null, \"GET\");\n\t\tSystem.out.println(groupXML);\n\t\tUserGroup group = new UserGroup(groupXML);\n\t\tSystem.out.println(group.getXML());\n\t\tgroup.setUserIds(new String[]{\"\", \"\"});\n\t\tString params = \"groupXML=\"+URLEncoder.encode(group.getXML(), java.nio.charset.StandardCharsets.UTF_8.toString());\n\t\tRESTClient.sendRequest(\"group/\"+group.getGroupName(), params, \"PUT\");","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Creating new relationship design","type":"text"}]},{"type":"codeBlock","attrs":{"language":"java"},"content":[{"text":"/**Method to create a fresh DRD*/\n\tpublic static void createDRD() throws Exception {\n\t\t\n\t\tString RF_1_ID = \"\";\n\t\tString RF_2_ID = \"\";\n\t\tDRDObject drdObject = new DRDObject();\n\t\tdrdObject.setViewType(Enums.DRDViewType.TABULAR);\n\t\tdrdObject.setName(\"\");\n\t\tdrdObject.setId(Utility.getGUID());\n\t\tdrdObject.setFolderName(\"\");\n drdObject.setFolderId(\"\");\n \n // Creating DRD Node using registered file id\n DRDObject.DRDDatasetDetails node1 = new DRDObject.DRDDatasetDetails();\n node1.setId(RF_1_ID);\n node1.setAliasName(\"NODE_NAME_1\");\n drdObject.addNode(\"NODE_ID_1\", node1);\n \n DRDObject.DRDDatasetDetails node2 = new DRDObject.DRDDatasetDetails();\n node2.setId(RF_2_ID);\n node2.setAliasName(\"NODE_NAME_2\");\n drdObject.addNode(\"NODE_ID_2\", node2);\n \n DRDRelation drdRelation = new DRDRelation();\n drdRelation.setSourceID(\"NODE_ID_1\");\n drdRelation.setFirstDSID(\"NODE_ID_1\");\n drdRelation.setSecondDSID(\"NODE_ID_2\");\n drdRelation.setRelationType(\"ONE_TO_MANY\");\n drdRelation.addJoin(\"ID\", \"Product_ID\"); \n drdRelation.setRelationName(\"test\");\n \n ArrayList drdRelationList = new ArrayList<>();\n drdRelationList.add(drdRelation);\n drdObject.getDrdRelationsMap().put(Utility.getClientGuid(\"\"), drdRelationList);\n System.out.println(drdObject.getXML());\n \n String params = \"drdXML=\"+URLEncoder.encode(drdObject.getXML(), java.nio.charset.StandardCharsets.UTF_8.toString());\n\t\tSystem.out.println(RESTClient.sendRequest(\"datasetrelationship\", params, \"POST\"));\n \n\t}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Updating relationship design","type":"text"}]},{"type":"codeBlock","attrs":{"language":"java"},"content":[{"text":"/**Method to update existing DRD*/\n\tpublic static void updateDRD(String drdName) {\n\t\tString drdXML = \"\";\n\t\tDRDObject drdObj = new DRDObject(drdXML);\n\t\t\n\t\t// user can add, remove or modify drd nodes from map.\n\t\tHashMap drdNodeMap = drdObj.getDrdDataSetDetailsMap();\n\t\t\n\t\t// user can add, remove or modify node relations.\n\t\tHashMap> relationMap = drdObj.getDrdRelationsMap();\n\t\tfor (String relationKEy : relationMap.keySet())\n\t\t{\n\t\t\tfor (DRDRelation drdRelation : relationMap.get(relationKEy))\n\t\t\t{\n\t\t\t\tif (\"NODE_ID_1\".equals(drdRelation.getSourceID())) {\n\t\t\t\t\tList joinByList = drdRelation.getDRDJoinByList();\n\t\t\t\t\tfor (DRDJoinBy joinBy : joinByList) {\n\t\t\t\t\t\tif (joinBy.getFirstDSCol().equalsIgnoreCase(\"saledate\")) {\n\t\t\t\t\t\t\tjoinBy.setFirstDSCol(\"saledate2\");\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\t\n\t\t\n\t\tSystem.out.println(drdObj.getXML());\n\t}\n}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Adding single data security rule to semantic model","type":"text"}]},{"type":"codeBlock","attrs":{"language":"java"},"content":[{"text":"* This method is used to add single data security rule to semantic model\n\t * \n\t * @param smodelId: is of semantic model \n\t * @throws ISecurityException, UnsupportedEncodingException\n\t * @throws ReportObjectException\n\t * @throws InterfaceInitException \n\t */\n\tpublic static ResponseStatus addDataSecurityRule(String smodelId)\n\t\t\tthrows ISecurityException, UnsupportedEncodingException, ReportObjectException, InterfaceInitException {\n\n\t\t// userInfo => get user info\n\n\t\tSecurityManager secMgr = SecurityManager.getInstance();\n\t\tRepositoryManager rm = new RepositoryManager();\n\n\t\t// get semantic model object in which rule is to be added.\n\t\tReportObjectManager rom = new ReportObjectManager();\n\t\tCubeObject co = (CubeObject) rom.getReportObject(Enums.IRO.TYPE.ANALYTICAL, smodelId, true, userInfo,\n\t\t\t\tEnums.IRO.SUBTYPE.CUBE);\n\n\t\tList columnFieldList = new ArrayList<>(); // will contain column level rule objects\n\t\tList rowFilterList = new ArrayList<>(); // will contain row level\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t// filter objects\n\n\t\t// create row level filters\n\t\tString rowFilterDimensionName = \"Account-CR\";\n\t\tString rowFilterFieldName = \"Account\";\n\t\tString rowFilterOperator = \"IN_LIST\";\n\t\tString rowFilterValue = \"Assets\";\n\n\t\t// create filter object.\n\t\t// For IN_LIST operator : public com.kyvos.commons.entity.olap.viewer.Filter\n\t\t// createRowLevelDimensionFilterByList(CubeObject cubeObject, String\n\t\t// dimensionName, String levelName, String operator, List valuesList)\n\t\t// For BETWEEN operator : public com.kyvos.commons.entity.olap.viewer.Filter\n\t\t// createFilter(CubeObject cubeObject, String dimensionName, String levelName,\n\t\t// String operator, String firstValue, String secondValue)\n\t\t// For other operators: public com.kyvos.commons.entity.olap.viewer.Filter\n\t\t// createRowLevelDimensionFilter(CubeObject cubeObject, String dimensionName,\n\t\t// String levelName, String operator, String value)\n\n\t\tcom.kyvos.commons.entity.olap.viewer.Filter rowFilter = secMgr.createRowLevelDimensionFilter(co,\n\t\t\t\trowFilterDimensionName, rowFilterFieldName, rowFilterOperator.toUpperCase(), rowFilterValue);\n\t\trowFilter.setRelation(Enums.FilterRelation.and);\n\n\t\trowFilterList.add(rowFilter);\n\n\t\t// create column level field\n\t\tString columnDimensionName = \"\";\n\t\tString columnFieldType = \"\";\n\t\tString columnFieldName = \"\";\n\t\tString columnRestriction = Enums.ColumnLevelSecurityRestriction.CONDITIONAL_MASK_DATA.name();\n\n\t\t// create masking info object if restriction type is masking. Add filters if\n\t\t// conditional masking is used.\n\t\tList columnFilterList = new ArrayList<>();\n\t\tString filterDimensionName = \"\";\n\t\tString filterFieldName = \"\";\n\t\tString filterOperator = \"\";\n\t\tString filterValue = \"\";\n\n\t\t// create filter object in same way as for row level rules\n\t\tcom.kyvos.commons.entity.olap.viewer.Filter colFilter = secMgr.createRowLevelDimensionFilter(co,\n\t\t\t\tfilterDimensionName, filterFieldName, filterOperator.toUpperCase(), filterValue);\n\t\tcolFilter.setRelation(Enums.FilterRelation.and);\n\n\t\t// for column level filters enclosures are supported\n\t\tcolFilter.setStartEnclosure(\"(\");\n\t\tcolFilter.setEndEnclosure(\")\");\n\n\t\tcolumnFilterList.add(colFilter);\n\t\tColumnLevelSecurityMaskingInfo columnMaskingInfo = new ColumnLevelSecurityMaskingInfo(\n\t\t\t\tEnums.ColumnLevelSecurityMaskType.FIX, \"*\", \"\", columnFilterList);\n\n\t\t// get ColumnLevelSecurityField object\n\t\t// createColumnLevelField(CubeObject cubeObject, String dimensionName, String\n\t\t// fieldType, String fieldName, String restriction,\n\t\t// ColumnLevelSecurityMaskingInfo maskingInfo) throws ISecurityException {\n\n\t\tColumnLevelSecurityField columnField = secMgr.createColumnLevelField(co, columnDimensionName, columnFieldType,\n\t\t\t\tcolumnFieldName, columnRestriction, columnMaskingInfo);\n\n\t\tcolumnFieldList.add(columnField);\n\n\t\tString ruleName = \"testRule\";\n\t\tString ruleDescription = \"desc\";\n\n\t\t// Add rule using Java API\n\t\treturn secMgr.addDataSecurityRule(co, ruleName, ruleDescription, rowFilterList, columnFieldList, userInfo);\n\n\t}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Updating single data security rule","type":"text"}]},{"type":"codeBlock","attrs":{"language":"java"},"content":[{"text":"**\n\t * This method is used to update single data security rule\n\t * \n\t * @param smodelId: is of cube\n\t * @param ruleName: name of rule to be updated\n\t * @throws ISecurityException, UnsupportedEncodingException\n\t * @throws ReportObjectException\n\t */\n\tpublic static ResponseStatus updateDataSecurityRule(String smodelId, String ruleName)\n\t\t\tthrows ISecurityException, UnsupportedEncodingException, ReportObjectException {\n\n\t\t// userInfo => get user info\n\n\t\tSecurityManager secMgr = SecurityManager.getInstance();\n\t\tRepositoryManager rm = new RepositoryManager();\n\n\t\t// get semantic model object in which rule is to be added.\n\t\tReportObjectManager rom = new ReportObjectManager();\n\t\tCubeObject co = (CubeObject) rom.getReportObject(Enums.IRO.TYPE.ANALYTICAL, smodelId, true, userInfo,\n\t\t\t\tEnums.IRO.SUBTYPE.CUBE);\n\n\t\tDataSecurityRule rule = DataSecurityJavaAPI.getDataSecurityRule(smodelId, ruleName);\n\t\tif (rule == null) {\n\t\t\treturn null;\n\t\t}\n\n\t\tList columnFieldList = new ArrayList<>(); // will contain column level rule objects\n\t\tList rowFilterList = new ArrayList<>(); // will contain row level\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t// filter objects\n\n\t\t// create row level filters\n\t\tString rowFilterDimensionName = \"\";\n\t\tString rowFilterFieldName = \"\";\n\t\tString rowFilterOperator = \"\";\n\t\tString rowFilterValue = \"\";\n\n\t\t// create filter object.\n\t\t// For IN_LIST operator : public com.kyvos.commons.entity.olap.viewer.Filter\n\t\t// createRowLevelDimensionFilterByList(CubeObject cubeObject, String\n\t\t// dimensionName, String levelName, String operator, List valuesList)\n\t\t// For BETWEEN operator : public com.kyvos.commons.entity.olap.viewer.Filter\n\t\t// createFilter(CubeObject cubeObject, String dimensionName, String levelName,\n\t\t// String operator, String firstValue, String secondValue)\n\t\t// For other operators: public com.kyvos.commons.entity.olap.viewer.Filter\n\t\t// createRowLevelDimensionFilter(CubeObject cubeObject, String dimensionName,\n\t\t// String levelName, String operator, String value)\n\n\t\tcom.kyvos.commons.entity.olap.viewer.Filter rowFilter = secMgr.createRowLevelDimensionFilter(co,\n\t\t\t\trowFilterDimensionName, rowFilterFieldName, rowFilterOperator.toUpperCase(), rowFilterValue);\n\t\trowFilter.setRelation(Enums.FilterRelation.and);\n\n\t\trowFilterList.add(rowFilter);\n\n\t\t// create column level field\n\t\tString columnDimensionName = \"\";\n\t\tString columnFieldType = \"\";\n\t\tString columnFieldName = \"\";\n\t\tString columnRestriction = Enums.ColumnLevelSecurityRestriction.CONDITIONAL_MASK_DATA.name();\n\n\t\t// create masking info object if restriction type is masking. Add filters if\n\t\t// conditional masking is used.\n\t\tList columnFilterList = new ArrayList<>();\n\t\tString filterDimensionName = \"\";\n\t\tString filterFieldName = \"\";\n\t\tString filterOperator = \"\";\n\t\tString filterValue = \"\";\n\n\t\t// create filter object in same way as for row level rules\n\t\tcom.kyvos.commons.entity.olap.viewer.Filter colFilter = secMgr.createRowLevelDimensionFilter(co,\n\t\t\t\tfilterDimensionName, filterFieldName, filterOperator.toUpperCase(), filterValue);\n\t\tcolFilter.setRelation(Enums.FilterRelation.and);\n\n\t\t// for column level filters enclosures are supported\n\t\tcolFilter.setStartEnclosure(\"(\");\n\t\tcolFilter.setEndEnclosure(\")\");\n\n\t\tcolumnFilterList.add(colFilter);\n\t\tColumnLevelSecurityMaskingInfo columnMaskingInfo = new ColumnLevelSecurityMaskingInfo(\n\t\t\t\tEnums.ColumnLevelSecurityMaskType.FIX, \"*\", \"\", columnFilterList);\n\n\t\tColumnLevelSecurityField columnField = secMgr.createColumnLevelField(co, columnDimensionName, columnFieldType,\n\t\t\t\tcolumnFieldName, columnRestriction, columnMaskingInfo);\n\n\t\tcolumnFieldList.add(columnField);\n\n\t\tString ruleDescription = \"desc\";\n\n\t\t// update rule information\n\t\trule.setColumnLevelFieldsList(columnFieldList);\n\t\trule.setRowLevelFiltersList(rowFilterList);\n\t\trule.setDescription(ruleDescription);\n\n\t\treturn secMgr.updateDataSecurityRule(co, rule, userInfo);\n\n\t}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Getting data security rule","type":"text"}]},{"type":"codeBlock","attrs":{"language":"java"},"content":[{"text":"/**\n\t * method to get data security rule\n\t * \n\t * @param smodelId: ID of Semantic Model\n\t * @param ruleName: name of rule to be deleted\n\t * @return object of type DataSecurityRule.\n\t * @throws ReportObjectException\n\t * @throws ISecurityException.\n\t */\n\tpublic static DataSecurityRule getDataSecurityRule(String smodelId, String ruleName)\n\t\t\tthrows ISecurityException, UnsupportedEncodingException, ReportObjectException {\n\t\t// userInfo => get user info\n\n\t\tSecurityManager secMgr = SecurityManager.getInstance();\n\n\t\t// get semantic model object in which rule is applied.\n\t\tReportObjectManager rom = new ReportObjectManager();\n\t\tCubeObject cubeObject = (CubeObject) rom.getReportObject(Enums.IRO.TYPE.ANALYTICAL, smodelId, true, userInfo,\n\t\t\t\tEnums.IRO.SUBTYPE.CUBE);\n\n\t\t// java api to get data security rule\n\t\treturn secMgr.getDataSecurityRule(cubeObject, ruleName, userInfo);\n\n\t}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Deleting data security rule from semantic model of given semantic model ID","type":"text"}]},{"type":"codeBlock","attrs":{"language":"java"},"content":[{"text":"/**\n\t * method to delete data security rule from semantic model of given semanitc model ID\n\t * \n\t * @param smodelId: ID of semantic model\n\t * @param ruleName: name of rule to be deleted\n\t * @return object of type ResponseStatus.\n\t * @throws ReportObjectException \n\t * @throws ISecurityException.\n\t */\n\tpublic static ResponseStatus deleteDataSecurityRule(String smodelId, String ruleName)\n\t\t\tthrows ISecurityException, UnsupportedEncodingException, ReportObjectException {\n\n\t\t// userInfo\n\n\t\t// get semantic model object in which rule is applied.\n\t\tReportObjectManager rom = new ReportObjectManager();\n\t\tCubeObject cubeObject = (CubeObject) rom.getReportObject(Enums.IRO.TYPE.ANALYTICAL, smodelId, true, userInfo,\n\t\t\t\tEnums.IRO.SUBTYPE.CUBE);\n\n\t\tSecurityManager secMgr = SecurityManager.getInstance();\n\n\t\t// java api to delete single data security rule\n\t\treturn secMgr.deleteDataSecurityRule(cubeObject, ruleName, userInfo);\n\n\t}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Adding data security rules mapping for user","type":"text"}]},{"type":"codeBlock","attrs":{"language":"java"},"content":[{"text":"/**\n\t * method to add data security rules mapping for a user.\n\t * \n\t * @param smodelId: ID of semantic model\n\t * @return object of type ResponseStatus.\n\t * @throws ReportObjectException\n\t * @throws ISecurityException.\n\t */\n\tpublic static ResponseStatus assignDataSecurityRulesToUser(String smodelId)\n\t\t\tthrows ISecurityException, UnsupportedEncodingException, ReportObjectException {\n\t\t// userInfo\n\n\t\t// get semantic model object in which rule is applied.\n\t\tReportObjectManager rom = new ReportObjectManager();\n\t\tCubeObject cubeObject = (CubeObject) rom.getReportObject(Enums.IRO.TYPE.ANALYTICAL, smodelId, true, userInfo,\n\t\t\t\tEnums.IRO.SUBTYPE.CUBE);\n\n\t\tSecurityManager secMgr = SecurityManager.getInstance();\n\n\t\t// user to which rules are to be assigned\n\t\tString userName = \"userName\";\n\n\t\t// set rules which are to be assigned to user\n\t\tList ruleNames = new ArrayList<>();\n\t\truleNames.add(\"testRule\");\n\n\t\t// java api to assign rules to user\n\t\treturn secMgr.addDataSecurityRulesMappingForUser(cubeObject, userName, ruleNames, userInfo);\n\t}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Adding data security rules mapping for a group","type":"text"}]},{"type":"codeBlock","attrs":{"language":"java"},"content":[{"text":"/**\n\t * method to add data security rules mapping for a group.\n\t * \n\t * @param cubeObject: Object of type CubeObject.\n\t * @return object of type ResponseStatus.\n\t * @throws ReportObjectException \n\t * @throws ISecurityException.\n\t */\n\tpublic static ResponseStatus assignDataSecurityRulesToGroup(String smodelId)\n\t\t\tthrows ISecurityException, UnsupportedEncodingException, ReportObjectException {\n\t\t// userInfo\n\n\t\t// get semantic model object in which rule is applied.\n\t\tReportObjectManager rom = new ReportObjectManager();\n\t\tCubeObject cubeObject = (CubeObject) rom.getReportObject(Enums.IRO.TYPE.ANALYTICAL, smodelId, true, userInfo,\n\t\t\t\tEnums.IRO.SUBTYPE.CUBE);\n\n\t\tSecurityManager secMgr = SecurityManager.getInstance();\n\n\t\t// group name to which rules are to be assigned\n\t\tString groupName = \"TestGroup\";\n\n\t\t// rules names which are to be assigned to group\n\t\tList ruleNames = new ArrayList<>();\n\t\truleNames.add(\"testRule\");\n\n\t\treturn secMgr.addDataSecurityRulesMappingForGroup(cubeObject, groupName, ruleNames, userInfo);\n\t}\n\n}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Creating a Registered file ","type":"text"}]},{"type":"codeBlock","attrs":{"language":"java"},"content":[{"text":"/**Method to create RF*/\n addRegisteredFile(\"\");\n }\n\n public static void addRegisteredFile(String fileName) throws Exception {\n\n ReportClient.init(\".\" + java.io.File.separator + \"conf\" + java.io.File.separator + \"kyvosclient.properties\", \".\" + java.io.File.separator + \"conf\" + java.io.File.separator + \"globals.properties\", true);\n \t \n \tRepositoryManager rm = new RepositoryManager();\n UserInfo userInfo = new UserInfo(\"Username\",\"Password\");\n\n RegisteredFile rf = new RegisteredFile();\n rf.setId(rm.getGuid());\n rf.setName(fileName);\n rf.setFolderId(\"folder_16648879882851127070040120298929\");\n rf.setFolderName(\"RESTAPI\");\n rf.setConnectionName(\"DefaultHadoopCluster01\");\n\n // To Create TABLE based Register file.\n rf.setInputType(Enums.RFInputTypes.TABLE);\n HCatalogSource hCatalogSource = (HCatalogSource)rf.getDataSource();\n hCatalogSource.setDbName(\"automationtables\");\n hCatalogSource.setTableName(\"account\");\n\n // Get column details for current Register file using REST API.\n ArrayList columnDetails = getColumnDetailsFromServer(rf);\n \n System.out.println(\"Colum Details \"+ columnDetails.size());\n\n // TO add or update user parameters.\n rf.addOrUpdateQOPrameter(\"dbName\", \"automationtables\", \"My Description \");\n\n // Setting column details.\n rf.setColumnDetails(columnDetails);\n\n // Invoking REST API to save file.\n String urlParameters = \"registerFileXML=\"+ URLEncoder.encode(rf.getXML(), java.nio.charset.StandardCharsets.UTF_8.toString());\n RESTClient.sendRequest(\"registerfiles\", urlParameters, \"POST\");\n\n RegisteredFile registeredFile = rm.getRegisteredFileByName(\"SQLRF\",\"RESTAPI\",userInfo);\n\n ArrayList columnsDetails = registeredFile.getFetchStep().getColumnDetails();\n System.out.println(\"columnDetails size = \" + columnsDetails.size());\n\n }\n\n public static ArrayList getColumnDetailsFromServer(RegisteredFile rf) throws IOException {\n \n \tString urlParameters = \"registerFileXML=\"+URLEncoder.encode(rf.getXML(), java.nio.charset.StandardCharsets.UTF_8.toString());\n \n \t/**Rest API Method to send request to create RF*/\n String responseString = RESTClient.sendRequest(\"registerfiles/createFetchStep\", urlParameters, \"POST\");\n \n FetchStep fetchStep = new FetchStep(responseString);\n return fetchStep.getColumnDetails();\n }\n\n}\n\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Creating semantic model","type":"text"}]},{"type":"codeBlock","attrs":{"language":"java"},"content":[{"text":"public class CubeAPI {\n\tString drdXML = \"\";\n\tDRDObject sourceDRD = new DRDObject(drdXML);\n\tpublic static void createCubeWithDRD(DRDObject drdObj) throws UnsupportedEncodingException {\n\t\tCubeObject cubeObject = new CubeObject(drdObj, \"API_CUBE_1_ID\", \"API_CUBE_1\");\n\t\t\n\t\tcubeObject.setFolderId(\"\");\n\t\tcubeObject.setFolderName(\"\");\n\t\t\n\t\tDimension dim = cubeObject.addDimension(\"Transactions\");\n\t\t\n\t\tDimAttribute attr = dim.addDimAttribute(\"lineorder\", \"COLUMN13\");\n\t\tattr.setName(\"QUANTITY\");\n\t\tattr.setDataType(\"NUMBER\");\n\t\tattr = dim.addDimAttribute(\"lineorder\", \"COLUMN12\");\n\t\tattr.setName(\"DISCOUNT\");\n\t\tattr.setDataType(\"NUMBER\");\n\t\t\n\t\t\n\t\tdim = cubeObject.addDimension(\"Dates\");\n\t\tHierarchy hierarchy = dim.addTimeHierarchy(\"H_Dates\", \"Y-M-D\", \"dates\", \"D_DATEKEY\");\n\t\t\n\t\tLevel level = hierarchy.addLevel(hierarchy.getAssociatedQueryName(), hierarchy.getDataField());\n\t\tlevel.setName(\"Year\");\n\t\tlevel.setDataType(\"DATE\");\n\t\tlevel.setDateDataType(\"Year\");\n\t\tlevel.setFormatType(\"4\");\n\t\t\n\t\tlevel = hierarchy.addLevel(hierarchy.getAssociatedQueryName(), hierarchy.getDataField());\n\t\tlevel.setName(\"Month\");\n\t\tlevel.setDataType(\"DATE\");\n\t\tlevel.setDateDataType(\"Month\");\n\t\t\n\t\tlevel = hierarchy.addLevel(hierarchy.getAssociatedQueryName(), hierarchy.getDataField());\n\t\tlevel.setName(\"Day\");\n\t\tlevel.setDataType(\"DATE\");\n\t\tlevel.setDateDataType(\"Day\");\n\t\t\n\t\tattr = dim.addDimAttribute(\"dates\", \"D_YEARMONTHNUM\");\n\t\tattr.setName(\"YEARMONTHNUM\");\n\t\tattr.setDataType(\"NUMBER\");\n\t\tattr = dim.addDimAttribute(\"dates\", \"D_WEEKNUMINYEAR\");\n\t\tattr.setName(\"D_WEEKNUMINYEAR\");\n\t\tattr.setDataType(\"NUMBER\");\n\t\tattr = dim.addDimAttribute(\"dates\", \"D_YEARMONTH\");\n\t\tattr.setName(\"D_YEARMONTH\");\n\t\t\n\t\tdim = cubeObject.addDimension(\"Parts\");\n\t\thierarchy = dim.addHierarchy(\"H_Parts\");\n\t\tlevel = hierarchy.addLevel(\"part\", \"COLUMN3\");\n\t\tlevel.setName(\"MFGR\");\n\t\tlevel = hierarchy.addLevel(\"part\", \"COLUMN4\");\n\t\tlevel.setName(\"CATEGORY\");\n\t\tlevel = hierarchy.addLevel(\"part\", \"COLUMN5\");\n\t\tlevel.setName(\"BRAND1\");\n\t\n\t\tCalculatedMember member = new CalculatedMember();\n\t\tmember.setId(\"CalculatedMember1_ID\");\n\t\tmember.setMemberName(\"CalculatedMember1\");\n\t\tmember.setExpression(\"[Measures].[Profit]-20\");\n\t\tmember.setParentMemberUname(hierarchy.getUniqueName());\n\t\tmember.setParentHierachy(hierarchy.getName());\n\t\tmember.setParentLevelMemb(\"ALLMEMBER\");\n\t\tmember.setDescription(\"test description\");\n\t\tArrayList calculatedMembers = dim.getCalculatedMembers();\n\t\tcalculatedMembers.add(member);\n\t\t\n\t\t\n\t\tdim = cubeObject.addDimension(\"Supplier\");\n\t\t\n\t\t// Set materialize\n\t\tdim.setMaterialize(\"NO\");\n\t\t// Set SCD\n\t\tdim.setScd(null);\n\t\t// Set SCD TYPE\n\t\tdim.setSCDType(1);\n\t\t\n\t\thierarchy = dim.addHierarchy(\"H_Supplier\");\n\t\t// Set materialize\n\t\thierarchy.setMaterialize(\"NO\");\n\t\tlevel = hierarchy.addLevel(\"supplier\", \"COLUMN6\");\n\t\tlevel.setName(\"REGION\");\n\t\tlevel = hierarchy.addLevel(\"supplier\", \"COLUMN5\");\n\t\tlevel.setName(\"NATION\");\n\t\tlevel = hierarchy.addLevel(\"supplier\", \"COLUMN4\");\n\t\tlevel.setName(\"CITY\");\n\t\t\n\t\tdim = cubeObject.addDimension(\"Customer\");\n\t\thierarchy = dim.addHierarchy(\"H_Customer\");\n\t\tlevel = hierarchy.addLevel(\"Customer\", \"COLUMN6\");\n\t\tlevel.setName(\"REGION\");\n\t\tlevel = hierarchy.addLevel(\"Customer\", \"COLUMN5\");\n\t\tlevel.setName(\"NATION\");\n\t\tlevel = hierarchy.addLevel(\"Customer\", \"COLUMN5\");\n\t\tlevel.setName(\"CITY\");\n\t\t\n\t\t// Set custom rollup\n\t\tlevel.setCustomrollup(null);\n\t\t\n\t\tcubeObject.addMeasureGroups(\"MeasureGroup\");\n\t\tMeasure measure = cubeObject.addMeasureInMeasureGroup(\"lineorder\", \"Revenue\", \"MeasureGroup\");\n measure.setIsDefault(true);\n measure.setFormat(\"#,##0\");\n measure = cubeObject.addMeasureInMeasureGroup(\"lineorder\", \"COLUMN13\", \"MeasureGroup\");\n measure.setName(\"Lo_Revenue\");\n measure = cubeObject.addMeasureInMeasureGroup(\"lineorder\", \"Profit\", \"MeasureGroup\");\n \n measure = new Measure();\n measure.setName(\"PROFIT-10\");\n measure.setType(Enums.CubeObject.Measure.Type.CALCULATED);\n measure.setSolveOrder(0);\n measure.setExpression(\"[Measures].[Profit]-10\");\n measure.setNonEmptyBehavior(Enums.CubeObject.Measure.NonEmptyBehavior.BY_EXPRESSION);\n cubeObject.addMeasureInMeasureGroup(measure, \"MeasureGroup\");\n \n \n // Sliding Window\n SlidingWindow slidingWindow = new SlidingWindow(); \n\t\tslidingWindow.setSlidingWindowID(\"ID\");\n slidingWindow.setDimensionIdForPartition(\"DIM_ID\");\n\t\tslidingWindow.setHierarchyIdForPartition(\"HIERARCHY_ID\");\n slidingWindow.setLevelIdForPartition(\"LEVEL_ID\");\n slidingWindow.setPartitionField(\"LEVEL_NAME\");\n slidingWindow.setPartitionLength(1);\n slidingWindow.setTotalPartitions(2);\n slidingWindow.setTotalLength(3);\n slidingWindow.setAutoCalculatePartition(true);\n slidingWindow.setUnit(\"UNIT\");\n slidingWindow.setSlidingWindowEnabled(true);\n\n // subPartition\n ArrayList subPartitions = new ArrayList();\n SubPartition subPartition = new SubPartition();\n subPartition.setDimensionId(\"MyDimID\");\n subPartition.setLevelId(\"LEVEL_ID\");\n subPartition.setField(\"LEVEL_NAME\");\n subPartition.setHierarchyId(\"HIERARCHY_ID\");\n subPartitions.add(subPartition);\n slidingWindow.getOrderedSubpartitionDims().add(subPartition.getDimensionId());\n slidingWindow.setSubPartitions(subPartitions);\n ArrayList slidingWindowList = new ArrayList();\n slidingWindowList.add(slidingWindow);\n cubeObject.setSlidingWindows(slidingWindowList);\n \n // Aggregation Strategy\n // Add CONFIGURATION_DRIVEN Aggregation Strategy.\n ConfigurationBasedAggregatesStrategy configAggregatesStrategy = new ConfigurationBasedAggregatesStrategy(cubeObject.getId());\n EntityProperty.EntityAdvanceProperty property = new EntityProperty.EntityAdvanceProperty();\n property.setName(\"nameNode\");\n property.setValue(\"valueNode\");\n property.setRecommendedValue(\"recValueNode\");\n property.setSystemDefaultValue(\"sysDefaultValueNode\");\n property.setInheritedValue(\"inheritedValueNode\");\n property.setMode(\"MANUAL\");\n property.setRemarks(\"remarks\");\n Map configurationBasedPropMap = new HashMap<>();\n configurationBasedPropMap.put(property.getName(), property);\n configAggregatesStrategy.setPropertiesMap(configurationBasedPropMap);\n cubeObject.setAggregatesStrategy(configAggregatesStrategy);\n \n // Add QUERY_DRIVEN Aggregation Strategy.\n QueryBasedAggregatesStrategy queryAggregatesStrategy = new QueryBasedAggregatesStrategy(cubeObject.getId());\n queryAggregatesStrategy.setAggregatesID(\"aggregateIdNode\");\n queryAggregatesStrategy.setOrientationInfo(\"orientationInfoNode\");\n queryAggregatesStrategy.setAggregateCount(\"aggregatesCountNode\");\n queryAggregatesStrategy.setLastAcceptedTime(\"lastAcceptedTimeNode\");\n queryAggregatesStrategy.setLastQueryCount(\"lastQueryCount\");\n queryAggregatesStrategy.setLastQueryConsiderationTime(\"lastQueryConsiderationTimeNode\");\n cubeObject.setAggregatesStrategy(queryAggregatesStrategy);\n \n // SET Raw data querying\n cubeObject.setAllowRawDataQuery(Enums.SQLRawDataQueryingModes.ENABALED);\n \n String params = \"smodelXML=\"+URLEncoder.encode(cubeObject.getXML(), java.nio.charset.StandardCharsets.UTF_8.toString());\n\t\tSystem.out.println(RESTClient.sendRequest(\"smodels\", params, \"POST\"));\n\t}\n\n\tpublic static void createCubeWithoutDRD() throws UnsupportedEncodingException {\n\t\tCubeObject cubeObject = new CubeObject();\n\t\tcubeObject.setId(\"CUBE_OBJECT_16618824042\");\n\t\tcubeObject.setName(\"test_cube_1_2222\");\n\t\tcubeObject.setFolderId(\"folder_16520830348231127029020129312845\");\n\t\tcubeObject.setFolderName(\"\");\n\n\t\tcubeObject.setDRDBasedCube(true);\n\t\tcubeObject.setDrdID(\"DRD_14641110707932127044085187784961\");\n\t\tcubeObject.setDrdName(\"Dell_Sample\");\n\t\t\n\t\tDimension dim = new Dimension();\n\t\tdim.setName(\"Product\");\n\t\tdim.setUniqueName(\"DIM_632407_1\");\n\t\tdim.setDimID(\"DIM_632407_1\");\n\t\tdim.setType(\"Regular\");\n\n\t\tHierarchy hierarchy = new Hierarchy();\n\t\thierarchy.setUniqueName(\"H_514877_1\");\n\t\thierarchy.setName(\"H_Product\");\n\t\t\n\t\tLevel level = new Level();\n\t\tlevel.setDataField(\"Product_Category\");\n\t\tlevel.setName(\"Product_Category\");\n\t\tlevel.setDataType(\"CHAR\");\n\t\tlevel.setAssociatedDimQueryName(\"SampleDell\");\n\t\tlevel.setAssociatedDimQueryId(\"14641108622483127092051153919832_0\");\n\t\tlevel.setUniqueName(\"DIMENSION_ATTRIBUTE_410611_1\");\n\t\t\n\t\thierarchy.addLevel(level);\n\t\t\t\t\n\t\tdim.addHierarchy(hierarchy);\n\t\t\n\t\tdim.addDimAttribute(null, null);\n\t\t\n\t\tcubeObject.addMeasureGroups(\"MeasureGroup\");\n\t\tMeasure measure = new Measure();\n\t\tmeasure.setName(\"Sale_Amount\");\n\t\tmeasure.setDataField(\"Sale_Amount\");\n\t\tmeasure.setQueryName(\"SampleDell\");\n\t\tmeasure.setQueryID(\"14641108622483127092051153919832_0\");\n\t\tmeasure.setDataType(\"NUMBER\");\n\t\tmeasure.setSummaryFunction(\"0\");\n\t\tmeasure.setFormat(\"#,##0.00\");\n\t\tmeasure.setFormatType(\"2\");\n measure.setIsDefault(true);\n cubeObject.addMeasureInMeasureGroup(measure, \"MeasureGroup\");\n\t\t\n\t\tcubeObject.addDimension(dim);\n\t\t\n\t\tString params = \"smodelXML=\"+URLEncoder.encode(cubeObject.getXML(), java.nio.charset.StandardCharsets.UTF_8.toString());\n\t\tSystem.out.println(RESTClient.sendRequest(\"smodels\", params, \"POST\"));\n\t}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Updating a semantic model","type":"text"}]},{"type":"codeBlock","attrs":{"language":"java"},"content":[{"text":"public static void updateCube(String smodelId) throws UnsupportedEncodingException {\n\t\tCubeObject co = new CubeObject(getCubeObject(smodelId, null, null));\n\t\t\n\t\t// get dimension list, iterate and get all dimensions. \n\t\t// dimensions cab be modified now.\n\t\t// dimensions cab also be removed from list.\n\t\tArrayList dimensions = co.getDimensions();\n\t\tDimension dim1 = dimensions.get(0);\n\t\t\n\t\t// get hierarchy and it can be modified. \n\t\tHierarchy hierarchy = dim1.getHierarchy();\n\t\t\n\t\t// get level list, iterate and get all levels. \n\t\t// levels cab be modified now.\n\t\t// levels cab also be removed from list.\n\t\tArrayList levels = hierarchy.getLevels();\n\t\t\n\t\t// get attribute list, iterate and get all attributes. \n\t\t// attributes cab be modified now.\n\t\t// attributes cab also be removed from list.\n\t\tArrayList attributes = dim1.getDimAttributes();\n\t\t\n\t\t// get calculated member list, iterate and get all calculated members. \n\t\t// calculated members cab be modified now.\n\t\t// calculated members cab also be removed from list.\n\t\tArrayList calcMembers = dim1.getCalculatedMembers();\n\t\t\n\t\t// below methods can be used to update measures.\n\t\tco.getMeasureById(\"measureid\");\n\t\tco.getMeasureByName(\"measureName\");\n\t\tco.removeMeasureByUniqName(\"measureId\");\n\t\tMap measures = co.getMeasures();\n\t\tfor(String measureName: measures.keySet()) {\n\t\t\tSystem.out.println(measureName);\n\t\t\tMeasure measure = measures.get(measureName);\n\t\t\tSystem.out.println(measure.getXML());\n\t\t}\n\t\t\n\t\t// Working with sliding windows.\n\t\tArrayList slidingWindows = co.getSlidingWindows();\n\t\t\n\t\tIAggregatesStrategy aggregatesStrategy = co.getAggregatesStrategy();\n\t\t\n\t\t// check aggregation strategy class.\n\t\tif (aggregatesStrategy instanceof QueryBasedAggregatesStrategy) {\n\t\t\tQueryBasedAggregatesStrategy queryBasedAggregatesStrategy = (QueryBasedAggregatesStrategy) aggregatesStrategy;\n\t\t} else if (aggregatesStrategy instanceof ConfigurationBasedAggregatesStrategy) {\n\t\t\tConfigurationBasedAggregatesStrategy configurationBasedAggregatesStrategy = (ConfigurationBasedAggregatesStrategy) aggregatesStrategy;\n\t\t}\n\t\t\n\t\t// finally update the semantic model object.\n\t\tString params = \"smodelXML=\"+URLEncoder.encode(co.getXML(), java.nio.charset.StandardCharsets.UTF_8.toString());\n\t\tRESTClient.sendRequest(\"smodels/\"+co.getId(), params, \"PUT\");\n\t}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Adding a connection ","type":"text"}]},{"type":"codeBlock","attrs":{"language":"java"},"content":[{"text":"public static void addConnection(String connectionName) throws UnsupportedEncodingException {\n\t\t\n\t\tDBConnection connection = new DBConnection();\n\t\tconnection.setConnectionName(connectionName);\n\t\tconnection.setProperty(\"kyvos.connection.role\", \"SYSADMIN\");\n\t\tconnection.setProperty(\"kyvos.connection.server\", \"\");\n\t\tconnection.setProperty(\"kyvos.connection.isEncryptedConnection\", \"true\");\n\t\tconnection.setProperty(\"kyvos.connection.provider\", \"SNOWFLAKE\");\n\t\tconnection.setProperty(\"kyvos.connection.properties.version\", \"\");\n\t\tconnection.setProperty(\"kyvos.connection.url\", \"\");\n\t\tconnection.setProperty(\"kyvos.connection.lastUpdateTimestamp\", \"\");\n\t\tconnection.setProperty(\"kyvos.connection.userImpersonation\", \"false\");\n\t\tconnection.setProperty(\"kyvos.connection.warehouse\", \"\");\n\t\tconnection.setProperty(\"kyvos.connection.user\", \"\");\n\t\tconnection.setProperty(\"kyvos.connection.isRead\", \"true\");\n\t\tconnection.setProperty(\"kyvos.connection.password\", \"\", \"true\", null);\n\t\tconnection.setProperty(\"kyvos.connection.database\", \"\");\n\t\tconnection.setProperty(\"kyvos.connection.account\", \"\");\n\t\tconnection.setProperty(\"kyvos.connection.defaultsqlengine\", \"true\");\n\t\tconnection.setProperty(\"kyvos.connection.name\", connectionName);\n\t\tconnection.setProperty(\"kyvos.connection.authenticationtype\", \"SNOWFLAKE\");\n\t\tconnection.setProperty(\"kyvos.databricks.cluster.id\", \"\");\n\t\tSystem.out.println(connection.getXML());\n\t\t\n\t\tString params = \"connectionXML=\"+URLEncoder.encode(connection.getXML(), java.nio.charset.StandardCharsets.UTF_8.toString());\n\t\t\n\t\t/**Rest API Method to create connection*/\n\t\tRESTClient.sendRequest(\"connection\", params, \"POST\");\n\t}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Updating a connection ","type":"text"}]},{"type":"codeBlock","attrs":{"language":"java"},"content":[{"text":"public static void updateConnection(String connectionName) throws UnsupportedEncodingException {\n\t\t/**Rest API Method to get connection details*/\n\t\tString connectionXML = RESTClient.sendRequest(\"connection/\"+connectionName+\"?addResponseTag=false\", null, \"GET\");\n\t\t\n\t\t/**Updating Connection XML*/\n\t\tDBConnection connection = new DBConnection(connectionXML);\n\t\tconnection.setProperty(\"kyvos.connection.user\", \"\");\n\t\t\n\t\tString params = \"connectionXML=\"+URLEncoder.encode(connection.getXML(), java.nio.charset.StandardCharsets.UTF_8.toString());\n\t\t\n\t\t/**Rest API Method to update connection*/\n\t\tSystem.out.println(RESTClient.sendRequest(\"connection\", params, \"PUT\"));\n\t}\n}\t","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}],"version":1}

Browser not supported