i18n - docs translations (#16779)

Created by Github action

---------

Co-authored-by: github-actions <github-actions@twenty.com>
This commit is contained in:
github-actions[bot]
2025-12-23 17:06:38 +01:00
committed by GitHub
parent 1bc344c6fa
commit e3757f300a
1080 changed files with 89730 additions and 9944 deletions
@@ -0,0 +1,122 @@
---
title: Fields
description: Understand the role of fields and how to manage them.
---
import { VimeoEmbed } from '/snippets/vimeo-embed.mdx';
## About Fields
Fields are like columns in a spreadsheet. They store different types of data like text, numbers, or dates. Fields can be standard (built-in) or custom (the ones you create).
### Standard Fields
Standard fields come built-in with Twenty to handle common business needs.
For example, `First Name` and `Last Name` are standard fields in the `People` object. They store text data for individual names.
You cannot delete standard fields, but you can deactivate them if you don't need them.
You can also customize the options of the standard `SELECT` type fields, for example the options for the `Stage` on Opportunities.
<img src="/images/user-guide/fields/standard-fields.png" style={{width:'100%'}} />
### Custom Fields
Custom fields can be added to any object. You can store text, numbers, dates, dropdown selections, and more. Use custom fields to track information that's specific to your business.
For instance, a custom field for SpaceX could be `Rocket Active Status`, indicating if a rocket is operational.
<img src="/images/user-guide/fields/custom-fields.png" style={{width:'100%'}} />
## Field Types
Twenty supports various field types:
| Type | Description | Example |
| ------------ | ----------------------------------------------------------------- | ------------------ |
| Address | Structured address with street, city, state, country, postal code | Office Address |
| Array | List of text values | Tags |
| Boolean | True/false checkbox | Is Active |
| Currency | Monetary value with currency code | Deal Amount (USD) |
| Date | Date values | Close Date |
| Date & Time | Date with time | Meeting Time |
| Domain | Website domain (used for Companies) | acme.com |
| Email | Email addresses (with primary + additional) | Contact Email |
| JSON | Structured JSON data | Custom metadata |
| Links | URLs with labels (primary + secondary) | Website, LinkedIn |
| Long Text | Multi-line text | Description, Notes |
| Multi-Select | Multiple choices from a predefined list | Tags, Categories |
| Number | Numeric values (integers or decimals) | Quantity, Score |
| Phone | Phone numbers with country code | Work Phone |
| Rating | Star rating (1-5) | Priority, Score |
| Relation | Links to records in other objects | Company → People |
| Select | Single choice from a predefined list | Stage, Status |
| Text | Single line of text | Name, Title |
## Create a Custom Field
To add a custom field to any object, follow these steps:
1. Go to `Settings` in the left sidebar.
2. Go to `Data Model`, then select the object you wish to customize.
3. Proceed by clicking on `Add Field`.
4. Choose a field name and type that suits your requirements. Consider adding a field description for better understanding.
Your newly created field is now available within the application's fields. To display it on a specific view, click on the options menu, then select `Fields`.
<VimeoEmbed videoId="927628219" title="Video demonstration" />
**Quick way:** Click the **+** button at the top right of any object table, then select `Customize fields`. This takes you directly to the Data Model settings.
<img src="/images/user-guide/fields/quick-new-field.png" style={{width:'100%'}} />
## Deactivate a Field
You can deactivate a field to hide it from the app without losing your data. Think of it as hiding the field rather than deleting it.
Here's how you can do it:
1. Find the field you want to deactivate in your object settings.
2. Click the three dots `⋮` next to the field to open the menu.
3. Select `Deactivate` from the dropdown.
<img src="/images/user-guide/fields/deactivate-field.png" style={{width:'100%'}} />
What happens when you deactivate a field?
1. **In the app:** The field disappears and you can't add new values to it.
2. **Existing relationships:** If it's a relation field, existing connections stay but you can't create new ones.
3. **API access:** You can still access the field and its data through the API.
You can reactivate Standard and Custom Fields or have the option to permanently delete them.
## Make Fields Unique
Make a field unique to ensure distinct records cannot have the same value. For example, email addresses are unique for each person.
If you get an error when setting uniqueness, check for duplicate values in your data (including deleted records).
## Field Configuration Best Practices
### Naming Conventions and Limitations
* **Singular and plural named must be distinct**: Our GraphQL API needs distinct names for mutations
* **Protected field names**: some names are reserved for system usage (e.g., `Type`, `Application`)
### Currency and Phone Fields
* **Default currency**: can be configured via the data model
* **Default country codes**: can be configured for phone fields via the data model
### Select Fields
* **A default option can be selected** for each Select field
### Record Text Fields
* **Each object has one main display field**: This field appears in the leftmost column and represents the record when linked to other objects. It must be a text field. For example, People uses `Name` as the main field, so when you link a person to a company, you'll see their name in the company's view.
@@ -0,0 +1,91 @@
---
title: Objects
description: Learn about standard and custom objects in Twenty.
---
import { VimeoEmbed } from '/snippets/vimeo-embed.mdx';
## Standard Objects
Standard objects are predefined entities in your workspace to help you get started. They're part of a shared data model accessible to all users of Twenty. You can use them as-is, customize them or deactivate them.
<img src="/images/user-guide/objects/standard-objects.png" style={{width:'100%'}} />
### People
The `People` object stores your contacts. It includes contact details and interaction history, so you can see all your customer interactions in one place.
### Company
The `Companies` object stores your business accounts. It includes details like industry, size and location. Companies connect to both `People` and `Opportunities` objects.
### Opportunities
The `Opportunities` object stores deal-related data. It tracks the progression of potential sales, from prospecting to closure, recording stages, deal sizes, associated account, and expected close date. You can view your sales pipeline in a kanban layout.
### Notes
The `Notes` object stores free-form notes that can be attached to People, Companies, Opportunities, and other records. Use notes to capture meeting summaries, important details, or any contextual information.
### Tasks
The `Tasks` object stores to-dos and action items. Tasks can be linked to People, Companies, Opportunities, and other records. Track due dates, assignees, and completion status to stay on top of your follow-ups.
## Custom Objects
Custom objects let you store information that's unique to your organization and that standard objects can't handle. For example, if you're SpaceX, you may want to create a custom object for Rockets and Launches.
<img src="/images/user-guide/objects/custom-objects.png" style={{width:'100%'}} />
### Creating a New Custom Object
To create a new custom object:
1. Go to Settings in the sidebar on the left.
2. Under Workspace, go to Data model. Here you'll be able to see an overview of all your existing Standard and Custom objects (both active and disabled).
<VimeoEmbed videoId="926288174" title="Video demonstration" />
3. Click on `+ New object` at the top. Enter the name (both singular and plural), choose an icon, and add a description for your custom object and hit Save (at the top right). Using Listing as an example of custom object, the singular would be "listing" and the plural would be "listings" along with a description like "Listings that hosts created to showcase their property."
4. Your custom object is now created and will appear in your sidebar. You can start adding records to it right away.
## Managing Objects
### Deactivating Objects
If you don't need a standard or custom object:
1. Go to Settings → Data Model
2. Find the object you want to deactivate
3. Click the toggle to deactivate it
4. The object will be hidden from your workspace but data is preserved
### Reactivating Objects
To bring back a deactivated object:
1. Go to Settings → Data Model
2. Look for deactivated objects (they'll be grayed out)
3. Click the toggle to reactivate it
4. The object and all its data will be restored
## Best Practices
### When to Create Custom Objects
* **Unique business entities**: Things specific to your industry or process
* **Complex relationships**: When you need to track connections between multiple entities
* **Scalable data**: When you might have many instances of something
### When to Use Fields Instead
* **Simple attributes**: Properties that describe existing objects
* **Categories or labels**: Ways to classify existing records
* **Single values**: Information that doesn't need its own lifecycle
### Object Naming
* **Use clear, descriptive names**: Make it obvious what the object represents
* **Follow conventions**: Use singular for the object name, plural for the collection
* **Consider your team**: Choose names everyone will understand
@@ -0,0 +1,92 @@
---
title: Relation Fields
description: Connect records across different objects using relation fields.
---
## Types of Relations
### One-to-Many
One record in Object A can be linked to many records in Object B.
**Example:** One Company can have many People (employees).
### Many-to-One
Many records in Object A can be linked to one record in Object B.
**Example:** Many People can belong to one Company.
### Relations to Multiple Object Types
Some objects can link to multiple object types on one side of the relation.
**Example:** A Note can be attached to one Person AND one Company AND one Opportunity simultaneously. The Note is on the "many" side, connecting to multiple "one" sides.
<img src="/images/user-guide/fields/many-to-one-morph.png" style={{width:'100%'}} />
Similarly, a Project (on the "one" side) could receive links from multiple People, multiple Companies, and multiple Notes.
<img src="/images/user-guide/fields/one-to-many-morph.png" style={{width:'100%'}} />
<Warning>
**Import/Export limitation**: Relations pointing to multiple object types are not yet supported for CSV import/export. This is on our roadmap.
</Warning>
### Many-to-Many
Many records in Object A can be linked to many records in Object B.
**Example:** Many People can be linked to many Projects, and vice versa.
<Warning>
**Many-to-Many is not yet supported.**
This relation type is planned for H1 2026. As a workaround, create an intermediate "junction" object (e.g., "Project Assignments") that has Many-to-One relations to both objects.
</Warning>
## Creating a Relation Field
1. Go to **Settings → Data Model**
2. Select the object where you want to add the relation
3. Click **+ Add Field**
4. Select **Relation** as the field type
5. Choose the target object(s) to relate to
6. Configure the relation settings:
* **Field name on source object**: The name of the relation field on the object you're editing
* **Field name on destination object**: The name of the relation field that will appear on the target object
* Relation type (one-to-many, many-to-one)
7. Click **Save**
## Standard Relations
Twenty comes with pre-built relations between standard objects:
| From Object | To Object | Relation Type |
| ------------- | --------- | ------------- |
| People | Companies | Many-to-One |
| Opportunities | Companies | Many-to-One |
| Opportunities | People | Many-to-One |
## Best Practices
### Planning Relations
* **Map your data model**: Plan relations before creating them
* **Consider direction**: Think about which object "owns" the relationship
* **Avoid circular dependencies**: Keep your data model clean
### Naming Relations
* **Use clear names**: Make it obvious what the relation represents
* **Be consistent**: Use similar naming patterns across relations
* **Consider both sides**: Name both sides of the relation appropriately
### Performance
* **Don't over-relate**: Too many relations can slow down your workspace
## Limitations
* **Deleting relations** removes the link but not the related records
* **Circular relations** should be avoided for data integrity