Modul extraction

Das extraction-Modul enthält standardisierte Funktionen zum Abrufen von Parameterwerten aus verschiedenen Plattformobjekten. Diese Dienstprogramme sorgen dafür, dass Daten korrekt typisiert und validiert werden. Sie unterstützen obligatorische Feldprüfungen und die Verwaltung von Leerzeichen für eine nahtlose Entwicklung von Integrationen.

TIPCommon.extraction.extract_action_param

TIPCommon.extraction.extract_action_param(siemplify, param_name, default_value=None, input_type=<class 'str'>, is_mandatory=False, print_value=False, remove_whitespaces=True)

Extrahiert einen Aktionsparameter aus dem siemplify-Objekt.

Parameter

Parameter
siemplify SiemplifyAction.SiemplifyAction

Das siemplify-Objekt, das für die Ausführung der Aktion verwendet wird.

param_name str

Der Name des zu extrahierenden Parameters.

default_value Any

Der Standardwert, der zurückgegeben wird, wenn der Parameter nicht gefunden wird.

input_type type

Der erwartete Datentyp des Parameters.

is_mandatory bool

Gibt an, ob der Parameter erforderlich ist.

remove_whitespaces bool

Gibt an, ob voran- und nachgestellte Leerzeichen aus dem Wert entfernt werden.

Gibt Folgendes zurück:

Der extrahierte Parameterwert.

Rückgabetyp

Any

TIPCommon.extraction.extract_configuration_param

TIPCommon.extraction.extract_configuration_param(siemplify, provider_name, param_name, default_value=None, input_type=<class 'str'>, is_mandatory=False, print_value=False, remove_whitespaces=True)

Extrahiert einen Konfigurationsparameterwert aus der globalen Konfiguration der Integration.

Parameter

Parameter
provider_name str

Die eindeutige Kennung für die Integration.

param_name str

Der abzurufende Konfigurationsschlüssel.

Gibt Folgendes zurück:

Der extrahierte Konfigurationswert.

TIPCommon.extraction.extract_connector_param

TIPCommon.extraction.extract_connector_param(siemplify, param_name, default_value=None, input_type=<class 'str'>, is_mandatory=False, print_value=False, remove_whitespaces=True)

Extrahiert einen Connector-Parameter aus dem siemplify-Objekt während der Connector-Ausführung.

Parameter

Parameter
siemplify SiemplifyConnectors.SiemplifyConnectorExecution

Das siemplify-Objekt, das für die Connectorausführung verwendet wird.

Gibt Folgendes zurück:

Der Wert des Connector-Parameters.

Rückgabetyp

Any

TIPCommon.extraction.extract_job_param

TIPCommon.extraction.extract_job_param(siemplify, param_name, default_value=None, input_type=<class 'str'>, is_mandatory=False, print_value=False, remove_whitespaces=True)

Extrahiert einen Jobparameter aus dem siemplify-Jobobjekt.

Parameter

Parameter
siemplify SiemplifyJob.SiemplifyJob

Das siemplify-Objekt für die aktuelle Job-Instanz.

Gibt Folgendes zurück:

Der extrahierte Wert des Jobparameters.

TIPCommon.extraction.extract_script_param

TIPCommon.extraction.extract_script_param(siemplify, input_dictionary, param_name, default_value=None, input_type=<class 'str'>, is_mandatory=False, print_value=False, remove_whitespaces=True)

Extrahiert einen Skriptparameter aus einem bereitgestellten Eingabewörterbuch.

Parameter

Parameter
input_dictionary dict

Die Dictionary-Quelle mit Skriptparametern.

Gibt Folgendes zurück:

Der extrahierte Parameterwert aus dem Dictionary.

TIPCommon.extraction.get_connector_detailed_params

TIPCommon.extraction.get_connector_detailed_params(siemplify)

Ruft eine detaillierte Liste der Parameter ab, die speziell für einen Connector definiert sind.

Parameter

Parameter
siemplify SiemplifyConnectors.SiemplifyConnectorExecution

Das siemplify-Objekt für den Connector.

Gibt Folgendes zurück:

Eine Liste mit ConnectorParameter-Objekten.

Rückgabetyp

list