4.5.3.1 チケットのフィールド

• チェックボックス
• 日付
• 日時
• ドロップダウン
• 本文
• テキストエリア

（図）チケット画面のカスタムAPI構成ファイル

構成ファイルの中で、フィールド追加時に編集が必要なファイルは、JavaScriptファイル、JSON Schemaファイル、UIのYAMLファイルです。これらのファイルはあらかじめ登録されている「初期YAMLファイル」です。初期YAMLファイルの格納場所については「初期YAMLファイルのカスタム」を参照してください。

以下に編集が必要なファイルについて説明します。

（表）編集が必要なJSON Schemaファイル

（図）JSON Schemaファイルの変更例

UI側に渡すフィールドの一覧を定義している「properties」にOps I側のフィールド名と設定値（type、format、enum、default、formControl）を追加します。

• Ops I側のフィールド名：任意の値を指定。ここで指定した値を、JavaScriptファイル、UIのYAMLファイルから参照。
• フィールドの設定値：フィールドのタイプによって、必要な設定値（type、format、enum、default、formControl）を設定。詳細は「（表）フィールドのタイプと設定値の関係」参照。

（表）フィールドのタイプと設定値の関係

（表）編集が必要なJavaScriptファイル

（図）記載形式（OTOBOからOps Iへのレスポンス）

（図）記載形式（Ops IからOTOBOへのリクエスト）

（図）記載形式（CUSTOM_FIELDS_MAP）

また、選択したフィールドタイプがドロップダウンの場合、およびチェックボックスで画面表示にtrue/falseを用いたい場合はドロップダウン、またはチェックボックスの選択肢の設定が必要です。
編集が必要なファイルは「apps/script/ticket-common/ticket_mapping_definition.js」です。

1. OTOBO_MAPPING_OpsI側のフィールド名を定義し、Ops Iの画面で表示する選択肢と（1）①で設定したダイナミック・フィールドの選択肢（チェックボックスの場合は0、1）をひもづけます。コロン（:）の左側にOps Iの画面で表示する選択肢を、右側にダイナミック・フィールドの選択肢を指定してください。
   ドロップダウンの場合：

   const OTOBO_MAPPING_NEWFIELD2 = {
    "opsi A" : "otobo a",
    "opsi B" : "otobo b",
    "opsi C" : "otobo c",
   };

   チェックボックスの場合：

   const OTOBO_MAPPING_NEWFIELD2 = {
    "true" : "1",
    "false" : "0",
   };

2. CUSTOM_FIELDS_VALUE_MAPに、OpsI側のフィールド名とⅠで定義した「OTOBO_MAPPING_Ops I側のフィールド名」を以下のように定義します。「CUSTOM_FIELDS_VALUE_MAP」は、「OTOBO_MAPPING_Ops I側のフィールド名」より後に定義してください。

   const CUSTOM_FIELDS_VALUE_MAP = {
    "newField2": OTOBO_MAPPING_NEWFIELD2,
   };

（表）編集が必要なUIのYAMLファイルと編集内容

画面	UIのYAMLファイル	変更対象/ 変更内容（斜体文字は実際の値で置換え）
チケット 詳細画面	タスクアプリケーション： apps/ui/ticket_detail_タイプ名※_agent/manifest.yaml リクエストアプリケーション： apps/ui/ticket_detail_タイプ名※_requester/manifest.yaml	＜更新対象コンポーネント＞ ticket_detail_form ＜変更内容＞ 以下の書式に従い、フォームのフィールド（fields）に要素を追加する。必須区分や入力チェックなど、必要に応じて「（表）Formのプロパティ（UIバージョン1.1）」に記載のfieldのプロパティを追加可能。 - name: 任意の名前   source: api   field:     read: ticketDetails.Ops I側のフィールド名     update: patchTicketCustom.Ops I側のフィールド名   label: ラベル表示名 メモ リクエストアプリケーションの場合、updateプロパティを記載しないでください。
		＜更新対象コンポーネント＞ related_records_ticket（関連レコードのチケット一覧） ＜変更内容＞ 以下の書式に従い、テーブルのカラム（columns）に要素を追加する。関連レコードのチケット一覧で、追加したカラムを初期表示させない場合は、hide属性のtrueを追加する。 - name: 任意の名前   source: api   column:     read: ticketRelated.Ops I側のフィールド名   label: ラベル表示名
新規 チケット 追加画面	タスクアプリケーション： apps/ui/ticket_new_タイプ名※_agent/manifest.yaml リクエストアプリケーション： apps/ui/ticket_new_タイプ名※_requester/manifest.yaml	＜更新対象コンポーネント＞ ticket_creation_form ＜変更内容＞ 以下の書式に従い、フォームのフィールド（fields）に要素を追加する。必須区分や入力チェックなど、必要に応じて「（表）Formのプロパティ（UIバージョン1.1）」に記載のfieldのプロパティを追加可能。 - name: 任意の名前   source: api   field:     create: createTicketCustom.Ops I側のフィールド名   label: ラベル表示名
チケット ブラウザー画面	タスクアプリケーション： apps/ui/ticket_browser_agent/manifest.yaml リクエストアプリケーション： apps/ui/ticket_browser_requester/manifest.yaml	＜更新対象タブ＞ ticket_filter_tab （全チケットタイプ用の一覧画面に追加する場合） ticket_filter_タイプ名※_tab （個々のチケットタイプ用の一覧画面に追加する場合） ＜更新対象コンポーネント＞ ticket_filter_table（チケット一覧） ＜変更内容＞ 以下の書式に従い、テーブルのカラム（columns）に要素を追加する。チケット一覧で、追加したカラムを初期表示させない場合は、hide属性のtrueを追加する。Ops I側のフィールド名とダイナミック・フィールド名が異なる場合は、sortnameにダイナミック・フィールド名を指定する。 チケット一覧取得APIには更新対象タブごとに以下の値を指定する。 ticket_filter_tab: ticketSearchList ticket_filter_incident_tab: ticketIncidentSearchList ticket_filter_request_tab: ticketRequestSearchList ticket_filter_task_tab: ticketTaskSearchList ticket_filter_rfc_tab: ticketRfcSearchList ticket_filter_problem_tab: ticketProblemSearchList ticket_filter_release_tab: ticketReleaseSearchList ticket_filter_case_tab: ticketCaseSearchList ticket_filter_unclassified_tab: ticketUnclassifiedSearchList - name: 任意の名前   source: api   column:      read: チケット一覧取得API.Ops I側のフィールド名    label: ラベル表示名    sortable: true    sortname: ダイナミック・フィールド名
		＜更新対象タブ＞ ticket_detail_タイプ名※_tab ＜更新対象コンポーネント＞ ticket_detail_form（チケット詳細） ＜変更内容＞ 以下の書式に従い、フォームのフィールド（fields）に要素を追加する。必須区分や入力チェックなど、必要に応じて「（表）Formのプロパティ（UIバージョン1.1）」に記載のfieldのプロパティが追加可能。 - name: 任意の名前   source: api   field:     read: ticketDetails.Ops I側のフィールド名     update: patchTicketCustom.Ops I側のフィールド名   label: ラベル表示名 メモ リクエストアプリケーションの場合、updateプロパティを記載しないでください。
		＜更新対象タブ＞ ticket_detail_タイプ名※_tab ＜更新対象コンポーネント＞ related_records_ticket（関連レコードのチケット一覧） ＜変更内容＞ 以下の書式に従い、テーブルのカラム（columns）に要素を追加する。関連レコードのチケット一覧で、追加したカラムを初期表示させない場合は、hide属性のtrueを追加する。 - name: 任意の名前   source: api   column:     read: ticketRelated.Ops I側のフィールド名   label: ラベル表示名

UIのYAML定義の詳細については、「UI」を参照してください。

（2）フィールドの削除

①OTOBOのダイナミック・フィールドを無効化する

②チケット画面のカスタムAPI構成ファイルを編集する

UI側に渡すフィールドの一覧を定義している「properties」から、①で無効化したフィールドの部分を削除します。
変更箇所については「（表）編集が必要なJSON Schemaファイル」を参照してください。

カスタムAPIを整形している変更箇所から、①で無効化したフィールドの部分を削除します。
変更箇所については「（表）編集が必要なJavaScriptファイル」を参照してください。

Formコンポーネント内の変更箇所から、①で無効化したフィールドの部分を削除します。
変更箇所については「（表）編集が必要なUIのYAMLファイルと編集内容」を参照してください。

フィルタ機能の変更箇所から、①で無効化したフィールドの部分を削除します。
変更箇所については「フィルタへの反映」を参照してください。

（3）フィルタへの反映

チケットブラウザー画面のフィルタ機能を使用する場合は、「フィールドの追加」のファイルに加えて、下記ファイルの修正が必要になります。

a. JSON Schemaファイル

b. JavaScriptファイル

c. UIのYAMLファイル

（4）フィールド名の変更

既存のフィールド名を変更できます。
フィールド名を変更するには、チケットのUIのYAMLファイルのlabel（ラベル表示名）を編集します。編集対象のYAMLファイルは、 「フィールドの追加」の「②c.UIのYAMLファイル」を参照してください。