user Guide - updating the csv export article (#13762)

Co-authored-by: Charles Bochet <charlesBochet@users.noreply.github.com> Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
2025-08-08 20:43:38 +02:00
parent 48e783c4fa
commit 42336f1d23
16 changed files with 170 additions and 40 deletions
@@ -0,0 +1,7 @@
+---
+title: Collaborate with your team
+icon: IconUsers
+info: Discover how to leverage Notes and Tasks to better collaborate with your team.
+image: /images/user-guide/what-is-twenty/20.png
+sectionInfo: A brief guide to grasp the basics of Twenty
+---
@@ -6,67 +6,85 @@ image: /images/user-guide/create-workspace/workspace-cover.png
 sectionInfo: Discover Twenty, an open-source CRM.
 ---

-Every business works differently. That’s why Twenty lets you shape the CRM around your needs—not force your process into ours. These three steps will help you set it up your way.
+Every business works differently. That’s why Twenty lets you shape the CRM around your needs—not force your processes into ours.  
+**Start with these three steps to set it up your way.**

 # Bring your data in
 Bringing your existing data into Twenty gives your team context from the start. 
 We're here to help you make this transition as smooth as possible. Do not hesitate to reach out.

 ## Connect your mailbox
-If you have not done so when creating your workspace, connect you Google or Microsoft account. This allows Twenty to:
+If you have not done so when creating your workspace, connect you **Google or Microsoft account**. This allows Twenty to:
 - Import your messages and meetings
 - Auto-create contacts based on interactions (optional)
 - Keep communication history visible for your team

 You can do so under Settings → Accounts.

-You control which contacts are imported in Twenty and what gets shared with the rest of your team: full message content, subjext and the metadata (sender, date, subject), or just the metadata. This is the same for your meetings.
-Configure the visibility and contact creation preferences under the Email and Calendar settings.
+You control which contacts are imported in Twenty and what gets shared with the rest of your team: full message content, subject and the metadata (sender, date, subject), or just the metadata. This is the same for your meetings.
+You can configure the visibility and the contact creation preferences under Settings → Email / Calendar.
+
+### Using another provider?
+This is currently under beta: you can activate this feature under Settings → Lab.
+You can add email accounts from any provider that supports IMAP and send emails with SMTP. Synchronizing calendars with CalDAV is coming soon!


 ## Import data via csv
 Use the csv import to add contacts who are not in your mailbox, product data or existing enrichment you might have, as well as your previous deals, notes, tasks.
 Import via csv is available for any custom object.

-To import a CSV, make sure you’re on the right object first—like 'All people’ if you’re uploading people. Then open the Command menu and choose ```Import records```. 
- Download the sample to provide a csv in the expected format.
- You can upload up to 10k records per csv
- Do not include duplicate emails for People or duplicate domains for Companies. These fields are used as unique identifiers, alongside the id fields.
- Creating relations between objects via csv currently needs to be done providing the records ids. Here is an example:
-  - Upload your companies in Twenty
-  - Export all the companies from Twenty
-  - Add in your People.csv a column companyId, containing the if of the related company in Twenty.
-  - Map this field to the Company when uploading your People records.
-  Relations will be supported by the csv import function during the Fall 2025. Please reach out to us to get any help importing your data.
+To import the csv file, make sure to open the Command menu ( ```Cmd + K``` or ```Ctrl + K```) from a view listing the object you're about to upload.  
+Then, click on ```Import records```. 
+
+Below are a few guidelines:
+
+- Download the sample file to understand the expected format.
+- Limit each file to 10k records.
+- Remove duplicate emails for People or duplicate domains for Companies. These fields are used as unique identifiers, alongside the id fields.
+- Create relations between objects using the Twenty id, the person's email or the company domain.  
+Creating relations via csv based on fields other than the Twenty id for the other objects will be supported during the Fall 2025. 
+- Review errors before starting the import: Potential errors are detected once the field mapping is completed. You can edit the wrong values - highlighted in yellow - directly in the UI.  
+
+**Please reach out to get any help importing your data.**

 # Customize your data model
-Twenty offers the flexibility you need to shape the data model that will best support your day-to-day. 
+Twenty offers the flexibility you need to shape the data model that will best support your day-to-day.   
 Create objects and fields of any type, inlcuding relations between your different objects. You can do so under Settings → Data Model.
 Here are a few tips:
+- **You are not limited in the number of custom fields nor custom objects**. Adding custom objects and fields will not lead to upgrading your plan.
+- **People and Companies are the two fields from where you will be able to access the emails and meetings**. We recommend using those as much as possible, adding fields to categorize your records if need be. Here is an example:
+  - It is best to use the People object for your prospects and partners, creating a field on the People object named ```Person Type```, instead of creating a Partner custom object (from where you will not be able to access the emails exchanged with this person).
+  - Create different views under People, one to display partners and one to display prospects. 
+- Two People cannot have the same email address. Two Companies cannot have hte same domain. 
 - You can deactivate fields and objects you do not want to use.
- You can hide fields from the views: don't be afraid of creating fields, you won't have to display all of them
- You are not limited in the number of custom fields nor custom objects
- People and Companies are the two fields from where you will be able to access the emails and meetings. We recommend using those as much as possible, adding fields to categorize your records if need be.
-  - As an example, it is preferred to use People for your Prospects and Partners, creating a custom field on the People object named ```Person Type```, instead of creating a Partner custom object (from where you will not be able to access the emails exchanged with this person).
- Two People records cannot have the same email address. This is the same for Companies and domains. 
-
+- You can hide fields from views: don't be afraid of creating fields, you won't have to display all of them.

 # Create your first Favourite view
 Creating different views is key to make the data actionable for your team.
+Here is how to proceed:
+-  **Add or hide columns**
+    - Manage the fields visible in a given view clicking on Options  → Fields (from the top right). You can show/hide fields from there.
+    - If the need is punctual, hide a column clicking on its name and then ```Hide```. Add a column clicking on the ```+``` at the very right of the table and select the one you need.

-Start editing a table view:
-  Add or hide columns.
-    - Hide a column clicking on its name and then ```Hide```
-    - Add a column clicking on the ```+``` at the very right of the table.
-    - You can also manage the fields visible in a given view clicking on Options and then Fields.
- Reorder fields
-  - Use the Move Left, Move Right functions when clicking on the column name or reorder the fields under the Options / Fields section.
- Filter records by value or status
- Sort records
-And then Save it. You can also switch to Kanban layout or Group by layout if your object has a “stage” or similar select-type field.
-Finally, you can add it to your Favourties section using the dropdown menu showing the different views.
+- **Reorder fields**
+    - Reorder the fields from a given view clicking on Options  → Fields (from the top right). Drag and drop the fields to reorder them. 
+    - If the need is punctual, you can ```Move Left/Right``` a column by clicking on its name.
+
+- **Filter records**
+    - This is done from the top right.
+    - Advanced filters are also available.
+
+- **Sort records**
+    - This is done from the top right, or by clicking on a column name.  
+
+-  **Save** your view and rename it
+
+-  **Choose the layout** 
+    - You can switch to a **Kanban layout** or a **Group By** layout -- as long as the object has a “Stage” or similar select-type field.  
+-  **Add it to your Favorties** 
+    - This can be done using the dropdown menu showing the different views.


 ## What's next?
-Start creating automations using workflows.
+Start creating automations using <ArticleLink href="https://twenty.com/user-guide/section/integrations/getting-started-workflows">workflows</ArticleLink>.
 <ArticleEditContent></ArticleEditContent>
@@ -1,5 +1,5 @@
 ---
-title: Functions
+title: Integrations
 info: Learn how to connect Twenty to your other tools.
 icon: IconApi
 image: /images/user-guide/api/api.png
@@ -5,6 +5,30 @@ icon: IconApi
 image: /images/user-guide/api/api.png
 sectionInfo: Learn how to connect Twenty to your other tools.
 ---
+## Twnenty API
+Twenty offers APIs in **REST and GraphQL**.  
+- Use the **Metadata API** for anything related to your workspace and its data model.
+- Use the **Core API** for anything related to your records.
+
+### Your unique APIs
+Unique APIs are generated for your workspace, to perfectly reflect your custom data model.  
+This means you will have a dedicated endpoint for each of your custom objects and custom fields -- which will make the dev experience much nicer!
+
+
+### Benefits of the GraphQL APIs
+- **Batch operations** are available with the GraphQL APIs. You just need to use the plural name of your object.  
+  *Example*: use the mutation ```CreateCompanies``` instead of ```CreateCompany``` for your batch creation.
+    *(This is the reason why the singular and plural names of your object needs to be distinct.)*
+
+- **Upsert** option is available with the GraphQL APIs.
+
+
+## API Documentation 
+**Twenty API documentation is accessible under your workspace Settings -> API.**
+As unique APIs are generated to perfectly reflect your data model, Twenty creates customized API documentation.
+This is why you need to input an API key to access it.  
+You will also find a playground where you can test the APIs and the data returned.
+

 ## API Keys

@@ -0,0 +1,52 @@
+---
+title: Getting started with workflows
+info: Learn how to add automations in Twenty and how to data in and out.
+icon: IconApi
+image: /images/user-guide/api/api.png
+sectionInfo: Learn how to connect Twenty to your other tools.
+---
+## What can I do with workflows?
+There are two main categories of actions you can automate using the workflows.
+  1. Automate the busy work within Twenty to reduce what your team needs to update manually while maintaining an up-to-date CRM.
+  2. Bring data in and out of Twenty from your other tools: forms, product data, enrichment, call recorders, invoicing solution and so on.
+
+Let's deep dive into a few examples before getting into the how.  
+
+## 1. Automate the busy work
+Your CRM is only helpful if the data’s up to date — but no one likes updating it manually.  
+Use workflows to automate low-value, repeatable tasks.
+- Bring a field from one object to another. Exaxmple:
+- Automatically attach the person you've just created with the related Company record. Create one if none exist.
+- Automatically update the Company tag from `Prospect` to `Customer` when an opportunity is moved to `Won`, create onboarding Tasks assigned to the relevant team and trigger an invoice.
+- Automatically update the Company tag from `Customer` to `Churned` when the related subscription gets cancelled.
+- Send an email alert to the company owner when a key prospect starts engaging with your solution.
+- Send an email alert to the company owner when a contract end date is near or engagement drops.
+
+To do so, you will mainly use the triggers Create/Update Records and the actions Create/Update Records, Send Email.
+
+
+## 2. Bring data in and out of Twenty
+If you need to bring data in and out of Twenty from your other tools, let's do this using a workflow.
+Below are a few examples of what you can build.
+- Create records from **form fills** on your website (flag demo requests in real-time, log job applicants, ...)
+- Give your sellers the context they need to be on top of their accounts, bringing **product data** in Twenty
+- Connect your **call recorder** to automatically create a Note in Twenty with the summary of a meeting and a Task with the action items
+- Enrich your leads with demographics enrichment to know who your team is talking to
+- Send the informations needed to generate an invoice once a deal is closed
+
+To do so, you will mainly leverage the ```On a schedule``` and ```Webhook``` triggers, as well as the ```HTTP``` and ```Code``` functions. 
+### What if I don't want to build those connections?
+We got you covered! Just reach out and we will put you in contact with our certified implementation partners. They can create your data model, migrate your data, build your workflows.  
+
+### I'm not sure the connection I need to doable 
+Send us a message and we will help you assess the feasibility. 
+
+## What we're working on
+Here are the main items we're working on to improve workflows:
+- If / Else step
+- Paths
+- Loops
+- AI agent to build workflows on your behalf
+
+
+<ArticleEditContent></ArticleEditContent>
@@ -1,5 +1,5 @@
 ---
-title: Objects
+title: Objects, Fields, Records
 info: Discover how to use standard and custom objects in your workspace.
 icon: IconChecklist
 image: /images/user-guide/objects/objects.png
@@ -7,20 +7,49 @@ sectionInfo: Discover how to use standard and custom objects in your workspace.
 ---

 ## Import data
+You can import data for any object into Twenty using a .csv, .xlsx, or .xls file. Each of the files you will upload needs to contains one type of object (for example, only People records). 
+You can use the Import to create or update records.

-You can import People and Companies data into Twenty from other apps using a .csv, .xlsx, or .xls file. In the <b>Companies</b> or <b>People</b> page, click on the `⋮` icon and then select `Import records`.
+### Download a sample file to match the expected formatting
+1. Go to a view of records of the object you're about to import. 
+2. Click on the `⋮` icon on the top right and then select `Import records`.
+3. Click on `Download sample file`.

-Upload your file, match the columns, check your data and import it.
+### Prepare your csv
+Here are a few things to check ahead of uploading your file. 
+- Limit the number of records to 10,000 per csv.
+- Remove duplicated email or duplicated domains from your file.
+- We recommend using the syntax ```https://domain.com``` when uploading your domains, as this is the one used by our connector with your mailbox and calendar.
+- You can import the relations between objects by providing the associated record id. 
+  - Example: A person is attached to an opportunity. Provide the (Twenty) company Id when uploading the people records - this will attach them to the associated company. 
+  - We are currently improving this: let us know if you need help in the meantime.
+
+### Upload your file
+1. Go to a view of records of the object you're about to import. 
+2. Click on the `⋮` icon on the top right and then select `Import records`.
+3. Click on `Select file`.
+4. Validate the mapping of the fields. You don't have to import all of them, you can choose the "Do not map" option. You might need to also map the values of your select type and multi select type fields.
+5. Click on `Next Steps` and `Review the rows with errors`. Cells with an issue are highlighted. You can either remove the row or update the cell directly from there.
+6. Once you're done, click on `Confirm`

 <img src="/images/user-guide/import-export-data/match-columns.png" style={{width:'100%'}}/>

+
+### Import FAQ
+- Duplicated email issue: make sure there is no record already in Twenty with this given email or twice the same email in your csv.
+- I cannot import relations: reach out to us, we will assist you. 
+- I want to migrate the IDs from my other system(s): we recommend creating a field with type Text. You can upload your ids there. 
+- I want to use the Import csv to update records: feel free to only match the id of your records and the field(s) to update. The remaining (unmapped) fields won't be changed.
+
+
 ## Export data

+You can download data from most of your objects and up to 20,000 records per export.
 To export data from an object:

 1. Visit the object index.
-2. Choose the view for data export.
-3. Access the side panel through the `⋮` icon.
+2. Choose the view for data export. Configure the columns you want to download by hiding or adding columns and find the records you need by filtering your view.
+3. Access the side panel through the `⋮` icon on the top right.
 4. Click on `Export view`.
 5. Select the save location for the CSV data. Note that exporting may take time with a large record count.

@@ -43,4 +72,4 @@ To export data from an object:
 </div>
 <script src="https://player.vimeo.com/api/player.js"></script>

-<ArticleEditContent></ArticleEditContent>
+<ArticleEditContent></ArticleEditContent>