Skip to content

Key words

Keywords are defined in the pathway configuration interface. They are available for all documents except for identity documents

The keywords are described in JSON as follows:

{
  "keywordsParticipantError": [],
  "keywordsOperatorInfo": [
    {
        "occurrences": [],
        "participantAlert": "NONE",
        "matchingValue": "2020-11-12",
        "alertOn": "ABSENCE",
        "id": "01",
        "type": "DATE"
    },
    {
        "occurrences": [
          {
            "startIndex": 10,
            "matchText": "PIERRE",
            "lineText": "given names>: 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"
    }
  ]
}

Each keyword has the following fields:

  • id: the identifier of the keyword as defined in the path configuration interface
  • matchingValue : the value searched
  • participantAlert : ON_ERROR (alerts the participant) | NONE (does not alert the participant)
  • alertOn : ABSENCE (the value is found) | PRESENCE (the value is not found)
  • type : DATE | STRING | POSTAL_ADDRESS : type of value searched
  • occurrences : the list of texts where the searched text was found. If the text was not found, this table will be empty.
    • lineText : the line containing the searched text
    • matchText : the value searched for
    • startIndex: the index where the searched text starts in the text line