Sealed — 使い方

Sealed がすること

Confluence のページに承認のゲートを置き、通ったらそのページの編集を締めます。承認の状態はページタイトルの下に出るので、読む人は開かなくても分かります。承認する人も同じ場所から操作します。

出てくる場所は5つです。ページタイトル下のバイライン、それをクリックすると開くパネル、本文に差し込む承認テーブルのマクロ、スペース設定の中の承認ワークフロー設定、そして通知の受け取り方を各自が選ぶ承認ダッシュボードです。

申請・承認・却下・ロック・解除は、すべて Atlassian 内のストレージにある監査証跡に残ります。1件ごとに直前の記録のハッシュを持たせてあるので、書き換えや欠落が分かります。

スペースの設定

スペース管理者がスペースごとに1回だけ行います。スペース設定を開き、承認ワークフロー設定を選んでください。この画面は Confluence 側がスペース管理者に限定しています。「Admin ロールが必要」と出たら、スペース管理者に開いてもらってください。

ワークフローとステップ

名前を付けてステップを足します。ステップは上から順に進みます。1つのステップにはユーザーとグループのどちらも指定でき、全員の承認で通すか、誰か1人の承認で通すかを選べます。

デフォルトのワークフロー

スペースのデフォルトを1つ決めます。そのスペースの申請はすべてこれを使います。デフォルトが無いと誰も申請できません。

ロック後も編集できるグループ

承認済みのページを編集し続けられるグループを指定します。空のままだと Sealed はロックを掛けません。ロックを当てにする前に必ず設定してください。

ページに出す情報量

ヘッダーのみ・コンパクト・詳細の3段階です。詳細にすると承認者が並びます。ヘッダーのみなら状態だけが出ます。初期値はコンパクトです。

ボタンを出さないグループ

ここに入れたグループの人には、承認の状態は見えますが操作ボタンは出ません。

ラベルの言語

英語か日本語で、初期値は英語です。これは Sealed がページ自体に書き込む文言の言語で、読む人が誰であっても同じ言葉が出ます。パネルと設定画面のほうは、読む人それぞれの Confluence の言語に従います。

承認を申請する

ページを開き、タイトル下の承認状態をクリックして、承認を申請を選びます。Sealed はスペースのデフォルトのワークフローを読み、グループを個人に展開して、申請を記録します。

承認者はその申請の瞬間で確定します。あとからワークフローを直しても、レビュー中のページの条件は変わりません。次の申請から新しい定義が使われます。

承認・却下・改訂の申請

ボタンが出るのは、いま進行中のステップの承認者だけです。2段のワークフローなら、1段目が通るまで2段目の承認者には何も出ません。

承認

必要な人数がそろった時点でステップが進みます。最後のステップが通るとページが承認済みになり、そこで Sealed がロックを掛けます。

却下

コメントが必須です。ページは差し戻しの状態に戻り、バイラインにもそう出るので、書いた人は直して出し直せます。

改訂を申請

承認済みのページを開け直すときに使います。ロックを外し、ロック前にそのページが持っていた制限を書き戻し、差し戻しの状態に戻します。操作できるのはそのページの承認者です。

ロックが何をするか

ページが承認済みになると、Sealed は Confluence の編集制限に、アプリ自身とスペース設定で指定したグループを書き込みます。

閲覧の権限は変わりません

触るのは編集の制限だけです。それまで見えていた人には、そのまま見えます。

アプリは必ず制限に残ります

Confluence は呼び出した本人を締め出す制限を受け付けないため、アプリユーザーが残ります。あとで Sealed がロックを外せるのも、これがあるからです。

グループ未指定ならロックしません

ロック後も編集できるグループが空のスペースでは、ロックを掛けずに「掛けなかった」と記録します。全員がページを触れなくなる状態を作らないためです。

ロックに失敗したとき

承認はそのままにして、バイラインに警告を出します。ロックされたと思い込ませないためです。そのスペースでアプリユーザーが制限を変更できないときに起きます。

承認後に編集されたら

編集の権限が残っている人は、承認済みのページを書き換えられます。そうなったとき、Sealed は承認を落とします。中身と合わなくなったバッジを出したままにしないためです。

バイラインは「承認後に編集された」に変わります。もう一度申請すれば、新しい版で承認をやり直せます。

Sealed は live doc を受け付けません。live doc の変更は Confluence から Sealed に通知されないため、承認しても内容が変わったときに承認を落とせないからです。それを黙って起こすかわりに、live doc では申請も承認も断ります。承認が必要な文書はページとして作成してください。

通知

Sealed は関係者をメンションしたフッターコメントを投稿し、そこから先は Confluence の通知に乗ります。Sealed 自身はメールを送りません。

すべてのイベント

承認依頼に加えて、承認・却下・改訂の申請といった結果も届きます。

承認依頼のみ

自分の承認が必要になったときだけ届き、結果では鳴りません。全員がここから始まります。

受け取らない

通知の宛先から外れます。

同じページの10分ぶんの動きを1件のコメントにまとめます。続けて5回操作しても通知は1件です。受け取り方は承認ダッシュボードで各自が選びます。

承認テーブルのマクロ

本文に承認テーブルのマクロを差し込むと、承認者と承認日がページの中に出ます。バイラインと同じ状態を読んでいて、ボタンを持ちません。大勢が読むページに置いても安全です。

ロックを外す

スペース設定にロック中のページというタブがあります。そのスペースで Sealed がロックしたページが並び、行ごとの解除と、上のすべて解除が使えます。一覧はページ側ではなく監査証跡から作っているので、ページに保存された状態が書き換えられていても表に出ます。

アンインストール時にも解除を試みますが、Atlassian が許す時間内に届いた範囲までです。規模の大きいサイトでは全部とは限りません。アンインストールの前に、ロック中のページから外しておいてください。

監査証跡

誰が・どのページの第何版に対して・何を・いつ行ったかを記録します。記録は Atlassian 内のストレージにあり、1件ずつ直前の記録に対してハッシュを取ってあります。

このリリースには、証跡を読む画面もエクスポートもありません。記録は書かれて保持されています。閲覧画面と CSV エクスポートは後のリリースで用意します。

先に知っておくとよい制限

承認者の数

1ステップ100人まで、1ワークフロー合計250人までです。グループを個人に展開したあとの人数で数えます。

スペースにデフォルトは1つ

スペースが持つデフォルトのワークフローは1つです。複数スペースへ一括で適用する機能はありません。

申請時にワークフローは選べません

申請は必ずスペースのデフォルトを使います。選択は求められません。

有効期限はありません

このリリースでは、承認が時間で失効することはありません。

live doc

live doc では申請と承認を断ります。Confluence が編集を通知しないため、承認しても内容の変更で落とせないからです。却下と改訂の申請は使えるので、すでにレビュー中の live doc は差し戻せます。承認が必要な文書はページで作成してください。

対応言語

英語と日本語です。

うまくいかないとき

設定画面に「Admin ロールが必要」と出る

この画面は Confluence 側がスペース管理者に限定していて、リクエストが Sealed まで届きません。スペース管理者に開いてもらってください。

状態は見えるがボタンが出ない

進行中のステップの承認者でないか、自分の所属グループがボタンを出さないグループに入っています。

「承認済み（ロック未適用）」と出る

そのスペースでアプリユーザーが制限を変更できませんでした。制限の追加と削除の権限をアプリに与えてから、もう一度申請してください。

通知が届かない

結果の通知はすべてのイベントを選んだ人にだけ届きます。初期値は承認依頼のみです。加えて、10分ぶんをまとめるので最大10分待ちます。

サポート

メールをいただければ返信します。スペースキーと対象のページ、そして何が起きると思っていたかを書き添えてください。