https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM71029001/customer/tips/tips_ticketcustom/index.html Recent content in 4.5.3 チケット画面のカスタム on JP1 Cloud Service 運用統合 利用ガイド Hugo -- gohugo.io ja https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM71029001/customer/tips/tips_ticketcustom/field_custom/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM71029001/customer/tips/tips_ticketcustom/field_custom/index.html チケットのフィールドは以下をカスタムすることができます。 フィールドの追加 フィールドの削除 フィルタへの反映 フィールド名の変更 ACLの設定 Ops Iのチケット画面ではチケットの情報を変更する際、APIによってOTOBOと情報のやり取りを行います。 チケット画面に表示する項目「フィールド」を追加または削除する場合、使用するAPIの構成ファイルの編集が必要になります。ここでは使用するAPIを「カスタムAPI」と呼びます。フィールドを変更しない場合、カスタムAPI構成ファイルの変更は不要です。 フィールドの追加、削除はチケットタイプごとに設定でき、同じチケットタイプのすべてのチケットに反映されます。すでに作成済のチケットに対しては、追加されたフィールドは空欄で表示され、削除されたフィールドは表示されなくなります。 また、フィールドの追加、削除をチケットブラウザー画面のフィルタ機能に反映することができます。詳細は「フィルタへの反映」を参照してください。 チケット画面の詳細は「チケット」を参照してください。 フィールド名を変更することも可能です。詳細は「フィールド名の変更」を参照してください。 フィールドを追加、削除できるカスタムAPIは以下になります。 （表）フィールドを編集可能なカスタムAPI一覧 動作 API 関連する画面 チケット一覧取得 GET /capi/v1/tickets チケットブラウザー画面 チケットの詳細情報取得 GET /capi/v1/tickets/{id} チケット詳細画面 チケットブラウザー画面 チケットの作成 POST /capi/v1/tickets 新規チケット追加画面 チケットの一部情報更新 PATCH /capi/v1/tickets/{id} チケット詳細画面 チケットブラウザー画面 関連チケットの表示※ GET /capi/v1/tickets/{id}/related-tickets チケットブラウザー画面 チケット詳細画面 ※チケットブラウザー画面とチケット詳細画面の関連レコードのチケットタブに表示させる場合に、追加してください。 注意事項 フィールドの追加、編集、削除で文法やフィールド名などに誤りがあった場合、エラーは表示されませんが、正しく表示されないなど期待通りに機能しないことがあります。期待通りに機能しない場合は、文法や表記の誤りなどの確認をしてください。 変更手順を以下に示します。 （1）フィールドの追加 ①OTOBOのダイナミック・フィールドを作成する ITSMアプリケーションで以下の作業を実施します。この操作はITSMアプリケーションの[管理]機能で行うため、Primitiveロール「itsm_admin」の権限が必要です。 a. メインメニュー[管理]を選択し、[プロセス & 自動化]-[ダイナミック・フィールド]を開きます。 b. [操作]-[チケット]を選択し、選択肢から作成するフィールドのタイプを選択します。選択できるタイプは以下になります。それ以外はOps Iでの表示が非対応のため選択しないでください。 チェックボックス日付日時ドロップダウン本文テキストエリア c. フィールドごとに必要な情報を入力し、保存します。入力情報の詳細はOTOBOのマニュアルを参照してください。OTOBOのマニュアルおよびバージョンについては付録「OSSのバージョンおよびエディション、参照先のマニュアル」を参照してください。また、「名前」に設定したフィールド名は②bでダイナミック・フィールド名として使用します。 d. 作成したフィールドが、ダイナミック・フィールド一覧に追加されます。 ②チケット画面のカスタムAPI構成ファイルを編集する OTOBOの情報をOps Iのチケット画面に反映するには、UIで定義されたカスタムAPIを実行します。カスタムAPIの構成ファイルの関係を以下に示します。 （図）チケット画面のカスタムAPI構成ファイル 構成ファイルの中で、フィールド追加時に編集が必要なファイルは、JavaScriptファイル、JSON Schemaファイル、UIのYAMLファイルです。これらのファイルはあらかじめ登録されている「初期YAMLファイル」です。初期YAMLファイルの格納場所については「初期YAMLファイルのカスタム」を参照してください。 以下に編集が必要なファイルについて説明します。 a. JSON Schemaファイル 各カスタムAPIに対し、1または2種類のJSON Schemaファイルが存在し、それぞれ編集が必要です。編集が必要なファイルは「apps/datamodel/otobo-datasource-schemas/」に格納されています。 （表）編集が必要なJSON Schemaファイル https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM71029001/customer/tips/tips_ticketcustom/status_custom/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM71029001/customer/tips/tips_ticketcustom/status_custom/index.html チケットのステータスは以下をカスタムすることができます。 ステータス名の変更 ステータスの初期状態、遷移順の変更 ステータスの追加、削除 （1）ステータス名の変更 ステータス名を変更する場合は、JavaScriptファイルとJSON Schemaファイルを編集します。 ■JavaScriptファイル 以下のファイルのダブルクォーテーション（"）で囲まれたステータス名を変更してください。 （表）JavaScriptファイルの変更箇所 JavaScriptファイル 変更箇所 説明 script/ticket-common/ticket_mapping_definition.js LABELSDISPLAY_STATUS ClientScript※ ※ClientScriptの詳細については「UI設計」を参照してください。 ＜定義例＞   DISPLAY_STATUS: {     NEW: "New",     CLOSED: "Closed",     IN_PROGRESS: "In Progress",     CANCELED: "Cancelled",     PENDING: "Pending",     RESOLVED: "Resolved",     AWAITING_APPROVAL: "Awaiting Approval",     PLANNING: "Planning",     COMPLETED: "Completed",     OPEN: "Open",     DECLINED: "Declined",     AWAITING_IMPLEMENTATION: "Awaiting Implementation",     AWAITING_BACKOUT: "Awaiting Backout",     CLOSED_WITH_BACKOUT: "Closed With Backout",     IMPLEMENTING: "Implementing",     INVESTIGATING: "Investigating",   } ■JSON Schemaファイル 以下のファイルのダブルクォーテーション（"）で囲まれたステータス名を変更してください。 （表）JSON Schemaファイルの変更箇所 JSON Schemaファイル 変更箇所 説明 datamodel/otobo-datasource-schemas/display-type-status.json properties.displayStatus.enum 複数のAPIに関連するファイル datamodel/datamodels_for_ticket_detail_ui/filter-form-schema.json properties.displayStatus.enum UIに関連するファイル ＜定義例＞     "displayStatus": {       "type": "string",       "enum": [         "New",         "Open",         "Declined",         "Awaiting Approval",         "Awaiting Implementation",         "Pending",         "Planning",         "In Progress",         "Resolved",         "Completed",         "Closed",         "Cancelled",         "Awaiting Backout", https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM71029001/customer/tips/tips_ticketcustom/type_custom/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM71029001/customer/tips/tips_ticketcustom/type_custom/index.html チケットのタイプは以下をカスタムできます。 タイプ名の変更 チケットタブから表示するタイプの追加、削除 （1）タイプ名の変更 タイプ名を変更する場合は、JavaScriptファイル、JSON Schemaファイル、ApplicationのYAMLファイル、UipathのYAMLファイルを編集してください。 ■JavaScriptファイル 以下のファイルのダブルクォーテーション（"）で囲まれたタイプ名を変更してください。 （表）JavaScriptファイルの変更箇所 JavaScriptファイル 変更箇所 説明 script/ticket-common/ticket_mapping_definition.js LABELSDISPLAY_TYPE ClientScript※ ※ClientScriptの詳細については「UI設計」を参照してください。 ＜定義例＞   DISPLAY_TYPE: {     INCIDENT: "Incident",     REQUEST: "Request",     TASK: "Task",     PROBLEM: "Problem",     RFC: "RFC",     RELEASE: "Release",     CASE: "Case",     UNCLASSIFIED: "Unclassified",   }, ■JSON Schemaファイル 以下のファイルのダブルクォーテーション（"）で囲まれたタイプ名を変更してください。 （表）JSON Schemaファイルの変更箇所 JSON Schemaファイル 変更箇所 説明 datamodel/otobo-datasource-schemas/display-type-status.json properties.displayType.enum 複数のAPIに関連するファイル datamodel/datamodels_for_ticket_detail_ui/filter-form-schema.json properties.displayType.enum UIに関連するファイル ＜定義例＞     "displayType": {       "type": "string",       "enum": [         "Incident",         "Request",         "Task",         "Problem",         "RFC",         "Release",         "Case",         "Unclassified"       ]     }, ■ApplicationのYAMLファイル （表）ApplicationのYAMLファイル変更箇所 ApplicationのYAMLファイル 変更箇所 application/sys_request/values.yaml※1 en.app.request.ticket.チケットタイプ※2.labelja.app.request.ticket.チケットタイプ※2.label application/sys_task/values.yaml※1 en.app.task.ticket.チケットタイプ※2.labelja.app.task.ticket.チケットタイプ※2.label ※1：タイプ名を定義している/application/sys_requestまたはsys_task/manifest.yamlのtabs.items.labelは変数で定義されているため、テンプレートファイルvalues.yamlを編集します。 ※2：チケットタイプはincident、request、task、problem、rfc、release、case、unclassifiedから選択します。 ■UipathのYAMLファイル ApplicationのYAMLファイルからIncludeでひもづいているUipathのYAMLファイルのlabelを編集します。 （表）UipathのYAMLファイルの変更箇所