> For the complete documentation index, see [llms.txt](https://studio-docs.japan-ai.co.jp/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://studio-docs.japan-ai.co.jp/rudatasetobjectstorage/design-object-structure.md).

# Objectの構造を設計する

Objectは、顧客・案件・申請・タスクなどの業務データを、決めた項目で管理するための機能です。1件ごとのデータを「レコード」、レコードに持たせる項目を「フィールド」と呼びます。

この記事では、Objectを作成する前に構造を整理し、画面からフィールド、他のObjectとのリレーション、アクセス条件を設計・設定する流れを説明します。レコードの入力・更新は、[Objectのデータを閲覧・更新する](/u/view-and-update-object-records.md)を参照してください。

* Objectの仕様・制限：[Objectの仕様・制限](/shi-yang-zhi-xian/object-specs-and-limits.md)
* SQLで構造を定義する場合：[Object SQLのDDL](/object-sqlrifarensu/object-sql-ddl.md)

## Objectの構造とは

Objectの構造は、単に項目を並べるものではありません。利用者が何を入力・検索できるか、他のデータとどう結び付くか、誰がどこまで扱えるかを決めます。先に次の3点を分けて設計すると、後からの修正を減らせます。

| 設計対象   | 決めること                         | 例                  |
| ------ | ----------------------------- | ------------------ |
| フィールド  | 何を保存し、どの形式・条件で入力させるか          | 顧客名、担当者、受注予定日、案件番号 |
| リレーション | どのObjectのどのレコードを参照するか         | 案件から顧客を参照する        |
| アクセス条件 | Object・フィールド・レコードを誰に見せ、操作させるか | 担当者は編集可、他部署は閲覧のみ   |

たとえば「案件」を作る場合、案件名・金額・状態だけでなく、顧客との関係や見込み金額の閲覧範囲も検討します。検索、Page、Agent、Workflowから利用される可能性も関係者に確認してください。

> **構造の変更は既存レコードにも影響します。** すでに値があるフィールドを削除すると、そのフィールドに保存されたデータも削除される確認が表示されます。必須・ユニーク制約などを後から追加する場合も、既存データが条件を満たすかを先に確認してください。

## 始める前に

* 対象のProjectと、作成するObjectの業務上の目的・管理責任者を確認します。
* 既存のObject、Page、Workflow、Agentで同じデータをすでに管理していないかを確認します。重複するObjectを作らないでください。
* 実際に登録するデータを数件用意し、必要な項目・空欄を許可する項目・識別子を洗い出します。
* 関連するObjectを使う場合は、参照先のObjectと、レコードを一意に識別するフィールドを確認します。
* Object・フィールド・レコードを操作する権限、およびアクセス設定を変更する権限があることを確認します。権限や組織の設定によって、表示・操作できる項目は異なります。
* 既存データや稼働中のPage・Workflowがある場合は、変更日時と影響範囲、修正が必要になった場合の対応を関係者と決めます。

## 1. 設計表を作る

画面を操作する前に、次のような設計表を作ります。表示名だけでなく、何のための値か、入力条件、参照関係を記録します。

| 項目          | 設計例             | 確認すること                     |
| ----------- | --------------- | -------------------------- |
| Objectの目的   | 営業案件を管理する       | 1レコードが何を表すか                |
| Object名・表示名 | 内部で使う名前／画面に出す名前 | 他のObjectと重複・混同しないか         |
| 識別子         | 案件番号            | 重複を許さないか、手入力かを決める          |
| フィールド       | 案件名、状態、受注予定日、金額 | 型、必須、初期値、許可する値             |
| 関係          | 顧客Objectを参照     | 参照先と、その識別フィールド             |
| アクセス条件      | 営業は編集、管理部は閲覧    | Object、フィールド、レコードのどこで制御するか |

表示用の名称と、重複を許さない管理用の識別子は役割を分けます。同じ情報を複数のObjectへコピーする前に、リレーションで参照できないかを検討してください。

## 2. Objectを作成する

1. 対象のProjectでObject一覧を開きます。
2. 「オブジェクトを作成」を選択します。
3. 「オブジェクト名 (英数字)」に、システム内で識別する名前を入力します。
4. 「表示名」に、利用者が分かる名称を入力します。
5. 「説明」に、用途、1レコードの意味、入力時の注意点を記載します。
6. 必要に応じて「変更履歴を記録」を設定します。オンにした後のレコード変更から履歴が記録され、すでにあるレコードの過去状態が新たに作られるわけではありません。
7. 「保存」を選択し、「オブジェクトを作成しました。」と表示されることを確認します。

Object名と表示名は用途を分けます。Object名は作成時に英字で始め、スペースは使えず、アンダースコア以外の記号は使えません。表示名は利用者が一覧や画面で確認するため、業務用語で分かりやすく付けます。

## 3. フィールドを設計・作成する

作成したObjectを開き、「フィールド」タブから「フィールドを作成」を選択します。最初に、登録・検索・参照に必要な最小限のフィールドを作成し、代表的なレコードで確認してから増やします。

### フィールド型を選ぶ

「フィールド型」では、次の型を選択できます。値の見た目ではなく、後で入力・検索・条件判定するときの意味に合う型を選びます。

| フィールド型 | 主な用途                | 設計時の注意                    |
| ------ | ------------------- | ------------------------- |
| 「テキスト」 | 名称、説明、コード、メールアドレスなど | 長文と識別子を同じフィールドに混在させない     |
| 「数値」   | 金額、件数、順序、点数など       | 単位、小数を使うか、許容範囲を決める        |
| 「真偽値」  | 対応済みか、公開対象かなど       | 「オン」と「オフ」が業務上何を意味するかを決める  |
| 「日時」   | 期限、発生日、更新予定など       | 日付だけか時刻まで必要かを整理する         |
| 「配列」   | 複数の値を持たせる場合         | 検索・参照・入力方法への影響を確認する       |
| 「JSON」 | 構造化された追加情報を扱う場合     | 通常の業務項目は、可能な限り個別フィールドに分ける |

1. 「フィールドを作成」を選択します。
2. 「フィールド名」と「表示名」を入力します。フィールド名も英字で始め、スペースは使えず、アンダースコア以外の記号は使えません。
3. 「説明」に、値の意味、例、入力時の注意を記載します。説明はAgentがフィールドを理解するためにも使われます。
4. 「フィールド型」を選択します。
5. 必要に応じて「デフォルト値」、「現在時刻を自動取得」、「任意入力を許可」、「ユニーク制約」などを設定します。
6. 値に条件を設ける場合は、「バリデーションルール」で必要な条件を追加します。
7. 内容を確認して保存します。

「任意入力を許可」をオフにすると必須フィールドになります。「ユニーク制約」は、レコード間で同じ値を重複させないための設定です。社員IDや案件番号など、1件だけを識別する値に使います。既存データがあるObjectで必須・ユニーク制約や検証条件を追加・変更すると、既存レコードの検証が行われ、未入力や重複などがあると変更できない場合があります。

> **表記ゆれや同名が起こり得る値だけを識別子にしないでください。** 氏名や会社名はユニーク制約に適さない場合があります。業務で一意に管理する番号がある場合は、専用フィールドを作ります。

## 4. Object間の関係を設計する

別のObjectのレコードに紐付けるときは、フィールドの「リレーション」を使います。例えば、案件Objectの「顧客」フィールドを顧客Objectへ紐付けると、案件ごとにどの顧客かを参照できます。

1. 関係を持たせる側のObjectで「フィールドを作成」を選択します。
2. 「リレーション」を有効にします。
3. 「参照先オブジェクト」で、紐付けるObjectを選択します。
4. 「参照先フィールド」で、参照先の識別フィールドを選択します。
5. 内容を確認して保存します。

リレーションでは、参照先のObjectとフィールドを選択します。参照先フィールドの型に合わせてフィールド型が決まります。配列型とJSON型はリレーションに使用できません。参照先として選べるフィールドや、ユニーク制約との組み合わせは、画面に表示される条件を確認してください。

関係を作る前に、次を確認します。

* 参照先に、重複しない識別フィールドがある。
* 参照元の各レコードが、参照先を必ず持つべきかを決めている。
* 顧客名のような変更され得る表示値ではなく、安定して識別できるフィールドを選んでいる。
* 参照先を削除・非表示にした場合の業務影響を確認している。

> **リレーションは、アクセス権を引き継ぐ設定ではありません。** 関連リンクがあっても、利用者が参照先の全レコードを閲覧・更新できるとは限りません。参照元と参照先のアクセス条件をそれぞれ設計してください。

## 5. アクセス条件を設計・設定する

Objectの操作権限と、Object内のデータへのアクセス条件は分けて考えます。アクセス設定のメニューが表示されるかは、機能の有効化や権限によって異なります。表示されない、または開けない場合は、Project管理者または組織の管理者に確認してください。

Objectの操作メニューで「アクセス設定」を開くと、次の対象を確認できます。

| 設定             | 管理する範囲                     | 設計例                      |
| -------------- | -------------------------- | ------------------------ |
| 「オブジェクト」       | Object自体の閲覧・作成・編集・削除       | 作成者だけが構造を編集できるようにする      |
| 「全体データ」        | Project全体のデータに対する既定のアクセス権限 | Projectの標準的なデータアクセスを確認する |
| 「フィールド」        | フィールド単位の表示・編集権限            | 見込み金額は管理職のみ編集できるようにする    |
| 「レコードのアクセスルール」 | 条件によるレコード単位のアクセス制御         | 担当部門のレコードだけを見せる          |

「オブジェクト」のアクセス設定では、対象ごとに「閲覧不可」「閲覧」「編集」「管理」を選択できます。追加する対象は、画面の「ロール・部署・メンバー・エージェントを検索」から選びます。部署を対象にする場合、部署内にObject閲覧権限を持たないメンバーが含まれる可能性があるという注意が表示されるため、実際の権限も確認してください。

フィールド単位の設定は、少なくとも1件のフィールドを作成すると設定できるようになります。レコード単位のルールは、少なくとも1件のレコードを作成すると設定できるようになります。初期設計では、まずObjectとフィールドのアクセスを決め、テスト用レコードで表示範囲を確認してからレコード条件を追加すると安全です。

「レコードのアクセスルール」では、フィールド・演算子・値を条件として指定し、ロール、メンバー、エージェントなどの「割り当て対象」に権限を割り当てます。複数条件は「すべての条件を満たす」または「いずれかの条件を満たす」で組み合わせます。似たルールが重なる場合は、優先度と対象を事前に整理してください。

既存ルールを編集するときは、現在のフィールド定義を読み込んでから条件を確認します。画面で表現できない保存済み条件がある場合は、条件部分が読み取り専用になることがあります。推測で条件を作り直さず、対象フィールドとルールを確認し、必要に応じて一覧を開き直してから編集してください。

> **アクセス設定を変更したら、設定者本人の画面だけで確認しないでください。** 想定するロール・部署・利用者の組み合わせで、Object一覧、レコード、対象フィールドがどのように見えるかを確認します。閲覧できることと、レコードの作成・編集・削除や、構造の変更ができることは別です。

## 6. テストして利用を始める

構造とアクセス条件を設定したら、実データを大量に登録する前に代表的なケースを確認します。

1. テスト用のレコードを作成します。必須項目、初期値、入力条件を確認します。
2. 同じ値を入力した場合に重複を防ぎたいフィールドでは、重複するレコードが作成できないことを確認します。
3. リレーションを設定した場合は、正しい参照先を選べること、関連先を確認できることを確認します。
4. 閲覧のみ・編集可など、想定するアクセス条件で各画面を確認します。
5. Page、Agent、Workflowから利用する場合は、それぞれが必要なフィールドとレコードを扱えるかを確認します。
6. 設計表、変更日時、確認結果、問い合わせ先を記録します。

> ユニーク制約を有効にするには、先にインデックスを有効にし、再構築が完了してから設定する必要があります。既存レコードに重複する値がある場合も有効にできません。

テストの結果、フィールドが多すぎて入力しづらい、同じ情報が複数箇所にある、権限の説明ができないといった問題があれば、本格運用の前に構造を見直します。制限値や対応する条件の詳細は、[Objectの仕様・制限](/shi-yang-zhi-xian/object-specs-and-limits.md)で確認してください。

## チェックリスト

* [ ] 1レコードが表す業務上の単位と、Objectの管理責任者を決めた
* [ ] 既存Objectとの重複、Page・Agent・Workflowへの影響を確認した
* [ ] Object名、表示名、説明を用途に合わせて決めた
* [ ] 各フィールドの型、必須、初期値、ユニーク制約、入力条件を決めた
* [ ] 重複を許さない識別子を、表示用の名称と分けて設計した
* [ ] リレーションの参照先と、画面で選択できる参照先フィールドを確認した
* [ ] Object・全体データ・フィールド・レコードのアクセス条件を分けて設計した
* [ ] 想定する利用者のアクセス条件で、テストレコードを確認した
* [ ] 既存データや利用中のPage・Workflowへの変更影響を確認した

## 次に読む記事

* [Objectのデータを閲覧・更新する](/u/view-and-update-object-records.md)
* [Objectの仕様・制限](/shi-yang-zhi-xian/object-specs-and-limits.md)
* [Object SQLのDDL](/object-sqlrifarensu/object-sql-ddl.md)
