Daten-Discovery-API

Referenz für Daten-Discovery-API

DataPatternValidator – match(String pattern, String input)

Validiert, ob die Eingabe mit dem Muster des regulären Ausdrucks (regulärer Ausdruck) übereinstimmt.

Tabelle : 1. Parameter

Name	Typ	Beschreibung
pattern	Zeichenfolge	Das Muster des regulären Ausdrucks
Eingabe	Zeichenfolge	Die abzugleichenden Eingabedaten

Tabelle : 2. Ergebnisse

Typ	Beschreibung
Boolean	Gibt „true“ zurück, wenn die Eingabe mit dem Muster übereinstimmt, andernfalls „false“.

Code-Beispiel

var datapatternValidatorApi = new sn_data_discovery_api.DataPatternValidator();
var pattern = '\\b[0-3]?[0-9]/[0-3]?[0-9]/(?:[0-9]{2})?[0-9]{2}\\b';
var input = '09/09/2023';
var output = datapatternValidatorApi.matches(pattern, input);
if (output) {
  gs.info('pattern found!');
} else {
  gs.info('pattern not found');
}

DataPatternValidator – isValid(String pattern)

Überprüft, ob das angegebene Muster ein gültiger regulärer Ausdruck ist.

Tabelle : 3. Parameter

Name	Typ	Beschreibung
pattern	Zeichenfolge	Das Muster des regulären Ausdrucks

Tabelle : 4. Ergebnisse

Typ	Beschreibung
Boolean	Gibt „true“ zurück, wenn der Ausdruck ein gültiger regulärer Ausdruck ist, andernfalls „false“.

Code-Beispiel

var datapatternValidatorApi = new sn_data_discovery_api.DataPatternValidator();
var pattern = '\\b[0-3]?[0-9]/[0-3]?[0-9]/(?:[0-9]{2})?[0-9]{2}\\b';
var output = datapatternValidatorApi.isValid(pattern);
if (output) {
 gs.info('pattern is valid!');
} else {
  gs.info('pattern is not valid');
}

DataPatternValidator – passwordMatches(String pattern, String input, String stichwörter, int stichwortProximity)

Validiert, ob die angegebenen Eingabedaten mit dem Muster des regulären Ausdrucks (regulärer Ausdruck) zusammen mit den Stichwörtern übereinstimmen. Weitere Informationen zu Stichwörtern und Stichwortnähe finden Sie unter Konfigurieren Sie Muster Datenerkennung ..

Tabelle : 5. Parameter

Name	Typ	Beschreibung
pattern	Zeichenfolge	Das Muster des regulären Ausdrucks
Eingabe	Zeichenfolge	Die abzugleichenden Eingabedaten
Stichwörter	Zeichenfolge	Kommagetrennte Stichwortwerte, die abgeglichen werden sollen
StichwortProximity	int	Die Nähe des Stichworts aus dem übereinstimmenden Muster

Tabelle : 6. Ergebnisse

Typ	Beschreibung
Boolean	Gibt „true“ zurück, wenn der Ausdruck ein gültiger regulärer Ausdruck ist, andernfalls „false“.

Code-Beispiel

var datapatternValidatorApi = new sn_data_discovery_api.DataPatternValidator();
var pattern = '\\b[0-3]?[0-9]/[0-3]?[0-9]/(?:[0-9]{2})?[0-9]{2}\\b';
var keywords = 'dob,date of birth';
var keywordProximity = 20;
var matchInput = 'dob: 09/09/2023';
var noMatchInput = '09/09/2023';
var output = datapatternValidatorApi.keywordMatches(pattern, matchInput, keywords, keywordProximity);
gs.info('match found for input: ' + matchInput + ' = ' + output);
output = datapatternValidatorApi.keywordMatches(pattern, noMatchInput, keywords, keywordProximity);
gs.info('match found for noMatchInput: ' + noMatchInput + ' = ' + output);

DataPatternScanner – scan(String input)

Hinweis:

Dem DataPatternScanner-Konstruktor muss ein Array von Datenmuster-System-IDs übergeben werden.

Tabelle : 7. Parameter

Name	Typ	Beschreibung
Eingabe	Zeichenfolge	Die zu scannenden Eingabedaten

Tabelle : 8. Ergebnisse

Typ

Beschreibung

Zeichenfolge

Serialisierte JSON-Zeichenfolge hasMatches Gibt „true“ zurück, wenn mindestens 1 Musterübereinstimmung vorhanden ist. "finding" : [ { # für jedes Muster mit Übereinstimmung, enthält Liste der Start- und Endpositionen von Übereinstimmungen. Fehler Enthält einen Fehlercode und eine Meldung, wenn die API fehlgeschlagen ist, andernfalls leer. unprocessedPatterns Gibt ein Array von Datenmuster-Sys-IDs zurück, die nicht verarbeitet wurden Suche Gibt die ID jedes Musters und eine Liste der Start- und Endpositionen der Übereinstimmungen zurück.

Code-Beispiel

var emailSysId = '8e5605bceb0561107977d256385228e6';
var ssnSysId = '4964417ceb0561107977d256385228b8';
var dataPatternSysIds = [emailSysId, ssnSysId] // Email and SSN
var dataDiscoveryApi = new sn_data_discovery_api.DataDiscoveryScanner(dataPatternSysIds);

var input = 'my ssn is 123-45-6789 and email is [e-mail]'
var jsonString = dataDiscoveryApi.scan(input);
var output = JSON.parse(jsonString);

if (output.hasMatches) {
   gs.info('found matches for patterns in input');
   for (var i=0; i<output.finding.length; i++) {
        curFinding = output.finding[i];
        gs.info('first match for ' + curFinding.pattern + ' is (' + curFinding.matches[0]['start'] + ',' + + curFinding.matches[0]['end'] + ')');
   }
}

Tabelle : 9. Konfiguration

Name	Konfigurationsmodus	Beschreibung
Maximale Länge der Stichwortzeichenfolge (CSV).	Kann nicht konfiguriert werden	Definiert die maximale Länge der Zeichenfolge, die im Feld „DataPattern.keyword“ konfiguriert werden kann Der Standardwert ist 128 Der Höchstwert beträgt 128
Mindest- und Höchstwert für Stichwortnähe	Kann nicht konfiguriert werden	Definiert den minimalen und maximalen Wert, der in das Feld DataPattern.keyword_proximity eingegeben werden kann. Mindestens 0 Maximal 64
Maximale Eingabegröße für Übereinstimmungen und „keywordMatches“-API	Kann nicht konfiguriert werden	Definiert die maximale Eingabegröße, die von den APIs „DataPatternValidator.matches“ und „DataPatternValidator.keywordMatches“ unterstützt wird Der Standardwert ist 2048 Der Höchstwert beträgt 2048
Zeitüberschreitung für Scan-API	DataDiscoveryScanner.setScanTimeout (lange Zeitüberschreitung Millis)	API-Aufruf, um die maximale Zeit in Millisekunden für den Abschluss der DataDiscoveryScanner.scan-Aufrufe zu definieren. Der Standardwert ist 20.000 (ms). Bereich ist ein ganzzahliger Wert zwischen 0 und 50000 (ms).