Migrating Review Form Responses to Custom Properties

Building the Custom Properties

For this code to work, you'll need to build a Custom Property for each response you want to capture. For example, if your Evaluation Form has three questions, and you have two reviewers that will complete it, and you want to capture each response to each question, you'll need to add six of these Custom Properties. You'll add JavaScript code that instructs the Custom Property to pull in your reviewers' Evaluation Form responses.

1. When configuring your Custom Property, enter a Label that will describe which form, question, and reviewer number you want to target. For example, use the Label  "Initial Review - Personal Statement Rating - 2" to capture the second reviewer's response to the Personal Statement question on your "Initial Review" Evaluation Form.
2. Select a Data Type that matches the output you expect to get from your Evaluation Form response.
3. In the Expression area, add the following code. (Use the view source icon at the top right to copy the code.)

{
  /* * * * * * * * * * * * *
   * * USER INPUT SECTION * *
   * * * * * * * * * * * * */
  
  // use this field to add the phase key
  let phaseId = "ready_for_faculty_review";
  
  // use this field to add the evaluation form key
  let evaluationForm = "faculty_review_form";
  
  // use this field to determine the number recommendation you want to output.
  let evaluationNumber = 1;
  
  // use this field to add the evaluation question key  
  let evaluationQuestion = "short_comment";
  
  // use this field to define the question type (as defined on the evaluation form) so the correct output is processed
  // type1: scale, text, paragraph text, drop down, number, multiple choice, date, email address, phone number, url
  // type2: check boxes, table
  // type3: scale group, address, name
  let questionType = "type1";
  
  /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  This function takes five inputs to return a single question response from the Outcomes Evaluation Data Object.
  NOTE: phases variable is available globally, does not need to be defined.
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
  
  function getEvaluationData(phases, phaseId, evaluationForm, evaluationNumber, evaluationQuestion, questionType) {
  
      let evals;
      
      // NOTE: Sort evaluations by created date in descending order (oldest to newest)
      if ((phases) &&
          (phases[evaluationForm]) &&
          (phases[evaluationForm].evaluations) &&
          (phases[evaluationForm].evaluations.length)) {
  
          evals = phases[evaluationForm].evaluations.sort((evalA, evalB) => {
              let evalACreatedDate = new Date(evalA.dateCreated).getTime();
              let evalBCreatedDate = new Date(evalB.dateCreated).getTime();
              return evalACreatedDate - evalBCreatedDate;
          });
      } else if ((phases) &&
          (phases[phaseId]) &&
          (phases[phaseId].evaluations) &&
          (phases[phaseId].evaluations.length)) {
  
          evals = phases[phaseId].evaluations.sort((evalA, evalB) => {
              let evalACreatedDate = new Date(evalA.dateCreated).getTime();
              let evalBCreatedDate = new Date(evalB.dateCreated).getTime();
              return evalACreatedDate - evalBCreatedDate;
          });
      }
  
      // NOTE: Evaluation Export Business Logic
      if ((evals) &&
          (evals[evaluationNumber - 1]) &&
          (evals[evaluationNumber - 1].form) &&
          (evals[evaluationNumber - 1].form[evaluationQuestion])) {
  
          let returnObject = evals[evaluationNumber - 1].form[evaluationQuestion];
  
          if (questionType == "type1") {
              return returnObject;
          } else if (questionType == "type2") {
              return returnObject.toString();
          } else if (questionType == "type3") {
              return Object.keys(returnObject).map((key) => { return key + ": " + returnObject[key] }).reduce((accumulator, currentValue) => { return accumulator + currentValue + ",  " }, "");
          } else {
              return;
          };
  
      } else if ((evals) &&
          (evals[evaluationNumber - 1]) &&
          (evals[evaluationNumber - 1].form) &&
          (evals[evaluationNumber - 1].form[evaluationQuestion])) {
  
          let returnObject = evals[evaluationNumber - 1].form[evaluationQuestion];
  
          if (questionType == "type1") {
              return returnObject;
          } else if (questionType == "type2") {
              return returnObject.toString();
          } else if (questionType == "type3") {
              return Object.keys(returnObject).map((key) => { return key + ": " + returnObject[key] }).reduce((accumulator, currentValue) => { return accumulator + currentValue + ",  " }, "");
          } else {
              return;
          };
      } else {
          return;
      }
  }
}

4. Make these adjustments so that the Custom Property works with your data:
   • Replace the phaseid "ready_for_faculty_review" with the key used in the Phase your Evaluation Form is associated with.
   • Replace "faculty_review" with the key used in your Evaluation Form.
   • Replace "review_question" with the key used in the question you're working with.
   • Replace evaluationNumber=1 with the reviewer you want to target. For example, use evaluationNumber=3 to capture the 3rd reviewer's response to this question.
5. Update the questionType variable based on the type of question you are working with:
   • Leave the default, type1, if your question is any of the following types: scale, text, paragraph text, drop down, number, multiple choice, date, email address, phone number, or url.
   • Change the questionType variable to type2 if your question type is check boxes or table.
   • Change the questionType variable to type3 if your question type is scale group, address, or name. 
6. Save your Custom Property and repeat these steps for each form, question, and response you need to migrate.

let phaseId = "ready_for_faculty_review";
// Here, you're telling Outcomes to look at the Ready for Faculty Review Phase.
let evaluationForm="committee_review";
// Here, you're telling Outcomes to look at the Committee Review Evaluation Form.
let evaluationNumber=1;
// Here, you're indicating which evaluator's results should be pulled in. Use 1 to pull in the response from the first evaluator.
let evaluationQuestion="committee_decision";
// Here, you're telling Outcomes to look at the Committee Decision question.

Displaying the Form Responses

Once you've added the JavaScript to capture these Review Form responses in Custom Properties, you can then display the responses in several areas.