Sources: Overview of Methods

A source is a separate connection to an external system in the BI connector module. The source defines which specific data from the external system will be available for use in reports and analytics in Bitrix24.

Quick navigation: All Methods

User documentation: BI Builder: Datasets

Connection of the Source with the Connector and DatasetsConnection of the Source with the Connector and Datasets

The source is registered through the connector. In the hierarchy of the BI connector module, sources occupy an intermediate level:

• Connector establishes a connection with an external data source.
• Source defines the access parameters for the data.
• Dataset forms the final set of data that can be used in reports and analytics.

Description of Source FieldsDescription of Source Fields

Settings FieldSettings Field

The settings field contains a list of parameters for authorization via the connector. Parameters are passed in an object format, where the key is the identifier of the code parameter.

The code values are stored in the settings field of the connector. They can be retrieved using the biconnector.connector.list or biconnector.connector.get methods. If the connector contains a parameter with the code token, when creating a source, pass the value in the object settings:

{
            "fields": {
                "connectorId": 12,
                "title": "Sales source",
                "settings": {
                    "token": "12345"
                }
            }
        }
        

Before You BeginBefore You Begin

1. Create a connector using the biconnector.connector.add method or select an existing connector using the biconnector.connector.list method
2. Retrieve the authorization parameter codes from the settings field of the connector
3. Create a source using the biconnector.source.add method and pass connectorId and the authorization values into the settings field
4. Verify the source using the biconnector.source.get or biconnector.source.list method

Overview of MethodsOverview of Methods

Scope: biconnector

Who can execute methods: A user with access to the "Analytics hub" section