syncable-entity-types-and-constants

Define syncable entity types, TypeORM entities, and central constant registrations.

54.6k|8.4k|Updated Dec 1, 2022
One-click install
npx skills add https://github.com/twentyhq/twenty --skill syncable-entity-types-and-constants-twentyhq
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: syncable-entity-types-and-constants
Source: https://github.com/twentyhq/twenty/tree/main/.cursor/skills/syncable-entity-types-and-constants
Command: npx skills add https://github.com/twentyhq/twenty --skill syncable-entity-types-and-constants-twentyhq

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides a standardized and robust framework for defining new syncable entities within the Twenty CRM system, ensuring consistency and enabling seamless data synchronization.

Core Features & Use Cases

  • Entity Definition: Establishes the foundational types, TypeORM entities, and flat representations for new syncable data.
  • Constant Registration: Integrates new entities into critical system constants for discovery and management (e.g., property configurations, relations).
  • Use Case: When developing a new feature that requires tracking custom "Projects" with associated "Tasks," this Skill guides the developer through creating the ProjectEntity and TaskEntity definitions, ensuring they are correctly registered for system-wide use.

Quick Start

Follow the steps outlined in the SKILL.md file to define a new syncable entity, starting with adding its metadata name.

Frequently Asked Questions about syncable-entity-types-and-constants

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I define a new syncable entity in Twenty CRM?

To define a syncable entity in Twenty CRM, you establish its metadata name, create the TypeORM entity, define the flat entity type, and register it in central constants for system-wide discovery and synchronization.

What does registering an entity in central constants do for TypeORM data modeling?

Registering an entity in central constants integrates the new syncable data into critical system configurations for property mappings and relations, ensuring seamless data synchronization and correct system integration across the workspace migration framework.

When do I need to create flat entity types for syncable data?

You need to create flat entity types when developing new syncable entities, ensuring all necessary metadata, relations, and properties are correctly configured for system integration alongside the foundational TypeORM entity definitions.

Can I use this approach to model custom entities like Projects and Tasks?

Yes, you can model custom entities by creating the foundational TypeORM entity definitions and flat representations for new syncable data, then registering them into critical system constants for management and discovery.

Why are my new syncable entities not integrating with the workspace migration system?

Syncable entities fail to integrate when they are not properly registered in central constants, missing required metadata, relations, or property configurations needed for system-wide discovery and seamless data synchronization.