experiment.yaml

# NOTE: Experimentation Inventory has no Search. Records remain in the Registry DB. (2024-04)
collection: experiment
dataset_type: experiment
title: Experimentation Inventory
notes: Access, upload and modify the Experimentation Inventory for your organization
portal_type: info
target_dataset: experiment
template_version: 3

resources:
  - resource_name: experiment

    published_resource_id: 07151ad9-52e2-4f99-b4fd-7cd208816a64

    title: "Experimentation Inventory"

    datastore_indexes: ""
    datastore_primary_key: reference_number
    default_preview_sort: reference_number
    create_form: true
    edit_form: true

    excel_data_height: 32
    excel_data_num_rows: 500
    excel_example_height: 32

    fields:

      - datastore_id: reference_number
        datastore_type: text
        description:
          en: "This field is populated by the user with the reference number of the Experiment. This number is a mandatory system requirement when publishing a template."
          fr: "Ce champ est rempli par l’utilisateur avec le numéro de référence de l'experiment. Le numéro est une exigence de système obligatoire pour la publication d’un modèle."
        excel_required: true
        format_type: "Free text"
        label:
          en: "Reference Number"
          fr: "Numéro de référence"
        obligation: Mandatory
        occurrence: Single
        validation: "This field must not be empty"

      - datastore_id: titre_du_projet_en
        datastore_type: text
        description:
          en: "This field describes the project title, in English"
          fr: "Ce champ décrira le titre du projet, en anglais"
        excel_required: true
        format_type: "Free text"
        form_attrs:
          size: 120
        label:
          en: "Project Title (English)"
          fr: "Titre du projet (en anglais)"
        obligation: Mandatory
        occurrence: Single
        validation: "This field must not be empty"
        visible_to_public: true

      - datastore_id: titre_du_projet_fr
        datastore_type: text
        description:
          en: "This field describes the project title, in French"
          fr: "Ce champ décrira le titre du projet, en français"
        excel_required: true
        format_type: "Free text"
        form_attrs:
          size: 120
        label:
          en: "Project Title (French)"
          fr: "Titre du projet (en français)"
        obligation: Mandatory
        occurrence: Single
        validation: "This field must not be empty"
        visible_to_public: true

      - datastore_id: question_de_recherche_en
        datastore_type: text
        description:
          en: "This field describes the research question informing the project, in English"
          fr: "Ce champ décrira la question de recherche guidant le projet, en anglais"
        excel_column_width: 50
        excel_required: true
        format_type: "Free text"
        form_attrs:
          size: 120
        label:
          en: "Research Question (English)"
          fr: "Question de recherche (en anglais)"
        obligation: Mandatory
        occurrence: Single
        validation: "This field must not be empty"
        visible_to_public: true

      - datastore_id: question_de_recherche_fr
        datastore_type: text
        description:
          en: "This field describes the research question informing the project, in French"
          fr: "Ce champ décrira la question de recherche guidant le projet, en français"
        excel_column_width: 50
        excel_required: true
        format_type: "Free text"
        form_attrs:
          size: 120
        label:
          en: "Research Question (French)"
          fr: "Question de recherche (en français)"
        obligation: Mandatory
        occurrence: Single
        validation: "This field must not be empty"
        visible_to_public: true

      - datastore_id: project_summary_en
        datastore_type: text
        description:
          en: "This field summarizes the key information about the project, including any findings once the initiative is completed, in English"
          fr: "Ce champ résumera les information-clés à propos du projet, y compris les résultats lorque le projet est complété, en anglais"
        excel_column_width: 50
        excel_required: true
        format_type: "Free Text (separate paragraphs with two blank lines)"
        form_snippet: scheming/form_snippets/textarea.html
        form_attrs:
            style: "width: 100%; display: block"
        label:
          en: "Project Summary (English)"
          fr: "Résumé du projet (en anglais)"
        obligation: Mandatory
        occurrence: Single
        validation: "This field must not be empty"
        visible_to_public: true

      - datastore_id: project_summary_fr
        datastore_type: text
        description:
          en: "This field summarizes the key information about the project, including any findings once the initiatve is completed, in French"
          fr: "Ce champ résumera les information-clés à propos du projet, y compris les résultats lorque le projet est complété, en français"
        excel_column_width: 50
        excel_required: true
        format_type: "Free Text (separate paragraphs with two blank lines)"
        form_snippet: scheming/form_snippets/textarea.html
        form_attrs:
            style: "width: 100%; display: block"
        label:
          en: "Project Summary (French)"
          fr: "Résumé du projet (en français)"
        obligation: Mandatory
        occurrence: Single
        validation: "This field must not be empty"
        visible_to_public: true

      - datastore_id: last_updated
        datastore_type: date
        description:
          en: "This field will display the latest update provided for the project."
          fr: "Ce champ décrira à quand remonte la dernière mise à jour."
        excel_column_width: 28
        excel_required: true
        format_type: "Date (Please format the data as YYYY-MM-DD)"
        form_snippet: scheming/form_snippets/date.html
        label:
          en: "Last Updated"
          fr: "Dernière mise à jour"
        obligation: Mandatory
        occurrence: Single
        validation: "This field must not be empty"
        visible_to_public: true

      - datastore_id: experimental_area
        choices:
          PO:
            en: Policy
            fr: Politique
          PR:
            en: Program
            fr: Programme
          RE:
            en: Regulatory
            fr: Règlementation
          SE:
            en: "Service Delivery"
            fr: "Prestation de services"
          SI:
            en: "Internal Services"
            fr: "Services internes"
          GC:
            en: "Grants and Contributions"
            fr: "Subventions et contributions"
          OA:
            en: Other
            fr: autres
        datastore_type: text
        description:
          en: "This field will display the area in which the experiment is taking place."
          fr: "Ce champ décrira dans quel secteur l'expérience prend place."
        excel_column_width: 20
        excel_full_text_choices: true
        excel_required: true
        format_type: "Controlled List"
        label:
          en: "Experimental area"
          fr: "Secteur d'expérimentation"
        obligation: Mandatory
        occurrence: Single
        validation: "This field must not be empty"
        visible_to_public: true

      - datastore_id: research_design
        choices:
          QEX:
            en: Quasi-experimental
            fr: Quasi-expérimental
          RDM:
            en: Randomized
            fr: Randomisé
          STR:
            en: "Structured pre-post"
            fr: "Avant-après structuré"
          OTH:
            en: Other
            fr: Autre
        datastore_type: text
        description:
          en: "This field will describe the research design used for the project."
          fr: "Ce champ décrira le devis de recherche employé dans le projet."
        excel_column_width: 20
        excel_full_text_choices: true
        excel_required: true
        format_type: "Controlled List"
        label:
          en: "Design"
          fr: "Devis"
        obligation: Mandatory
        occurrence: Single
        validation: "This field must not be empty"
        visible_to_public: true

      - datastore_id: design_details_en
        datastore_type: text
        description:
          en: "This field will describe the details of the research design used for the project."
          fr: "Ce champ décrira les détails du devis de recherche employé dans le projet."
        excel_column_width: 50
        excel_required: true
        format_type: "Free Text (separate paragraphs with two blank lines)"
        form_snippet: scheming/form_snippets/textarea.html
        form_attrs:
            style: "width: 100%; display: block"
        label:
          en: "Design Details (English)"
          fr: "Devis details (anglais)"
        obligation: Mandatory
        occurrence: Single
        validation: "This field must not be empty"
        visible_to_public: true

      - datastore_id: design_details_fr
        datastore_type: text
        description:
          en: "This field will describe the details of the research design used for the project."
          fr: "Ce champ décrira les détails du devis de recherche employé dans le projet."
        excel_column_width: 50
        excel_required: true
        format_type: "Free Text (separate paragraphs with two blank lines)"
        form_snippet: scheming/form_snippets/textarea.html
        form_attrs:
            style: "width: 100%; display: block"
        label:
          en: "Design Details (French)"
          fr: "Devis details (français)"
        obligation: Mandatory
        occurrence: Single
        validation: "This field must not be empty"
        visible_to_public: true

      - datastore_id: intervention_en
        datastore_type: text
        description:
          en: "This field will describe the intervention tested in the project."
          fr: "Ce champ décrira l’intervention testée dans le projet."
        excel_column_width: 50
        excel_required: true
        format_type: "Free Text (separate paragraphs with two blank lines)"
        form_snippet: scheming/form_snippets/textarea.html
        form_attrs:
            style: "width: 100%; display: block"
        label:
          en: "Intervention (English)"
          fr: "Intervention (anglais)"
        obligation: Mandatory
        occurrence: Single
        validation: "This field must not be empty"
        visible_to_public: true

      - datastore_id: intervention_fr
        datastore_type: text
        description:
          en: "This field will describe the intervention tested in the project."
          fr: "Ce champ décrira l’intervention testée dans le projet."
        excel_column_width: 50
        excel_required: true
        format_type: "Free Text (separate paragraphs with two blank lines)"
        form_snippet: scheming/form_snippets/textarea.html
        form_attrs:
            style: "width: 100%; display: block"
        label:
          en: "Intervention (French)"
          fr: "Intervention (français)"
        obligation: Mandatory
        occurrence: Single
        validation: "This field must not be empty"
        visible_to_public: true

      - datastore_id: mesure_des_resultats_en
        datastore_type: text
        description:
          en: "This field will describe the intervention tested in the project."
          fr: "Ce champ décrira l’intervention testée dans le projet."
        excel_column_width: 50
        excel_required: true
        format_type: "Free Text (separate paragraphs with two blank lines)"
        form_snippet: scheming/form_snippets/textarea.html
        form_attrs:
            style: "width: 100%; display: block"
        label:
          en: "Outcomes (English)"
          fr: "Mesure des résultats (anglais)"
        obligation: Mandatory
        occurrence: Single
        validation: "This field must not be empty"
        visible_to_public: true

      - datastore_id: mesure_des_resultats_fr
        datastore_type: text
        description:
          en: "This field will describe the outcomes measured in the project."
          fr: "Ce champ décrira la/les mesure(s) de résultat(s) employée(s) dans le projet."
        excel_column_width: 50
        excel_required: true
        format_type: "Free Text (separate paragraphs with two blank lines)"
        form_snippet: scheming/form_snippets/textarea.html
        form_attrs:
            style: "width: 100%; display: block"
        label:
          en: "Outcomes (French)"
          fr: "Mesure des résultats (françcais)"
        obligation: Mandatory
        occurrence: Single
        validation: "This field must not be empty"
        visible_to_public: true

      - datastore_id: resultats_en
        datastore_type: text
        description:
          en: "This field will describe the outcomes measured in the project."
          fr: "Ce champ décrira la/les mesure(s) de résultat(s) employée(s) dans le projet."
        excel_column_width: 50
        excel_required: true
        format_type: "Free Text (separate paragraphs with two blank lines)"
        form_snippet: scheming/form_snippets/textarea.html
        form_attrs:
            style: "width: 100%; display: block"
        label:
          en: "Findings (English)"
          fr: "Résultats (anglais)"
        obligation: Optional
        occurrence: Single
        validation: None
        visible_to_public: true

      - datastore_id: resultats_fr
        datastore_type: text
        description:
          en: "This field will describe the findings of the project."
          fr: "Ce champ décrira les résultats observés dans le projet."
        excel_column_width: 50
        excel_required: true
        format_type: "Free Text (separate paragraphs with two blank lines)"
        form_snippet: scheming/form_snippets/textarea.html
        form_attrs:
            style: "width: 100%; display: block"
        label:
          en: "Findings (French)"
          fr: "Résultats (françcais)"
        obligation: Optional
        occurrence: Single
        validation: None
        visible_to_public: true

      - datastore_id: status
        choices:
          ACT:
            en: Active
            fr: Actif
          INA:
            en: Inactive
            fr: Inactif
          COM:
            en: Completed
            fr: Complété
        datastore_type: text
        description:
          en: "This field will describe the status of the project."
          fr: "Ce champ décrira le statut du projet."
        excel_column_width: 20
        excel_full_text_choices: true
        excel_required: true
        format_type: "Controlled List"
        label:
          en: Status
          fr: Statut
        obligation: Mandatory
        occurrence: Single
        validation: "This field must not be empty"
        visible_to_public: true

      - datastore_id: lead_branch_en
        datastore_type: text
        description:
          en: "This field describes the organizational structure tied to the project owner (if applicable), in English"
          fr: "Ce champ décrira la structure organisationnelle liée à ce projet (si applicable), en anglais"
        excel_column_width: 35
        excel_required: false
        format_type: "Free text"
        label:
          en: "Lead Branch and/or Unit (English)"
          fr: "Direction et/ou unité responsable (en anglais)"
        obligation: Optional
        occurrence: Single
        validation: None
        visible_to_public: true

      - datastore_id: lead_branch_fr
        datastore_type: text
        description:
          en: "This field describes the organizational structure tied to the project owner (if applicable), in French."
          fr: "Ce champ décrira la structure organisationnelle liée à ce projet (si applicable), en français"
        excel_column_width: 35
        excel_required: false
        format_type: "Free text"
        label:
          en: "Lead Branch and/or Unit (French)"
          fr: "Direction et/ou unité responsable (en français))"
        obligation: Optional
        occurrence: Single
        validation: None
        visible_to_public: true

      - datastore_id: info_supplementaire_en
        datastore_type: text
        description:
          en: "This field includes a URL link to additional information on the project (e.g. report, blog post, etc.), in English."
          fr: "Ce champ incluera un lien URL fournissant des information additionnelles (p.ex. rapport, blogue), en anglais."
        excel_column_width: 50
        excel_required: false
        format_type: "Free text"
        form_snippet: scheming/form_snippets/textarea.html
        form_attrs:
          style: "width: 100%; display: block"
        label:
          en: "Further Information / Links (English)"
          fr: "Informations supplémentaires / liens (anglais)"
        obligation: Optional
        occurrence: Single
        validation: None
        visible_to_public: true

      - datastore_id: info_supplementaire_fr
        datastore_type: text
        description:
          en: "This field includes a URL link to additional information on the project (e.g. report, blog post, etc.), in Frencjh."
          fr: "Ce champ incluera un lien URL fournissant des information additionnelles (p.ex. rapport, blogue), en français."
        excel_column_width: 50
        excel_required: false
        format_type: "Free text"
        form_snippet: scheming/form_snippets/textarea.html
        form_attrs:
          style: "width: 100%; display: block"
        label:
          en: "Further Information / Links (French)"
          fr: "Informations supplémentaires / liens (en français)"
        obligation: Optional
        occurrence: Single
        validation: None
        visible_to_public: true

      - datastore_id: record_created
        datastore_type: timestamp
        import_template_include: false
        label: "Record Creation Time"
        preview_class: bg-info
        visible_to_public: false

      - datastore_id: record_modified
        datastore_type: timestamp
        import_template_include: false
        label: "Last Record Modification Time"
        preview_class: bg-info
        visible_to_public: false

      - datastore_id: user_modified
        datastore_type: text
        import_template_include: false
        label: "User Last Modified Record"
        preview_class: bg-info
        visible_to_public: false

    triggers:
      - experiments_trigger: |
            DECLARE
              errors text[][] := '{{}}';
              crval RECORD;
            BEGIN
              errors := errors || required_error(NEW.reference_number, 'reference_number');
              errors := errors || required_error(NEW.titre_du_projet_en, 'titre_du_projet_en');
              errors := errors || required_error(NEW.titre_du_projet_fr, 'titre_du_projet_fr');
              errors := errors || required_error(NEW.question_de_recherche_en, 'question_de_recherche_en');
              errors := errors || required_error(NEW.question_de_recherche_fr, 'question_de_recherche_fr');
              errors := errors || required_error(NEW.project_summary_en, 'project_summary_en');
              errors := errors || required_error(NEW.project_summary_fr, 'project_summary_fr');
              errors := errors || required_error(NEW.last_updated, 'last_updated');
              errors := errors || choice_error(NEW.experimental_area, {experimental_area}, 'experimental_area');
              errors := errors || choice_error(NEW.research_design, {research_design}, 'research_design');
              errors := errors || required_error(NEW.design_details_en, 'design_details_en');
              errors := errors || required_error(NEW.design_details_fr, 'design_details_fr');
              errors := errors || required_error(NEW.intervention_en, 'intervention_en');
              errors := errors || required_error(NEW.intervention_fr, 'intervention_fr');
              errors := errors || required_error(NEW.mesure_des_resultats_en, 'mesure_des_resultats_en');
              errors := errors || required_error(NEW.mesure_des_resultats_fr, 'mesure_des_resultats_fr');
              errors := errors || choice_error(NEW.status, {status}, 'status');
              IF errors = '{{}}' THEN
                RETURN NEW;
              END IF;
              RAISE EXCEPTION E'TAB-DELIMITED\t%', array_to_string(errors, E'\t');
            END;
      - update_record_modified_created_trigger

    examples:
      filter_one:
        reference_number: HC-2019-EI-00001
      filters:
        experimental_area: "PR"
      record:
        experimental_area: "PR"
        info_supplementaire_en: ""
        info_supplementaire_fr: ""
        last_updated: "2019-12-01"
        project_summary_en: "This experiment entailed a live, randomized A/B test using the existing consumer incident reporting landing page as well as a modified ‘intervention’ landing page. The intent was to determine if changes in language and presentation could successfully drive online users to continue through to the consumer incident reporting form. That experiment ran between December 12, 2018 and March 11, 2019. During the experimental period, there were 1,999 visits to the intervention landing page and 2,592 to the existing one. After reaching the landing page, visitors would click on a link to enter the consumer incident reporting form. A greater number of visitors from the intervention page entered the consumer incident reporting form (61%), compared to the existing page (27%). This difference in proportions (34%) is statistically significant (p<0. 01). This is an indication that optimizing the landing page content with consumer-focused changes played an important role in retaining consumers within the incident reporting pathway"
        project_summary_fr: "Cette expérience comportait un test A/B en direct et aléatoire touchant la page de renvoi existante pour la déclaration des incidents concernant un produit de consommation, ainsi que la page de renvoi « intervention » modifiée. L’objectif était de déterminer si le fait d’apporter des changements dans la langue et la présentation pouvait amener les utilisateurs en ligne à naviguer vers le formulaire de déclaration des incidents concernant un produit de consommation. Cette expérience s’est déroulée entre le 12 décembre 2018 et le 11 mars 2019. Au cours de la durée du processus expérimental, il y a eu 1 999 visites à la page de renvoi d’intervention et 2 592 à la page de renvoi existante. Après avoir atteint la page de renvoi, les visiteurs doivent cliquer sur un lien pour entrer dans le formulaire de déclaration d’incident concernant un produit de consommation. Un plus grand nombre de visiteurs provenant de la page d’intervention ont rempli le formulaire de déclaration d’incident concernant un produit de consommation (61 %), comparativement à ceux provenant de la page existante (27 %). Cette différence de pourcentage (34 %) est statistiquement significative (p<0. 01). Cela indique que l’optimisation du contenu de la page de renvoi grâce à des changements axés sur les consommateurs a joué un rôle important dans le maintien des visiteurs dans le processus de déclaration des incidents"
        question_de_recherche_en: "Are enhancements to the landing page, compared to the existing one, resulting in more Canadians proceeding to the consumer incident report form?"
        question_de_recherche_fr: "Les améliorations apportées à la page d’accueil, par rapport à la page existante, ont-elles pour effet d’augmenter le nombre de Canadiens qui utilisent le rapport d’incident pour les produits de consommation?"
        reference_number: HC-2019-EI-00001
        research_design: "STR"
        design_details_en: "The experiment was a randomized A/B test that used the existing landing page for consumer incident reporting and a modified landing page. The intent of the experiment was to determine if changes in language and presentation could successfully encourage users to complete the cosmetic or consumer incident report form. For the experiment, users were sent to either the existing landing page (that is, the control group) or the modified landing page (that is, the experimental group)."
        design_details_fr: "L’expérience était un essai A/B aléatoire qui utilisait les éléments suivants : la page d’accueil existante pour signaler un incident concernant un produit de consommation; une page d’accueil modifiée. Le but de l’expérience était de déterminer si des changements dans le libellé et la présentation pourraient inciter les utilisateurs à remplir le rapport d’incident concernant un produit de consommation ou un produit cosmétique. En ce qui concerne l’expérience, les utilisateurs ont été dirigés soit vers la page d’accueil existante (c’est‑à-dire le groupe témoin), soit vers la page d’accueil modifiée (c’est-à-dire le groupe expérimental)."
        intervention_en: "The modified landing page improved the user interface by providing: a button that makes it easier to submit a report form and a plain language instructions on how to fill out the report form. The modified landing page provided clearer direction to users about: which incidents should be reported to the Consumer Product Safety Program, why incidents should be reported to the program, and how to report such incidents."
        intervention_fr: "La page d’accueil modifiée a amélioré l’interface utilisateur grâce aux éléments suivants : un bouton qui facilite la soumission d’un rapport d’incident; des instructions en langage clair et simple sur la façon de remplir le rapport d’incident. La page d’accueil modifiée fournissait des instructions plus claires aux utilisateurs sur les éléments suivants : les incidents qui devraient être signalés au Programme de la sécurité des produits de consommation; la raison pour laquelle les incidents devraient être signalés au programme; la façon de signaler ces incidents."
        mesure_des_resultats_en: "There were two main outcomes for this project: the number of unique page visits for each webpage used; the number of visitors accessing the cosmetic or consumer incident report form."
        mesure_des_resultats_fr: "Il y avait deux mesures principales dans ce projet: le nombre de visites uniques aux pages web employées; le nombre de visiteurs accédant au rapport d’incident concernant un produit de consommation ou un produit cosmétique."
        resultats_en: "The experiment ran for 3 months, from December 12, 2018, to March 11, 2019. During this time, there were 2,592 page visits to the existing landing page and 1,999 page visits to the modified landing page. After reaching the landing page, visitors would click on a link to access the consumer incident report form. A greater number of visitors of the modified page accessed the cosmetic or consumer incident report form (61%), compared to visitors of the existing page (27%). The difference (34.0%) in the percentage of visitors who accessed the report form is statistically significant. This difference indicates that making the landing page more user-focused played an important role in encouraging users to access the incident report form."
        resultats_fr: "L’expérience a duré trois mois, du 12 décembre 2018 au 11 mars 2019. Au cours de cette période, la page d’accueil existante a été consultée 2 592 fois et la page d’accueil modifiée, 1 999 fois. Après avoir accédé à la page d’accueil, les visiteurs cliquaient sur un lien pour accéder au rapport d’incident concernant un produit de consommation. Un plus grand nombre de visiteurs de la page modifiée ont accédé au rapport d’incident concernant un produit de consommation ou un produit cosmétique (61 %), comparativement aux visiteurs de la page existante (27 %). La différence (34 %) dans le pourcentage de visiteurs qui ont accédé au rapport d’incident est statistiquement significative. Cette différence indique que le fait de rendre la page d’accueil plus axée sur l’utilisateur a joué un rôle important pour inciter les utilisateurs à accéder au rapport d’incident."
        status: "COM"
        lead_branch_en: "Consumer Product Safety Program"
        lead_branch_fr: "Programme de la sécurité des produits de consommation"
        titre_du_projet_en: "Experimenting with content design"
        titre_du_projet_fr: "Expérimentation de la conception de contenu"

excel_column_heading_style:
  PatternFill:
    fgColor: FFFF7733
    patternType: solid
excel_edge_style:
  PatternFill:
    fgColor: FFFF5500
    patternType: solid
excel_header_style:
  PatternFill:
    fgColor: FFFF5500
    patternType: solid