Aller au contenu

Mots clés

Les mots clés sont définis dans l'interface de configuration des parcours. Ils sont disponibles pour tous les documents sauf les documents d'identités

Les mots clés sont décrits en JSON de la manière suivante :

{
  "keywordsParticipantError": [],
  "keywordsOperatorInfo": [
    {
        "occurrences": [],
        "participantAlert": "NONE",
        "matchingValue": "2020-11-12",
        "alertOn": "ABSENCE",
        "id": "01",
        "type": "DATE"
    },
    {
        "occurrences": [
          {
            "startIndex": 10,
            "matchText": "PIERRE",
            "lineText": "Prenoms>: PIERRE PAUL JACQUES"
          }
        ],
        "participantAlert": "NONE",
        "matchingValue": "Pierre",
        "alertOn": "PRESENCE",
        "id": "PRESENCE_0",
        "type": "STRING",
        "location": {
            "x": 1675,
            "y": 1182,
            "width": 273,
            "height": 42
        }
    },
    {
        "occurrences": [],
        "participantAlert": "ON_ERROR",
        "matchingValue": "Rue Victor Hugo\nboulevard Victor Hugo\n34000 Montpellier",
        "alertOn": "PRESENCE",
        "id": "02",
        "type": "POSTAL_ADDRESS"
    }
  ]
}

Chaque mot clé possède les champs suivants :

  • id : l'identifiant du mot clé comme défini dans l'interface de configuration du parcours
  • matchingValue : la valeur recherchée
  • participantAlert : ON_ERROR (alerte le participant) | NONE (n'alerte pas le participant)
  • alertOn : ABSENCE (la valeur est trouvée) | PRESENCE (la valeur n'est pas trouvée)
  • type : DATE | STRING | POSTAL_ADDRESS : type de valeur recherchée
  • occurrences : la liste des textes où ont été trouvé le texte recherché. Si le texte n'a pas été trouvé, ce tableau sera vide.
    • lineText : la ligne contenant le texte recherché
    • matchText : la valeur recherchée
    • startIndex : l'index où débute le texte recherché dans la ligne de texte