extraction module

The extraction module contains standardized functions to retrieve parameter values from various platform objects. These utilities ensure that data is correctly typed and validated, supporting mandatory field checks and whitespace management for seamless integration development.

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)

Extracts an action parameter from the siemplify object.

Parameters

Parameters
siemplify	SiemplifyAction.SiemplifyAction The siemplify object used for action execution.
param_name	str The name of the parameter to extract.
default_value	Any The default value to return if the parameter isn't found.
input_type	type The expected data type of the parameter.
is_mandatory	bool Indicates if the parameter is required.
remove_whitespaces	bool Indicates if leading and trailing whitespaces are removed from the value.

Returns

The extracted parameter value.

Return type

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)

Extracts a configuration parameter value from the integration's global configuration.

Parameters

Parameters
provider_name	str The unique identifier for the integration.
param_name	str The specific configuration key to retrieve.

Returns

The extracted configuration value.

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)

Extracts a connector parameter from the siemplify object during connector execution.

Parameters

Parameters
siemplify	SiemplifyConnectors.SiemplifyConnectorExecution The siemplify object used for connector execution.

Returns

The value of the connector parameter.

Return type

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)

Extracts a job parameter from the siemplify job object.

Parameters

Parameters
siemplify	SiemplifyJob.SiemplifyJob The siemplify object for the current job instance.

Returns

The extracted job parameter value.

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)

Extracts a script parameter from a provided input dictionary.

Parameters

Parameters
input_dictionary	dict The dictionary source containing script parameters.

Returns

The extracted parameter value from the dictionary.

TIPCommon.extraction.get_connector_detailed_params

TIPCommon.extraction.get_connector_detailed_params(siemplify)

Retrieves a detailed list of parameters specifically defined for a connector.

Parameters

Parameters
siemplify	SiemplifyConnectors.SiemplifyConnectorExecution The siemplify object for the connector.

Returns

A list of ConnectorParameter objects.

Return type

list