How to use the Collaborative Editing Feedback Tool to provide problem reports

お困りですか?

アトラシアン コミュニティをご利用ください。

コミュニティに質問

アトラシアン社外秘

この記事は未検証なのでお客様と共有できません。

目的

If you experience serious problems with collaborative editing, such as data duplication, our Support team may ask help from users report problems and collect editing data.  The plugin extracts data from the editor then matches it with page events and version history to create a complete snapshot of the lifecycle of the page. This data can assist our Support and development teams to identify low level issues in the editor. 

You should only use the plugin when suggested by support, and should consider the files sensitive data.

What data does the tool collect?

When someone reports a problem, we collect all the changes that have happened to that page, including the page or blog history, any page events, and data from the collaborative editor (for the past 72 hours). The user reporting the problem will also be prompted to describe the issue in their own words. 

(warning) Note: Synchrony captures every key stroke made in the editor when editing a page. For example if you type "The best ice cream is Vanilla" and then backspace and change it to "Chocolate", both "Vanilla" and "Chocolate" will be included in the Synchrony data. 

このデータは zip ファイルとしてエクスポートされ、次のディレクトリに保存されます。

  • <shared-home>/collab-data/ if you run Confluence in a cluster

  • <local-home>/shared-home/collab-data/ you are using non-clustered Confluence.

Because the collected data includes user generated content, generated reports are only kept for 5 days, then automatically deleted by the Clean up collaborative editing feedback reports scheduled job.  A maximum of 200 reports are kept at any one time.  You can change both of these values if necessary. See Configure the plugin.  

How do I send this data to Atlassian? 

The data collected is stored in your shared home directory. If you choose to share this data with our Support team for analysis, you can transfer the files through a support ticket. Do not share this data in any public locations, such as in Atlassian bug reports.

This data should only be provided when requested by a Support team member.

Using the plugin

Install the Collaborative editing feedback plugin

You need System Administrator global permissions to do this. 

To install the Collaborative editing feedback plugin:

  1. Download the collaborative-editing-feedback-plugin-1.0.1.jar file.
  2. [管理] > [アプリの管理] に移動します。
  3. Select Upload app and browse for the jar file. 

(warning) Note: The tool will be bundled with Confluence in a future version.

Allow your users to self report problems

By default, the plugin only allows people with System Administrator global permissions to report problems through the administrative interface. 

ユーザーによる問題の自己報告を許可するには、次の手順に従います。

  1. Go to Administration  > General Configuration > Collaborative editing feedback.
  2. [設定] を選択します。
  3. Select the Allow users to report editor problems checkbox. 

This will add the Report editing problems button to the header, when viewing or editing a page. 

編集の問題を報告する

ページやブログ投稿から編集の問題を報告するには、次の手順に従います。

  1. 問題のあるページまたはブログ投稿に移動します。
  2. Select Report editing problems from the header.
  3. 何をしているときに問題が発生したのかなど、関連情報を入力します。
  4. Indicate if you had recently copied and pasted data on the page, or if the page was updated externally (such as through the API, or by an app).
  5. Select Send feedback

レポートは共有ホーム ディレクトリに保存され、利用可能なレポートのリストに表示されます (システム管理者のみがアクセスできます)。 

ページ ID で編集の問題を報告する

システム管理者は、ページ ID で問題のあるページのレポートを生成することもできます。これは、ユーザーによる問題の自己報告を許可したくない場合に便利です。

特定のページやブログ投稿のレポートを作成するには、次の手順に従います。

  1. Go to Administration  > General Configuration > Collaborative editing feedback.
  2. ページ ID またはブログ投稿 ID を
  3. Select Create dump button. 

レポート ファイルは、利用可能なレポートのリストに表示されます。 

Configure the plugin

You can change the default behaviour of the Collaborative editing feedback plugin using the following System Properties

プロパティ既定値説明
confluence.plugins.collab.feedback.destination.folder<shared-home>/collab-data

Set this property to change where problem reports should be saved.  For non-clustered installations, the default location will be <local-home>/shared-home/collab-data.  

confluence.plugins.collab.feedback.files.max200Set this property to limit the number of problem reports to store. 
confluence.plugins.collab.feedback.operation.timeout.sec20Set this property, in seconds, to change the operation timeout in seconds. 
confluence.plugins.collab.feedback.concurrent.max5Set this property to change the maximum number of concurrent data collection operations. 
confluence.plugins.collab.feedback.operation.formatcsvエクスポートするファイルの形式を変更する場合に、このプロパティを設定します。csv または json を指定できます。 
confluence.plugins.collab.feedback.cleanup.threshold.hours120レポートを保持する期間 (時間単位) を変更する場合に、このプロパティを設定します。スケジュール ジョブでは、この制限を超えるレポートは最も古いものから順に削除されます。 


最終更新日 2021 年 11 月 29 日

この内容はお役に立ちましたか?

はい
いいえ
この記事についてのフィードバックを送信する
Powered by Confluence and Scroll Viewport.