Apprivo Blog: Time Based Worfklow New Code

For those of you that deployed time based workflow with the Salesforce partner portal summer 06 edition and have upgraded to the winter 07 PRM portal edition there is an update to the Run Workflow Schedule scontrol. The change reflects the fact that partner users as of the Winter 07 PRM edition are represented differently in the application, and therefore the code that detects if records are owned by partner users also changes.

To apply the change you just need to:

Copy the text from below
Open the Run "Workflow Schedule" scontrol
Paste the text into Run "Workflow Schedule" window and press save

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <title>Run Workflow Schedule</title> <HEAD></head> <style type="text/css" media="screen">div.visible { display: visible; } div.hidden { display: none; }</style> <link href="/dCSS/Theme2/default/common.css", type="text/css" rel="stylesheet"> <link href="/dCSS/Theme2/default/custom.css", type="text/css" rel="stylesheet"> <link href="/css/assistive.css", type="text/css" rel="stylesheet"> <script src="https://www.salesforce.com/services/lib/ajax/beta3.3/sforceclient.js" type="text/javascript"></script> <script language="JavaScript" src="{!Scontrol.URL}"></script> <script type="text/javascript"> /* iterate through all schedules evaluate when to run the schedule based on frequency (do from calling code, not within here) change to specific uers */ var scheduleHistoryRunID; //Keeps the id of the current schedule history object var checkedTransferPerm = false; //Boolean to track if the current user has transfer ownership permissins var loggedError = false; //Set to true if any error is logged var ownerInfoArray = new Array(); //array to cache user information to minimize the number of API calls var recordInfoArray = new Array(); //array to cache record information to minimize the number of API calls var recordsUpdatedArray = new Array(); //Array storing the unique ids of the records that were updated var apiHitCount=0; //Counts the number of times the API is invoked var apiHitInfoArray = new Array(); //Tracks what functions are calling the sforceclient var describeFieldArray = new Array(); //Array storing cached field values to minimize describe object calls and improve performance //Name account variables var namedAccountsArray = new Array(); //Array storing the named account information var namedAccountLisRetrieved = false; //Boolean informing if an attempt was made to retrieve the named accounts //Boolean fields determining if the respective pre and post update fields should be updated var updateObjectField = false; var updateBefore = false; var updateAfter = false; //Window error handling window.onerror = function ( strErr, strURL, strLineNumber ) { if(strURL=="") strURL=document.location.href + "\n"; var strMess = "Error:\n"; strMess += "URL: " + strURL + "\n"; if(strLineNumber!=0) strMess += "<br>nline number: " + strLineNumber + "\n"; strMess += "<br>Error Message: " + strErr + "\n"; logError(strMess); shutDown(); } //This function initializes the page display header. //It is called from the body's onload event. function printStart() { document.getElementById('header').innerHTML = "<h3><center>Processing Workflow Schedule for \"{!APPR_Workflow_Schedule__c.Schedule_Name__c}\"</center></h3>"; document.getElementById('header').innerHTML +="<center><img id=\"progress\" src=\"/img/waiting_dots.gif\" alt=\"Processing, please wait\"></center>"; if("{!User.Id}" != "00520000000vvl4") { //call the process initialization function. This is not the AppExchange testdrive user window.setTimeout("initPage()", 100); } else { window.location.href = "/servlet/servlet.FileDownload?file=01530000000Ba4H"; } } //Function initializes the sforce Api Connection function initPage() { // get session id and initialize the sforceClient() object getsforceClient("initPage").registerInitCallback(processSchedule); getsforceClient("initPage").init("{!API.Session_ID}", "{!API.Partner_Server_URL_80}"); } function processSchedule() { //check everything is ok if (getsforceClient("processSchedule").getSessionId().indexOf("!API_Session_ID") != -1) { //alert("You are not logged in");. The alert is commented out since this process is generally an unattended process } else { //showDebug(); var retVal; //Log the run start in the worflow history object retVal = logWorkFlowRun("{!APPR_Workflow_Schedule__c.Id}"); if(retVal != null) { //Validate the selections retVal = validateSelections(); if(retVal) { //Run the referenced report var recordIDs = runReport("{!APPR_Workflow_Schedule__c.Report_ID__c}") var recordsInReport; if(recordIDs == null) recordsInReport = 0; else recordsInReport = recordIDs.length; //Determine what fields (if any) need to be updated //window.setTimeout('determineFieldUpdates()', 2500); // Sathish 0,1 determineFieldUpdates(); //Perform the requested action var saveResults; switch ("{!APPR_Workflow_Schedule__c.Action__c}".toUpperCase()) { case "CHANGE OWNER": //Validate that the user can transfer records if(validateTransferPerm()) { //Preprocessing step for named accounts. Remove records (leads) that are named account leads if("{!APPR_Workflow_Schedule__c.To_Target__c}".toUpperCase() == "NAMED ACCOUNT OWNER") recordIDs = preProcessNamedAccountRecords(recordIDs); //Preprocessing step to exclude records whose current owner is the same as the targeted new owner. This prevents false positive emails going to the owner recordIDs = removeSameOwner(recordIDs); //Should the fields be updated prior to changing the owner? if(updateObjectField && updateBefore) saveResults = updateField(recordIDs, "{!APPR_Workflow_Schedule__c.Update_Before_Change__c}"); //Change the owner saveResults = changeOwner(recordIDs); //Should the fields be updated after changing the owner? if(updateObjectField && updateAfter) saveResults = updateField(recordIDs, "{!APPR_Workflow_Schedule__c.Update_After_Change__c}"); break; } else { logError("The current user - {!User.FirstName} {!User.LastName} - does not have permission to transfer records"); } break; case "UPDATE FIELD": saveResults = updateField(recordIDs, "{!APPR_Workflow_Schedule__c.Update_Before_Change__c}"); break; } } var recordsProcessed = 0; if(recordIDs == null) recordsProcessed = 0; else recordsProcessed = recordIDs.length; logWorkFlowRunEnd(recordsInReport, recordsProcessed , "{!APPR_Workflow_Schedule__c.Id}"); } } //Update the schedule history flag if any messages were logged if(loggedError) updateScheduleHasError(); shutDown(); } //Called on scontrol completion function shutDown() { var x = getURLParam("lastone"); if(x == "true") { //The function was called by the run all workflow process and this is the last workflow schedule to run. Just close the window } else { //refresh the callin page, either the individual workflow schedule or the run all workflow scontrol to process the next schedule window.opener.location.reload(true); } window.close(); } //Validates the workflow schedule selections function validateSelections() { var retVal = true; //Validate change owner if("{!APPR_Workflow_Schedule__c.Action__c}" == "Change Owner") { //Change owner has been selected. Ensure that a "to" or user selection is made if("{!APPR_Workflow_Schedule__c.To_Target__c}" == "" && "{!APPR_Workflow_Schedule__c.User__c}" == "") { //No selection has been made logError("'Change Owner' has been selected, but neither a 'to' or user selection is made"); retVal = false; } } //Validate update field if("{!APPR_Workflow_Schedule__c.Action__c}" == "Update Field") { //Update field has selected. Ensure that a "Update Before Change" or "Update After Change" selection is made if("{!APPR_Workflow_Schedule__c.Update_Before_Change__c}" == "" && "{!APPR_Workflow_Schedule__c.Update_After_Change__c}" == "") { //No selection has been made logError("'Update Field' has been selected, but neither a 'Update Before Change' or 'Update After Change' selection is made"); retVal = false; } } //Validate that any pre or post values are valid fields var fieldArray = new Array("{!APPR_Workflow_Schedule__c.Update_Before_Change__c}", "{!APPR_Workflow_Schedule__c.Update_After_Change__c}"); for(var i = 0; i < fieldArray.length; i++) { if(fieldArray[i] != "") { //Validate the the fields exist if(getDBFieldName(fieldArray[i], "APPR_Workflow_Event__c") == null) retVal = false; } } //Validate a report is selected if("{!APPR_Workflow_Schedule__c.Report_ID__c}" == "") { logError("A report to base the schedule on has not been entered"); retVal = false; } //Validate that the from days is <= the to days if({!APPR_Workflow_Schedule__c.Between_Days__c} > {!APPR_Workflow_Schedule__c.And_Days__c}) { logError("The 'Between (Days)' field value ({!APPR_Workflow_Schedule__c.Between_Days__c}) cannot be greter than the 'And (Days)' field value ({!APPR_Workflow_Schedule__c.And_Days__c})"); retVal = false; } //Validate that the chosen object type support the Named Account Owner Selection if("{!APPR_Workflow_Schedule__c.To_Target__c}".toUpperCase() == "NAMED ACCOUNT OWNER" && "{!APPR_Workflow_Schedule__c.Object_Type__c}".toUpperCase() != "LEAD") { logError("The 'Named Account Owner' is valid only for LEAD records. The current rule is defined for the object type {!APPR_Workflow_Schedule__c.Object_Type__c}"); retVal = false; } return retVal; } function determineFieldUpdates(){ //Determine if and when the field should be updated if("{!APPR_Workflow_Schedule__c.Update_Field__c}" != "") updateObjectField = true; if(updateObjectField) { switch ("{!APPR_Workflow_Schedule__c.Update_Field__c}") { case "Before Change": if("{!APPR_Workflow_Schedule__c.Update_Before_Change__c}" != "") updateBefore = true; break; case "After Change": if("{!APPR_Workflow_Schedule__c.Update_After_Change__c}" != "") updateAfter = true; break; case "Both": if("{!APPR_Workflow_Schedule__c.Update_Before_Change__c}" != "") updateBefore = true; if("{!APPR_Workflow_Schedule__c.Update_After_Change__c}" != "") updateAfter = true; break; default: if("{!APPR_Workflow_Schedule__c.Update_Before_Change__c}" != "") updateBefore = true; break; } } } //Maps the date values to the repective report url parms function resolveDateNameFields(objectType, from, to) { var retVal; switch (objectType.toUpperCase()) { case "LEAD": retVal = "sdate=" + from + "&edate=" + to; break; case "OPPORTUNITY": retVal = "quarter_s=" + from + "&quarter_e=" + to; break; case "CAMPAIGN": retVal = "pc0=END_DATE&pn0=ge&pv0=" + from + "&pc1=END_DATE&pn1=le&pv1=" + to; break; case "TASK": retVal = "pc0=DUE_DATE&pn0=ge&pv0=" + from + "&pc1=DUE_DATE&pn1=le&pv1=" + to; break; default: retVal = "colDt_s=" + from + "&colDt_e=" + to; break; } return retVal; } //Run the report referenced in the Based On Report ID field function runReport(reportID){ //Array to hold the object ids var recordIDs = new Array(); //get report date range var date = new Date(); var fromDate; var toDate; switch ("{!APPR_Workflow_Schedule__c.Into_The__c}".toUpperCase()) { case "FUTURE": //Campaigns are an example of a case where you may want to find records that are expiring in the future, versus in the past. var toDate = new Date(date.getTime() + {!APPR_Workflow_Schedule__c.And_Days__c}*24*60*60*1000); var fromDate = new Date(date.getTime() + {!APPR_Workflow_Schedule__c.Between_Days__c}*24*60*60*1000); break; case "PAST": fromDate = new Date(date.getTime() - {!APPR_Workflow_Schedule__c.And_Days__c}*24*60*60*1000); toDate = new Date(date.getTime() - {!APPR_Workflow_Schedule__c.Between_Days__c}*24*60*60*1000); break; default: fromDate = new Date(date.getTime() - {!APPR_Workflow_Schedule__c.And_Days__c}*24*60*60*1000); toDate = new Date(date.getTime() - {!APPR_Workflow_Schedule__c.Between_Days__c}*24*60*60*1000); break; } fromDate = (fromDate.getMonth()+1) + "/" + fromDate.getDate() + "/" + fromDate.getFullYear(); toDate = (toDate.getMonth()+1) + "/" + toDate.getDate() + "/" + toDate.getFullYear(); var retVal = resolveDateNameFields("{!APPR_Workflow_Schedule__c.Object_Type__c}", fromDate, toDate); if(retVal != null) { var url = "/" + reportID + "?" + retVal + "&isExcel=1&export=1&enc=UTF-8&xf=csv"; var http = new JKL.ParseXML.CSV(url); var data = http.parse(); /** Check that the object id is the first column by a) checking that its value is not blank, indicatinig no data b) checking that its value is 15 characters long b) verifying that the id prefix matches the prefix used by the 'Object Type' defined in the workflow schedule */ var verifyReport = true; if(data.length >0) { var id = data[1][0]; //a) if(id != "") { //b if(id.length == 15) { //c var keyPrefix = getObjectTypePrefix("{!APPR_Workflow_Schedule__c.Object_Type__c}"); if(keyPrefix != null) { if(keyPrefix != Left(id,3)) { verifyReport = false; logError("The prefix on the report object (" + Left(id,3) + ") does not match the defined {!APPR_Workflow_Schedule__c.Object_Type__c} object prefix (" + keyPrefix + ")"); } } else { verifyReport = false; logError("Unable to determine the prefix on object type {!APPR_Workflow_Schedule__c.Object_Type__c}"); } } else { verifyReport = false; logError("The first column in the report (" + data[0][0] + ") does not contain record ids. Reorder the columns and put the record id in the first column"); } } else { logError("The report /" + reportID + " returned no data. Check the users access to the report and ensure the user has the 'export reports' permission"); verifyReport = false; } } if(verifyReport) { for(i=0;i<data.length;i++) { if(data[i+1][0] != "") //i+1 as the first row contains headings recordIDs.push(data[i+1][0]); else break; //you have reached the end of the report } } } else { logError("Unable to determine the start and end date parameters for the object type - {!APPR_Workflow_Schedule__c.Object_Type__c}"); } return recordIDs; } //Establishes the owner to change to function getToOwner(recordID){ var retVal; if("{!APPR_Workflow_Schedule__c.To_Target__c}" != "") { //The user has selected a role based choice var recordOwnerId = getRecordOwnerID(recordID, "{!APPR_Workflow_Schedule__c.Object_Type__c}"); if(recordOwnerId != null) { switch ("{!APPR_Workflow_Schedule__c.To_Target__c}") { case "User Above Owner Role": retVal = getUserAboveRole(recordOwnerId); break; case "Named Account Owner": var matchValue = setNamedAccountMatchValue(recordID); if(matchValue != null && matchValue != "") retVal = getNamedAccountOwner(matchValue); break; default: retVal = getUserAboveRole(recordOwnerId); break; } } } else { if("{!APPR_Workflow_Schedule__c.UserId__c}" != "") retVal = "{!APPR_Workflow_Schedule__c.UserId__c}"; } return retVal; } function updateRecordOwner(recordID, ownerid) { recordInfoArray[recordID].ownerID = ownerid; } //Retrieve user information for a given userid function getUserInfo(userid) { var retVal; var qr = getsforceClient("getUserInfo").Retrieve("id, UserRoleId, FirstName, LastName, IsPartner", "User", userid); if(qr != null && qr.length >0) { //Cache the entry var recordEntry= { "userRoleID": qr[0].get("UserRoleId"), "userName": qr[0].get("FirstName") + " " + qr[0].get("LastName"), "isPartner": qr[0].get("IsPartner") }; ownerInfoArray[userid] = recordEntry; retVal = ownerInfoArray[userid]; } else if(qr.className == "Fault") { logError("Could not retrieve user information for userid '" + userid + "'. Error: " + qr.faultstring); } return retVal; } //Returns a user role id for the given user function getUserRoleID(userid) { var retVal; //See if the information has been cached from a previous record if(ownerInfoArray[userid] != undefined) { //The user has some information cached, determine if property we need is present if(ownerInfoArray[userid].userRoleID != null) retVal = ownerInfoArray[userid].userRoleID; } if(retVal == null) retVal = getUserInfo(userid).userRoleID; return retVal; } //Returns a user role id for the given user function getUserName(userid) { var retVal; //See if the information has been cached from a previous record if(ownerInfoArray[userid] != undefined) { //The user has some information cached, determine if property we need is present if(ownerInfoArray[userid].userName != null) retVal = ownerInfoArray[userid].userName; } if(retVal == null) retVal = getUserInfo(userid).userName; return retVal; } //Returns the record owner for the given record id function getRecordOwnerID(recordID, objectType) { var retVal; retVal = getRecordInfo(recordID, objectType).ownerID; return retVal; } //Returns the record name for the given record id function getRecordName(recordID, objectType) { var retVal; retVal = getRecordInfo(recordID, objectType).recordName; return retVal; } //Returns the last modified data for the given record id function getRecordLastModifiedDate(recordID, objectType) { var retVal; retVal = getRecordInfo(recordID, objectType).lastModifiedDate; return retVal; } //Returns the created date for the given record id function getRecordCreatedDate(recordID, objectType) { var retVal; retVal = getRecordInfo(recordID, objectType).recordCreatedDate; return retVal; } //Returns record information for the given record id function getRecordInfo(recordID, objectType) { var retVal; //See if the information has been cached from a previous record fetch if(recordInfoArray[recordID] != undefined) { retVal = recordInfoArray[recordID]; } else { //The information is not cached. Query for the record id and cache //Standard field for all records var standardFields="id, ownerID, CreatedDate, LastModifiedDate, "; //Object specific fields var extraFields = new Array(); switch (objectType.toUpperCase()) { case "LEAD": extraFields.push("Company"); extraFields.push("FirstName"); extraFields.push("LastName"); extraFields.push("Email"); break; case "CONTACT": extraFields.push("FirstName"); extraFields.push("LastName"); break; case "TASK": extraFields.push("Subject"); extraFields.push("ActivityDate"); break; default: extraFields.push("Name"); } for(var i=0;i<extraFields.length;i++) { standardFields += extraFields[i]; if(i+1>=extraFields.length) break; else standardFields += ","; } var qr = getsforceClient("getRecordInfo").Retrieve(standardFields, objectType, recordID); if(qr != null && qr.length >0) { //Cache the entry var email; if(objectType.toUpperCase() == "LEAD") email = qr[0].get("Email"); var recordEntry= { "recordID": qr[0].get("id"), "ownerID": qr[0].get("ownerID"), "recordName": null, "recordCreatedDate": qr[0].get("CreatedDate"), "lastModifiedDate": qr[0].get("LastModifiedDate"), "email": email }; //Set the record name property which can vary by object switch (objectType.toUpperCase()) { case "LEAD": recordEntry.recordName = "Company Name: " + checkForNull(qr[0].get("Company")) + ", Contact Name: " + checkForNull(qr[0].get("FirstName")) + " " + checkForNull(qr[0].get("LastName")); break; case "CONTACT": recordEntry.recordName = "Contact Name: " + checkForNull(qr[0].get("FirstName")) + " " + checkForNull(qr[0].get("LastName")); break; case "TASK": recordEntry.recordName = "Task Subject: " + qr[0].get("Subject") + " Due Date: " + qr[0].get("ActivityDate").toLocaleString(); break; default: recordEntry.recordName = qr[0].get("Name"); } recordInfoArray[recordID] = recordEntry; retVal = recordInfoArray[recordID]; } else { logError("No records returns for the fields - " + standardFields + " - on the object '" + objectType + "' and recordID '" + recordID + "'."); } } return retVal; } //Gets the user directly above the user if passed in function getUserAboveRole(userID) { var retVal; //See if the information has been cached from a previous record if(ownerInfoArray[userID] != undefined) { //The user has some information cached, determine if property we need is present if(ownerInfoArray[userID].userAboveRole != null) retVal = ownerInfoArray[userID].userAboveRole; } if(retVal == null) { //The user above the userID was not found in the cache, get the role id for the current user var userRoleID = getUserRoleID(userID); if(userRoleID != null) { //get the parent role ID var qr = getsforceClient("getUserAboveRole").Retrieve("id, ParentRoleId", "UserRole", userRoleID); if(qr != null && qr.length >0) { var parentRoleID = qr[0].get("ParentRoleId"); if(parentRoleID == null) { /** The parentrole id is null, indicating that the top of the role hieurarchy has been reached Return false, which the calling function will take a sign of such. **/ retVal = false; } else { //Get a user with this parent role id qr = getsforceClient("getUserAboveRole").Query("Select Id, IsPartner from User where UserRoleId = '" + parentRoleID + "' and IsActive = true"); if(qr.className == "Fault") { logError("Could not retrieve a user id for a the role id ('" + parentRoleID + "') above the current record owner. Error: " + qr.faultstring); } else { if(qr.size > 0) { retVal = qr.records[0].get("Id"); //Cache the details for future lookups if(ownerInfoArray[userID] != undefined) { //The entry is already there. Add the role value ownerInfoArray[userID].userAboveRole = retVal; } else { //Create a new entry var ownerEntry= { "OwnerId": userID, "isPartner": qr.records[0].get("IsPartner"), "userAboveRole": retVal }; ownerInfoArray[userID] = ownerEntry; } } else { logError("Could not retrieve a user id for a the role id ('" + parentRoleID + "') above the current record owner"); } } } } else if(qr.className == "Fault") { logError("Could not retrieve the parent role id for the role id '" + userRoleID + "' . Error: " + qr.faultstring); } } } return retVal; } //Set the value that is used to index the named accoun list function setNamedAccountMatchValue(recordID) { //Use this to determine what field is used to look up the named account index in the namedAccountsArray var matchVal = getRecordInfo(recordID, "LEAD").email; //Since we are using email domain as the match value we need to strip off up the @ character if(matchVal != null) matchVal = stripEmail(matchVal); return matchVal; } //Get the named account owner for the passed in record (lead) and match value function getNamedAccountOwner(matchVal) { var retVal; //See if the information has been cached from a previous record if(namedAccountLisRetrieved) { if(namedAccountsArray[matchVal] != undefined) retVal = namedAccountsArray[matchVal].ownerID; } else { retVal = getNamedAccountInfo(matchVal); if(retVal != null) retVal = retVal.ownerID; } return retVal; } //Build and caches the named accoun list and returns a single entry in that list for the tiven matchValue function getNamedAccountInfo(matchValue) { var retVal; if(!namedAccountLisRetrieved) { //The list has not been previously retrieved . Build the list //Set this value to true so subsequent records do not continue to make the this call namedAccountLisRetrieved = true; var qr = getsforceClient("getNamedAccountInfo").Query("Select Id, Email_Domain__c, OwnerId from Account where Named_Account__c = true"); if(qr.className == "Fault") { logError("Named Account Error: Could not retrieve the named account list. Error: " + qr.faultstring); } else { if (qr != null && qr.size > 0) { var done = false; while (done == false) { for (var i=0;i<qr.records.length;i++) { //Create a cache for a new account entry var matchOn = qr.records[i].get("Email_Domain__c"); var accountEntry= { "ownerID": qr.records[i].get("OwnerId"), "Email_Domain": matchOn, "id": qr.records[i].get("id") }; namedAccountsArray[matchOn] = accountEntry; } if (qr.done == true) { done = true; } else { //Get more records qr = sforceClient.queryMore(qr.queryLocator); } } } retVal = namedAccountsArray[matchValue]; } } if(namedAccountsArray[matchValue] != undefined) retVal = namedAccountsArray[matchValue]; return retVal; } //Changes the record owners for a series of records function changeOwner(recordIDS) { //There is a limit of 200 records per update call. For more than 200 records you need to chunk through the records in 200 record increments var updateObjects = new Array(); var saveResults; var recObject; for (var i=0; i < recordIDS.length; i++){ var updateRecord = true; if({!APPR_Workflow_Schedule__c.Partner_Records_Only__c}){ //Only partner owned records should be updated. Check to see if the currently owned record is owned by a partner user if(!isPartnerRecord(recordIDS[i])) updateRecord = false; } if(updateRecord) { var newOwner = getToOwner(recordIDS[i]); if(newOwner != false && newOwner != null){ recObject = new Sforce.Dynabean("{!APPR_Workflow_Schedule__c.Object_Type__c}"); recObject.set("id", recordIDS[i]); recObject.set("ownerid", newOwner); updateObjects.push(recObject); //Need to update the cached value for record owner so that subsequent calls (such as a post update) get the most current record owner updateRecordOwner(recordIDS[i], newOwner) if(updateObjects.length >= 200) { var sdate = new Date(); updateRecordUpdateCount(updateObjects); saveResults = getsforceClient("changeOwner").Update(updateObjects); if (saveResults.success == false) logError("Updating record /" + recordIDS[i] + " failed: " + saveResults.errors[0].message); //Resize/ empty the array updateObjects = new Array(); } } } } if(updateObjects.length > 0) { updateRecordUpdateCount(updateObjects); saveResults = getsforceClient("changeOwner").Update(updateObjects); if (saveResults.success == false) logError("Error updating records: " + saveResults.errors[0].message); } return saveResults; } //Validates true/ false that the current user can transfer records function validateTransferPerm() { var retVal = true; //Get the users rights to transfer records if(!checkedTransferPerm) { //Get the transfer perm for the current user, and store so its not checked for each record retVal = getTransferPerm("{!User.Id}"); checkedTransferPerm = true; } return retVal; } //Checks for null values in a field function checkForNull(value) { if(value != null) return value; else return " "; } //Runs queries to establish if the given user can transfer records function getTransferPerm(userID) { var retVal = false; //get the profile for the current user var qr=getsforceClient("getTransferPerm").retrieve("Id, ProfileId", "User", userID); if(qr != null && qr.length > 0) { //Get the profile info var qrProfile=getsforceClient("getTransferPerm").retrieve("Id, PermissionsTransferAnyEntity", "Profile", qr[0].get("ProfileId")); if(qrProfile[0].get("PermissionsTransferAnyEntity")) retVal = true; } else { retVal = false; if(qr.className == "Fault") logError("Could not retrieve the profile for userid '" + userID + "'. Error: " + qr.faultstring); } return retVal; } //Check if the record owner is a partner user function isPartnerRecord(recordID) { var retVal = false; var valueCached = false; //Get the record owner var recordOwnerId = getRecordOwnerID(recordID, "{!APPR_Workflow_Schedule__c.Object_Type__c}"); if(recordOwnerId != null) { //Query the array to see if the logic has already encounted this ownerid, rather than querying each time for it if(ownerInfoArray[recordOwnerId] != undefined) { //The record owner is cached, determine if the owner is a partner user if(ownerInfoArray[recordOwnerId].isPartner != null) { retVal = ownerInfoArray[recordOwnerId].isPartner; valueCached = true; } } if(!valueCached) { //There are no cached details on the record owner. Query for them, and then cache them. var sql = "Select Id, IsPartner from user where id = '" + recordOwnerId + "'"; var qr2 = getsforceClient("isPartnerRecord").Query(sql); if(qr2.className == "Fault") { logError("Error querying the user record to determine IsPartner '" + recordOwnerId + "'. Error: " + qr2.faultstring); } else { if(qr2.size > 0) retVal = true; //Cache the details for future lookups var ownerEntry= { "OwnerId": recordOwnerId, "isPartner": qr2.records[0].get("IsPartner"), "userAboveRole": null }; ownerInfoArray[recordOwnerId] = ownerEntry; } } } else { logError("Could not retrieve the ownerid for the {!APPR_Workflow_Schedule__c.Object_Type__c} record id '/" + recordID + "'"); } return retVal; } //Get the database fieldnae for a given diplay name that is passed in function getDBFieldName(fieldLabel, objectName) { var retVal; //Query the array to see if fieldname has been cached, rather than querying each time for it if(describeFieldArray[fieldLabel] != undefined) { retVal = describeFieldArray[fieldLabel].fieldName; } else { //Perform a describe on the given object. var dsoResult = getsforceClient("getDBFieldName").DescribeSObject(objectName); if(dsoResult.className != "Fault") { //Get the array of field objects from the DescribeResult. fields = dsoResult.fields; //Declare the boolean and set it to false. var fieldFound = false; //Loop through the field array to see if the field exists. for(l=0;l<fields.length && fieldFound==false;l++){ var fieldFromDescribe = fields[l]; if (fieldFromDescribe.label == fieldLabel) { fieldFound = true; retVal = fieldFromDescribe.name; } } if(fieldFound == true) { //Cache the details for future lookups var fieldEntry= { "fieldLabel": fieldLabel, "fieldName": retVal }; describeFieldArray[fieldLabel] = fieldEntry; } else { logError("The field name " + fieldLabel + " does not exist on the object " + objectName); } } else { logError("DescribeSObject failed for fieldname " + fieldLabel + " on the object " + objectName + ". Error: "+ dsoResult.faultstring); } } return retVal; } //get the object prefix for the given object type function getObjectTypePrefix(objectType) { var retVal; var dsoResult = getsforceClient("getObjectTypePrefix").DescribeSObject(objectType); if(dsoResult.className != "Fault") { retVal = dsoResult.keyPrefix; } else { logError("Error retrieving information the object " + objectType + ". Error: " + dsoResult.faultstring); } return retVal; } //Update the specified value to true in the passed in record ids function updateField(recordIDS, fieldName) { //Update the passed in field field which will trigger a workflow (if the user has set one up) //array to hold object to update var createObjects = new Array(); //There is a limit of 200 records per update call. For more than 200 records you need to chunk through the records in 200 record increments for (var i = 0; i < recordIDS.length; i++){ var updateRecord = true; if({!APPR_Workflow_Schedule__c.Partner_Records_Only__c}){ //Only partner owned records should be updated. Check to see if the currently owned record is owned by a partner user if(!isPartnerRecord(recordIDS[i])) updateRecord = false; } if(updateRecord) { //Create a workflow event record in order to fire the configured workflow rule //Check that the fieldName passed in is valid var recObject = new Sforce.Dynabean("APPR_Workflow_Event__c"); recObject.set("record_url__c", getSFDCDomain() + "/" + recordIDS[i]); var recordOwnerID = getRecordOwnerID(recordIDS[i], "{!APPR_Workflow_Schedule__c.Object_Type__c}"); recObject.set("ownerid", recordOwnerID); recObject.set("record_name__c", getRecordName(recordIDS[i], "{!APPR_Workflow_Schedule__c.Object_Type__c}")); recObject.set("Record_Last_Modified__c", getRecordLastModifiedDate(recordIDS[i], "{!APPR_Workflow_Schedule__c.Object_Type__c}")); recObject.set("Record_Created__c", getRecordCreatedDate(recordIDS[i], "{!APPR_Workflow_Schedule__c.Object_Type__c}")); recObject.set("Record_Owner_Name__c", getUserName(recordOwnerID)); recObject.set("Workflow_Schedule_History__c", scheduleHistoryRunID); recObject.set(getDBFieldName(fieldName, "APPR_Workflow_Event__c" ), true); createObjects.push(recObject); if(createObjects.length >= 200) { var saveResults = getsforceClient("updateField").Create(createObjects); if (saveResults.success == false) logError("Error creating event records: " + saveResults.errors[0].message); //Resize/ empty the array updateObjects = new Array(); } } } if(createObjects.length > 0) { var saveResults = getsforceClient("updateField").Create(createObjects); if (saveResults.success == false) logError("Error creating event records: " + saveResults.errors[0].message); } return saveResults; } function stripEmail(Email){ var atsign = Email.substring(0,Email.lastIndexOf('@')+1); var domain = Email.substring(atsign.length,Email.length+1); return domain; } //Preprocessing step for named accounts. Remove records (leads) that are named account leads function preProcessNamedAccountRecords(recordIDs) { /*Not all records (leads) will be matched to named account owners. To prevent updates from going to all records, we need to remove records from the recordsIDS array that are not named account records and then proceed */ var netRecordArray = new Array(); for(var i = 0; i < recordIDs.length; i++) { var matchValue = setNamedAccountMatchValue(recordIDs[i]); if(matchValue != null && matchValue != "") { if(getNamedAccountOwner(matchValue) != null) { //The account is a named account, add it to the list netRecordArray.push(recordIDs[i]); } } } //Return the array that the rest of the process will use to the netArray of named accounts return netRecordArray; } //Removes records whose current owner is the same as the targeted new owner. This prevents false positive emails going to the owner function removeSameOwner(recordIDs) { var netRecordArray = new Array(); for(var i = 0; i < recordIDs.length; i++) { var toOwner = Left(getToOwner(recordIDs[i]),15); // The toOwner may be null where the current owner is at the top of the role hierarchy if( toOwner != null && toOwner != false && Left(getRecordOwnerID(recordIDs[i], "{!APPR_Workflow_Schedule__c.Object_Type__c}"),15) != toOwner ) { //The owners are different, add it to the list netRecordArray.push(recordIDs[i]); } } return netRecordArray; } //Logs the start of the workflow schedule process function logWorkFlowRun(scheduleID) { var retVal = true; //Log the Schedule History var updateObjects = new Array(1); var recObject = new Sforce.Dynabean("APPR_Workflow_Schedule_History__c"); recObject.set("Start_Run_Date__c", new Date()); recObject.set("Workflow_Schedule__c", scheduleID); updateObjects[0] = recObject; var saveResults = getsforceClient("logWorkFlowRun").create(updateObjects); if (saveResults[0].success == true) { scheduleHistoryRunID = saveResults[0].id; } else { //There was an error setting up the logging retVal = false; } return retVal; } //Logs the end of the workflow schedule process function logWorkFlowRunEnd(recordsInReport, recordProcessedCount, scheduleID) { //Calculate the number of records updated var updatedCount =0; for (key in recordsUpdatedArray) updatedCount++ //Get the API Call History var apiHistory=""; for (key in apiHitInfoArray) apiHistory += "\n" + key + ":" + apiHitInfoArray[key].count; apiHistory += "\n" + "logWorkFlowRunEnd: 1"; apiHistory += "\n" + "Total API Calls: " + parseInt(apiHitCount+1); //Log information about the job var lastDateRun = new Date(); var updateObjects = new Array(1); var recObject = new Sforce.Dynabean("APPR_Workflow_Schedule_History__c"); recObject.set("id", scheduleHistoryRunID); recObject.set("End_Run_Date__c", lastDateRun); recObject.set("Number_API_Calls__c", apiHitCount+1); //+1 in order to include the upcoming update call recObject.set("Number_Report_Records__c", recordsInReport); recObject.set("Number_Records_Processed__c", recordProcessedCount); recObject.set("Number_Records_Updated__c", updatedCount); recObject.set("API_Call_History__c", apiHistory); recObject.set("Workflow_Schedule__c", "{!APPR_Workflow_Schedule__c.Id}"); updateObjects[0] = recObject; var saveResults = getsforceClient("logWorkFlowRunEnd").update(updateObjects); if (saveResults.success == false) logError("Updating the last run date failed: " + saveResults.errors[0].message); //Log the last run value updateObjects = new Array(1); recObject = new Sforce.Dynabean("APPR_Workflow_Schedule__c"); recObject.set("id", scheduleID); recObject.set("Last_Run__c", lastDateRun); updateObjects[0] = recObject; saveResults = getsforceClient("logWorkFlowRunEnd").update(updateObjects); if (saveResults.success == false) logError("Updating the last run date failed: " + saveResults.errors[0].message); else retVal = true; } //Logs an error in the processing function logError(message) { if(scheduleHistoryRunID != null) { var updateObjects = new Array(1); var recObject = new Sforce.Dynabean("APPR_Workflow_Schedule_Messages__c"); recObject.set("Workflow_Schedule_History__c", scheduleHistoryRunID); recObject.set("Message__c", Left(message,255)); updateObjects[0] = recObject; var saveResults = getsforceClient("logError").create(updateObjects); loggedError = true; } } //Updates the workflow schedule history function updateScheduleHasError() { var updateObjects = new Array(1); var recObject = new Sforce.Dynabean("APPR_Workflow_Schedule_History__c"); recObject.set("id", scheduleHistoryRunID); recObject.set("Has_Error__c", true); updateObjects[0] = recObject; var saveResults = getsforceClient("updateScheduleHasError").update(updateObjects); if (saveResults.success == false) logError("Error updating records: " + saveResults.errors[0].message); } //Maintains an array of unique records that have been updated function updateRecordUpdateCount(updates) { for(i=0;i<updates.length;i++) { var recId = updates[i].get("id"); if(recordsUpdatedArray[recId] == undefined) recordsUpdatedArray[recId] = recId; } } //Function to hide the progress meter when an error occurrs. function hideProgressImg() { document.getElementById('progress').style.display = 'none'; } //Return the sforceclient variable and increments the API hit variable function getsforceClient(callingFunction) { apiHitCount += 1; //Track where the API hits are coming from if(apiHitInfoArray[callingFunction] != undefined) { apiHitInfoArray[callingFunction].count = parseInt(apiHitInfoArray[callingFunction].count) + 1; } else { var entry = { "count": "1" }; apiHitInfoArray[callingFunction] = entry; } return sforceClient; } // Show the debug window function showDebug() { window.top.debugWindow = window.open("", "Debug", "left=0,top=0,width=300,height=700,scrollbars=yes," +"status=yes,resizable=yes"); window.top.debugWindow.opener = self; // open the document for writing window.top.debugWindow.document.open(); window.top.debugWindow.document.write( "<HTML><HEAD><TITLE>Debug Window</TITLE></HEAD><BODY><PRE>\n"); //getsforceClient().debuglog.show(); } // If the debug window exists, then write to it function debug(val) { if (window.top.debugWindow && ! window.top.debugWindow.closed) { window.top.debugWindow.document.write(val+"\n"); } //getsforceClient().debuglog.writeln(val); } //Return the 'n' number of characters from the left of the string function Left(str, n){ if (n <= 0) return ""; else if (n > String(str).length) return str; else return String(str).substring(0,n); } function checkForNull(value) { if(value != null) return value; else return ""; } //Get the sfdc instance in use function getSFDCDomain() { var retVal=""; var curUrl = window.location.href; var loc = curUrl.indexOf('.com'); if(loc > 0) retVal = Left(curUrl, loc+4) return retVal; } //Returns a URL Parm function getURLParam(strParamName){ var strReturn = ""; var strHref = window.location.href; //var strHref = href; if ( strHref.indexOf("?") > -1 ){ var strQueryString = strHref.substr(strHref.indexOf("?")); var aQueryString = strQueryString.split("&"); for ( var iParam = 0; iParam < aQueryString.length; iParam++ ){ if ( aQueryString[iParam].indexOf(strParamName + "=") > -1 ){ var aParam = aQueryString[iParam].split("="); strReturn = aParam[1]; break; } } } return strReturn; } --> </script> <body onload="printStart();" class="setup "> <TABLE cellSpacing=0 cellPadding=8 width="100%" border=0> <TR> <TD> <DIV class=alertBox> <DIV class=content> <TABLE cellSpacing=5 cellPadding=0 width="100%" border=0> <TBODY> <TR> <div id="header"></div> <div id="output" style="font-family: monospace; font-size:10pt;"></div><br> <TD noWrap colSpan=2><SPAN class=bodyBold>Running Workflow Tips</SPAN></TD> </TR> <TR> <TD class=blackLine colSpan=2 height=1><IMG height=1 alt="" src="cool.thmk_files/s.gif" width=1 border=0></TD></TR> <TR> <TD vAlign=top align=right width="1%"><li></li></TD> <TD vAlign=top align=left class="resource">This window stays up for the duration of the processing time and closes upon completion</TD></TR> <TR> <TD vAlign=top align=right width="1%"><li></li></TD> <TD vAlign=top align=left>Schedules impacting a large number of records and updates can take several minutes to complete</TD></TR> <TR> <TD vAlign=top align=right width="1%"><li></li></TD> <TD vAlign=top align=left>Consider running large schedules using an automated scheduler to kick off the process. Refer to the customization and enhancement guide in the AppExchange listing for details</TD></TR> <TR> <TD vAlign=top align=right width="1%"><li></li></TD> <TD vAlign=top align=left>Any errors encountered are reported in detail in the "Schedule Messages" related list</TD></TR> <TR> <TD vAlign=top align=right width="1%"><li></li></TD> <TD vAlign=top align=left>The "Schedule History" related list shows a checkmark next to the scheduled runs with errors</TD></TR> <TR> <TD vAlign=bottom colSpan=2><BR><SPAN class=bodyBold>* It is recommended that you test the schedule with a small number of records first to ensure you have correctly defined the schedule</SPAN></TD></TR> </TBODY> </table> </DIV> </DIV> </TD> </TR> </TABLE> </body> </html>

Time Based Worfklow New Code

TrackBack

Comments