ODBC Driver for Kintone

Build 25.0.9539

ProcessManagement

Controls the workflow rules that govern how records move through states, allowing administrators to manage process steps, transitions, and restrictions.

Select

The AppId column is required in the WHERE clause. The driver will use the Kintone APIs to filter the results by this column. By default, the driver will process other filters client-side within the driver.

For example, the following queries are processed server side:

SELECT * FROM ProcessManagement WHERE AppId = 6
SELECT * FROM ProcessManagement WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM ProcessManagement WHERE AppId = 6 AND IsPreview = false

Update

For updating the ProcessManagement, provide the States and Actions as an aggregate. The AppId column is required to update the ProcessManagement.

UPDATE ProcessManagement SET Enable = true, States = '{"In progress":{"name":"In progress","index":"1","assignee":{"type":"ONE","entities":[]}},"Ready":{"name":"Ready","index":"3","assignee":{"type":"ONE","entities":[]}},"Completed":{"name":"Completed","index":"2","assignee":{"type":"ONE","entities":[]}},"Not started":{"name":"Not started","index":"0","assignee":{"type":"ONE","entities":[{"entity":{"type":"FIELD_ENTITY","code":"Created_by"},"includeSubs":false}]}}}', Actions = '[{"name":"Start","from":"Not started","to":"In progress","filterCond":""},{"name":"Complete","from":"Completed","to":"Completed","filterCond":""}]' WHERE AppId = 6

Columns

Name Type ReadOnly References Description
AppId [KEY] Integer False

Identifier of the Kintone app whose process-management configuration is being retrieved or updated.

Enable Boolean False

Indicates whether process management is enabled for the app, controlling whether records progress through defined workflow states.

Actions String False

Array containing the app's process-management actions in the same order shown in the user interface, with the value of 'null' returned when process management has never been enabled.

Revision String True

Revision number of the app settings, helping track updates made to the process-management configuration.

Name String False

Display name of the workflow status associated with the current process-management state.

Index String False

Ascending display order of the workflow status, determining its position relative to other statuses.

AssigneeType String False

Type of assignee list used for the status, defining how users or groups are selected to handle the workflow step.

AssigneeEntities String False

Array listing the assignees configured for the status, returned in the same order presented in the user interface.

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 process-management details in a specific language.

IsPreview Boolean

Indicates whether to retrieve process-management details from the preview environment ('true') or from the live environment ('false'). The default value is 'true'.

States String

Value used only when performing an update to supply modified process-management state definitions.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 25.0.9539