From 79715ffc8d9b3a5226406fe342c36c63f4be46ae Mon Sep 17 00:00:00 2001 From: Constantin Graf Date: Wed, 16 Oct 2024 10:33:33 +0200 Subject: [PATCH] Updated import/export --- docs/user-guide/delete-users-organizations.md | 2 +- docs/user-guide/export.md | 59 +++++++++++++++++++ docs/user-guide/import.md | 7 ++- 3 files changed, 65 insertions(+), 3 deletions(-) create mode 100644 docs/user-guide/export.md diff --git a/docs/user-guide/delete-users-organizations.md b/docs/user-guide/delete-users-organizations.md index cf9df72..7a4fedd 100644 --- a/docs/user-guide/delete-users-organizations.md +++ b/docs/user-guide/delete-users-organizations.md @@ -1,5 +1,5 @@ --- -sidebar_position: 5 +sidebar_position: 7 --- # Delete organizations or your account diff --git a/docs/user-guide/export.md b/docs/user-guide/export.md new file mode 100644 index 0000000..822784a --- /dev/null +++ b/docs/user-guide/export.md @@ -0,0 +1,59 @@ +--- +sidebar_position: 6 +--- + +# Export + +To make sure that you can always access your data, we provide a way to export your data from solidtime. +The export can also be useful to migrate from a self-hosted solidtime instance to the cloud version or to another self-hosted instance. + +## Exporting an organization + +1. Choose the organization you want to export in dropdown in the left top corner +2. Click on "Export" in the left navigation under "Admin" (You need to be Admin or Owner of the organization to see this) +3. Click on "Export" and save the ZIP file + +The ZIP file contains the following data: + - Clients + - Members + - Organization invitations + - Organization settings + - Projects (incl. members) + - Tags + - Tasks + - Time entries + +### Technical details + +The export is a ZIP file that contains a CSV file for each entity. It also contains a `meta.json` file that contains the metadata of the export. + +The CSV files are: + - `clients.csv` + - `members.csv` + - `organization_invitations.csv` + - `organizations.csv` + - `project_members.csv` + - `projects.csv` + - `tags.csv` + - `tasks.csv` + - `time_entries.csv` + +The CSV files are named after the entity in the database. The columns in the CSV files are named after the attributes of the entity. + +The CSV files are UTF-8 encoded, have a header row, and are separated by a comma (`,`). If necessary the values are enclosed by double quotes (`"`). + +More information about how data types are exported: + + - Boolean: `true` or `false` + - Date time: ISO 8601 format, Timezone is always UTC (example: `2021-01-01T12:00:00Z`) + - IDs: UUID version 4 (example: `ebf1384d-6dc7-4f93-872d-2f53dd481d30`) + - Null values: Empty string (`""`) + - Money values: Integer value in cents (example: `1000` for `10.00`) + +The `meta.json` file contains the following data: + + - `id`: The ID of the export + - `version`: The version of the export format + - `organizations`: An array of organization keys that are exported + - `exported_at`: The timestamp when the export was created in ISO 8601 format (example: `2021-01-01T12:00:00Z`) + diff --git a/docs/user-guide/import.md b/docs/user-guide/import.md index 50f2ec8..d288a4c 100644 --- a/docs/user-guide/import.md +++ b/docs/user-guide/import.md @@ -9,14 +9,17 @@ To make migrating to solidtime as easy as possible, we provide a way to import y Currently, we support importing data from the following sources: - [Toggl](https://toggl.com/) - [Clockify](https://clockify.me/) + - solidtime More import sources will be added in the future. If you are using a different time tracking tool and would like to import your data into solidtime, please [contact us](mailto:hello@solidtime.io) or [create a GitHub issue](https://github.com/solidtime-io/solidtime/issues/new). ## How to import data -1. In the left top corner click on the name of your organization and in the dropdown click on "Organization Settings" -2. Scroll down to the "Import Data" section +To import data into solidtime, follow these steps: + +1. Select the organization you want to import the data to in the left top corner +2. Click on "Import" in the left navigation under "Admin" (You need to be Admin or Owner of the organization to see this) 3. Select the import that you want to use 4. After selecting the import an instruction will be shown on how to export the data from the source tool 5. Follow the instruction and upload the exported file in the upload area below the instructions