added ADD_RECORDS_FROM_KOBO mutation

Author: estelafs

apps/back-office/src/app/components/synchronize-kobo-modal/graphql/mutations.ts

@@ -12,3 +12,10 @@ export const EDIT_FORM_KOBO_PREFERENCES = gql`
     }
   }
 `;
+
+/** For the form created from a Kobotoolbox form, import data submissions to create records. */
+export const ADD_RECORDS_FROM_KOBO = gql`
+  mutation addRecordsFromKobo($form: ID!) {
+    addRecordsFromKobo(form: $form)
+  }
+`;

apps/back-office/src/app/components/synchronize-kobo-modal/synchronize-kobo-modal.component.html

@@ -3,11 +3,16 @@
     <h3 class="font-semibold">{{ 'components.form.create.kobo.data.synchronize' | translate }}</h3>
   </ng-container>
   <ng-container ngProjectAs="content">
+    <ui-spinner *ngIf="loading" size="medium"></ui-spinner>
+    <div class="flex flex-col items-center my-2">
+      <ui-button category="secondary" variant="primary" (click)="onSynchronize()">{{
+        'components.form.create.kobo.data.start' | translate
+      }}</ui-button>
+    </div>
     <ui-alert>
       {{ 'components.form.create.kobo.data.fromFormWithVersion' | translate : { formName: data.form.name, versionId: data.deployedVersionId} }}
     </ui-alert>
     <!-- Loading indicator -->
-    <ui-spinner *ngIf="loading" size="medium"></ui-spinner>
     <form [formGroup]="formGroup" class="mt-2">
       <ui-toggle formControlName="dataFromDeployedVersion" class="mb-5">
         <ng-container ngProjectAs="label">

apps/back-office/src/app/components/synchronize-kobo-modal/synchronize-kobo-modal.component.ts

@@ -14,6 +14,7 @@ import {
   TooltipModule,
 } from '@oort-front/ui';
 import {
+  AddRecordsFromKoboMutationResponse,
   ApiConfiguration,
   EditFormMutationResponse,
   UnsubscribeComponent,
@@ -30,7 +31,10 @@ interface DialogData {
   apiConfiguration: ApiConfiguration;
   form: { id: string; name: string };
 }
-import { EDIT_FORM_KOBO_PREFERENCES } from './graphql/mutations';
+import {
+  ADD_RECORDS_FROM_KOBO,
+  EDIT_FORM_KOBO_PREFERENCES,
+} from './graphql/mutations';
 
 /**
  * Synchronize kobo form data (modal, import data submissions from kobo)
@@ -131,6 +135,54 @@ export class SynchronizeKoboModalComponent extends UnsubscribeComponent {
       });
   }
 
+  /**
+   * Synchronize data submissions from kobo
+   */
+  public onSynchronize() {
+    this.loading = true;
+    this.apollo
+      .mutate<AddRecordsFromKoboMutationResponse>({
+        mutation: ADD_RECORDS_FROM_KOBO,
+        variables: {
+          form: this.data.form.id,
+        },
+      })
+      .pipe(takeUntil(this.destroy$))
+      .subscribe({
+        next: ({ errors, data }) => {
+          if (!errors) {
+            if (data?.addRecordsFromKobo) {
+              this.snackBar.openSnackBar(
+                this.translate.instant('common.notifications.objectCreated', {
+                  value: this.translate.instant('common.record.few'),
+                  type: '',
+                })
+              );
+            } else {
+              this.snackBar.openSnackBar(
+                this.translate.instant(
+                  'components.form.create.kobo.data.nothingToSynchronize'
+                )
+              );
+            }
+          } else {
+            this.snackBar.openSnackBar(
+              this.translate.instant('common.notifications.objectNotCreated', {
+                type: this.translate.instant('common.record.few').toLowerCase(),
+                error: errors ? errors[0].message : '',
+              }),
+              { error: true }
+            );
+          }
+          this.loading = false;
+        },
+        error: (err) => {
+          this.loading = false;
+          this.snackBar.openSnackBar(err.message, { error: true });
+        },
+      });
+  }
+
   /**
    * Create the form group
    *

libs/shared/src/i18n/en.json

@@ -842,8 +842,10 @@
           "placeholder": "Enter a KoboToolbox form id",
           "data": {
             "synchronize": "Synchronize kobo data",
+            "start": "Start synchronization",
             "fromFormWithVersion": "The form '{{formName}}' was created from the original Kobotoolbox form with the deploy version id {{versionId}}",
             "syncOnlyFromDeployedVersion": "Synchronize data submissions only from the same form deploy version",
+            "nothingToSynchronize": "No data found for synchronization",
             "tooltip": {
               "syncOnlyFromDeployedVersion": "Only data submissions sent when the form was in the same version as when it was imported will be used to create records. Data submissions registered in earlier or later versions will be disregarded."
             }

libs/shared/src/i18n/fr.json

@@ -853,8 +853,10 @@
           "placeholder": "Entrez l'identifiant du formulaire KoboToolbox",
           "data": {
             "synchronize": "Synchroniser les données Kobo",
+            "start": "Démarrer la synchronisation",
             "fromFormWithVersion": "Le formulaire '{{formName}}' a été créé à partir du formulaire Kobotoolbox d'origine avec l'ID de version de déploiement {{versionId}}",
             "syncOnlyFromDeployedVersion": "Synchronisez les soumissions de données uniquement à partir de la même version de déploiement du formulaire",
+            "nothingToSynchronize": "Aucune donnée trouvée pour la synchronisation",
             "tooltip": {
               "syncOnlyFromDeployedVersion": "Seules les soumissions de données envoyées lorsque le formulaire était dans la même version que lors de son importation seront utilisées pour créer des enregistrements. Les soumissions de données enregistrées dans des versions antérieures ou ultérieures seront ignorées."
             }

libs/shared/src/lib/models/record.model.ts

@@ -26,6 +26,7 @@ export interface Record {
   modifiedBy?: User;
   canUpdate?: boolean;
   canDelete?: boolean;
+  koboId?: string;
   validationErrors?: { question: string; errors: string[] }[];
 }
 
@@ -88,3 +89,8 @@ export interface DeleteRecordsMutationResponse {
 export interface GenerateRecordsMutationResponse {
   generateRecords: Record[];
 }
+
+/** Model for add records from kobo graphql mutation response */
+export interface AddRecordsFromKoboMutationResponse {
+  addRecordsFromKobo: boolean;
+}