feat: add business id (display name) to survey unit (#76)

davdarras · web-flow · commit b7e86a4c728b · 2024-11-05T13:37:20.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -28,6 +28,10 @@ target/
 build/
 src/test/resources/out
 src/test/resources/**/testScenarios
+
+application-*.properties
+application-*.yaml
+application-*.yml
 ### VS Code ###
 .vscode/
 
diff --git a/pom.xml b/pom.xml
@@ -5,7 +5,7 @@
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>fr.insee.pearljam</groupId>
 	<artifactId>pearljam-batch</artifactId>
-	<version>3.1.2</version>
+	<version>3.2.0</version>
 	<packaging>jar</packaging>
 	<name>pearljam-batch</name>
 	<description>PearlJam Batch</description>
diff --git a/src/main/java/fr/insee/pearljam/batch/Launcher.java b/src/main/java/fr/insee/pearljam/batch/Launcher.java
@@ -164,15 +164,19 @@ public BatchErrorCode runBatch(String[] options)
         logger.log(Level.INFO, "Batch is running with option {}", batchOption.getLabel());
 
         return switch (batchOption) {
+            // Update states of survey units based on the visibility dates
             case DAILYUPDATE -> triggerService.updateStates();
+            // synchronize interviewers and survey unit affectations for the interviewers
             case SYNCHRONIZE -> triggerService.synchronizeWithOpale(FOLDER_OUT);
+            // send communications
             case COMMUNICATION -> {
                 try {
                     yield communicationService.handleCommunications();
                 } catch (SynchronizationException | MissingCommunicationException e) {
                     yield BatchErrorCode.KO_TECHNICAL_ERROR;
                 }
             }
+            // use pilotage launcher
             default -> pilotageLauncherService.validateLoadClean(batchOption, FOLDER_IN, FOLDER_OUT);
         };
 
diff --git a/src/main/java/fr/insee/pearljam/batch/dao/SurveyUnitDaoImpl.java b/src/main/java/fr/insee/pearljam/batch/dao/SurveyUnitDaoImpl.java
@@ -50,14 +50,14 @@ public void deleteSurveyUnitByCampaignId(String campaignId) {
         pilotageJdbcTemplate.update(qString, campaignId);
     }
 
-    @Override
-    public void createSurveyUnit(String campaignId, SurveyUnitType surveyUnit, Long addressId,
-                                 Long sampleIdentifierId, String interviewerId, String organizationUnitId) {
-        String qString = "INSERT INTO survey_unit (id, priority, address_id, campaign_id, interviewer_id, sample_identifier_id, organization_unit_id) VALUES (?, ?, ?, ?, ?, ?, ?)";
+	@Override
+	public void createSurveyUnit(String campaignId, SurveyUnitType surveyUnit, Long addressId,
+			Long sampleIdentifierId, String interviewerId, String organizationUnitId) {
+		String qString = "INSERT INTO survey_unit (id, display_name, priority, address_id, campaign_id, interviewer_id, sample_identifier_id, organization_unit_id) VALUES (?, ?, ?, ?, ?, ?, ?, ?)";
 
-        pilotageJdbcTemplate.update(qString, surveyUnit.getId(), surveyUnit.isPriority(),
-                addressId, campaignId, interviewerId, sampleIdentifierId, organizationUnitId);
-    }
+		pilotageJdbcTemplate.update(qString, surveyUnit.getId(), surveyUnit.getDisplayName(), surveyUnit.isPriority(),
+				addressId, campaignId, interviewerId, sampleIdentifierId, organizationUnitId);
+	}
 
     @Override
     public List<String> getAllSurveyUnitByCampaignId(String campaignId) {
@@ -111,6 +111,7 @@ private static final class SurveyUnitTypeMapper implements RowMapper<SurveyUnitT
         public SurveyUnitType mapRow(ResultSet rs, int rowNum) throws SQLException {
             SurveyUnitType su = new SurveyUnitType();
             su.setId(rs.getString("id"));
+            su.setDisplayName(rs.getString("display_name"));
             su.setPriority(rs.getBoolean("priority"));
             su.setInterviewerId(rs.getString("interviewer_id"));
             su.setOrganizationalUnitId(rs.getString("organization_unit_id"));
diff --git a/src/main/java/fr/insee/pearljam/batch/service/PilotageLauncherService.java b/src/main/java/fr/insee/pearljam/batch/service/PilotageLauncherService.java
@@ -173,12 +173,16 @@ private String getName(BatchOption batchOption) {
 	 */
 	public BatchErrorCode load(BatchOption batchOption, String in, String out, String processing) throws SQLException, DataBaseException, ValidateException, SynchronizationException, IOException, BatchException, ParserConfigurationException, SAXException {
 		switch(batchOption) {
+			// Delete campaign
 			case DELETECAMPAIGN:
 				return deleteCampaign(in, out);
+			// extract campaign data
 			case EXTRACT:
 				return extractCampaign(in, out);
+			// Create context when empty database
 			case LOADCONTEXT:
 				return loadContext(in);
+			// Create/Update survey units
 			case SAMPLEPROCESSING:
 				return loadSampleProcessing(in, processing);
 			default:
@@ -391,7 +395,12 @@ public BatchErrorCode loadSampleProcessing(String in, String processing) throws
 		// Extract campaignId, list of steps and list of survey-unit id from sampleprocessing
 		String campaignId = sampleProcessing.getIdSource() + sampleProcessing.getMillesime() + sampleProcessing.getIdPeriode();
 		List<String> steps = sampleProcessing.getSteps().getStep().stream().map(Step::getName).collect(Collectors.toList());
-		List<String> surveyUnits = sampleProcessing.getQuestionnaires().getQuestionnaire().stream().map(su -> su.getInformationsGenerales().getUniteEnquetee().getIdentifiant()).collect(Collectors.toList());
+		List<String> surveyUnits = sampleProcessing
+				.getQuestionnaires()
+				.getQuestionnaire()
+				.stream()
+				.map(Campagne.Questionnaires.Questionnaire::getIdInterrogation)
+				.toList();
 		
 		logger.log(Level.INFO, "Start split sample processing content");
 		Map<String, SurveyUnit> mapDataCollectionSu = extractAndValidateDatacollectionFromSamplProcessing(steps, campaignId, sampleProcessing);
diff --git a/src/main/java/fr/insee/pearljam/batch/utils/DataCollectionMapper.java b/src/main/java/fr/insee/pearljam/batch/utils/DataCollectionMapper.java
@@ -28,7 +28,7 @@ public static fr.insee.queen.batch.sample.Campaign mapSampleProcessingToDataColl
 		campaign.getSurveyUnits().getSurveyUnit().addAll(
 				c.getQuestionnaires().getQuestionnaire().stream().map(su -> {
 					fr.insee.queen.batch.sample.SurveyUnitType surveyUnitType = new fr.insee.queen.batch.sample.SurveyUnitType();
-					surveyUnitType.setId(su.getInformationsGenerales().getUniteEnquetee().getIdentifiant());
+					surveyUnitType.setId(su.getIdInterrogation());
 					surveyUnitType.setQuestionnaireModelId(su.getIdModele());
 					surveyUnitType.setData(su.getInformationsPersonnalisees().getData());
 					return surveyUnitType;
diff --git a/src/main/java/fr/insee/pearljam/batch/utils/PilotageMapper.java b/src/main/java/fr/insee/pearljam/batch/utils/PilotageMapper.java
@@ -46,7 +46,8 @@ public static Campaign mapSampleProcessingToPilotageCampaign(Campagne c) {
 		campaign.getSurveyUnits().getSurveyUnit().addAll(
 				c.getQuestionnaires().getQuestionnaire().stream().map(su -> {
 					SurveyUnitType surveyUnitType = new SurveyUnitType();
-					surveyUnitType.setId(su.getInformationsGenerales().getUniteEnquetee().getIdentifiant());
+					surveyUnitType.setId(su.getIdInterrogation());
+					surveyUnitType.setDisplayName(su.getInformationsGenerales().getUniteEnquetee().getIdentifiant());
 					surveyUnitType.setPriority(su.getInformationsGenerales().getUniteEnquetee().isPrioritaire());
 					surveyUnitType.setInterviewerId(
 							su.getInformationsGenerales().getUniteEnquetee().getAffectation().getEnqueteurId());
diff --git a/src/main/resources/xsd/campaign.xsd b/src/main/resources/xsd/campaign.xsd
@@ -139,6 +139,7 @@
 	<xs:complexType name="SurveyUnitType">
 		<xs:all>
 			<xs:element name="Id" type="xs:string" />
+			<xs:element name="DisplayName" type="xs:string" minOccurs="0" />
 			<xs:element minOccurs="0" maxOccurs="1" name="InterviewerId" type="xs:string" />
 			<xs:element minOccurs="0" maxOccurs="1" name="OrganizationalUnitId" type="xs:string" />
 			<xs:element minOccurs="0" maxOccurs="1" name="CampaignId" type="xs:string" />
diff --git a/src/main/resources/xsd/sampleProcessing.xsd b/src/main/resources/xsd/sampleProcessing.xsd
@@ -166,6 +166,7 @@
 										</xs:element>
 									</xs:sequence>
 									<xs:attribute name="idModele" type="xs:string" use="required" />
+									<xs:attribute name="idInterrogation" type="xs:string" use="required" />
 								</xs:complexType>
 							</xs:element>
 						</xs:sequence>
diff --git a/src/test/resources/in/sampleprocessing/init/sampleprocessingScenario1/sampleProcessing.xml b/src/test/resources/in/sampleprocessing/init/sampleprocessingScenario1/sampleProcessing.xml
@@ -11,12 +11,12 @@
 		</Step>
 	</Steps>
 	<Questionnaires>
-		<Questionnaire idModele="simpsons">
+		<Questionnaire idModele="simpsons" idInterrogation="SIM1234">
 			<!--[WEB]<Questionnaire idModele="SIMPSON" idVague="1" idLot="1"> -->
 			<InformationsGenerales>
 				<UniteEnquetee>
 					<test></test>
-					<Identifiant>SIM1234</Identifiant>
+					<Identifiant>business-id-SIM1234</Identifiant>
 					<Prioritaire>true</Prioritaire>
 					<IdentifiantsInsee>
 						<Bs>0</Bs>
diff --git a/src/test/resources/in/sampleprocessing/init/sampleprocessingScenario2/sampleProcessing.xml b/src/test/resources/in/sampleprocessing/init/sampleprocessingScenario2/sampleProcessing.xml
@@ -11,11 +11,11 @@
 		</Step>
 	</Steps>
 	<Questionnaires>
-		<Questionnaire idModele="simpsons">
+		<Questionnaire idModele="simpsons" idInterrogation="SIM1234">
 			<!--[WEB]<Questionnaire idModele="SIMPSON" idVague="1" idLot="1"> -->
 			<InformationsGenerales>
 				<UniteEnquetee>
-					<Identifiant>SIM1234</Identifiant>
+					<Identifiant>business-id-SIM1234</Identifiant>
 					<Prioritaire>true</Prioritaire>
 					<IdentifiantsInsee>
 						<Bs>0</Bs>
diff --git a/src/test/resources/in/sampleprocessing/init/sampleprocessingScenario3/sampleProcessing.xml b/src/test/resources/in/sampleprocessing/init/sampleprocessingScenario3/sampleProcessing.xml
@@ -11,11 +11,11 @@
 		</Step>
 	</Steps>
 	<Questionnaires>
-		<Questionnaire idModele="simpsons">
+		<Questionnaire idModele="simpsons" idInterrogation="SIM1234">
 			<!--[WEB]<Questionnaire idModele="SIMPSON" idVague="1" idLot="1"> -->
 			<InformationsGenerales>
 				<UniteEnquetee>
-					<Identifiant>SIM1234</Identifiant>
+					<Identifiant>business-id-SIM1234</Identifiant>
 					<Prioritaire>true</Prioritaire>
 					<IdentifiantsInsee>
 						<Bs>0</Bs>
diff --git a/src/test/resources/in/sampleprocessing/init/sampleprocessingScenario4/sampleProcessing.xml b/src/test/resources/in/sampleprocessing/init/sampleprocessingScenario4/sampleProcessing.xml
@@ -11,11 +11,11 @@
 		</Step>
 	</Steps>
 	<Questionnaires>
-		<Questionnaire idModele="simpsons">
+		<Questionnaire idModele="simpsons" idInterrogation="SIM1234">
 			<!--[WEB]<Questionnaire idModele="SIMPSON" idVague="1" idLot="1"> -->
 			<InformationsGenerales>
 				<UniteEnquetee>
-					<Identifiant>SIM1234</Identifiant>
+					<Identifiant>business-id-SIM1234</Identifiant>
 					<Prioritaire>true</Prioritaire>
 					<IdentifiantsInsee>
 						<Bs>0</Bs>
diff --git a/src/test/resources/in/sampleprocessing/init/sampleprocessingScenario5/sampleProcessing.xml b/src/test/resources/in/sampleprocessing/init/sampleprocessingScenario5/sampleProcessing.xml
@@ -11,11 +11,11 @@
 		</Step>
 	</Steps>
 	<Questionnaires>
-		<Questionnaire idModele="simpsons">
+		<Questionnaire idModele="simpsons" idInterrogation="SIM1234">
 			<!--[WEB]<Questionnaire idModele="SIMPSON" idVague="1" idLot="1"> -->
 			<InformationsGenerales>
 				<UniteEnquetee>
-					<Identifiant>SIM1234</Identifiant>
+					<Identifiant>business-id-SIM1234</Identifiant>
 					<Prioritaire>true</Prioritaire>
 					<IdentifiantsInsee>
 						<Bs>0</Bs>
diff --git a/src/test/resources/in/sampleprocessing/init/sampleprocessingScenario6/sampleProcessing.xml b/src/test/resources/in/sampleprocessing/init/sampleprocessingScenario6/sampleProcessing.xml
@@ -11,11 +11,11 @@
 		</Step>
 	</Steps>
 	<Questionnaires>
-		<Questionnaire idModele="simpsons">
+		<Questionnaire idModele="simpsons" idInterrogation="SIM1234">
 			<!--[WEB]<Questionnaire idModele="SIMPSON" idVague="1" idLot="1"> -->
 			<InformationsGenerales>
 				<UniteEnquetee>
-					<Identifiant>SIM1234</Identifiant>
+					<Identifiant>business-id-SIM1234</Identifiant>
 					<Prioritaire>true</Prioritaire>
 					<IdentifiantsInsee>
 						<Bs>0</Bs>
diff --git a/src/test/resources/sql/masterPilotage.xml b/src/test/resources/sql/masterPilotage.xml
@@ -62,4 +62,7 @@
 
 	<!-- move mail/tel to visibility  -->
 	<include file="pilotage/546_update_communication_information.xml" relativeToChangelogFile="true" />
+
+	<!-- add business id  -->
+	<include file="pilotage/550_add_business_id.xml" relativeToChangelogFile="true" />
 </databaseChangeLog>
diff --git a/src/test/resources/sql/pilotage/550_add_business_id.xml b/src/test/resources/sql/pilotage/550_add_business_id.xml
@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<databaseChangeLog xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
+                   xmlns:ext="http://www.liquibase.org/xml/ns/dbchangelog-ext"
+                   xmlns:pro="http://www.liquibase.org/xml/ns/pro"
+                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+                   xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog-ext http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-ext.xsd http://www.liquibase.org/xml/ns/pro http://www.liquibase.org/xml/ns/pro/liquibase-pro-latest.xsd http://www.liquibase.org/xml/ns/dbchangelog http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-latest.xsd">
+    <changeSet author="davdar" id="550-1">
+        <addColumn tableName="survey_unit">
+            <column name="display_name" type="VARCHAR(50)"/>
+        </addColumn>
+    </changeSet>
+
+    <changeSet author="davdar" id="550-2">
+        <update tableName="survey_unit">
+            <column name="display_name" valueComputed="id"/>
+        </update>
+    </changeSet>
+</databaseChangeLog>
diff --git a/src/test/resources/sql/pilotage/reinit-data.sql b/src/test/resources/sql/pilotage/reinit-data.sql
@@ -136,20 +136,20 @@ INSERT INTO public.state ("date","type",survey_unit_id) VALUES
 	 (1590504478334,'NVM','26'),
 	 (1590504478334,'NVM','27'),
 	 (1590504478334,'NVM','28');
-INSERT INTO public.survey_unit (id,priority,address_id,campaign_id,interviewer_id,sample_identifier_id,organization_unit_id,viewed,"move") VALUES
-	 ('11',true,1,'SIMPSONS2020X00','INTW1',1,'OU-NORTH',false,NULL),
-	 ('12',true,2,'SIMPSONS2020X00','INTW1',2,'OU-NORTH',false,NULL),
-	 ('13',false,3,'SIMPSONS2020X00','INTW2',3,'OU-SOUTH',false,NULL),
-	 ('14',false,4,'SIMPSONS2020X00','INTW3',4,'OU-SOUTH',false,NULL),
-	 ('20',true,5,'VQS2021X00','INTW1',5,'OU-NORTH',false,NULL),
-	 ('21',true,6,'VQS2021X00','INTW2',6,'OU-NORTH',false,NULL),
-	 ('22',false,7,'VQS2021X00','INTW4',7,'OU-NORTH',false,NULL),
-	 ('23',true,8,'VQS2021X00','INTW4',8,'OU-NORTH',false,NULL),
-	 ('24',false,9,'STATE2020X00','INTW1',9,'OU-NORTH',false,NULL),
-	 ('25',true,10,'STATE2021X00','INTW1',10,'OU-NORTH',false,NULL),
-	 ('26',true,11,'STATE2022X00','INTW1',11,'OU-NORTH',false,NULL),
-	 ('27',false,12,'STATE2023X00','INTW1',12,'OU-NORTH',false,NULL),
-	 ('28',true,13,'STATE2024X00','INTW1',13,'OU-NORTH',false,NULL);
+INSERT INTO public.survey_unit (id, display_name, priority,address_id,campaign_id,interviewer_id,sample_identifier_id,organization_unit_id,viewed,"move") VALUES
+	 ('11','business-id-11',true,1,'SIMPSONS2020X00','INTW1',1,'OU-NORTH',false,NULL),
+	 ('12','business-id-12',true,2,'SIMPSONS2020X00','INTW1',2,'OU-NORTH',false,NULL),
+	 ('13','business-id-13',false,3,'SIMPSONS2020X00','INTW2',3,'OU-SOUTH',false,NULL),
+	 ('14','business-id-14',false,4,'SIMPSONS2020X00','INTW3',4,'OU-SOUTH',false,NULL),
+	 ('20','business-id-20',true,5,'VQS2021X00','INTW1',5,'OU-NORTH',false,NULL),
+	 ('21','business-id-21',true,6,'VQS2021X00','INTW2',6,'OU-NORTH',false,NULL),
+	 ('22','business-id-22',false,7,'VQS2021X00','INTW4',7,'OU-NORTH',false,NULL),
+	 ('23','business-id-23',true,8,'VQS2021X00','INTW4',8,'OU-NORTH',false,NULL),
+	 ('24','business-id-24',false,9,'STATE2020X00','INTW1',9,'OU-NORTH',false,NULL),
+	 ('25','business-id-25',true,10,'STATE2021X00','INTW1',10,'OU-NORTH',false,NULL),
+	 ('26','business-id-26',true,11,'STATE2022X00','INTW1',11,'OU-NORTH',false,NULL),
+	 ('27','business-id-27',false,12,'STATE2023X00','INTW1',12,'OU-NORTH',false,NULL),
+	 ('28','business-id-28',true,13,'STATE2024X00','INTW1',13,'OU-NORTH',false,NULL);
 INSERT INTO public."user" (id,first_name,last_name,organization_unit_id) VALUES
 	 ('ABC','Melinda','Webb','OU-NORTH'),
 	 ('DEF','Everett','Juste','OU-NORTH'),
