Kintone Ingestion Source
See the Connector Marketplace topic. Please request your administrator to start a trial or subscribe to the Premium Kintone connector.
In Gathr, it can be added as a channel to help in fetching customers’ and prospects’ data and transform it as needed before storing it in a desired data warehouse to run further analytics.
Data Source Configuration
Configure the data source parameters as explained below.
Fetch From Source/Upload Data File
To design the application, you can either fetch the sample data from the Kintone source by providing the data source connection details or upload a sample data file in one of the supported formats to see the schema details during the application design phase.
Upload Data File
To design the application, please upload a data file containing sample records in a format supported by Gathr.
The sample data provided for application design should match the data source schema from which data will be fetched during runtime.
If Upload Data File method is selected to design the application, provide the below details.
File Format
Select the format of the sample file depending on the file type.
Gathr-supported file formats for Kintone data sources are CSV, JSON, TEXT, Parquet and ORC.
For CSV file format, select its corresponding delimiter.
Header Included
Enable this option to read the first row as a header if your Kintone sample data file is in CSV format.
Upload
Please upload the sample file as per the file format selected above.
Fetch From Source
If Fetch From Source method is selected to design the application, then the data source connection details will be used to get sample data.
Continue to configure the data source.
Connection Name
Connections are the service identifiers. A connection name can be selected from the list if you have created and saved connection details for Kintone earlier. Or create one as explained in the topic - Kintone Connection →
Use the Test Connection option to ensure that the connection with the Kintone channel is established successfully.
A success message states that the connection is available. In case of any error in test connection, edit the connection to resolve the issue before proceeding further.
Entity
Tables in Kintone are statically defined to model Kintone entities.
If you selected the Fetch From Source method to design the application, the Entities will list as per the configured connection. Select the entity to be read from Kintone.
If you selected the Upload Data File method to design the application, the exact name of the entity should be provided to read the data from Kintone.
If you selected the Fetch From Source method to design the application, the Fields would list as per the Entity chosen in the previous configuration parameter. Select the fields or provide a custom query to read the desired records from Kintone.
Fields
The conditions to fetch source data from a Kintone table can be specified using this option.
Select Fields: Select the column(s) of the entity that should be read.
Custom Query: Provide an SQL query specifying the read conditions for the source data.
Example: SELECT "Id" FROM Companies
If you selected the Upload Data File method to design the application, provide a custom query to fetch records from the Kintone entity specified in the previous configuration.
Query
The conditions to fetch source data from a Kintone table can be specified using this option.
Provide an SQL query specifying the read conditions for the source data.
Example: SELECT "Id" FROM Companies
Partitioning
This section contains partitioning-related configuration parameters.
Enable Partitioning
This enables parallel reading of the data from the entity.
Partitioning is disabled by default.
If enabled, an additional option will appear to configure the partitioning conditions.
Column
The selected column will be used to partition the data.
Max Rows per Partition: Enter the maximum number of rows to be read in a single request.
Example: 10,000
It implies that a maximum number of 10,000 rows can be read in one partition.
Advanced Configuration
This section contains additional configuration parameters.
Fetch Size
The number of rows to be fetched per round trip. The default value is 1000.
Page size
The number of results to return per page of data retrieved from Kintone.
The page size will automatically be determined if you do not manually set it. It is generally not necessary to ever set this value.
Check for Subtables in
A comma-separated list of Kintone apps to retrieve subtables from.
Set this field to * to check for subtables in all Kintone apps.
Set this field to ‘None’ to not search for any subtables.
Kintone subtables are exposed as separate tables and retrieving the list of all subtables from the API is a time-consuming operation.
By specifying only some app names in this field, the performance of the connector increases.
If there is a large number of apps, listing the tables will take much longer.
Subtable Separator Character
The character used for dividing tables from subtables in the format tablename + char + subtable.
Default Value: “_”
If an app has a subtable, it is represented as a separate table.
Its name will be the AppName + SubtableSeparatorCharacter + SubtableName.
Use this property to set a custom character as the separator and easily identify subtables from apps.
This property allows you to set different special characters in the subtable’s name without breaking your app’s naming conventions.
Guest Space Id
Restrict query results to a guest space.
This connection property restricts query results to the specified guest space.
Example: In the following URL, the GuestSpaceId would be “3”:
https://xlqc1.cybozu.com/k/guest/3/#/space/3/thread/3
Allow Special Characters
Determines whether or not to allow special characters. If true special characters will not be replaced.
Add Configuration: Additional properties can be added using this option as key-value pairs.
Schema
Check the populated schema details. For more details, see Schema Preview →
If you have any feedback on Gathr documentation, please email us!