first commit
This commit is contained in:
+236
@@ -0,0 +1,236 @@
|
||||
---
|
||||
title: テナント設定
|
||||
description: ABC User Feedbackのテナント情報、ログイン方式、ユーザー管理など、組織全体に影響を与える設定を管理する方法を案内します。
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# テナント設定
|
||||
|
||||
テナント設定はABC User Feedbackの最上位管理機能で、組織全体に影響を与える重要な設定を扱います。このドキュメントでは、テナント情報管理、ログイン方式設定、全ユーザー管理方法を説明します。
|
||||
|
||||
> **注意**: これらの設定は**Super Admin権限**を持つユーザーのみがアクセスできます。
|
||||
|
||||
---
|
||||
|
||||
## テナント設定
|
||||
|
||||
テナントは組織の最上位単位で、すべてのプロジェクトとユーザーが含まれる範囲です。
|
||||
|
||||
### アクセス方法
|
||||
|
||||
1. 右上メニューで**Home**アイコンをクリックします
|
||||
2. 左メニューから**Tenant Information**を選択します
|
||||
|
||||
### 編集可能な項目
|
||||
|
||||
| 項目 | 説明 | 編集可能 | 例 |
|
||||
| --------------- | ------------------------------------- | -------- | ----------------------- |
|
||||
| **ID** | テナント固有識別子(システム自動生成) | ❌ 不可 | `1` |
|
||||
| **Name** | テナント名(組織名、会社名など) | ✅ 可能 | `ABC Company` |
|
||||
| **Description** | テナント説明(オプション) | ✅ 可能 | `顧客フィードバック管理システム` |
|
||||
|
||||
### 情報編集方法
|
||||
|
||||
1. **Name**または**Description**フィールドを編集します
|
||||
2. 右上の**Save**ボタンをクリックします
|
||||
3. 保存完了時に成功メッセージが表示されます
|
||||
|
||||
> テナント名はログインUIに表示される場合があります。
|
||||
|
||||
---
|
||||
|
||||
## ログイン設定
|
||||
|
||||
ユーザーがシステムにアクセスする際に使用する認証方式を設定します。
|
||||
|
||||
### アクセス方法
|
||||
|
||||
1. 右上メニューで**Home**アイコンをクリックします
|
||||
2. 左メニューから**Login Management**を選択します
|
||||
|
||||
### サポートされるログイン方式
|
||||
|
||||
#### 1. メールログイン
|
||||
|
||||
デフォルトで提供されるメール+パスワードの組み合わせ方式です。
|
||||
|
||||
**特徴**:
|
||||
|
||||
- 追加設定なしでデフォルト有効化
|
||||
- ユーザー招待 → メール認証 → パスワード設定の順序
|
||||
- パスワードリセット機能提供
|
||||
|
||||
**パスワードポリシー**:
|
||||
|
||||
- 最低8文字以上
|
||||
- 英字、数字、特殊文字を含むことを推奨
|
||||
- 連続文字禁止(例:`aa`、`11`)
|
||||
|
||||
#### 2. Googleログイン
|
||||
|
||||
Google OAuth 2.0によるソーシャルログイン方式です。
|
||||
|
||||
**設定方法**:
|
||||
|
||||
1. **Googleログイン有効化**: トグルをONに切り替えます
|
||||
2. **Google Cloud Console設定が必要です**:
|
||||
|
||||
> **参考**: Google OAuth統合の詳細な実装方法については、[OAuth統合ガイド](/ja/developer-guide/oauth-integration)を参照してください。
|
||||
|
||||
#### 3. カスタムOAuthログイン
|
||||
|
||||
独自のOAuthサーバーや他のOAuthプロバイダーを使用する方式です。
|
||||
|
||||
**設定項目**:
|
||||
|
||||
| 項目 | 説明 | 例 |
|
||||
| ----------------- | ----------------------------- | ---------------------------------------- |
|
||||
| **Provider Name** | ログインボタンに表示される名前 | `Microsoftでログイン` |
|
||||
| **Client ID** | OAuthクライアントID | `abc123xyz` |
|
||||
| **Client Secret** | OAuthクライアントシークレット | `supersecret` |
|
||||
| **Auth URL** | 認証リクエストURL | `https://auth.example.com/oauth2/auth` |
|
||||
| **Token URL** | トークンリクエストURL | `https://auth.example.com/oauth2/token` |
|
||||
| **User Info URL** | ユーザー情報リクエストURL | `https://auth.example.com/oauth2/userinfo` |
|
||||
| **Scope** | リクエストする権限範囲 | `openid email profile` |
|
||||
| **Email Key** | ユーザー情報のメールフィールド名 | `email` |
|
||||
|
||||
**設定順序**:
|
||||
|
||||
1. 各フィールドにOAuthサーバー情報を入力します
|
||||
2. **Save**ボタンをクリックして保存します
|
||||
3. ログイン画面で設定されたProvider Nameでボタンが表示されます
|
||||
|
||||
### ログイン方式の組み合わせ
|
||||
|
||||
複数のログイン方式を同時に有効化できます:
|
||||
|
||||
- **メールのみ**: デフォルトログインフォームのみ表示
|
||||
- **メール+Google**: ログインフォーム+「Googleでログイン」ボタン
|
||||
- **メール+カスタム**: ログインフォーム+カスタムOAuthボタン
|
||||
|
||||
### ログイン設定のテスト
|
||||
|
||||
設定変更後、必ずテストを実施してください:
|
||||
|
||||
1. ブラウザのシークレットモードでログインページにアクセス
|
||||
2. 設定したログイン方式が正常に表示されるか確認
|
||||
3. 各方式で実際のログインテストを実行
|
||||
|
||||
---
|
||||
|
||||
## ユーザー管理
|
||||
|
||||
テナント全体のユーザーを中央で統合管理する機能です。
|
||||
|
||||
### アクセス方法
|
||||
|
||||
1. 右上メニューで**Home**アイコンをクリックします
|
||||
2. 左メニューから**User Management**を選択します
|
||||
|
||||
### ユーザーリストの確認
|
||||
|
||||
#### 表示される情報
|
||||
|
||||
| 列 | 説明 | 表示例 |
|
||||
| ---------- | ------------------------- | ---------------------- |
|
||||
| Email | ログインアカウントメールアドレス | `user@company.com` |
|
||||
| Name | ユーザー名(プロフィール基準) | `山田太郎` |
|
||||
| Department | 所属部門 | `開発チーム` |
|
||||
| Type | ユーザータイプ | `SUPER` / `GENERAL` |
|
||||
| Project | アクセス可能なプロジェクトリスト | `プロジェクトA、プロジェクトB` |
|
||||
| Created | アカウント作成日時 | `2024-03-15 14:30` |
|
||||
|
||||
#### ユーザータイプの説明
|
||||
|
||||
| タイプ | 説明 | 権限範囲 |
|
||||
| --------- | -------------------------------------------------------- | --------------- |
|
||||
| `SUPER` | すべてのプロジェクトと設定にアクセス可能。全体システム管理者の役割 | テナント全体 |
|
||||
| `GENERAL` | 指定されたプロジェクトにのみアクセス可能 | 特定のプロジェクトのみ |
|
||||
|
||||
### ユーザー検索とフィルタリング
|
||||
|
||||
大量のユーザーがいる場合、希望するユーザーを素早く見つけることができます。
|
||||
|
||||
#### フィルタ機能
|
||||
|
||||
上部の**Filter**ボタンをクリックして条件を設定します。
|
||||
|
||||
**フィルタ条件**:
|
||||
|
||||
- **Email**: メールアドレスで検索
|
||||
- **Name**: ユーザー名で検索
|
||||
- **Department**: 部門名で検索
|
||||
|
||||
**演算子オプション**:
|
||||
|
||||
- **CONTAINS**: 含む場合
|
||||
- **IS**: 完全一致する場合
|
||||
|
||||
### ユーザーの招待
|
||||
|
||||
新しいユーザーをシステムに招待します。
|
||||
|
||||
#### 招待方法
|
||||
|
||||
1. 右上の**Invite User**ボタンをクリックします
|
||||
2. 招待情報を入力します
|
||||
|
||||
| 項目 | 説明 | オプション |
|
||||
| ----------- | --------------------------- | ----------------------------- |
|
||||
| **Email** | 招待するユーザーのメールアドレス | 必須入力 |
|
||||
| **Type** | ユーザータイプ | `GENERAL` / `SUPER` |
|
||||
| **Project** | アクセスを許可するプロジェクト | プロジェクトリストから選択 |
|
||||
| **Role** | そのプロジェクトでの役割 | `Admin` / `Editor` / `Viewer` |
|
||||
|
||||
3. **Invite**ボタンをクリックして招待を完了します
|
||||
|
||||
#### 招待後のプロセス
|
||||
|
||||
1. 招待されたユーザーにメールが送信されます
|
||||
2. ユーザーがメールのリンクをクリックして登録手続きを進めます
|
||||
3. 登録完了後、指定されたプロジェクトに自動的に追加されます
|
||||
|
||||
### ユーザー情報の編集
|
||||
|
||||
既存のユーザーの情報と権限を変更できます。
|
||||
|
||||
#### 編集方法
|
||||
|
||||
1. ユーザーリストで編集したいユーザーをクリックします
|
||||
2. **Edit User**ポップアップが開きます
|
||||
|
||||
#### 編集可能な項目
|
||||
|
||||
| 項目 | 編集可能 | 説明 |
|
||||
| --------- | -------- | ------------------------------ |
|
||||
| **Email** | ❌ 不可 | アカウント識別子として変更不可 |
|
||||
| **Type** | ✅ 可能 | `GENERAL` ↔ `SUPER`変更可能 |
|
||||
|
||||
#### 保存と適用
|
||||
|
||||
1. 必要な情報を編集します
|
||||
2. **Save**ボタンをクリックします
|
||||
3. 変更は即座に適用され、該当ユーザーの次回ログインから反映されます
|
||||
|
||||
### ユーザーの削除
|
||||
|
||||
システムを使用しなくなったユーザーを削除できます。
|
||||
|
||||
#### 削除方法
|
||||
|
||||
1. ユーザー編集ポップアップ下部の**Delete**ボタンをクリックします
|
||||
2. 確認ダイアログで削除を承認します
|
||||
|
||||
#### 削除時の注意事項
|
||||
|
||||
- **復元不可能**: 削除されたユーザーアカウントは元に戻せません
|
||||
- **アクセス権限の即座削除**: 削除時、すべてのシステムアクセスが即座にブロックされます
|
||||
|
||||
---
|
||||
|
||||
## 関連ドキュメント
|
||||
|
||||
- [プロジェクト管理](../02-project-management.md) - プロジェクト別メンバーと権限管理
|
||||
- [OAuth統合ガイド](../../02-developer-guide/03-oauth-integration.md) - OAuth設定の技術的実装方法
|
||||
- [API統合](/ja/developer-guide/api-integration) - APIによるユーザー管理方法
|
||||
|
||||
+134
@@ -0,0 +1,134 @@
|
||||
---
|
||||
title: APIキー設定
|
||||
description: ABC User Feedbackで外部システム統合のためのAPIキーを作成、管理し、セキュリティを維持する方法を説明します。
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# APIキー設定
|
||||
|
||||
APIキーは、外部システムがABC User Feedbackと安全に統合できるようにする認証手段です。このドキュメントでは、APIキーの作成から管理、セキュリティ維持まで、画面中心で説明します。
|
||||
|
||||

|
||||
|
||||
---
|
||||
|
||||
## APIキーの概要
|
||||
|
||||
### APIキーの役割
|
||||
|
||||
APIキーは次の目的で使用されます:
|
||||
|
||||
- **外部システム認証**: ウェブサイト、モバイルアプリからフィードバック送信
|
||||
- **自動化統合**: バッチジョブ、スクリプトによるデータ収集
|
||||
- **サードパーティツール接続**: 分析ツール、モニタリングシステム統合
|
||||
- **セキュリティ制御**: プロジェクト別の独立したアクセス権限管理
|
||||
|
||||
### セキュリティ特徴
|
||||
|
||||
- **プロジェクト別独立性**: 各プロジェクトごとに別々のキー発行
|
||||
- **ステータス管理**: Active/Inactiveステータスで即座に制御可能
|
||||
|
||||
---
|
||||
|
||||
## APIキーの作成
|
||||
|
||||
### アクセス方法
|
||||
|
||||
1. 上部メニューで**Settings**をクリック
|
||||
2. 左メニューから**APIキー管理**を選択
|
||||
|
||||
### キー作成プロセス
|
||||
|
||||
#### 1. 作成ボタンをクリック
|
||||
|
||||
APIキー管理画面で右上の**Create API Key**ボタンをクリックします。
|
||||
|
||||
#### 2. 自動生成と表示
|
||||
|
||||
ボタンをクリックするとすぐに新しいAPIキーが自動生成され、ポップアップで表示されます。
|
||||
|
||||
**ポップアップ構成要素**:
|
||||
|
||||
- **APIキー値**: 完全なキー文字列を表示
|
||||
- **Copyボタン**: クリップボードに即座にコピー
|
||||
|
||||
---
|
||||
|
||||
## APIキーリスト管理
|
||||
|
||||
### キーリスト画面構成
|
||||
|
||||
作成されたAPIキーはテーブル形式で管理されます。
|
||||
|
||||
#### テーブル列情報
|
||||
|
||||
| 列 | 説明 | 表示形式 |
|
||||
| ----------- | ---------------------- | -------------------------- |
|
||||
| **APIキー** | 生成されたキー値 | `AbcdEfgh...` |
|
||||
| **Status** | 現在の有効化ステータス | Active / Inactive |
|
||||
| **Created** | キー作成日時 | `2024-03-15 14:30` |
|
||||
| **Actions** | 管理アクションボタン | ステータス変更、削除ボタン |
|
||||
|
||||
#### キー識別方法
|
||||
|
||||
完全なキー値を再度確認できないため、次の方法でキーを区別します:
|
||||
|
||||
- **作成時刻**: いつ作成されたキーか確認
|
||||
- **使用目的メモ**: 別途キーの用途を記録しておく
|
||||
|
||||
---
|
||||
|
||||
## APIキーステータス管理
|
||||
|
||||

|
||||
|
||||
### Active / Inactiveの切り替え
|
||||
|
||||
各APIキーは即座に有効化/無効化できます。
|
||||
|
||||
#### ステータス別の意味
|
||||
|
||||
| ステータス | 説明 | API呼び出し結果 |
|
||||
| ------------ | --------------------------- | ---------------- |
|
||||
| **Active** | 実際のAPI呼び出しに使用可能 | 正常処理 |
|
||||
| **Inactive** | 呼び出しブロック状態 | 401 Unauthorized |
|
||||
|
||||
#### ステータス変更方法
|
||||
|
||||
1. APIキーリストで**Status**列のトグルスイッチをクリックします
|
||||
2. ステータスが即座に変更され、画面に反映されます
|
||||
3. そのキーを使用する外部システムで即座に影響を受けます
|
||||
|
||||
---
|
||||
|
||||
## APIキーの削除
|
||||
|
||||
### 削除タイミング
|
||||
|
||||
次の場合、APIキーを削除する必要があります:
|
||||
|
||||
- **キー公開**: 誤ってキーが公開された場合
|
||||
- **プロジェクト終了**: 該当プロジェクトの使用終了
|
||||
- **セキュリティポリシー**: 定期的なキー交換ポリシーに従って
|
||||
- **未使用キー**: 使用しなくなったキーの整理
|
||||
|
||||
### 削除方法
|
||||
|
||||
#### 1. 削除ボタンをクリック
|
||||
|
||||
キーリストで削除したいキーの**Actions**列の削除ボタンをクリックします。
|
||||
|
||||
#### 2. 削除確認
|
||||
|
||||
確認ダイアログで削除を最終承認します。
|
||||
|
||||
#### 3. 削除完了
|
||||
|
||||
**Delete**ボタンをクリックすると、キーが即座に削除され、リストから削除されます。
|
||||
|
||||
---
|
||||
|
||||
## 関連ドキュメント
|
||||
|
||||
- [API統合ガイド](/ja/developer-guide/api-integration) - APIキーを使用した実際の統合実装方法
|
||||
- [プロジェクト管理](/ja/user-guide/project-management) - プロジェクト別APIキー管理
|
||||
+167
@@ -0,0 +1,167 @@
|
||||
---
|
||||
title: イシュートラッカー設定
|
||||
description: ABC User Feedbackで外部イシュートラッカー(Jiraなど)と統合してイシューを追跡し、リンクする方法を案内します。
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# イシュートラッカー設定
|
||||
|
||||
イシュートラッカー設定により、ABC User Feedbackのイシューを外部イシュー管理システム(Jiraなど)と統合できます。内部イシューに外部チケットリンクを接続して、開発ワークフローと自然に統合できます。
|
||||
|
||||
---
|
||||
|
||||
## イシュートラッカーの概要
|
||||
|
||||
### 統合の目的
|
||||
|
||||
イシュートラッカー統合は次の目的で使用されます:
|
||||
|
||||
- **ワークフロー統合**: 顧客フィードバックと開発作業の接続
|
||||
- **イシュー追跡**: 内部イシューと外部チケットの1対1マッピング
|
||||
- **進行状況共有**: 開発チームとカスタマーサポートチーム間の情報同期
|
||||
- **効率性向上**: 重複作業の防止とコンテキストの維持
|
||||
|
||||
### 統合方式
|
||||
|
||||
- **手動リンク接続**: ABCイシューに外部チケット番号を手動で入力
|
||||
- **URL自動生成**: 設定されたBase URLとProject Keyで自動リンク生成
|
||||
- **クリック移動**: 生成されたリンクをクリックして外部システムにすぐに移動
|
||||
|
||||
> **参考**: リアルタイム双方向同期はサポートしていません。ステータス変更などの同期が必要な場合は、[Webhook](./04-webhook-management.md)を活用してください。
|
||||
|
||||
---
|
||||
|
||||
## 設定画面へのアクセス
|
||||
|
||||
### アクセス方法
|
||||
|
||||
1. 上部メニューで**Settings**をクリック
|
||||
2. 左メニューから**イシュートラッカー管理**を選択
|
||||
|
||||
### 設定画面構成
|
||||
|
||||
イシュートラッカー管理画面は次のように構成されます:
|
||||
|
||||
- **Issue Tracking System**: 統合するシステムを選択するドロップダウン
|
||||
- **Connection Settings**: 接続情報入力エリア
|
||||
- **Link Preview**: 生成されるリンクのプレビュー
|
||||
- **Test Connection**: 接続テストボタン
|
||||
|
||||
---
|
||||
|
||||
## Jira統合設定
|
||||
|
||||
### システム選択
|
||||
|
||||
#### 1. Issue Tracking System設定
|
||||
|
||||
ドロップダウンから**Jira**を選択します。
|
||||
|
||||
### 接続情報入力
|
||||
|
||||
#### 2. Base URL設定
|
||||
|
||||
Jiraシステムの基本アドレスを入力します。
|
||||
|
||||
| 入力例 | 説明 |
|
||||
| ----------------------------------- | ----------------------- |
|
||||
| `https://yourcompany.atlassian.net` | Jira Cloudインスタンス |
|
||||
| `https://jira.company.com` | セルフホスティングJira Server |
|
||||
| `https://jira.internal:8080` | 内部ネットワークJira |
|
||||
|
||||
**注意事項**:
|
||||
|
||||
- `https://`または`http://`プロトコルを含める必要があります
|
||||
- 最後のスラッシュ(`/`)を削除
|
||||
- ポート番号がある場合は含める
|
||||
|
||||
#### 3. Project Key設定
|
||||
|
||||
Jiraプロジェクトの固有キーを入力します。
|
||||
|
||||
| 入力例 | 説明 |
|
||||
| --------- | -------------------- |
|
||||
| `PROJ` | 一般的なプロジェクトキー |
|
||||
| `DEV` | 開発チームプロジェクト |
|
||||
| `CS` | カスタマーサポートチームプロジェクト |
|
||||
| `BUG` | バグ管理専用 |
|
||||
|
||||
**Project Key確認方法**:
|
||||
|
||||
1. Jiraで該当プロジェクトにアクセス
|
||||
2. イシュー番号の`-`の前の部分がProject Key
|
||||
3. 例:`PROJ-123`で`PROJ`がProject Key
|
||||
|
||||
### リンクプレビュー
|
||||
|
||||
設定した情報に基づいて生成されるリンクをプレビューできます。
|
||||
|
||||
#### プレビュー構成
|
||||
|
||||
```
|
||||
Base URL + /browse/ + Project Key + - + Issue Number
|
||||
```
|
||||
|
||||
**例**:
|
||||
|
||||
- Base URL: `https://yourcompany.atlassian.net`
|
||||
- Project Key: `PROJ`
|
||||
- Issue Number: `123`(ユーザーが入力)
|
||||
- **生成されたリンク**: `https://yourcompany.atlassian.net/browse/PROJ-123`
|
||||
|
||||
#### リンク形式検証
|
||||
|
||||
プレビューで次を確認してください:
|
||||
|
||||
- URL形式が正しいか
|
||||
- 実際のJiraイシューにアクセス可能か
|
||||
- チームメンバーがアクセス権限を持っているか
|
||||
|
||||
---
|
||||
|
||||
## イシューでのチケット接続
|
||||
|
||||
### チケット番号入力
|
||||
|
||||
イシュートラッカー設定が完了すると、個別のイシューで外部チケットを接続できます。
|
||||
|
||||
#### 接続方法
|
||||
|
||||
1. **Issue**タブで希望するイシューをクリックします
|
||||
2. 右側の**Issue Details**パネルが開きます
|
||||
3. **Ticket**フィールドに外部チケット番号を入力します
|
||||
|
||||
#### 入力形式
|
||||
|
||||
| 入力方式 | 説明 | 生成されるリンク |
|
||||
| --------- | ----------- | ------------------------------------------ |
|
||||
| `123` | 数字のみ入力 | `https://jira.company.com/browse/PROJ-123` |
|
||||
|
||||
システムが自動的にProject Keyを追加するため、数字のみ入力すれば十分です。
|
||||
|
||||
### リンク自動生成
|
||||
|
||||
チケット番号入力後、**Save**ボタンをクリックするとリンクが自動生成されます。
|
||||
|
||||
#### リンク機能
|
||||
|
||||
- **クリック移動**: リンクをクリックすると新しいタブで外部Jiraイシューに移動
|
||||
- **外部リンク表示**: リンクの横に外部リンクアイコンを表示
|
||||
- **編集可能**: Editモードでチケット番号を変更可能
|
||||
|
||||
### 接続解除
|
||||
|
||||
外部チケット接続を削除するには:
|
||||
|
||||
1. イシュー詳細パネルで**Edit**ボタンをクリック
|
||||
2. **Ticket**フィールドの内容を削除
|
||||
3. **Save**ボタンで変更を保存
|
||||
|
||||
---
|
||||
|
||||
## 関連ドキュメント
|
||||
|
||||
- [イシュー管理](/ja/user-guide/issue-management) - イシュー作成とチケット接続の使用方法
|
||||
- [Webhook管理](/ja/user-guide/settings/webhook-management) - イシューステータス変更時の外部システム通知
|
||||
- [API統合ガイド](/ja/developer-guide/api-integration) - APIによるイシュー管理
|
||||
|
||||
+170
@@ -0,0 +1,170 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
title: 'ウェブフック設定'
|
||||
description: '外部システムと自動統合するためにウェブフックを設定し、イベント発生時に通知を送信する方法を説明します。'
|
||||
---
|
||||
|
||||
# ウェブフック設定
|
||||
|
||||
ウェブフックは、ABC User Feedbackで**特定のイベント発生時に外部システムに自動通知**を送信する機能です。フィードバック作成、イシューステータス変更などのイベントをリアルタイムで外部サービス(Slack、Discord、独自サーバーなど)に配信できます。詳細な統合ガイドについては、[ウェブフック統合](/ja/developer-guide/webhook-integration)ドキュメントを参照してください。
|
||||
|
||||

|
||||
|
||||
---
|
||||
|
||||
## アクセス方法
|
||||
|
||||
1. 上部メニューで**Settings**をクリック
|
||||
2. 左メニューから**Webhook Integration**を選択
|
||||
|
||||
---
|
||||
|
||||
## Webhook Integration画面の概要
|
||||
|
||||

|
||||
|
||||
ウェブフック統合画面は次のように構成されます:
|
||||
|
||||
### ウェブフックリストテーブル構成
|
||||
|
||||
| 列 | 説明 |
|
||||
| ----------------- | --------------------------------------- |
|
||||
| **On/Off** | ウェブフック有効化/無効化トグルスイッチ |
|
||||
| **Name** | ウェブフック名 |
|
||||
| **URL** | 通知を受信する外部エンドポイント |
|
||||
| **Event Trigger** | 購読中のイベントトリガー |
|
||||
| **Created** | ウェブフック作成日時 |
|
||||
|
||||
---
|
||||
|
||||
## 新しいウェブフックの作成
|
||||
|
||||
### 1. ウェブフック登録開始
|
||||
|
||||
右上の**Register Webhook**ボタンをクリックすると、ウェブフック登録モーダルが開きます。
|
||||
|
||||
### 2. 基本情報入力
|
||||
|
||||
#### 必須入力項目
|
||||
|
||||
| 項目 | 説明 |
|
||||
| -------- | ------------------------------------------- |
|
||||
| **Name** | ウェブフック識別のための名前 |
|
||||
| **URL** | HTTP POSTリクエストを受信するエンドポイント |
|
||||
|
||||
### 3. トークン設定(オプション)
|
||||
|
||||
**Token**フィールドで認証用のトークンを設定できます:
|
||||
|
||||
- **Generate**ボタンをクリックして自動生成
|
||||
- または直接トークン値を入力
|
||||
|
||||
### 4. Event Trigger選択
|
||||
|
||||
購読するイベントをチャネル別に選択できます:
|
||||
|
||||
#### サポートされるイベントタイプ
|
||||
|
||||
各チャネル(VOC、Review、Survey、VOC Test)について、次のイベントを選択できます:
|
||||
|
||||
| イベントタイプ | 説明 |
|
||||
| ----------------------- | ------------------------------------------ |
|
||||
| **Feedback Creation** | 新しいフィードバックが登録されたとき |
|
||||
| **Issue Registration** | 新しいイシューが作成されたとき |
|
||||
| **Issue Status Change** | イシューステータスが変更されたとき |
|
||||
| **Issue Creation** | イシューがフィードバックにリンクされたとき |
|
||||
|
||||
### 5. ウェブフック保存
|
||||
|
||||
すべての情報を入力した後:
|
||||
|
||||
1. **OK**ボタンをクリックしてウェブフックを作成
|
||||
2. **Cancel**ボタンでキャンセル可能
|
||||
|
||||
---
|
||||
|
||||
## ウェブフックステータス管理
|
||||
|
||||
### 有効化/無効化の切り替え
|
||||
|
||||
ウェブフックリストで各ウェブフックの**On/Off**列にあるトグルスイッチをクリックしてステータスを変更できます:
|
||||
|
||||
- **On(有効化)**: イベント発生時にリアルタイム送信
|
||||
- **Off(無効化)**: ウェブフックは維持されますが送信は停止
|
||||
|
||||
### 一時無効化シナリオ
|
||||
|
||||
- 外部サーバーがメンテナンス中の場合
|
||||
- ウェブフックURL変更作業中の場合
|
||||
- スパム通知を防ぐ必要がある場合
|
||||
|
||||
---
|
||||
|
||||
## ウェブフック編集と削除
|
||||
|
||||
### ウェブフック編集
|
||||
|
||||
ウェブフックリストで編集したいウェブフックをクリックすると編集モーダルが開きます:
|
||||
|
||||
#### 編集可能な項目
|
||||
|
||||
- ウェブフック名
|
||||
- Target URL変更
|
||||
- トークン値修正
|
||||
- イベントタイプ追加/削除
|
||||
|
||||
### ウェブフック削除
|
||||
|
||||
ウェブフックを完全に削除するには:
|
||||
|
||||
1. 編集モーダルで削除オプションを選択
|
||||
2. またはリストから直接削除ボタンをクリック(UIに削除ボタンがある場合)
|
||||
|
||||
---
|
||||
|
||||
## ウェブフックテストと検証
|
||||
|
||||
### 手動検証方法
|
||||
|
||||
1. **フィードバック作成テスト**:
|
||||
- テストフィードバックを登録して`Feedback Creation`イベントを確認
|
||||
2. **イシュー管理テスト**:
|
||||
- イシューを作成またはステータスを変更して関連イベントを確認
|
||||
3. **外部サービス確認**:
|
||||
- Slack、Discordなどでメッセージ受信を確認
|
||||
|
||||
---
|
||||
|
||||
## 一般的な統合例
|
||||
|
||||
### Slackウェブフック設定
|
||||
|
||||
```
|
||||
Name: Slack通知
|
||||
URL: https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXX
|
||||
Events: Feedback Creation, Issue Registration(すべてのチャネル)
|
||||
```
|
||||
|
||||
### Discordウェブフック設定
|
||||
|
||||
```
|
||||
Name: Discord開発チーム通知
|
||||
URL: https://discord.com/api/webhooks/123456789/abcdefghijk
|
||||
Events: Issue Status Change(VOCチャネルのみ)
|
||||
```
|
||||
|
||||
### カスタムサーバー統合
|
||||
|
||||
```
|
||||
Name: 内部分析システム
|
||||
URL: https://api.yourcompany.com/webhooks/feedback
|
||||
Token: your-generated-token
|
||||
Events: すべてのイベント(すべてのチャネル)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 関連ドキュメント
|
||||
|
||||
- [Webhook開発者ガイド](/ja/developer-guide/webhook-integration) - ウェブフック受信サーバーの実装方法
|
||||
- [APIキー管理](./02-api-key-management.md) - APIキーベース認証設定
|
||||
+272
@@ -0,0 +1,272 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
title: 'AI設定'
|
||||
description: '生成AI機能を使用するための基本設定と統合方法を説明します。'
|
||||
---
|
||||
|
||||
# AI設定
|
||||
|
||||
ABC User Feedbackで**生成AI機能**を使用するには、まずAIプロバイダーとの統合を設定する必要があります。
|
||||
AI設定を完了すると、**AIフィールドテンプレート**、**AIイシュー推奨**、**AI使用量モニタリング**などのすべての機能を活用できます。
|
||||
|
||||
---
|
||||
|
||||
## アクセス方法
|
||||
|
||||
1. 上部メニューで**Settings**をクリック
|
||||
2. 左メニューから**Generative AI Integration**を選択
|
||||
3. 上部タブで**AI Setting**をクリック
|
||||
|
||||
---
|
||||
|
||||
## AIプロバイダー選択と設定
|
||||
|
||||

|
||||
|
||||
### 1. プロバイダー選択
|
||||
|
||||
現在サポートされているAIプロバイダーOpenAI、Google Geminiのいずれかを選択します:
|
||||
|
||||
### 2. APIキー入力
|
||||
|
||||
選択したAIプロバイダーから発行されたAPIキーを入力します。
|
||||
|
||||
### 3. Base URL設定(オプション)
|
||||
|
||||
ほとんどの場合、**空欄にしておくとデフォルト値**が自動的に使用されます。
|
||||
|
||||
特別なエンドポイントやプロキシサーバーを使用する場合のみ入力してください。
|
||||
|
||||
### 4. System Prompt設定(オプション)
|
||||
|
||||
AIがすべてのリクエストを処理する際に参照する**基本指示**を設定できます。
|
||||
|
||||
組織のトーンアンドマナーや特別な要件がある場合に活用してください。
|
||||
|
||||
### 5. 設定保存
|
||||
|
||||
すべての情報を入力した後、右上の**Save**ボタンをクリックします。
|
||||
|
||||
---
|
||||
|
||||
## AI使用量モニタリング
|
||||
|
||||

|
||||
|
||||
**AI Usage**タブでAI機能の使用量とコストをモニタリングできます。
|
||||
|
||||
### 使用量ダッシュボード
|
||||
|
||||
確認できる情報:
|
||||
|
||||
- **日次/月次API呼び出し数**
|
||||
- **トークン使用量**(入力/出力別)
|
||||
- **機能別使用分布**(AIフィールド vs イシュー推奨)
|
||||
|
||||
---
|
||||
|
||||
## AIフィールドテンプレート管理
|
||||
|
||||

|
||||
|
||||
AI設定を完了した後、**AI Field Template**タブでフィードバック自動分析テンプレートを管理できます。
|
||||
|
||||
### デフォルトテンプレート
|
||||
|
||||
システムで提供されるデフォルトテンプレート:
|
||||
|
||||
| テンプレート | 説明 | 活用例 |
|
||||
| ---------------------- | ---------------------------------------------- | ------------------------------ |
|
||||
| **Feedback Summary** | フィードバックを1文で要約 | 長いフィードバックの核心を把握 |
|
||||
| **Sentiment Analysis** | 感情分析(ポジティブ/ネガティブ/ニュートラル) | 顧客満足度トレンド分析 |
|
||||
| **Translation** | フィードバックを英語に翻訳 | 多言語フィードバック統合分析 |
|
||||
| **Keyword Extraction** | 核心キーワード2-3個抽出 | イシューカテゴリ自動タグ付け |
|
||||
|
||||
### カスタムテンプレート作成
|
||||
|
||||

|
||||
|
||||
1. **Create New**カードをクリック
|
||||
2. テンプレート情報を入力
|
||||
|
||||
| 項目 | 説明 |
|
||||
| --------------- | --------------------- |
|
||||
| **Title** | テンプレート名 |
|
||||
| **Prompt** | AIに与える指示文 |
|
||||
| **Model** | 使用するAIモデル選択 |
|
||||
| **Temperature** | 創造性調整(0.0~1.0) |
|
||||
|
||||
3. Playgroundでテスト
|
||||
|
||||
- "Add Data"ボタンでテストフィードバック入力
|
||||
- "AI test execution"クリックで結果確認
|
||||
|
||||
### テンプレート編集と削除
|
||||
|
||||
- テンプレートカードクリック → 編集
|
||||
- **Delete Template**ボタンで削除
|
||||
- 削除時、そのテンプレートを使用するAIフィールドに影響を与える可能性があります
|
||||
|
||||
---
|
||||
|
||||
## AIフィールドをチャネルに適用
|
||||
|
||||
AIフィールドテンプレートを作成した後、実際のチャネルのフィールドとして適用する必要があります。フィードバックでAI分析結果を確認できます。
|
||||
|
||||
### 1. Field ManagementでAIフィールド追加
|
||||
|
||||
**Settings > Channel List > [チャネル選択] > Field Management**でAIフィールドを追加します。
|
||||
|
||||
#### AIフィールド設定項目
|
||||
|
||||
| 項目 | 説明 | 必須 |
|
||||
| ----------------------- | ------------------------------------ | ---------- |
|
||||
| **Key** | フィールド固有識別子 | 必須 |
|
||||
| **Display Name** | UIに表示される名前 | 必須 |
|
||||
| **Format** | `aiField`選択 | 必須 |
|
||||
| **Template** | 作成したAIフィールドテンプレート選択 | 必須 |
|
||||
| **Target Field** | 分析対象となるテキストフィールド | 必須 |
|
||||
| **Property** | EditableまたはRead Only | 必須 |
|
||||
| **AI Field Automation** | 自動実行有無 | オプション |
|
||||
|
||||
#### 設定例
|
||||
|
||||
```
|
||||
Key: sentiment_analysis
|
||||
Display Name: 感情分析
|
||||
Format: aiField
|
||||
Template: Feedback Sentiment Analysis
|
||||
Target Field: message
|
||||
Property: Read Only
|
||||
AI Field Automation: ON(自動実行)
|
||||
```
|
||||
|
||||
### 2. Template接続とTarget Field設定
|
||||
|
||||
**Template**ドロップダウンから以前に作成したAIフィールドテンプレートを選択します。
|
||||
|
||||
**Target Field**はAI分析の対象となるフィールドを指定します
|
||||
|
||||
### 3. AI Field Automation設定
|
||||
|
||||
**AI Field Automation**トグルを通じて実行方式を選択します:
|
||||
|
||||
- **ON(自動実行)**: 新しいフィードバック登録時に自動的にAI分析実行
|
||||
- **OFF(手動実行)**: ユーザーが手動で実行ボタンをクリックする必要があります
|
||||
|
||||
## フィードバックでAI分析結果確認
|
||||
|
||||
AIフィールド設定が完了すると、フィードバックリストと詳細画面でAI分析結果を確認できます。
|
||||
|
||||
### フィードバックリストで確認
|
||||
|
||||
フィードバックテーブルにAIフィールドが新しい列として追加されます:
|
||||
|
||||
- **Summary**: AIが生成した要約
|
||||
- **Classification**: AI分類結果
|
||||
- **Korean**: 翻訳結果など
|
||||
|
||||
### フィードバック詳細画面で確認
|
||||
|
||||
フィードバック詳細表示パネルでより詳細なAI分析結果を確認できます:
|
||||
|
||||
1. フィードバック行をクリック → 右側詳細パネルが開きます
|
||||
2. AIフィールド別の分析結果を確認
|
||||
3. 各AIフィールドごとに分析結果とともに表示
|
||||
|
||||
## AI分析手動実行
|
||||
|
||||
フィードバック詳細画面で手動でAI分析を実行できます。
|
||||
|
||||
### Run AIボタン使用
|
||||
|
||||
1. フィードバック詳細画面で**Run AI**ボタンをクリック
|
||||
2. AI分析が実行され、結果がそのフィールドに自動入力されます
|
||||
3. 分析完了後、結果をすぐに確認可能
|
||||
|
||||
### 手動実行活用シナリオ
|
||||
|
||||
- **コスト節約**: 必要なフィードバックのみを選択してAI分析
|
||||
- **パフォーマンス確認**: 新しいテンプレートの結果を事前にテスト
|
||||
- **再分析**: テンプレート修正後、既存フィードバックを再分析
|
||||
|
||||
---
|
||||
|
||||
## AIイシュー推奨設定
|
||||
|
||||
**AI Issue Recommendation**タブでフィードバックベースの自動イシュー推奨機能を設定できます。
|
||||
|
||||

|
||||
|
||||
### 推奨設定作成
|
||||
|
||||

|
||||
|
||||
1. **Create New**ボタンをクリック
|
||||
2. 設定項目を入力
|
||||
|
||||
| 項目 | 説明 | 必須 |
|
||||
| ---------------- | --------------------------------- | ---------- |
|
||||
| **Channel** | 適用するチャネル選択 | 必須 |
|
||||
| **Target Field** | 分析対象フィールド(例:message) | 必須 |
|
||||
| **Prompt** | 推奨基準プロンプト | オプション |
|
||||
| **Enable** | 機能有効化トグル | 必須 |
|
||||
|
||||
3. 高度な設定
|
||||
|
||||
| 設定 | 説明 |
|
||||
| ------------------------- | -------------------------------------------------- |
|
||||
| **Model** | 使用モデル |
|
||||
| **Temperature** | 創造性調整 |
|
||||
| **Data Reference Amount** | 参照するイシュー量(イシューと関連フィードバック) |
|
||||
|
||||
### 推奨機能テスト
|
||||
|
||||
入力された設定についてPlaygroundでテスト:
|
||||
|
||||
1. 例示フィードバック入力
|
||||
2. "AI test execution"クリック
|
||||
3. 推奨イシューリスト確認
|
||||
|
||||
### 実際のフィードバックで推奨活用
|
||||
|
||||
フィードバック詳細表示で:
|
||||
|
||||
- AI推奨イシューリスト確認
|
||||
- チェックボックスで適切なイシュー選択
|
||||
- **Retry**ボタンで別の推奨リクエスト
|
||||
|
||||
### フィードバックリストでイシュー推奨使用
|
||||
|
||||
AIイシュー推奨を設定したチャネルでは、フィードバックリスト画面でも直接イシュー推奨機能を使用できます。
|
||||
|
||||
#### 使用方法
|
||||
|
||||
1. フィードバックリストでイシューを接続したいフィードバックの**Issue列**にある**+ボタン**をクリック
|
||||
2. ドロップダウンメニューが表示されたら**"Run AI"**を選択
|
||||
3. AIが関連イシューを分析して推奨リストを表示
|
||||
|
||||
#### 推奨結果確認と適用
|
||||
|
||||
AI分析完了後、推奨イシューリストから:
|
||||
|
||||
- **推奨されたイシュー**確認
|
||||
- 推奨された適切なイシュー選択
|
||||
- 新しいイシュー作成オプションも提供
|
||||
- 選択完了後、該当イシューがフィードバックに自動接続
|
||||
|
||||
#### 一括処理活用
|
||||
|
||||
複数のフィードバックを選択した状態でもAIイシュー推奨を使用でき、効率的なフィードバック分類が可能です:
|
||||
|
||||
1. フィードバックリストで複数行選択(チェックボックス活用)
|
||||
2. 上部一括作業メニューでAIイシュー推奨実行
|
||||
3. 各フィードバックごとに推奨イシュー確認と適用
|
||||
|
||||
---
|
||||
|
||||
## 関連ドキュメント
|
||||
|
||||
- [フィールド設定](/ja/user-guide/feedback-management) - AIフィールドをチャネルに適用する方法
|
||||
- [イシュー作成とステータス管理](/ja/user-guide/issue-management) - AI推奨イシューの活用方法
|
||||
- [フィードバック確認とフィルタリング](/ja/user-guide/feedback-management) - AI分析結果確認方法
|
||||
+102
@@ -0,0 +1,102 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
title: '画像設定'
|
||||
description: 'フィードバックに添付された画像の保存方式とセキュリティポリシーを設定する方法を案内します。'
|
||||
---
|
||||
|
||||
# 画像設定
|
||||
|
||||
ABC User Feedbackでは、ユーザーがフィードバックを提出する際に**画像と一緒にアップロード**できるようにサポートしています。画像の保存方式とセキュリティポリシーを適切に設定することで、安全で効率的なフィードバック収集環境を構築できます。
|
||||
|
||||

|
||||
|
||||
---
|
||||
|
||||
## アクセス方法
|
||||
|
||||
1. 上部メニューで**Settings**をクリック
|
||||
2. 左メニューから**Channel List > [チャネル選択]**
|
||||
3. 下部タブから**Image Management**を選択
|
||||
|
||||
---
|
||||
|
||||
## Image Storage Integration設定
|
||||
|
||||
**Multipart Upload API**方式で画像をサーバーに直接アップロードするか、**Presigned URL Download**機能を活用するには、S3またはS3互換ストレージ統合が必要です。
|
||||
|
||||
### 必須設定項目
|
||||
|
||||
| 項目 | 説明 | 例 |
|
||||
| --------------------- | ---------------------------- | ----------------------------------------- |
|
||||
| **Access Key ID** | S3アクセスのためのキーID | `AKIAIOSFODNN7EXAMPLE` |
|
||||
| **Secret Access Key** | キーに対するシークレット | `wJalrXUtnFEMI/K7MDENG/...` |
|
||||
| **End Point** | S3 APIエンドポイントURL | `https://s3.ap-northeast-1.amazonaws.com` |
|
||||
| **Region** | バケットが位置する地域 | `ap-northeast-1` |
|
||||
| **Bucket Name** | 画像が保存される対象バケット | `consumer-ufb-images` |
|
||||
|
||||
### Presigned URL Download設定
|
||||
|
||||
**Presigned URL Download**オプションを通じて画像ダウンロードセキュリティを強化できます。
|
||||
|
||||
#### 設定オプション
|
||||
|
||||
- **Enable**: 認証されたワンタイムURLを通じて画像にアクセス(セキュリティ強化)
|
||||
- **Disable**: 画像URLが直接公開され、公開アクセス可能
|
||||
|
||||
### 接続テスト
|
||||
|
||||
すべての設定を入力した後、**Test Connection**ボタンをクリックしてストレージ接続を確認します。
|
||||
|
||||
接続結果:
|
||||
|
||||
- ✅ **成功**: "Connection test succeeded"メッセージ
|
||||
- ❌ **失敗**: 入力値、バケット権限、ネットワーク設定を再確認する必要があります
|
||||
|
||||
---
|
||||
|
||||
## Image URL Domain Whitelist設定
|
||||
|
||||
**Image URL方式**を使用するか、セキュリティを強化したい場合、信頼できるドメインのみを許可するようにホワイトリストを設定できます。
|
||||
|
||||
### 現在の状態確認
|
||||
|
||||
デフォルト設定は**"All image URLs are allowed"**状態で、すべてのドメインの画像URLを許可します。
|
||||
|
||||
### ホワイトリスト追加
|
||||
|
||||
セキュリティ強化のために特定のドメインのみを許可するには:
|
||||
|
||||
1. **Whitelist**エリアに信頼できるドメインを追加
|
||||
2. 例示ドメイン:
|
||||
- `cdn.yourcompany.com`
|
||||
- `images.trusted-partner.io`
|
||||
- `storage.googleapis.com`
|
||||
|
||||
---
|
||||
|
||||
## サポートされるストレージサービス
|
||||
|
||||
### AWS S3
|
||||
|
||||
- 最も一般的に使用されるクラウドストレージ
|
||||
- 安定性が高く、拡張性に優れています
|
||||
|
||||
---
|
||||
|
||||
## 設定保存
|
||||
|
||||
すべての設定を完了した後、右上の**Save**ボタンをクリックして変更を保存します。
|
||||
|
||||
保存後:
|
||||
|
||||
- 新しい画像アップロードが設定した方式で動作
|
||||
- 既存の画像は既存設定のまま維持
|
||||
- Test Connectionで設定の正常動作を再確認することを推奨
|
||||
|
||||
---
|
||||
|
||||
## 関連ドキュメント
|
||||
|
||||
- [フィールド設定](/ja/user-guide/feedback-management) - 画像フィールドをフィードバックフォームに追加する方法
|
||||
- [フィードバック確認とフィルタリング](/ja/user-guide/feedback-management) - アップロードされた画像をフィードバックで確認する方法
|
||||
- [APIキー管理](./02-api-key-management.md) - APIキーセキュリティ管理方法
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"position": 7,
|
||||
"label": "設定",
|
||||
"description": "設定に関するガイドです。"
|
||||
}
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: 設定
|
||||
---
|
||||
|
||||
import DocCardList from '@theme/DocCardList';
|
||||
|
||||
<DocCardList />
|
||||
Reference in New Issue
Block a user