Skip to content

Commit 2183841

Browse files
korridorkorridor
committed
Added imports, updated placeholder roles
1 parent 21c1658 commit 2183841

File tree

2 files changed

+46
-4
lines changed

2 files changed

+46
-4
lines changed

‎docs/user-guide/import.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ To make migrating to solidtime as easy as possible, we provide a way to import y
99
Currently, we support importing data from the following sources:
1010
- [Toggl](https://toggl.com/)
1111
- [Clockify](https://clockify.me/)
12+
- [Harvest](https://www.getharvest.com/)
1213
- solidtime
14+
- [Generic CSV Import](#generic-csv-import)
1315

1416
More import sources will be added in the future.
1517
If you are using a different time tracking tool and would like to import your data into solidtime, please [contact us](mailto:[email protected]) or [create a GitHub issue](https://github.com/solidtime-io/solidtime/issues/new).
@@ -36,3 +38,43 @@ To get the most accurate data, the order of the imports is important.
3638
For example, when importing Toggl data, you should first use the "Toggl Data Importer" and then the "Toggl Time Entries" import.
3739

3840
The correct order of the imports is shown in the instructions after selecting the import. Please read those instructions carefully, before importing data.
41+
42+
## Generic CSV Import
43+
44+
solidtime offers to import from common other time tracking tools, but you might want to migrate from a different tool or a custom solution like an Excel sheet.
45+
In that case the generic CSV import might help you achieve that.
46+
To use this import method you need to convert your data into CSVs with a data structure like the one defined in the following sections.
47+
Since the time entries importer can indirectly also import projects it is better to first import the projects and then the time entries.
48+
This way you can import more information about the project then just the name.
49+
All generic import CSVs need to be comma-seperated and in UTF-8. If necessary the values can be enclosed in `"`.
50+
51+
52+
### Generic projects importer
53+
54+
55+
| Column | Description | Data type |
56+
|------------------|-------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------|
57+
| name | Name of the project | Text (f.e. `Big project 2030`) |
58+
| color | Color of the project. If empty a random color that matches the style of solidtime will be used. | Color in Hex (f.e. `#ef5350`) |
59+
| billable_rate | Billable rate for this project (in Cents) | Number (f.e. `20000`) |
60+
| is_public | Whether the project is public | `true` or `false` |
61+
| client | The name of the client of the project. If empty the project doesn't have a client | Text (f.e. `Big ACME company`) |
62+
| billable_default | Whether the time entries should be billable per default | `true` or `false` |
63+
| estimated_time | Estimated time the project takes (in seconds) | Number (f.e. `3600`) |
64+
| archived_at | When the project was archived. If empty the project is not archived | ISO 8601 format, Timezone is always UTC (example: `2021-01-01T12:00:00Z`) |
65+
66+
### Generic time entries importer
67+
68+
69+
| Column | Description | Data type |
70+
|-------------|------------------------------------|----------------------------------------------------------------------------------------|
71+
| description | Name of the project | Text (f.e. `Video conference about XY`) |
72+
| billable | Whether the time entry is billable | `true` or `false` |
73+
| client | Name of the client | Text (f.e. `Big company`) |
74+
| project | Name of the project | Text (f.e. `Big project 2030`) |
75+
| tags | List of tags | Comma-seperated list (f.e. `Project managment,Meeting`) |
76+
| start | Start timestamp | Date time in ISO 8601 format, Timezone is always UTC (example: `2021-01-01T12:00:00Z`) |
77+
| end | End timestamp | Date time in ISO 8601 format, Timezone is always UTC (example: `2021-01-01T12:10:01Z`) |
78+
| task | Name of the task | Text (f.e. `Feature YX`) |
79+
| user_name | Name of the user | Text (f.e. `Peter Tester`) |
80+
| user_email | Email of the user | Email (f.e. `[email protected]`) |

‎docs/user-guide/roles.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The owner has full access of the organization.
1313
The owner is the only role that can:
1414
- delete the organization
1515
- transfer the ownership to another user
16-
- solidtime cloud: access to the billing settings
16+
- solidtime Cloud: access to the billing settings
1717

1818
## Admin
1919

@@ -38,11 +38,11 @@ Placeholder users are used for imports and to remove users from the organization
3838
If you are importing data from another time tracking tool, the importer, depending on the data, needs to create users in the organization.
3939
Since you might want to invite users to solidtime one by one, the importer only creates placeholder users, that will be used for their time entries.
4040

41-
**Remove users**
41+
**Deactivate members**
4242

43-
Note: This feature will be available soon
43+
If you want to remove a user from the organization, but you don't want to delete their time entries, you can deactivate the member from the organization and the user will be converted to a placeholder user.
44+
If you use solidtime Cloud, those deactivated members are also not billed.
4445

45-
If you want to remove a user from the organization, but you don't want to delete their time entries, you can remove the user from the organization and the user will be converted to a placeholder user.
4646

4747
### Invite placeholder users to become real users
4848

0 commit comments

Comments
 (0)