Complete button 1

Author: “Carmel

.gitignore

@@ -1,3 +1,4 @@
 venv/
 new_ldot_workflows/ldot_config.json
-new_ldot_workflows/qualtrics_settings.py
+new_ldot_workflows/qualtrics_settings.py
+scratch.py

app.py

@@ -29,7 +29,8 @@ def index():
 
 @app.route("/api/button1", methods=["POST"])
 def button1():
-    """Get the participants who have not yet been added to Qualtrics"""
+    """Get the participants who have not yet been given a survey link and return their subjectIDs"""
+    
     data = request.json
     study_id = data.get("study_id")
     print(f"Received study_id: {study_id}")
@@ -39,61 +40,61 @@ def button1():
         return jsonify({"success": False, "message": f"Unknown study_id: {study_id}"}), 400
 
     ldot_study_id = ldot_vars.get("ldot_study_id")
-    link_creation_eaid = ldot_vars.get("link_creation_eaid") or ldot_vars.get("survey_progress_wait_for_entry_eaid")
+    link_creation_eaid = ldot_vars.get("eaid_qualtrics_survey_link_creation_to_do_date")
 
-    subject_ids = get_new_subjects(ldot_study_id, link_creation_eaid)
+    new_subjects_ids = get_new_subjects(ldot_study_id, link_creation_eaid)
 
-    message = f"Found {len(subject_ids)} subject IDs for study {study_id}" if study_id else f"Found {len(subject_ids)} subject IDs"
-    return jsonify({"success": True, "message": message, "subject_ids": subject_ids})
+    message = f"Found {len(new_subjects_ids)} new subjects in this study"
+    return jsonify({"success": True, "message": message, "new_subject_ids": new_subjects_ids})
 
 
 
 @app.route("/api/button2", methods=["POST"])
 def button2():
-    """Second API call - uses subjectIDs from button1"""
+    """Uses subjectIDs from button 1 to add them to Qualtrics and send the links back to LDOT"""
     data = request.json
     study_id = data.get("study_id")
-    subject_ids = data.get("subject_ids")
+    new_subject_ids = data.get("new_subject_ids")
 
     if not study_id:
         return jsonify({"success": False, "message": "Missing study_id in request"}), 400
 
-    if not subject_ids:
-        return jsonify({"success": False, "message": "Missing subject_ids in request"}), 400
+    if not new_subject_ids:
+        return jsonify({"success": False, "message": "Missing new_subject_ids in request"}), 400
 
     # Lookup study variables from STUDIES config
     study, ldot_vars, qualtrics_vars = get_study_settings(study_id)
-    if not study:
-        return jsonify({"success": False, "message": f"Unknown study_id: {study_id}"}), 400
 
     ldot_study_id = ldot_vars.get("ldot_study_id")
-    survey_id = qualtrics_vars.get("survey_id")
+    qualtrics_survey_id = qualtrics_vars.get("survey_id")
     mailing_list_id = qualtrics_vars.get("mailing_list_id")
     embedded_data_field = qualtrics_vars.get("embedded_data_field")
     directory_id = qualtrics_vars.get("directory_id")
     distribution_id = qualtrics_vars.get("distribution_id")
-    link_creation_eaid = ldot_vars.get("link_creation_eaid") or ldot_vars.get("survey_progress_wait_for_entry_eaid")
-    
+
+
+    # link_creation_eaid = ldot_vars.get("eaid_qualtrics_survey_link_creation_to_do_date") or ldot_vars.get("eaid_qualtrics_survey_link_creation_completed")
+
     if not ldot_study_id:
         return jsonify({"success": False, "message": f"Missing ldot_study_id for study_id: {study_id}"}), 400
 
     debug_inputs = {
         "study_id": study_id,
         "ldot_study_id": ldot_study_id,
-        "subject_ids": subject_ids,
-        "survey_id": survey_id,
+        "new_subject_ids": new_subject_ids,
+        "qualtrics_survey_id": qualtrics_survey_id,
         "mailing_list_id": mailing_list_id,
         "embedded_data_field": embedded_data_field,
         "directory_id": directory_id,
         "distribution_id": distribution_id
     }
 
-    participant_to_link_dict = add_individuals_to_survey(subject_ids, embedded_data_field, distribution_id, survey_id, mailing_list_id, directory_id)
-    send_links_to_ldot(ldot_study_id, link_creation_eaid)
+    participant_to_link_dict = add_individuals_to_survey(new_subject_ids, embedded_data_field, distribution_id, qualtrics_survey_id, mailing_list_id, directory_id)
+    # send_links_to_ldot(ldot_study_id, link_creation_eaid)
 
     return jsonify({
         "success": True,
-        "message": f"Processed {len(subject_ids)} subject IDs for study {study_id}",
+        "message": f"Processed {len(new_subject_ids)} subject IDs for study {study_id}",
         "debug_inputs": debug_inputs,
         "participant_to_link_dict": participant_to_link_dict,
     })
@@ -142,17 +143,17 @@ def button4():
     if not study:
         return jsonify({"success": False, "message": f"Unknown study_id: {study_id}"}), 400
 
-    survey_id = vars.get("survey_id")
+    qualtrics_survey_id = vars.get("qualtrics_survey_id")
     embedded_data_field = vars.get("embedded_data_field")
 
-    participant_to_progress_dict = get_individual_progress(subject_ids, embedded_data_field, survey_id)
+    participant_to_progress_dict = get_individual_progress(subject_ids, embedded_data_field, qualtrics_survey_id)
 
 
     return jsonify({
         "success": True,
         "message": f"Retrieved progress for {len(participant_to_progress_dict)} subjects",
         "study_id": study_id,
-        "survey_id": survey_id,
+        "qualtrics_survey_id": qualtrics_survey_id,
         "embedded_data_field": embedded_data_field,
         "progress_results": participant_to_progress_dict,
     })

new_ldot_workflows/__pycache__/b_1_get_new_subjects.cpython-311.pyc

@@ -40,4 +40,5 @@ def get_new_subjects(study_id: str, link_creation_eaid: str) -> list:
     ]
 
 if __name__ == "__main__":
+    # For testing purposes
     print(get_new_subjects("5c9c6a47-c8d7-8142-a8c8-ccdcb8a8044b", "5d31129c-d814-5d4b-a96f-048cadc150ce"))

new_ldot_workflows/__pycache__/b_2_get_qualtrics_links.cpython-311.pyc

@@ -29,7 +29,6 @@ def check_contact_in_mailing_list(participant_study_id: str, mailing_list_id: st
 
 def add_contact_to_mailing_list(participant_study_id: str, embedded_data_field: str, mailing_list_id: str, directory_id: str) -> None:
     """Add contact to a mailing list"""
-    print(participant_study_id)
 
     endpoint = f"{BASE_URL}/directories/{directory_id}/mailinglists/{mailing_list_id}/contacts"
     contact_information_payload ={
@@ -40,7 +39,6 @@ def add_contact_to_mailing_list(participant_study_id: str, embedded_data_field:
     }
     try:
         response = requests.post(endpoint, headers=HEADERS, json=contact_information_payload)
-        print(response.json())
         response.raise_for_status()
 
     except requests.exceptions.RequestException as exc:
@@ -52,14 +50,14 @@ def add_contact_to_mailing_list(participant_study_id: str, embedded_data_field:
             f"Unexpected response format when adding contact to mailing list."
         ) from exc
 
-def get_personal_link(survey_id: str, distribution_id: str, participant_study_id: str) -> str:
+def get_personal_link(qualtrics_survey_id: str, distribution_id: str, participant_study_id: str) -> str:
     """Get the person link of an individual for a specified survey. Returns personal link for the participant, looks like
         https://survey.uu.nl/jfe/form/SV_efCMOg6wHU0T8ii?Q_CHLqe2Pdrma&_g_=g
     """
     print(f"Fetching personal link for {participant_study_id}... ")
     endpoint = f"{BASE_URL}/distributions/{distribution_id}/links"
     parameters = {
-        "surveyId": str(survey_id)
+        "surveyId": str(qualtrics_survey_id)
     }
     try:
         response = requests.get(endpoint, headers=HEADERS, params=parameters)
@@ -77,7 +75,7 @@ def get_personal_link(survey_id: str, distribution_id: str, participant_study_id
             f"Unexpected response format when fetching personal link of individual {participant_study_id}."
         ) from exc    
 
-def add_individuals_to_survey(participant_ids_list: list, embedded_data_field, distribution_id, survey_id, mailing_list_id, directory_id):
+def add_individuals_to_survey(participant_ids_list: list, embedded_data_field, distribution_id, qualtrics_survey_id, mailing_list_id, directory_id):
     participant_to_link_dict = {}
     for participant_id in participant_ids_list:
         contact_exists = check_contact_in_mailing_list(participant_id, mailing_list_id, directory_id)
@@ -87,27 +85,25 @@ def add_individuals_to_survey(participant_ids_list: list, embedded_data_field, d
         else:
             print(f"Participant study ID {participant_id} already exists in this mailing list")
 
-        personal_link = get_personal_link(survey_id, distribution_id, participant_id)
+        personal_link = get_personal_link(qualtrics_survey_id, distribution_id, participant_id)
 
         participant_to_link_dict[participant_id] = personal_link
 
-    print(participant_to_link_dict)
     return participant_to_link_dict
 
 if __name__ == "__main__":
     # # Example usage
     participant_study_id = ["11111TEST11111", "22222TEST22222", "33333TEST33333"]
     embedded_data_field = "study_id_child"
-    survey_id="SV_efCMOg6wHU0T8ii"
+    qualtrics_survey_id="SV_efCMOg6wHU0T8ii"
     mailing_list_id="CG_2dMbO6WUBMnCeIK"
     distribution_id="EMD_7AEa416lRwFhrkF"
     directory_id="POOL_10pyxk9leSUisrT"
 
 
+    link = add_individuals_to_survey(participant_study_id, embedded_data_field, distribution_id, qualtrics_survey_id, mailing_list_id, directory_id)
 
+    print(link)
 
-    link = add_individuals_to_survey(participant_study_id, embedded_data_field, distribution_id, survey_id, mailing_list_id, directory_id)
-
-
-    # print(link)
+    
     # print(get_mailing_list_id_of_distribution("SV_efCMOg6wHU0T8ii",  "EMD_SZFeoK7LAJBHU4d"))

new_ldot_workflows/b_1_get_new_subjects.py

@@ -1,34 +1,14 @@
 LDOT-001:
   name: PIAMA study
   ldot_variables:
-    ldot_study_id: 96a54061-555d-d74b-8e0b-84d43853897e
-    link_creation_eaid: 5c9c6a47-c8d7-8142-a8c8-ccdcb8a8044b #Action event 
-    linked_created_survey_eaid: "?"
-    survey_progress_wait_for_entry_eaid: 9f09f2cf-32cc-844d-9a41-7a44accd3dfd
-    survey_progress_completed_eaid: 120d298d-9aa9-084b-abc6-432148db0e10
+    ldot_study_id: 5c9c6a47-c8d7-8142-a8c8-ccdcb8a8044b
+    eaid_qualtrics_survey_link_creation_to_do_date: 5d31129c-d814-5d4b-a96f-048cadc150ce #Action event for when the qualtrics survey link creation  hasn't been done
+    eaid_qualtrics_survey_link_creation_completed: 31599192-8e9b-4341-b7f4-8b8967dd846a #Action event for when the qualtrics survey link creation is completed
+    # survey_progress_wait_for_entry_eaid: 9f09f2cf-32cc-844d-9a41-7a44accd3dfd
+    # survey_progress_completed_eaid: 120d298d-9aa9-084b-abc6-432148db0e10
   qualtrics_variables:
-    survey_id: SV_efCMOg6wHU0T8ii
+    qualtrics_survey_id: SV_efCMOg6wHU0T8ii
     directory_id: POOL_10pyxk9leSUisrT
     distribution_id: EMD_7AEa416lRwFhrkF
     mailing_list_id: CG_2dMbO6WUBMnCeIK
-    embedded_data_field: study_id_child
-
-LDOT-002:
-  name: 
-  ldot_variables:
-    ldot_study_id: 
-  qualtrics_variables:
-    survey_id: 
-    mailing_list_id: 
-    embedded_data_field: 
-
-LDOT-003:
-  name: 
-  ldot_variables:
-    ldot_study_id: 
-  qualtrics_variables:
-    survey_id: 
-    directory_id: 
-    distribution_id: 
-    mailing_list_id: 
-    embedded_data_field: 
+    embedded_data_field: study_id_child

new_ldot_workflows/b_2_get_qualtrics_links.py

@@ -219,6 +219,13 @@ <h1>LDOT Qualtrics API Workflow</h1>
     </div>
 
     <script>
+        const buttonLabels = {
+            1: 'Find new subjects in Ldot',
+            2: 'Create Qualtrics survey links and send to Ldot',
+            3: "Find subjects' survey completion status",
+            4: 'Send survey completion status to Ldot'
+        };
+
         const state = {
             selectedStudy: null,
             completed: [false, false, false, false],
@@ -287,7 +294,7 @@ <h1>LDOT Qualtrics API Workflow</h1>
                     row.classList.add('completed');
                     row.classList.remove('error');
                     btn.className = '';
-                    btn.textContent = `Step ${step} ✓`;
+                    btn.textContent = buttonLabels[step];
 
                     // Store subject_ids if returned
                     if (data.subject_ids) {
@@ -311,7 +318,7 @@ <h1>LDOT Qualtrics API Workflow</h1>
                 row.classList.add('error');
                 row.classList.remove('completed');
                 btn.className = '';
-                btn.textContent = `Execute Step ${step}`;
+                btn.textContent = buttonLabels[step];
             }
         }
 
@@ -326,7 +333,7 @@ <h1>LDOT Qualtrics API Workflow</h1>
                 const row = document.getElementById(`row-${i}`);
 
                 btn.className = '';
-                btn.textContent = `Execute Step ${i}`;
+                btn.textContent = buttonLabels[i];
                 btn.disabled = true;
                 output.textContent = 'No output yet';
                 output.className = 'output empty';