<%= if @popup do %>
<.popup>
diff --git a/core/systems/project/tool_ref_model.ex b/core/systems/project/tool_ref_model.ex
index b1524d8bd..48846037b 100644
--- a/core/systems/project/tool_ref_model.ex
+++ b/core/systems/project/tool_ref_model.ex
@@ -6,7 +6,7 @@ defmodule Systems.Project.ToolRefModel do
alias Systems.{
Project,
- Survey,
+ Questionnaire,
Lab,
DataDonation,
Benchmark
@@ -14,7 +14,7 @@ defmodule Systems.Project.ToolRefModel do
schema "tool_refs" do
has_one(:item, Project.ItemModel, foreign_key: :tool_ref_id)
- belongs_to(:survey_tool, Survey.ToolModel)
+ belongs_to(:questionnaire_tool, Questionnaire.ToolModel)
belongs_to(:lab_tool, Lab.ToolModel)
belongs_to(:data_donation_tool, DataDonation.ToolModel)
belongs_to(:benchmark_tool, Benchmark.ToolModel)
@@ -34,13 +34,15 @@ defmodule Systems.Project.ToolRefModel do
def preload_graph(:down),
do:
preload_graph([
- :survey_tool,
+ :questionnaire_tool,
:lab_tool,
:data_donation_tool,
:benchmark_tool
])
- def preload_graph(:survey_tool), do: [survey_tool: Survey.ToolModel.preload_graph(:full)]
+ def preload_graph(:questionnaire_tool),
+ do: [questionnaire_tool: Questionnaire.ToolModel.preload_graph(:full)]
+
def preload_graph(:lab_tool), do: [lab_tool: Lab.ToolModel.preload_graph(:full)]
def preload_graph(:data_donation_tool),
diff --git a/core/systems/questionnaire/_public.ex b/core/systems/questionnaire/_public.ex
new file mode 100644
index 000000000..a51abfc27
--- /dev/null
+++ b/core/systems/questionnaire/_public.ex
@@ -0,0 +1,134 @@
+defmodule Systems.Questionnaire.Public do
+ @moduledoc """
+
+ Questionnaire tools allow a researcher to setup a link to an external questionnaire
+ tool. The participant goes through the flow described below:
+
+ - Receive invitation to start a questionnaire (mail, push etc.).
+ - Open questionnaire tool, this opens it on the platform and requires authentication.
+ - The participant is then redirected to the questionnaire at a 3rd party web-application.
+ - After completion the user is redirect back to the platform.
+ - The platform registers the completion of this questionnaire for the participant.
+
+
+ A researcher is required to configure the 3rd party application with a redirect
+ link. The redirect link to be used is show on the questionnaire tool configuration
+ screen (with copy button).
+
+ IDEA: The tool requires a sucessful round-trip with a verify flow to ensure
+ that everything is configured correctly.
+
+ Participants need to be invited to a particular questionnaire explicitly. This avoids
+ the situation where a new user joins a study and then can immediately complete
+ previous questionnaires.
+
+ Once a participant has completed a questionnaire they are no longer allowed to enter it
+ a second time. The status is clearly shown when the attempt to do so.
+
+ IDEA: A list of questionnaires can be access by the notification icon which is shown
+ on all screens.
+ """
+
+ import Ecto.Query, warn: false
+ alias Ecto.Multi
+ alias Core.Repo
+
+ alias Frameworks.{
+ Signal
+ }
+
+ alias Systems.{
+ Questionnaire
+ }
+
+ @doc """
+ Returns the list of questionnaire_tools.
+ """
+ def list_questionnaire_tools do
+ Repo.all(Questionnaire.ToolModel)
+ end
+
+ @doc """
+ Gets a single questionnaire_tool.
+
+ Raises `Ecto.NoResultsError` if the Questionnaire tool does not exist.
+ """
+ def get_questionnaire_tool!(id), do: Repo.get!(Questionnaire.ToolModel, id)
+ def get_questionnaire_tool(id), do: Repo.get(Questionnaire.ToolModel, id)
+
+ @doc """
+ Creates a questionnaire_tool.
+ """
+ def create_tool(attrs, auth_node) do
+ %Questionnaire.ToolModel{}
+ |> Questionnaire.ToolModel.changeset(:mount, attrs)
+ |> Ecto.Changeset.put_assoc(:auth_node, auth_node)
+ |> Repo.insert()
+ end
+
+ @doc """
+ Updates a questionnaire_tool.
+ """
+ def update_questionnaire_tool(%Questionnaire.ToolModel{} = questionnaire_tool, type, attrs) do
+ questionnaire_tool
+ |> Questionnaire.ToolModel.changeset(type, attrs)
+ |> update_questionnaire_tool()
+ end
+
+ def update_questionnaire_tool(_, _, _), do: {:error, nil}
+
+ def update_questionnaire_tool(changeset) do
+ result =
+ Multi.new()
+ |> Repo.multi_update(:tool, changeset)
+ |> Repo.transaction()
+
+ with {:ok, %{tool: tool}} <- result do
+ Signal.Public.dispatch!(:questionnaire_tool_updated, tool)
+ end
+
+ result
+ end
+
+ @doc """
+ Deletes a questionnaire_tool.
+ """
+ def delete_questionnaire_tool(%Questionnaire.ToolModel{} = questionnaire_tool) do
+ Repo.delete(questionnaire_tool)
+ end
+
+ @doc """
+ Returns an `%Ecto.Changeset{}` for tracking questionnaire_tool changes.
+ """
+ def change_questionnaire_tool(
+ %Questionnaire.ToolModel{} = questionnaire_tool,
+ type,
+ attrs \\ %{}
+ ) do
+ Questionnaire.ToolModel.changeset(questionnaire_tool, type, attrs)
+ end
+
+ def copy(%Questionnaire.ToolModel{} = tool, auth_node) do
+ %Questionnaire.ToolModel{}
+ |> Questionnaire.ToolModel.changeset(:copy, Map.from_struct(tool))
+ |> Ecto.Changeset.put_assoc(:auth_node, auth_node)
+ |> Repo.insert!()
+ end
+
+ def ready?(%Questionnaire.ToolModel{} = questionnaire_tool) do
+ changeset =
+ %Questionnaire.ToolModel{}
+ |> Questionnaire.ToolModel.operational_changeset(Map.from_struct(questionnaire_tool))
+
+ changeset.valid?
+ end
+end
+
+defimpl Core.Persister, for: Systems.Questionnaire.ToolModel do
+ def save(_tool, changeset) do
+ case Systems.Questionnaire.Public.update_questionnaire_tool(changeset) do
+ {:ok, %{tool: tool}} -> {:ok, tool}
+ _ -> {:error, changeset}
+ end
+ end
+end
diff --git a/core/systems/survey/experiment_task_view.ex b/core/systems/questionnaire/experiment_task_view.ex
similarity index 91%
rename from core/systems/survey/experiment_task_view.ex
rename to core/systems/questionnaire/experiment_task_view.ex
index 4002c81a3..a45cbe705 100644
--- a/core/systems/survey/experiment_task_view.ex
+++ b/core/systems/questionnaire/experiment_task_view.ex
@@ -1,4 +1,4 @@
-defmodule Systems.Survey.ExperimentTaskView do
+defmodule Systems.Questionnaire.ExperimentTaskView do
use CoreWeb, :live_component
alias Frameworks.Utility.LiveCommand
diff --git a/core/systems/survey/tool_form.ex b/core/systems/questionnaire/tool_form.ex
similarity index 73%
rename from core/systems/survey/tool_form.ex
rename to core/systems/questionnaire/tool_form.ex
index 379c3eef0..1d76a5291 100644
--- a/core/systems/survey/tool_form.ex
+++ b/core/systems/questionnaire/tool_form.ex
@@ -1,4 +1,4 @@
-defmodule Systems.Survey.ToolForm do
+defmodule Systems.Questionnaire.ToolForm do
use CoreWeb.LiveForm
import CoreWeb.UI.StepIndicator
@@ -11,7 +11,7 @@ defmodule Systems.Survey.ToolForm do
alias Systems.{
Director,
- Survey
+ Questionnaire
}
# Handle initial update
@@ -25,9 +25,9 @@ defmodule Systems.Survey.ToolForm do
},
socket
) do
- entity = Survey.Public.get_survey_tool!(entity_id)
+ entity = Questionnaire.Public.get_questionnaire_tool!(entity_id)
- changeset = Survey.ToolModel.changeset(entity, :create, %{})
+ changeset = Questionnaire.ToolModel.changeset(entity, :create, %{})
{
:ok,
@@ -52,13 +52,13 @@ defmodule Systems.Survey.ToolForm do
_params,
%{assigns: %{user: user, changeset: changeset, entity: entity}} = socket
) do
- changeset = Survey.ToolModel.validate(changeset, :roundtrip)
+ changeset = Questionnaire.ToolModel.validate(changeset, :roundtrip)
if changeset.valid? do
Director.public(entity).assign_tester_role(entity, user)
fake_panl_id = "TEST-" <> Faker.UUID.v4()
- external_path = Survey.ToolModel.external_path(entity, fake_panl_id)
+ external_path = Questionnaire.ToolModel.external_path(entity, fake_panl_id)
{:noreply, LiveView.redirect(socket, external: external_path)}
else
@@ -78,7 +78,7 @@ defmodule Systems.Survey.ToolForm do
# Saving
def save(socket, entity, type, attrs) do
- changeset = Survey.ToolModel.changeset(entity, type, attrs)
+ changeset = Questionnaire.ToolModel.changeset(entity, type, attrs)
socket
|> save(changeset)
@@ -89,7 +89,7 @@ defmodule Systems.Survey.ToolForm do
def validate_for_publish(%{assigns: %{id: id, entity: entity}} = socket) do
changeset =
- Survey.ToolModel.operational_changeset(entity, %{})
+ Questionnaire.ToolModel.operational_changeset(entity, %{})
|> Map.put(:action, :validate_for_publish)
send(self(), %{id: id, ready?: changeset.valid?})
@@ -100,21 +100,21 @@ defmodule Systems.Survey.ToolForm do
defp redirect_instructions_link() do
link_as_string(
- dgettext("link-survey", "redirect.instructions.link"),
+ dgettext("link-questionnaire", "redirect.instructions.link"),
"https://www.qualtrics.com/support/survey-platform/survey-module/survey-options/survey-termination/#RedirectingRespondentsToAUrl"
)
end
defp panlid_instructions_link() do
link_as_string(
- dgettext("link-survey", "panlid.instructions.link"),
- "https://www.qualtrics.com/support/survey-platform/survey-module/survey-flow/standard-elements/passing-information-through-query-strings/?parent=p001135#PassingInformationIntoASurvey"
+ dgettext("link-questionnaire", "panlid.instructions.link"),
+ "https://www.qualtrics.com/support/survey-platform/survey-module/survey-flow/standard-elements/passing-information-through-query-strings/?parent=p001135#PassingInformationIntoAQuestionnaire"
)
end
defp study_instructions_link() do
link_as_string(
- dgettext("link-survey", "study.instructions.link"),
+ dgettext("link-questionnaire", "study.instructions.link"),
"https://www.qualtrics.com/support/survey-platform/distributions-module/web-distribution/anonymous-link/#ObtainingTheAnonymousLink"
)
end
@@ -134,12 +134,12 @@ defmodule Systems.Survey.ToolForm do
~H"""
<.form id={@id} :let={form} for={@changeset} phx-change="save" phx-target={@myself}>
-
<%= dgettext("link-survey", "form.title") %>
-
<%= dgettext("link-survey", "form.description") %>
+
<%= dgettext("link-questionnaire", "form.title") %>
+
<%= dgettext("link-questionnaire", "form.description") %>
<.spacing value="M" />
- <%= dgettext("link-survey", "setup.title") %>
+ <%= dgettext("link-questionnaire", "setup.title") %>
<.spacing value="M" />
@@ -148,9 +148,9 @@ defmodule Systems.Survey.ToolForm do
<.step_indicator text="1" bg_color="bg-tertiary" text_color="text-grey1" />
- <%= dgettext("link-survey", "panlid.title") %>
+ <%= dgettext("link-questionnaire", "panlid.title") %>
<.spacing value="XS" />
- <%= raw(dgettext("link-survey", "panlid.description", link: panlid_instructions_link())) %>
+ <%= raw(dgettext("link-questionnaire", "panlid.description", link: panlid_instructions_link())) %>
@@ -159,9 +159,9 @@ defmodule Systems.Survey.ToolForm do
<.step_indicator text="2" bg_color="bg-tertiary" text_color="text-grey1" />