1. REST API for Oracle Enterprise Performance Management Cloud
  2. CSS Common Helper Functions for Groovy

E CSS Common Helper Functions for Groovy

This appendix shows the CSS common helper functions for Groovy for the EPM Cloud REST APIs.

Note:
  • Proxy setting: In case of proxies, set the proxy host and port as the system arguments.
  • Username: The username variable uses the format <domain>.<username>. Authentication. 
import java.nio.charset.StandardCharsets

import groovy.json.JsonSlurper

serverUrl="<SERVICE_URL>"
username="<DOMAINNAME.USERNAME>"
password="<PASSWORD>"

apiVersion = "v1";
userCredentials = username + ":" + password;
basicAuth = "Basic " + javax.xml.bind.DatatypeConverter.printBase64Binary(userCredentials.getBytes())

def getResponse(is) {
	BufferedReader br = new BufferedReader(new InputStreamReader(is));
	StringBuilder sb = new StringBuilder();
	String line;
	while ((line = br.readLine()) != null) {
		sb.append(line+"\n");
	}
	br.close();
	return sb.toString();
}

def getUrlFromResponse(scenario, response, relValue) {
	def object = new JsonSlurper().parseText(response)
	def pingUrlStr
	if (object.status == -1) {
		println "Started - " + scenario
		def links = object.links
		links.each{
			if (it.rel.equals(relValue)) {
				pingUrlStr=it.href
			}
		}
	} else {
		println "Error details: " + object.details
		System.exit(0);
	}
	return pingUrlStr
}

def getJobStatus(pingUrlString, methodType) {

	def pingUrl = new URL(pingUrlString);
	def completed = false;
	while (!completed) {
		pingResponse = executeRequest(pingUrl, methodType, null, "application/x-www-form-urlencoded");
		status = getJobStatusFromResponse(pingResponse);
		if (status == "Processing") {
			try {
				println "Processing. Please wait..."
				Thread.sleep(5000);
			} catch (InterruptedException e) {
				completed = true
			}
		} else {
			println status
			completed = true
		}
	}
}

def getJobStatusFromResponse(response) {
	def object = new JsonSlurper().parseText(response)
	def status = object.status
	if (status == -1)
		return "Processing"
	else if (status == 0)
		return "Completed"
	else
		return object.details
}

def getJobDetailsFromResponse(response) {
	def object = new JsonSlurper().parseText(response)
	def details = object.details
	if (details != null)
		return object.details
	else
		return null
}

def executeRequest(url, requestType, payload, contentType) {
	HttpURLConnection connection = (HttpURLConnection) url.openConnection();
	connection.setDoOutput(true);
	connection.setInstanceFollowRedirects(false);
	connection.setRequestMethod(requestType);
	connection.setRequestProperty("Content-Type", contentType);
	//           connection.setRequestProperty("charset", StandardCharsets.UTF_8);
	connection.setRequestProperty("Authorization", basicAuth);
	connection.setUseCaches(false);

	if (payload != null) {
		OutputStreamWriter writer = new OutputStreamWriter(connection.getOutputStream());
		writer.write(payload);
		writer.flush();
	}

	int statusCode
	try {
		statusCode = connection.responseCode;
	} catch (all) {
		println "Error connecting to the URL"
		System.exit(0);
	}

	def response
	if (statusCode == 200 || statusCode == 201) {
		if (connection.getContentType() != null && !connection.getContentType().startsWith("application/json")) {
			println "Error occurred in server"
			System.exit(0)
		}
		InputStream is = connection.getInputStream();
		if (is != null)
			response = getResponse(is)
	} else {
		println "Error occurred while executing request"
		println "Response error code : " + statusCode
		InputStream is = connection.getErrorStream();
		if (is != null && connection.getContentType() != null && connection.getContentType().startsWith("application/json"))
			println getJobStatusFromResponse(getResponse(is))
		System.exit(0);
	}
	connection.disconnect();
	return response;
}

def addUsersToGroup(fileName, groupName) {

	String scenario = "Adding users in " + fileName + " to group " + groupName;
	String params = "jobtype=ADD_USERS_TO_GROUP&filename="+ fileName +"&groupname="+ groupName;
	def url = null;
	def response = null;
	try {
		url = new URL(serverUrl + "/interop/rest/security/" + apiVersion + "/groups");
	} catch (MalformedURLException e) {
		println "Please enter a valid URL"
		System.exit(0);
	}
	response = executeRequest(url, "PUT", params, "application/x-www-form-urlencoded");
	if (response != null) {
		getJobStatus(getUrlFromResponse(scenario, response, "Job Status"), "GET");
	}
}

def removeUsersFromGroup(fileName, groupName) {

	String scenario = "Removing users in " + fileName + " from group " + groupName;
	String params = "jobtype=REMOVE_USERS_FROM_GROUP&filename="+ fileName +"&groupname="+ groupName;
	def url = null;
	def response = null;
	try {
		url = new URL(serverUrl + "/interop/rest/security/" + apiVersion + "/groups");
	} catch (MalformedURLException e) {
		println "Please enter a valid URL"
		System.exit(0);
	}
	response = executeRequest(url, "PUT", params, "application/x-www-form-urlencoded");
	if (response != null) {
		getJobStatus(getUrlFromResponse(scenario, response, "Job Status"), "GET");
	}
}

def addUserToGroups(fileName, userName) {

	String scenario = "Adding users in " + fileName + " to group " + userName;
	String params = "jobtype=ADD_USER_TO_GROUPS&filename="+ fileName +"&username="+ userName;
	def url = null;
	def response = null;
	try {
		url = new URL(serverUrl + "/interop/rest/security/" + apiVersion + "/groups");
	} catch (MalformedURLException e) {
		println "Please enter a valid URL"
		System.exit(0);
	}
	response = executeRequest(url, "PUT", params, "application/x-www-form-urlencoded");
	if (response != null) {
		getJobStatus(getUrlFromResponse(scenario, response, "Job Status"), "GET");
	}
}

def removeUserFromGroups(fileName, userName) {

	String scenario = "Removing users in " + fileName + " from group " + userName;
	String params = "jobtype=REMOVE_USER_FROM_GROUPS&filename="+ fileName +"&username="+ userName;
	def url = null;
	def response = null;
	try {
		url = new URL(serverUrl + "/interop/rest/security/" + apiVersion + "/groups");
	} catch (MalformedURLException e) {
		println "Please enter a valid URL"
		System.exit(0);
	}
	response = executeRequest(url, "PUT", params, "application/x-www-form-urlencoded");
	if (response != null) {
		getJobStatus(getUrlFromResponse(scenario, response, "Job Status"), "GET");
	}
}

def addUsers(fileName, resetPassword, userPassword) {

	String scenario = "Creating users in " + fileName;
	String params = "jobtype=ADD_USERS&filename="+ fileName +"&resetpassword="+ resetPassword +"&userpassword="+ userPassword;
	def url = null;
	def response = null;
	try {
		url = new URL(serverUrl + "/interop/rest/security/" + apiVersion + "/users");
	} catch (MalformedURLException e) {
		println "Please enter a valid URL"
		System.exit(0);
	}
	response = executeRequest(url, "POST", params, "application/x-www-form-urlencoded");
	if (response != null) {
		getJobStatus(getUrlFromResponse(scenario, response, "Job Status"), "GET");
	}
}

def addUsers(fileName) {
	addUsers(fileName, null, null);
}

def deleteUsers(fileName) {

	String scenario = "Deleting users in " + fileName;
	String params = null;
	def url = null;
	def response = null;
	try {
		url = new URL(serverUrl + "/interop/rest/security/" + apiVersion + "/users?filename=" + fileName);
	} catch (MalformedURLException e) {
		println "Please enter a valid URL"
		System.exit(0);
	}
	response = executeRequest(url, "DELETE", null, "application/x-www-form-urlencoded");
	if (response != null) {
		getJobStatus(getUrlFromResponse(scenario, response, "Job Status"), "GET");
	}
}

def assignUsersRoles(fileName, roleName) {

	String scenario = "Assigning users in " + fileName + " with role " + roleName;
	String params = "jobtype=ASSIGN_ROLE&filename="+ fileName +"&rolename="+ roleName;
	def url = null;
	def response = null;
	try {
		url = new URL(serverUrl + "/interop/rest/security/" + apiVersion + "/users");
	} catch (MalformedURLException e) {
		println "Please enter a valid URL"
		System.exit(0);
	}
	response = executeRequest(url, "PUT", params, "application/x-www-form-urlencoded");
	if (response != null) {
		getJobStatus(getUrlFromResponse(scenario, response, "Job Status"), "GET");
	}
}

def unassignUsersRoles(fileName, roleName) {

	String scenario = "Un-assigning users in " + fileName + " with role " + roleName;
	String params = "jobtype=UNASSIGN_ROLE&filename="+ fileName +"&rolename="+ roleName;
	def url = null;
	def response = null;
	try {
		url = new URL(serverUrl + "/interop/rest/security/" + apiVersion + "/users");
	} catch (MalformedURLException e) {
		println "Please enter a valid URL"
		System.exit(0);
	}
	response = executeRequest(url, "PUT", params, "application/x-www-form-urlencoded");
	if (response != null) {
		getJobStatus(getUrlFromResponse(scenario, response, "Job Status"), "GET");
	}
}

def generateRoleAssignmentReport(fileName, userType) {

	String scenario = "Generating Role assignment report in " + fileName + " with usertype as " + userType;
	String params = "jobtype=GENERATE_ROLE_ASSIGNMENT_REPORT&filename="+ fileName + "&usertype=" + userType;
	def url = null;
	def response = null;
	try {
		url = new URL(serverUrl + "/interop/rest/security/" + apiVersion + "/roleassignmentreport");
	} catch (MalformedURLException e) {
		println "Please enter a valid URL"
		System.exit(0);
	}
	response = executeRequest(url, "POST", params, "application/x-www-form-urlencoded");
	if (response != null) {
		getJobStatus(getUrlFromResponse(scenario, response, "Job Status"), "GET");
	}
}

def generateUserGroupReport(fileName) {

	String scenario = "Generating User Group Report in " + fileName;
	String params = "jobtype=GENERATE_USER_GROUP_REPORT&filename="+ fileName;
	def url = null;
	def response = null;
	try {
		url = new URL(serverUrl + "/interop/rest/security/" + apiVersion + "/usergroupreport");
	} catch (MalformedURLException e) {
		println "Please enter a valid URL"
		System.exit(0);
	}
	response = executeRequest(url, "POST", params, "application/x-www-form-urlencoded");
	if (response != null) {
		getJobStatus(getUrlFromResponse(scenario, response, "Job Status"), "GET");
	}
}

def addGroups(fileName) {
	println "addgroups"
	String scenario = "Creating Groups in " + fileName;
	String params = "filename="+ fileName;
	def url = null;
	def response = null;
	try {
		url = new URL(serverUrl + "/interop/rest/security/" + apiVersion + "/groups");
	} catch (MalformedURLException e) {
		println "Please enter a valid URL"
		System.exit(0);
	}
	response = executeRequest(url, "POST", params, "application/x-www-form-urlencoded");
	if (response != null) {
		getJobStatus(getUrlFromResponse(scenario, response, "Job Status"), "GET");
	}
}

def removeGroups(fileName) {

	String scenario = "Deleting Groups in " + fileName;
	String params = null;
	def url = null;
	def response = null;
	try {
		url = new URL(serverUrl + "/interop/rest/security/" + apiVersion + "/groups?filename=" + fileName);
	} catch (MalformedURLException e) {
		println "Please enter a valid URL"
		System.exit(0);
	}
	response = executeRequest(url, "DELETE", null, "application/x-www-form-urlencoded");
	if (response != null) {
		getJobStatus(getUrlFromResponse(scenario, response, "Job Status"), "GET");
	}
}

def generateRoleAssignmentAuditReport(from_date,to_date,fileName) {

	String scenario = "Generating Role assignment audit report in " + fileName;
	String params = "jobtype=GENERATE_ROLE_ASSIGNMENT_AUDIT_REPORT&from_date="+from_date+"&to_date="+to_date+"&filename="+ fileName;
	def url = null;
	def response = null;
	try {
		url = new URL(serverUrl + "/interop/rest/security/" + apiVersion + "/roleassignmentauditreport");
	} catch (MalformedURLException e) {
		println "Please enter a valid URL"
		System.exit(0);
	}
	response = executeRequest(url, "POST", params, "application/x-www-form-urlencoded");
	if (response != null) {
		getJobStatus(getUrlFromResponse(scenario, response, "Job Status"), "GET");
	}
}

def generateInvalidLoginReport(from_date,to_date,fileName) {

	String scenario = "Generating Invalid Login report in " + fileName;
	String params = "jobtype=GENERATE_INVALID_LOGIN_REPORT&from_date="+from_date+"&to_date="+to_date+"&filename="+ fileName;
	def url = null;
	def response = null;
	try {
		url = new URL(serverUrl + "/interop/rest/security/" + apiVersion + "/invalidloginreport");
	} catch (MalformedURLException e) {
		println "Please enter a valid URL"
		System.exit(0);
	}
	response = executeRequest(url, "POST", params, "application/x-www-form-urlencoded");
	if (response != null) {
		getJobStatus(getUrlFromResponse(scenario, response, "Job Status"), "GET");
	}
}

def updateUsers(fileName) {

	String scenario = "Updating users from " + fileName ;
	String params = "jobtype=UPDATE_USERS&filename="+ fileName;
	def url = null;
	def response = null;
	try {
		url = new URL(serverUrl + "/interop/rest/security/" + apiVersion + "/users");
	} catch (MalformedURLException e) {
		println "Please enter a valid URL"
		System.exit(0);
	}
	response = executeRequest(url, "PUT", params, "application/x-www-form-urlencoded");
	if (response != null) {
		getJobStatus(getUrlFromResponse(scenario, response, "Job Status"), "GET");
	}
}

//Execute commands here
//addUsersToGroup("Users.csv", "G1");                                                                                           //PUT
//removeUsersFromGroup("Users.csv", "G1");                                                                            //PUT
//addUsers("AddUsers123.csv", "false", "newPassword");                                        //POST
//addUsers("AddUsers456.csv");                                                                                                                                 //POST
//deleteUsers("RemoveUsers.csv");                                                                                                             //DELETE
//assignUsersRoles("Users.csv", "Service Administrator");                           //PUT
//assignUsersRoles("users.csv", "viewer");                                                          //PUT
//unassignUsersRoles("Users.csv", "Drill Through");                                                   //PUT
//generateRoleAssignmentReport("GroovySampleReport3.csv,"ServiceUsers");								// POST
//generateUserGroupReport("UserGroupReportGroovy.csv");									// POST
//addUserToGroups("Group.csv", "user1");                                               //PUT
//removeUserFromGroups("groups.csv", "joe");                                          //PUT
//addGroups("CreateGroup1.csv");												// POST
//removeGroups("DeleteGroup1.csv");												// DELETE
//generateInvalidLoginReport("2020-06-01", "2021-06-10", "report12345.csv"); //POST
//updateUsers("updateuser.csv"); 								// PUT