tabsdata.SalesforceReportSource

class SalesforceReportSource(
credentials: SalesforceCredentials,
report: str | list[str],
column_name_strategy: Literal['columnName', 'label'],
find_report_by: Literal['id', 'name'] = None,
filter: tuple[str, str, str] | list[tuple[str, str, str]] = None,
filter_logic: str = None,
instance_url: str = None,
last_modified_column: str = None,
initial_last_modified: str = None,
**kwargs,
)

Bases: SourcePlugin

Salesforce Reports based data inputs.

__init__(
credentials: SalesforceCredentials,
report: str | list[str],
column_name_strategy: Literal['columnName', 'label'],
find_report_by: Literal['id', 'name'] = None,
filter: tuple[str, str, str] | list[tuple[str, str, str]] = None,
filter_logic: str = None,
instance_url: str = None,
last_modified_column: str = None,
initial_last_modified: str = None,
**kwargs,
)

Initializes the SalesforceReportSource with the report information and the credentials to access Salesforce.

Parameters:

  • credentials – The credentials to access Salesforce.

  • report – The report or reports to execute in Salesforce. It can be a single string or a list of strings. The string must be either the report ID or the name of the report.

  • column_name_strategy – Indicates which column attribute to use as the column name in the output data. It can be one of the following: - “columnName”: The API name of the column (e.g., “ACCOUNT.NAME”). - “label”: The label of the column (e.g., “Account Name”).

  • find_report_by – Indicates whether the ‘report’ parameter contains report IDs or report names. If not provided, it will be inferred from the value of the ‘report’ parameter.

  • filter –

    A filter or list of filters to apply to the report. Each filter is a tuple of three strings: (field, operator, value). For example: [(“CreatedDate”, “greaterThan”, “2023-01-01T00:00:00.000Z”)]. The possible operators are:

    • equals

    • notEqual

    • lessThan

    • greaterThan

    • lessOrEqual

    • greaterOrEqual

    • contains

    • notContain

    • startsWith

    • includes

    • excludes

    • within

    • between

    Defaults to None.

  • filter_logic – A string representing the logic to apply to the filters. For example: “(1 AND 2) OR 3”. The numbers correspond to the position of the filters in the ‘filter’ list (starting at 1). Defaults to None.

  • instance_url – The URL of the instance to which we want to connect. Only necessary when the username and password are associated to more than one instance. Defaults to None.

  • last_modified_column – The name of the column to use for incremental loading based on the last modified date. If provided, the report must contain this column. Defaults to None.

  • initial_last_modified – The initial last modified date to use for incremental loading. This is useful when we want to load only the records that have been modified since a certain date. Defaults to None. If provided, it must be a string in Salesforce datetime format (with informed timezone).

Methods

__init__(credentials, report, ...[, ...])

Initializes the SalesforceReportSource with the report information and the credentials to access Salesforce.

chunk(working_dir)

Trigger the import of the data.

stream(working_dir)

Attributes

column_name_strategy

credentials

filter

filter_logic

find_report_by

initial_values

Return a dictionary with the initial values to be stored after execution of the plugin.

report