GeneralSettings
Provides access to an app's high-level configuration such as name, icon, and operational behavior, supporting version control and configuration audits.
Select
The AppId column is required in the WHERE clause. The connector will use the Kintone APIs to filter the results by this column. By default, the connector will process other filters client-side within the connector.
For example, the following queries are processed server side:
SELECT * FROM GeneralSettings WHERE AppId = 6 SELECT * FROM GeneralSettings WHERE AppId = 6 AND IsPreview = false
Update
You must specify the AppId and IconKey of the GeneralSetting to update.
UPDATE GeneralSettings SET Name = 'UpdatedName', Description = 'Test Description', IconType = 'PRESET', IconKey = 'APP72' WHERE IconKey = 'APP72' AND AppId = 6
Columns
| Name | Type | ReadOnly | References | Description |
| AppId [KEY] | Integer | True |
Identifier of the Kintone app whose general settings are being retrieved or updated. | |
| IconKey [KEY] | String | False |
Key identifier of the app's icon, returned when the app uses one of Kintone's preset icons. | |
| IconType | String | False |
Specifies the type of icon used for the app, indicating whether the icon is a PRESET icon or an uploaded FILE. | |
| IconFile | String | False |
Object containing data for an uploaded icon file when a custom icon is used for the app. | |
| Name | String | False |
Display name of the app as shown in the Kintone interface. | |
| Description | Longvarchar | False |
HTML-formatted description of the app, often used to provide context or usage instructions to users. | |
| Theme | String | False |
Color theme applied to the app, controlling the visual styling of the app's header and interface accents. | |
| Revision | String | True |
Revision number of the app settings, helping track updates made to the app's configuration. | |
| TitleFieldSelectionMode | String | False |
Method used to determine which field becomes the record title, allowing either AUTO selection or MANUAL selection by the app designer. | |
| TitleFieldCode | String | False |
Field code of the field designated as the record title when MANUAL selection mode is used. | |
| EnableBulkDeletion | Boolean | False |
Indicates whether users are allowed to delete multiple records at once using the bulk deletion feature. | |
| EnableComments | Boolean | False |
Indicates whether commenting is enabled for the app, allowing users to post comments on records. | |
| EnableDuplicateRecord | Boolean | False |
Indicates whether users are allowed to duplicate existing records to create new ones more quickly. | |
| EnableThumbnails | Boolean | False |
Indicates whether thumbnails should be displayed for fields that support image previews. | |
| FirstMonthOfFiscalYear | Integer | False |
Specifies the first month of the fiscal year for the app, returned as a numeric month value. | |
| NumberPrecisionDecimalPlaces | Integer | False |
Specifies the number of decimal places to use when rounding numeric values. | |
| NumberPrecisionDigits | Integer | False |
Specifies the total number of digits to allow for numeric values, including integer and fractional parts. | |
| NumberPrecisionRoundingMode | String | False |
Rounding mode applied to numeric values, supporting HALF_EVEN, UP, or DOWN. | |
| EnableInlineRecordEditing | Boolean | False |
Indicates whether inline editing is enabled in the record list, allowing users to modify fields directly without opening the record. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Lang | String |
Locale code used to retrieve general setting values in a specific language. |
| IsPreview | Boolean |
Indicates whether to retrieve general-setting details from the preview environment ('true') or from the live environment ('false'). The default value is 'true'. |