Kaiten universal imports
This specification outlines the process and requirements for importing data from other task management tools into Kaiten. The import process is designed to integrate external data seamlessly into our system, ensuring that it can be processed accurately and effectively. Kaiten supports importing data across multiple sections, including:
Boards*
Cards
Columns*
Comments
Custom fields
Card files
Users
Spaces
Folders
Documents*
Document files
* - Variants of imports.
Import Option 1: Documents Only
The user can choose to import just the Documents section without needing to include Boards, or Columns. This import will function with only document-related data present in the meta-data.json file.Import Option 2: Columns and Boards
If the user specifies import of Boards or Columns, the system will require both entities to be included in the meta-data.json file.Import Option 3: Everything
The user can choose to import all sections: Documents, Boards, and Columns, in which case all must be present in the meta-data.json file.In summary, the system allows:
Importing Documents only.
Importing Columns and Boards as a group (both must be included).
Importing everything (Documents, Boards, Columns).
The import process begins with a file named meta-data.json, which acts as the entry point for the import. This file contains references to each of the sections mentioned above, with the value of each section being the relative path to its corresponding JSON file. These JSON files contain the detailed structure and required fields for each section, ensuring that the imported data is compatible with Kaiten's internal architecture. Once the meta-data.json file is processed, each section is handled separately based on its respective JSON schema. The schema definitions provide a clear guideline on the expected format and content, allowing for a smooth import and integration into the Kaiten system.
