Kintone Reader
Note
This adapter is in preview and is available on Striim Developer only. See Striim Developer for more information.
Kintone is a cloud-based platform for creating custom business applications without needing to write code, particularly useful for managing workflows, automating tasks, and organizing data. The Kintone Reader allows you to reader from Kintone and synchronize this data with an external database or a data warehouse.
Feature summary
Feature | Supported? | Notes | |
---|---|---|---|
Objects | Standard objects | ✓ | |
Custom objects | ✓ | ||
Authentication | Basic authentication | Username and password | |
OAuth authentication | ✓ | Manual configuration based | |
Custom authentication methods | Not all methods may be supported | ||
Operations | Automated mode | ✓ | |
Initial load | ✓ | ||
Pull-based incremental load | ✓ | ||
Push-based incremental load | |||
Automated pipeline | |||
Governance | Connection profile | ||
Sherlock AI | |||
Sentinel AI | |||
Schema handling | Initial schema creation | ✓ | Works with supported targets |
Schema evolution | |||
Setup | Wizard template | ||
Flow Designer | ✓ | ||
Striim TQL | ✓ | ||
Runtime | Resilience/recovery | ✓ | Supported only for Incremental load. Recovers the data based on the provided Incremental Load Marker. |
Parallel execution | |||
Metrics | ✓ | Standard metrics |
Supported authentication method
The Kintone Reader supports basic authentication.
Supported objects
The Kintone Reader can read from the following supported objects in Kintone:
ActionSettings
ActionSettingsEntities
ActionSettingsMappings
AppPermissions
Apps
FieldPermissions
FieldPermissionsEntities
FormFields
FormLayout
FormLayoutFields
GeneralNotifications
GeneralSettings
GraphSettings
PerRecordNotifications
PerRecordNotificationsTargets
ProcessManagement
ProcessManagementActions
RecordPermissions
RecordPermissionsEntities
ReminderNotifications
ReminderNotificationsTargets
SampleApp
SampleApp_Table
Views
The following objects are not supported:
Comments
Space
SpaceMembers
Kintone Reader properties
Property | Type | Default value | Notes |
---|---|---|---|
App ID | String | The App ID of the kintone application. Data is extracted using this ID. Format: <TableName1>=<AppID1>;<TableName2>=<AppID2> For example: ActionSettings=1 The data of the ActionSettings table is extracted only for this application ID. | |
Connection pool size | Integer | 20 | Specifies the maximum number of active connections. |
Guest Space ID | String | A unique identifier for a Guest Space within the platform. If the URL is https://example.kintone.com/k/guest/12345/ then Guest Space ID is 12345. | |
Exclude tables | String | A list of tables excluded from read operations. Typically used to create a list of exceptions when the Tables property includes wildcards. Misconfiguration of the Tables and Exclude Tables properties can cause "Invalid table names" errors. | |
Incremental load marker | String | The incremental load marker is a unique incremental column in each object used for incremental load. When no marker is specified, tables are resynced at each polling interval. Specify the name of the column that contains the start position value. This column must meet the following criteria:
| |
Migrate schema | Boolean | False | Only available in Initial Load or Automated mode. Set to |
Mode | Select list:
| Automated | Automated mode applies incremental updates to objects that support incremental load and performs full resyncs for objects that do not support incremental load. |
Polling interval | Integer | 5m | Specifies an interval as an integer followed by a unit. Supported units are days ( |
Refresh token | Password | An OAuth 2.0 refresh token.Use the value generated while creating the token. | |
Start Position | String | %=-1 | Value of the incremental load marker that defines the initial reading position. |
Tables | String | A semicolon-delimited (;) list of objects to read from the source. Supports the | |
Thread pool count | Integer | 10 | The number of parallel running threads. The default value of zero specifies single-threaded operation. When the value of the thread pool counter is higher than the connection pool size, large data ingestion operations can cause the app to halt. Since best performance is achieved when using one thread for each table being synced, increasing the size of the connection pool to match the number of threads in use is a performance best practice. |
URL | String | The Kintone workspace URL. | |
Username | String | The Kintone account user name. | |
Password | Password | The Kintone account password. |
Limitations
The Kintone Reader does not support wizards to create an application. You can create your application with the Flow Designer.