Sistem Meta Verilerini Hedefleme

Twenty içindeki her nesne, kendi başınıza asla bildirmediğiniz sistem meta verileriyle birlikte gelir; bir alan kümesi ve sütunlarıyla birlikte ana liste görünümü gibi. Sunucu, nesne sağlandığında bunların hepsini oluşturur ve Twenty büyüdükçe bu küme de büyür. Siz bunu bildirmediğiniz için, içe aktarabileceğiniz bir universalIdentifier sabiti yoktur. Bunun yerine, sunucu her tanımlayıcıyı deterministik olarak türetir ve twenty-sdk, bildirim dosyanızın sunucunun kullandığı kesin değeri çözümleyebilmesi için aynı türetmeyi dışa açar.

Sistem Alanları

Her nesnede bulunan, hiçbirini defineField() ile bildirmediğiniz skaler alanlar: id, createdAt, updatedAt, deletedAt, createdBy, updatedBy, position, searchVector Peki bir görünümde createdAt alanına sütun olarak nasıl referans verirsiniz?

Sorun

Twenty 2.19’dan beri, bir sistem alanının evrensel tanımlayıcısı, sunucu tarafından üç girdiden deterministik olarak türetilir: uygulama evrensel tanımlayıcısı, nesne evrensel tanımlayıcısı ve alan adı. Rastgele bir id uydurup onu hardcode etmek işe yaramaz: sunucudaki hiçbir şeyle eşleşmez ve senkronizasyon, askıda kalan referansı reddeder:

Dev sync failed: viewField: INVALID_VIEW_DATA: Field metadata not found

Çözüm

getFieldUniversalIdentifier, twenty-sdk 2.21 sürümünden itibaren kullanılabilir.

Sunucunun kullandığıyla tamamen aynı değeri elde etmek için getFieldUniversalIdentifier kullanın. Üç girdiyi alır ve alanın evrensel tanımlayıcısını döndürür:

import { getFieldUniversalIdentifier } from 'twenty-sdk/define';

const createdAtFieldId = getFieldUniversalIdentifier({
  applicationUniversalIdentifier: APPLICATION_UNIVERSAL_IDENTIFIER,
  objectUniversalIdentifier: MY_OBJECT_UNIVERSAL_IDENTIFIER,
  name: 'createdAt',
});

applicationUniversalIdentifier, uygulamanızın tanımlayıcısıdır; defineApplication() çağrısına aktardığınız tanımlayıcı.
objectUniversalIdentifier, alanın ait olduğu nesnenin tanımlayıcısıdır.
name, sistem alan adıdır; yukarıda listelenen değerlerden biridir.

Örnek: bir görünümde createdAt sütunu

Tipik durum, özel nesnelerinizden birinin görünümüne bir createdAt sütunu eklemektir. Alan id’sini çözümleyin ve ona, herhangi bir fieldMetadataUniversalIdentifier gibi referans verin:

src/views/example-view.ts

import {
  defineView,
  getFieldUniversalIdentifier,
} from 'twenty-sdk/define';

const APPLICATION_UNIVERSAL_IDENTIFIER =
  '0b04e15c-27b2-4741-9046-b32e07469072';
const MY_OBJECT_UNIVERSAL_IDENTIFIER =
  'c782b61c-70fd-4c88-9cd6-4e61ab8d7591';

export default defineView({
  universalIdentifier: '70f10d44-144a-4da8-8c6f-3ec2422138c0',
  name: 'All records',
  objectUniversalIdentifier: MY_OBJECT_UNIVERSAL_IDENTIFIER,
  icon: 'IconList',
  position: 0,
  fields: [
    {
      universalIdentifier: '75a90bc4-d901-4df4-85e0-af29db5e0104',
      fieldMetadataUniversalIdentifier: getFieldUniversalIdentifier({
        applicationUniversalIdentifier: APPLICATION_UNIVERSAL_IDENTIFIER,
        objectUniversalIdentifier: MY_OBJECT_UNIVERSAL_IDENTIFIER,
        name: 'createdAt',
      }),
      position: 0,
      isVisible: true,
      size: 200,
    },
  ],
});

Aynı çözümlenen id, bir fieldMetadataUniversalIdentifier beklendiği her yerde çalışır: görünüm alanları, filtreler, sıralamalar, gruplar ve sayfa düzeni bileşenleri.

Id’yi çözümleyin, hardcode etmeyin. Sunucu değeri uygulama id’si, nesne id’si ve alan adından türettiği için, getFieldUniversalIdentifier çağrısı, bu girdiler değişse bile referansınızı doğru tutar ve türetme zaman içinde gelişirse sapmayı önler.

Sistem ilişki alanları

getSystemRelationFieldUniversalIdentifier 2.23 sürümünden itibaren twenty-sdk içinde kullanılabilir ve Twenty sunucusunun 2.23 veya daha yeni bir sürümünü gerektirir.

Yukarıdaki skaler sistem alanlarının yanı sıra, sunucu her nesne üzerinde dört sistem ilişki alanı da sağlar: timelineActivities, attachments, noteTargets ve taskTargets. Bunların her biri, karşılık gelen standart ilişki nesnesini işaret eder. Bu alanlar getFieldUniversalIdentifier ile çözümlenmez: tanımlayıcıları, alanı barındıran nesne ve alanın işaret ettiği nesneden isimden bağımsız olarak türetilir. Bu sayede bir nesnenin adını değiştirmek, ilişki alanlarının tanımlayıcılarını asla değiştirmez. Bunları çözümlemek için getSystemRelationFieldUniversalIdentifier kullanın:

import {
  getSystemRelationFieldUniversalIdentifier,
  STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS,
} from 'twenty-sdk/define';

// rocket.attachments — the relation field hosted on your custom object
const rocketAttachmentsFieldId = getSystemRelationFieldUniversalIdentifier({
  applicationUniversalIdentifier: APPLICATION_UNIVERSAL_IDENTIFIER,
  objectUniversalIdentifier: ROCKET_OBJECT_UNIVERSAL_IDENTIFIER,
  relationTargetObjectUniversalIdentifier:
    STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS.attachment.universalIdentifier,
});

objectUniversalIdentifier, alanın barındırıldığı nesnedir.
relationTargetObjectUniversalIdentifier, alanın işaret ettiği nesnedir.

Yön, argüman sırasına göre kodlanır. Ters tarafı çözümlemek için (örneğin, attachment.targetRocket, sunucunun standart ilişki nesnesi üzerinde oluşturduğu morph alanı), ikisini değiştirin:

// attachment.targetRocket — the reverse morph field on Attachment
const attachmentTargetRocketFieldId =
  getSystemRelationFieldUniversalIdentifier({
    applicationUniversalIdentifier: APPLICATION_UNIVERSAL_IDENTIFIER,
    objectUniversalIdentifier:
      STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS.attachment.universalIdentifier,
    relationTargetObjectUniversalIdentifier: ROCKET_OBJECT_UNIVERSAL_IDENTIFIER,
  });

Skaler sistem alanlarında olduğu gibi, çözümlenen kimlik, fieldMetadataUniversalIdentifier beklendiği her yerde çalışır.

Sistem görünümleri

getSystemViewUniversalIdentifier ve getSystemViewFieldUniversalIdentifier, twenty-sdk 2.26 sürümünden itibaren kullanılabilir ve Twenty sunucusunun 2.26 veya daha yeni bir sürümünü gerektirir.

Sunucu ayrıca her nesnede bir sistem görünümü de sağlar: ana liste görünümü (All {objectLabelPlural}, ViewKey.INDEX anahtarıyla), gösterilebilir her alan için bir sütunla. Sistem ilişki alanlarında olduğu gibi, tanımlayıcıları isimden bağımsız olarak türetilir; bu nedenle bir nesnenin veya alanın adını değiştirmeniz onları asla değiştirmez. Görünümü çözümlemek için getSystemViewUniversalIdentifier kullanın:

import { getSystemViewUniversalIdentifier, ViewKey } from 'twenty-sdk/define';

const rocketIndexViewId = getSystemViewUniversalIdentifier({
  objectMetadataApplicationUniversalIdentifier: APPLICATION_UNIVERSAL_IDENTIFIER,
  objectUniversalIdentifier: ROCKET_OBJECT_UNIVERSAL_IDENTIFIER,
  viewKey: ViewKey.INDEX,
});

objectMetadataApplicationUniversalIdentifier, görünümün ad alanını belirleyen, nesneye sahip olan uygulamadır.
objectUniversalIdentifier, görünümün listelediği nesnedir.
viewKey, bugün için ViewKey.INDEX olan sistem görünüm anahtarıdır.

Çözümlenen kimlik, bir viewUniversalIdentifier beklendiği her yerde, örneğin bir NavigationMenuItemType.VIEW kenar çubuğu girdisinde çalışır. Sadece bir nesnenin ana listesini açmak için, targetObjectUniversalIdentifier ile NavigationMenuItemType.OBJECT kullanmayı tercih edin: hiçbir türetmeye ihtiyaç duymaz. getSystemViewFieldUniversalIdentifier, bir sistem görünümündeki tek bir sütunu, görünümden ve görüntülediği alandan yola çıkarak çözümler:

import { getSystemViewFieldUniversalIdentifier } from 'twenty-sdk/define';

const rocketNameColumnId = getSystemViewFieldUniversalIdentifier({
  fieldMetadataApplicationUniversalIdentifier: APPLICATION_UNIVERSAL_IDENTIFIER,
  viewUniversalIdentifier: rocketIndexViewId,
  fieldMetadataUniversalIdentifier: ROCKET_NAME_FIELD_UNIVERSAL_IDENTIFIER,
});

İlk argümana dikkat edin: bir sütun, görüntülediği alana sahip olan uygulamanın ad alanındadır, görünüme sahip olanın değil. Uygulamanızın standart bir nesneye eklediği bir alan, Twenty’ye ait bir görünüm üzerinde, kendi uygulamanız altında türetilen bir sütun alır.

Sistem görünümleri ve sütunları sunucuya aittir: bunları bildirmek için değil, yalnızca onlara başvurmak için tanımlayıcılarını çözümleyin. defineView() üzerindeki key kullanımdan kaldırılmıştır ve yok sayılır; bu nedenle bir bildirim görünümü asla INDEX anahtarını talep edemez ve sunucu, eklediğiniz her alan için zaten bir sütun sağlar; bu yüzden bir sistem görünümünde aynı alan için kendi defineViewField() bildiriminizi yapmak bununla çelişir.

Standart Twenty nesneleri

Standart bir Twenty nesnesi (Person, Company, Opportunity, …) için hiçbir şey türetmeniz gerekmez: hem alanlar hem de görünümler için, doğrudan içe aktarabileceğiniz önceden hesaplanmış sabit tanımlayıcılar vardır.

import { STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS } from 'twenty-sdk/define';

// STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS.company.fields.createdAt.universalIdentifier
// STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS.person.fields.updatedAt.universalIdentifier
// STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS.person.views.allPeople.universalIdentifier

Yukarıdaki yardımcı işlevlere, defineObject() ile uygulamanızın tanımladığı ve böyle bir sabitin bulunmadığı nesneler için başvurun.

name, bir sistem alanı değil, bir varsayılan alandır. Kendi hardcode edilmiş evrensel tanımlayıcısını korur ve getFieldUniversalIdentifier ile çözülmez. Tanımladığınız nesnelerde, name alanına defineObject() içinde ona verdiğiniz tanımlayıcı ile referans verin.

Genel Bakış

Uygulamalar

API

Kendi Kendine Barındırma

Katkıda Bulunun

Sistem Alanları

Sorun

Çözüm

Örnek: bir görünümde createdAt sütunu

Sistem ilişki alanları

Sistem görünümleri

Standart Twenty nesneleri

​Sistem Alanları

​Sorun

​Çözüm

​Örnek: bir görünümde createdAt sütunu

​Sistem ilişki alanları

​Sistem görünümleri

​Standart Twenty nesneleri

Sistem Alanları

Sorun

Çözüm

Örnek: bir görünümde createdAt sütunu

Sistem ilişki alanları

Sistem görünümleri

Standart Twenty nesneleri