Context

Type: object

Le contexte d'un processus. Il contient toutes les métadonnées nécessaires à l'execution du processus, la configuration des applications (en particulier les plateformes de collecte), et l'envoi de communications. // The context of a process. It contains all the metadata necessary for process execution, application configuration (particularly collection platforms), and communication sending.

Type: stringFormat: uuid

Identifiant technique de la collecte (non signifiant). A la cible, il sera généré par ACDC. Pour le moment, il est généré par l'intégrateur du fichier de contexte. // Technical identifier of the collection (non-significant). At target, it will be generated by ACDC. For now, it is generated by the context file integrator.

Type: string

Nom de la collecte. Utilisé pour l'affichage dans Moog (choix de campagne) et pour l'affichage dans Platine Gestion (fiche collecte). // Collection name. Used for display in Moog (campaign selection) and for display in Platine Gestion (collection sheet).

Type: string

Nom court de la collecte. Utilisé pour l'affichage dans Moog (url, nom du fichier d'extraction pour les relances) et pour l'affichage dans Platine Gestion (fiche collecte, interrogation, contact, page d'accueil). // Short collection name. Used for display in Moog (url, extraction file name for reminders) and for display in Platine Gestion (collection sheet, survey, contact, home page).

Type: enum (of string)

Contexte de la collecte. Indique s'il s'agit d'une collecte ménage ou entreprise, ce qui permet de configurer différemment certains paramètres (taille du mot de passe créé par exemple, page de garde ménage ou entreprise pour les questionnaires web...) // Collection context. Indicates whether it is a household or business collection, which allows different configuration of certain parameters (created password size for example, household or business cover page for web questionnaires...).

Must be one of:

  • "HOUSEHOLD"
  • "BUSINESS"

Type: object

Type: string

Identifiant technique de la série d'opération statistique (non signifiant). A récupérer de RMeS (ex : s1275) // Technical identifier of the statistical operation series (non-significant). To be retrieved from RMeS (e.g.: s1275).

Type: string

Nom court de la série d'opération statistique. Utilisé dans l'URL du portail de promotion, affiché dans l'onglet Collecte de Platine Gestion et utilisé pour faire des recherches sur une série. // Short name of the statistical operation series. Used in the promotion portal URL, displayed in the Collection tab of Platine Gestion and used to search for a series.

Type: string

Nom de la série d'opération statistique. // Name of the statistical operation series.

Type: enum (of string)

Fréquence de la collecte. Utilisé pour configurer Platine. Les codes : X=pluriannuelle; A=annuelle ; S=semi-annuelle ; T=trimestrielle; B=bi-mensuelle; M=mensuelle // Collection frequency. Used to configure Platine. Codes: X=multiannual; A=annual; S=semi-annual; T=quarterly; B=bi-monthly; M=monthly.

Must be one of:

  • "X"
  • "A"
  • "S"
  • "T"
  • "B"
  • "M"

Type: enum (of string)

Période de l'enquête. A00: annuelle; X00-X99: pluriannuelle; S01-02: 1er et 2nd semestre; T1-4: 1er-4e trimestre; M01-M12: Mois de l'année; B01-B06: Bimestre dans l'année // Survey period. A00: annual; X00-X99: multi-year; S01-02: 1st and 2nd semester; T1-4: 1st-4th quarter; M01-M12: month of the year; B01-B06: two-month period within the year

Must be one of:

  • "A00"
  • "X00"
  • "X01"
  • "X02"
  • "X03"
  • "X04"
  • "X05"
  • "X06"
  • "X07"
  • "X08"
  • "X09"
  • "X10"
  • "X11"
  • "X12"
  • "X13"
  • "X14"
  • "X15"
  • "X16"
  • "X17"
  • "X18"
  • "X19"
  • "X20"
  • "X21"
  • "X22"
  • "X23"
  • "X24"
  • "X25"
  • "X26"
  • "X27"
  • "X28"
  • "X29"
  • "X30"
  • "X31"
  • "X32"
  • "X33"
  • "X34"
  • "X35"
  • "X36"
  • "X37"
  • "X38"
  • "X39"
  • "X40"
  • "X41"
  • "X42"
  • "X43"
  • "X44"
  • "X45"
  • "X46"
  • "X47"
  • "X48"
  • "X49"
  • "X50"
  • "X51"
  • "X52"
  • "X53"
  • "X54"
  • "X55"
  • "X56"
  • "X57"
  • "X58"
  • "X59"
  • "X60"
  • "X61"
  • "X62"
  • "X63"
  • "X64"
  • "X65"
  • "X66"
  • "X67"
  • "X68"
  • "X69"
  • "X70"
  • "X71"
  • "X72"
  • "X73"
  • "X74"
  • "X75"
  • "X76"
  • "X77"
  • "X78"
  • "X79"
  • "X80"
  • "X81"
  • "X82"
  • "X83"
  • "X84"
  • "X85"
  • "X86"
  • "X87"
  • "X88"
  • "X89"
  • "X90"
  • "X91"
  • "X92"
  • "X93"
  • "X94"
  • "X95"
  • "X96"
  • "X97"
  • "X98"
  • "X99"
  • "S01"
  • "S02"
  • "T01"
  • "T02"
  • "T03"
  • "T04"
  • "M01"
  • "M02"
  • "M03"
  • "M04"
  • "M05"
  • "M06"
  • "M07"
  • "M08"
  • "M09"
  • "M10"
  • "M11"
  • "M12"
  • "B01"
  • "B02"
  • "B03"
  • "B04"
  • "B05"
  • "B06"

Type: integer

Value must be greater or equal to 1000 and lesser or equal to 9999

Type: string

Identifiant technique de l'opération statistique (non signifiant). A récupérer de RMeS (ex : s1558) // Technical identifier of the statistical operation (non-significant). To be retrieved from RMeS (e.g.: s1558).

Type: string

Nom court de l'opération statistique. // Short name of the statistical operation.

Type: string

Nom de l'opération statistique. // Name of the statistical operation.

Type: string

Objectifs de l'enquête (court). Apparaît sur la page de garde du questionnaire web. // Survey objectives (short). Appears on the cover page of the web questionnaire.

Type: string

Numéro de visa de l'enquête // Survey visa number.

Type: string

Année du visa // Visa year.

Type: boolean

Enquête à caractère obligatoire // Mandatory survey.

Type: boolean

Enquête d'intérêt général // Survey of general interest.

Type: boolean

Enquête de qualité statistique // Statistical quality survey.

Type: boolean

Enquête qui n'est pas passée par le comité du Label et qui n'a pas de numéro de visa // Survey that did not go through the Label committee and has no visa number.

Type: boolean

Publication du visa Cnis au journal officiel // Publication of the Cnis visa in the official journal.

Type: string

Date de publication au journal officiel, apparaissant sur les courriers/mails envoyés aux enquêtés // Publication date in the official journal, appearing on letters/emails sent to respondents.

Type: string

Ministère responsable de l'enquête // Ministry responsible for the survey.

Type: string

Responsable opérationnel pour l'exercice des droits // Operational manager for the exercise of rights.

Type: string

Email du responsable opérationnel pour l'exercice des droits // Email of the operational manager for the exercise of rights.

Type: string

Nom du responsable du traitement affiché dans le cadre légal // Name of the data controller displayed in the legal framework.

Type: string

Nom court du responsable du traitement affiché dans le cadre légal // Short name of the data controller displayed in the legal framework.

Type: boolean

Genre féminin du responsable du traitement // Feminine gender of the data controller.

Type: string

URL du site du responsable du traitement // URL of the data controller's website.

Type: boolean

Présence d'un prestataire pour réaliser la collecte de l'enquête // Presence of a provider to conduct the survey collection.

Type: string

Nom du prestataire // Provider name.

Type: string

URL du prestataire // Provider URL.

Type: boolean

Mention des représentants légaux dans les courriers // Mention of legal representatives in letters.

Type: boolean

Présence de mineurs parmi les personnes échantillonnées // Presence of minors among sampled individuals.

Type: string

Phrase à ajouter dans le cartouche en cas de présence de mineurs parmi les personnes échantillonnées // Sentence to add in the cartridge if minors are present among sampled individuals.

Type: boolean

Mention du délégué à la protection des données dans le cadre légal // Mention of the data protection officer in the legal framework.

Type: string

Email du délégué à la protection des données, affiché dans le cadre légal // Email of the data protection officer, displayed in the legal framework.

Type: boolean

Mention des appariements dans le cadre légal // Mention of data matching in the legal framework.

Type: string

Données administratives utilisées pour les appariements, affichées dans le cadre légal en cas d'appariement // Administrative data used for matching, displayed in the legal framework in case of matching.

Type: boolean

Archivage ou non des données // Data archiving or not.

Type: string

Durée de conservation des données indiquée dans le document de conformité RGPD, affichée dans le cadre légal // Data retention period indicated in the GDPR compliance document, displayed in the legal framework.

Type: string

Durée de conservation des données d'identification (affichée dans le cadre légal) // Identification data retention period (displayed in the legal framework).

Type: string

URL de l'enquête // Survey URL.

Type: string

Précisions sur l'opportunité de l'enquête dans le cadre légal // Details on the survey opportunity in the legal framework.

Type: boolean

Affichage ou non d'un paragraphe sur les données personnelles dans le cadre légal // Display or not of a paragraph on personal data in the legal framework.

Type: string

Fréquence de traitement des données - pour produire les tables statistiques (exécution Kraftwerk) -- Visiblement une expression de type cron ; préciser le forma. Pas utilisé pour le moment. // Data processing frequency - to produce statistical tables (Kraftwerk execution) -- Apparently a cron-type expression; specify the format. Not currently used.

Type: enum (of string)

Stratégie de livraison des données. Pas utilisé pour le moment. // Data delivery strategy. Not currently used.

Must be one of:

  • "ALL"
  • "DIFF"

Type: enum (of string)

Format de livraison des données traitées (pour les tables statistiques - execution Kraftwerk). Pas utilisé pour le moment. // Processed data delivery format (for statistical tables - Kraftwerk execution). Not currently used.

Must be one of:

  • "PARQUET"
  • "PARQUET_CSV"
  • "JSON"

Type: string

Boite fonctionnelle en charge de l'enquête. Pas utilisé pour le moment. // Functional mailbox in charge of the survey. Not currently used.

Type: array of object

Référents de l'enquête, affiché dans Sabiane Gestion - peuvent être principaux (sinon considérés comme secondaires). Pas utilisé pour le moment. // Survey referents, displayed in Sabiane Gestion - can be primary (otherwise considered secondary). Not currently used.

No Additional Items

Each item of this array must be:

SurveyReferent

Type: object

Type: string

Email pour l'assistance de second niveau // Email for second-level support.

Type: array of object

Liste des lots associés au processus de collecte. Un lot est un regroupement d'unités enquêtés partageant les mêmes métadonnées pour une opération de collecte donnée, en particulier les dates de collecte et le protocole de communication. En cas de concurrentiel (web et téléphone par exemple), il y a un seul lot avec 2 modes de collecte. // List of batches associated with the collection process. A batch is a grouping of surveyed units sharing the same metadata for a given collection operation, particularly collection dates and communication protocol. In case of concurrent modes (web and telephone for example), there is a single batch with 2 collection modes.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

partition

Type: object

Type: stringFormat: uuid

Identifiant technique du lot. A la cible, il sera généré par ACDC. En attendant, il est généré par l'intégrateur du fichier de contexte. // Technical identifier of the batch. At target, it will be generated by ACDC. Meanwhile, it is generated by the context file integrator.

Type: string

Label du lot. Affiché au répondant dans le tableau 'Répondre à l'enquête' du portail Platine. Utilisé aussi dans Platine Gestion pour sélection et affichage d'un lot, et dans REM pour affichage. // Batch label. Displayed to the respondent in the 'Respond to the survey' table of the Platine portal. Also used in Platine Gestion for batch selection and display, and in REM for display.

Type: string

Label court du lot // Short batch label.

Type: array of object

Liste des lots liés à ce lot (utilisés notamment pour les remises en collecte). Pas utilisé pour le moment. // List of batches related to this batch (used particularly for re-collection). Not currently used.

No Additional Items

Each item of this array must be:

Relatedpartition

Type: object

Type: stringFormat: uuid

Identifiant technique du lot lié. Pas utilisé pour le moment. // Technical identifier of the related batch. Not currently used.

Type: enum (of string)

Lien entre le lot lié et le lot décrit. Ex: previous ==> le lot en lien precede le lot actuel. Pas utilisé pour le moment. // Link between the related batch and the described batch. E.g.: previous ==> the linked batch precedes the current batch. Not currently used.

Must be one of:

  • "PREVIOUS"
  • "NEXT"

Type: string

Règle de remise en collecte entre le lot décrit et le lot lié -- A PRECISER LE FORMAT. Pas utilisé pour le moment. // Re-collection rule between the described batch and the related batch -- FORMAT TO BE SPECIFIED. Not currently used.

Type: enum (of string)

Type d'unités dans le lot : logement ou individu ou entreprise // Type of units in the batch: housing or individual or business.

Must be one of:

  • "HOUSING"
  • "INDIVIDUAL"
  • "BUSINESS"

Type: array

Modes de collecte du lot (en cas de concurrentiel, il y a plusieurs modes de collecte). Permet la configuration du processus. // Collection modes of the batch (in case of concurrent modes, there are multiple collection modes). Allows process configuration.

Must contain a minimum of 1 items

All items must be unique

No Additional Items

Each item of this array must be:

Type: boolean

Reprise manuelle ou non. Utilisé pour la configuration de Platine. // Manual rework or not. Used for Platine configuration.

Type: stringFormat: date-time

Date de fin de reprise manuelle. Pas utilisé pour le moment. // Manual rework end date. Not currently used.

Type: stringFormat: date-time

Date de début de visibilité du lot dans Sabiane Gestion pour les gestionnaires en DEM. Pas utilisé pour le moment. // Start date of batch visibility in Sabiane Gestion for DEM managers. Not currently used.

Type: stringFormat: date-time

Date de début de visibilité du lot dans Sabiane Collecte pour les enquêteurs. Pas utilisé pour le moment. // Start date of batch visibility in Sabiane Collecte for interviewers. Not currently used.

Type: stringFormat: date-time

Date de début de repérage : les interrogations de ce lot deviennent cliquables dans Sabiane Collecte. Pas utilisé pour le moment. // Identification phase start date: the surveys of this batch become clickable in Sabiane Collecte. Not currently used.

Type: stringFormat: date-time

Date de début de la collecte. Le questionnaire est accessible à partir cette date. // Collection start date. The questionnaire is accessible from this date.

Type: stringFormat: date-time

Date de fin de la collecte. Le questionnaire n'est plus accessible à partir de cette date. // Collection end date. The questionnaire is no longer accessible from this date.

Type: stringFormat: date-time

Date de fin de visibilité pour les enquêteurs et les gestionnaires dans Sabiane. Pas utilisé pour le moment. // Visibility end date for interviewers and managers in Sabiane. Not currently used.

Type: stringFormat: date-time

Date de retour attendue pour remplir le questionnaire. Affiché au répondant dans le tableau 'Répondre à l'enquête', et dans Platine Gestion. // Expected return date for completing the questionnaire. Displayed to the respondent in the 'Respond to the survey' table, and in Platine Gestion.

Type: array of string

Liste des identifiants des instruments de collecte possibles pour les interrogations de ce lot. Ils doivent tous être décrits dans collectionInstruments // List of identifiers of possible collection instruments for the surveys of this batch. They must all be described in collectionInstruments.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: boolean

Recherche de contacts précédents dans la plateforme de collecte web Platine. Si oui, les contacts pré-existants dans Platine qui sont liés aux unités enquêtées pour cette source sont rattachés aux nouvelles interrogations de ce lot, avec les mêmes attributs (principal, secondaire). // Search for previous contacts in the Platine web collection platform. If yes, pre-existing contacts in Platine that are linked to the surveyed units for this source are attached to the new surveys of this batch, with the same attributes (primary, secondary).

Type: enum (of string)

Configuration du reperage dans Sabiane. Pas utilisé pour le moment. // Identification configuration in Sabiane. Not currently used.

Must be one of:

  • "HOUSEF2F"
  • "INDTEL"
  • "INDTELNOR"
  • "INDF2F"
  • "INDF2FNOR"
  • "NOIDENT"

Type: array of object

Liste des sites de gestion, utilisé pour configurer la campagne dans Sabiane... Uniquement si collecte Sabiane // List of management sites, used to configure the campaign in Sabiane... Only if Sabiane collection.

No Additional Items

Each item of this array must be:

OrganizationalUnit

Type: object

Type: string

Identifiant du site de gestion // Management site identifier.

Type: string

Email de l'assistance pour le site de gestion (apparaît sur les courriers envoyés aux enquêtés) // Support email for the management site (appears on letters sent to respondents).

Type: string

Telephone de l'assistance pour le site de gestion (apparaît sur les courriers envoyés aux enquêtés) // Support telephone for the management site (appears on letters sent to respondents).

Type: boolean

Configuration de l'envoi des courriers depuis Sabiane pour le site de gestion // Configuration of letter sending from Sabiane for the management site.

CoverPageData

Type: object

Variables présentes sur la page de garde

No Additional Properties

Type: string

Précision de Qui doit répondre sur la page de garde (phrase 1) // Specification of who should respond on the cover page (sentence 1)

Type: string

Précision de Qui doit répondre sur la page de garde (phrase 2) // Specification of who should respond on the cover page (sentence 2)

Type: string

Précision de Qui doit répondre sur la page de garde (phrase 3) // Specification of who should respond on the cover page (sentence 3)

Type: array of object

Configuration des communications du lot. Il s'agit d'un tableau listant les différentes communications (courriers ou emails) prévues au cours du processus. Il y a autant d'éléments dans le tableau que de communications effectivement prévues. Par exemple, s'il y a 2 courriers de relances prévues à 2 dates différentes, il faut créer 2 éléments dans le tableau. Autre exemple : une communication qui se fait à la demande d'un enquêteur dans Sabiane et non à une date fixe doit également figurer comment un élement de ce tableau. Chaque élément de ce tableau est intégré dans Meshuggah en tant que patron de communication. // Batch communication configuration. This is an array listing the different communications (letters or emails) planned during the process. There are as many elements in the array as communications actually planned. For example, if there are 2 reminder letters planned at 2 different dates, 2 elements must be created in the array. Another example: a communication that is done at the request of an interviewer in Sabiane and not at a fixed date must also appear as an element of this array. Each element of this array is integrated into Meshuggah as a communication template.

No Additional Items

Each item of this array must be:

CommunicationStep

Type: object

Type: stringFormat: uuid

Identifiant technique de la communication (non signifiant). A la cible, il sera généré par ACDC. Pour le moment, il est généré par l'intégrateur du fichier de contexte. // Technical identifier of the communication (non-significant). At target, it will be generated by ACDC. For now, it is generated by the context file integrator.

Type: string

Label pour la communication. A titre informatif, affiché dans Meshuggah. // Label for the communication. For information purposes, displayed in Meshuggah.

Type: stringFormat: date-time

Date à laquelle Protools déclenche l'envoi de communication. Pour un email, l'envoi se fait ce même jour. Pour un courrier, c'est à la date à laquelle la demande est envoyé à l'éditique. Format d'horaire UTC. // Date at which Protools triggers the communication sending. For an email, sending occurs on the same day. For a letter, it is the date at which the request is sent to the publishing system. UTC time format.

Type: enum (of string)

Moyen de communication. Permet de configurer l'envoi. // Communication medium. Allows sending configuration.

Must be one of:

  • "LETTER"
  • "EMAIL"

Type: enum (of string)

Type de communication. // Communication type.

Must be one of:

  • "NOTICE"
  • "REMINDER"
  • "FORMAL_NOTICE"
  • "NON_RESPONSE"
  • "QUESTIONNAIRE_ACCOMPANIEMENT"

Type: string

Modèle de communication à utiliser pour l'envoi. Il s'agit du nom exact du modèle éditique ou de mail. Ex : ouvertureWebCOLEM, relanceCOLT... // Communication model to use for sending. This is the exact name of the publishing or email model. E.g.: ouvertureWebCOLEM, relanceCOLT...

Type: boolean

Envoi d'un questionnaire papier avec le courrier. // Sending a paper questionnaire with the letter.

Type: string

Nom de l'opération d'envoi du courrier. A renseigner uniquement pour un envoi de courrier (mais obligatoire dans ce cas). Attention, il doit être identique au nom d'opération donné dans la fiche de saisine à l'équipe éditique pour le pilotage de l'édition. Les règles de nommage préconisées par l'éditique sont indiquées dans la documentation des communications. Ex : COLMPROWEBOUV // Name of the letter sending operation. To be filled in only for a letter sending (but mandatory in this case). Attention, it must be identical to the operation name given in the referral form to the publishing team for edition management. The naming rules recommended by the publishing system are indicated in the communications documentation. E.g.: COLMPROWEBOUV.

Type: string

Partie libre du nom de fichier contenant les pdfs générés par l'éditique. A renseigner uniquement pour un envoi de courrier (mais obligatoire dans ce cas). Les règles de nommage préconisées par l'éditique sont indiquées dans la documentation des communications. Ex : TIC2024OUV // Free part of the filename containing the pdfs generated by the publishing system. To be filled in only for a letter sending (but mandatory in this case). The naming rules recommended by the publishing system are indicated in the communications documentation. E.g.: TIC2024OUV.

Type: object

Indique si le fichier transmis doit faire l'objet d'un passage RNVP (Restructuration, normalisation et validation postale) avant l'envoi effectif (la normalisation concerne les coordonnées du/des destinaires en L1 à L7). Par défaut, configuré à false. // Indicates whether the transmitted file must undergo RNVP processing (Restructuring, normalization and postal validation) before actual sending (normalization concerns the recipient's coordinates in L1 to L7). By default, set to false.

Type: boolean

Envoi avec accusé de réception. // Sending with acknowledgment of receipt.

FlexibleKeyValueMap

Type: array

Un tableau contenant plusieurs FlexibleKeyValueMapEntry

No Additional Items

Each item of this array must be:


Type: object

Information sur le registre fournissant les instruments de collecte et les nomenclatures // Information on the registry providing collection instruments and code lists

Type: string

URL du registre fournissant instruments de collecte et nomenclatures // URL of the registry providing collection instruments and code lists

Type: string

Chemin sur le registre fournissant les instruments de collecte // Path on the registry providing collection instruments

Type: string

Chemin sur le registre fournissant les nomenclatures // Path on the registry providing code lists

Type: array of object

Tous les instruments de collecte dont les id sont référencés dans les lots de ce contexte sont décrits ici // All collection instruments whose IDs are referenced in the batches of this context are described here

No Additional Items

Each item of this array must be:

CollectionInstrument

Type: object

Type: string

Identifiant définissant l'instrument de collecte à utiliser // Identifier defining the collection instrument to use

Mode

Type: enum (of string)

Collect modes

Must be one of:

  • "CATI"
  • "CAPI"
  • "CAWI"
  • "PAPI"

Type: array of string

Liste des identifiants des nomenclatures référencées par le modèle de questionnaire // List of identifiers of code lists referenced by the questionnaire model

No Additional Items

Each item of this array must be:

Type: array of object

Toutes les nomenclatures référencées par au moins un modèle de questionnaire sont décrites ici // All code lists referenced by at least one questionnaire model are described here

No Additional Items

Each item of this array must be:

CodeLists

Type: object

Type: string

L'identifiant définissant la nomenclature à utiliser // Identifier defining the code list to use