This page contains the instructions on how to create a new SQL connector and connect it to your source systems.
It is assumed that the development tools described in Setting up a development environment are installed.
If you want to build a new SQL connector you can download the template connector that contains the basic setup for a SQL connector.
It is advised to store your connector in a version control system, for example, GitHub.
Create a new repository that contains the complete connector directory.
First, the extraction settings need to be set, to point to the desired source system and staging database. These configuration steps must be done once for each developer environment, and for the production environment.
Each connector comes with a set of specific extraction methods. One of the extraction methods needs to be configured, to extract source data.
• Set up a CData job for the Load-from-file extractor. See Extractors: Load from file.
To load input data from a source system, use the specific instructions located in
The load-from-source extractor is only available in connectors made for specific source systems, for example a Purchase-to-pay for SAP connector.
Make sure to set the appropriate filters for your extractor, to load only the data that is necessary for your analysis. For example, limit the data to the last 6 months, or only a specific department that’s of interest.
Specific instructions on filtering input data can be found in
instructions.md of the extractor.
If the connector uses CData Sync for data extraction, the
extract_cdata.ps1 script must be pointed to the correct job. Follow these steps to configure the extraction script.
If the connector does not use CData Sync for extracting data, then use the specific instructions provided in
To perform the transformation on the right staging database,
profiles.yml needs to have a reference to your staging database for this connector. These configuration steps need to be done once for each developer environment, and for the production environment. Follow these steps to configure the transformation.
Copy the contents of
Paste the contents in your personal
Change the contents to point to your staging database.
To perform cache generation by using the load.ps1 script, it must be pointed to the Process Mining environment on which the corresponding app release is active. Follow these steps to configure the extraction script.
Step 1 can be omitted if it was already performed during configuration of the extraction.
When the SQL connector is set up properly, it can be run. See Running a SQL connector.
Updated about a month ago