レビュー設定
レビュー設定はアクションの実行前に他のユーザーによるレビューを必須にできる機能です。
承認に必要な条件は柔軟に設定でき、例えば以下のような条件を設定できます。
- 特定のユーザーからの承認を必須にする
- 特定のグループのユーザー最低○人からの承認を必須にする
こうした条件は承認パターンとして複数設定でき、そのうちどれか1つのパターンを満たせば承認されます。
またレビューを有効化するかどうかや、承認条件は環境ごとに別の設定が可能で、例えば本番環境ではレビューを有効、開発環境ではレビューを無効といった設定ができます。
レビュー設定の作成
レビュー設定はプロジェクト設定のレビュー設定から作成できます。
- 右上のメニューから「設定」を選択します。
- 左のサイドバーから「レビュー設定」を選択してレビュー設定の一覧画面に移動します。
- 「追加」ボタンを選択して、レビュー設定の作成画面に移動します。
レビュー設定では以下の項目を設定します。
- 名前
- 各環境の設定
- レビューを有効化する
- 承認条件
- 自身のレビュー依頼を承認可能にする
- 自身のレビュー依頼を自動承認する
- 承認者もアクションを実行可能にする
- 承認後の自動実行
- レビュー依頼のデフォルト設定
名前
レビュー設定の名前です。
以下は各環境ごとに設定する項目です。
レビューを有効化する
その環境でレビューを有効化するかどうかを設定します。
有効化すると以下の項目が設定できるようになります。
承認条件
承認に必要なユーザー・グループは、承認パターンとして設定します。承認パターンは「承認パターンを追加（または）」ボタンから複数設定でき、そのうちどれか1つのパターンを満たすと承認されます。1つのパターンに複数の承認者を設定した場合は、そのパターン内の承認者全員の承認が必要です。
グループを承認者に設定する場合は、そのグループのうち最低何人の承認が必要なのかも設定できます。
承認パターンは最低1つ必要で、各パターンには承認者を1人以上設定する必要があります。
自身のレビュー依頼を承認可能にする
レビュー依頼者が自分自身のレビュー依頼を承認できるかどうかを設定します。
「自身のレビュー依頼を承認可能にする」が無効の場合、レビュー依頼者は自分のレビュー依頼を承認できません。承認者として設定された他のユーザーのみが承認できます。
自身のレビュー依頼を自動承認する
レビュー依頼作成時、自分自身が承認者の場合に自動で承認するかどうかを設定します。
この設定は「自身のレビュー依頼を承認可能にする」が有効な場合にのみ設定できます。
承認者もアクションを実行可能にする
レビュー依頼の承認後に、承認者もアクションを実行可能にするかどうかを設定します。
「承認者もアクションを実行可能にする」が無効な場合、アクションを実行できるのはレビュー依頼を作成したユーザーのみです。
「承認者もアクションを実行可能にする」が有効な場合でも、承認者がアクションの実行権限を持っていない場合はアクションを実行できません。
承認後の自動実行
レビュー依頼が承認されたとき、アクションを自動で実行するかどうかを設定します。
| 選択肢 | 挙動 |
|---|---|
| 必ず手動で実行 | 承認されてもアクションは自動で実行されません。承認後の実行の記載に従って手動で実行します |
| レビュー依頼ごとに選択（デフォルトでOFF） | レビュー依頼の作成者が、レビュー依頼フォームの「承認後に自動実行する」で自動実行するかどうかを依頼ごとに選択できます。初期値は無効です |
| レビュー依頼ごとに選択（デフォルトでON） | レビュー依頼の作成者が、レビュー依頼フォームの「承認後に自動実行する」で自動実行するかどうかを依頼ごとに選択できます。初期値は有効です |
| 必ず承認と同時に実行する | すべてのレビュー依頼で、承認の完了と同時にアクションが自動で実行されます。レビュー依頼の作成者は自動実行するかどうかを変更できません |
「レビュー依頼ごとに選択」を設定した場合は、レビュー依頼フォームに「承認後に自動実行する」が表示されます。「必ず手動で実行」を設定した場合、レビュー依頼フォームに「承認後に自動実行する」は表示されません。
「承認後の自動実行」の設定は、レビュー依頼の作成時点の内容がレビュー依頼ごとに適用されます。設定を変更しても、作成済みのレビュー依頼には反映されません。
自動実行は、レビュー依頼の作成者の権限で行なわれます。作成者のユーザーが無効化されているなど、作成者がアクションを実行できない状態になっている場合、アクションは自動で実行されません。この場合、レビュー依頼は承認された状態のまま維持され、承認後の実行の記載に従って手動で実行できます。
自動実行されたアクションはジョブとして非同期に実行されます。実行結果はジョブの一覧、またはジョブの詳細画面から確認できます。
組み込み関数createReviewRequest（ビュー・JavaScriptアクション）や公開APIで作成するレビュー依頼でも、自動実行するかどうかを依頼ごとに指定できます。指定にはoptions.autoExecuteOnApproval（公開APIではauto_execute_on_approval）を使用します。指定しない場合は「承認後の自動実行」の設定に従います。
レビュー依頼のデフォルト設定
レビュー依頼を作成する際に、入力フォームに自動で入力されるデフォルト値を設定できます。
レビュー依頼の説明
レビュー依頼作成時に「説明」欄に自動入力される文章を設定します。
レビュー期限を設定しない
有効にすると、レビュー依頼作成時に「有効期限を設定しない」がデフォルトで有効になります。
レビュー依頼作成時にこの設定を変更して、有効期限を設定できます。
アクションのレビュー設定
アクションの編集画面の「レビュー設定」のタブで、アクションにレビュー設定を紐づけられます。
レビューが有効化されている環境で、アクションの実行権限を持ったユーザーがアクション実行画面に移動すると、アクションの実行フォームの代わりにレビュー依頼フォームが表示されます。
レビューが有効化されている環境では、レビューが承認されてからでなければアクションを実行できません。
なお、実行権限を持たないユーザーはレビューを依頼できません。
実行権限の設定とレビューの設定の対応関係は、以下のとおりです。
| 誰でも実行できる | 実行権限を設定する | |
|---|---|---|
| レビュー無効 | すべての人が即実行できる | 実行権限のある人は即実行できる。実行権限のない人は何もできない |
| レビュー有効 | 誰でもレビュー依頼が行なえる | 実行権限のある人はレビュー依頼ができる。実行権限のない人は何もできない |
確認と実行
自分に依頼されたレビュー、または自分が他の人に依頼したレビューの履歴は専用の画面で確認できます。
画面上部のメニューからレビュー依頼のアイコンをクリックして、レビューの一覧画面に移動してください。
レビュー依頼ごとの詳細画面に行くとレビューを出した人や確認状況を見ることができます。
詳細画面では依頼時点で入力されたパラメーターの値の情報などを確認したうえで、承認・却下、そして承認後の実行などを行なえます。
承認・却下
レビュー依頼をされたユーザーは、画面右上のボタンから承認または却下をコメント付きで行なえます。
また承認済みのレビュー依頼の却下も可能です。
レビューを依頼したユーザーは、それらのコメントを後から確認することで、なぜレビューが承認・却下されたのかを知ることができます。
承認後の実行
レビュー依頼が承認されると「承認者もアクションを実行可能にする」が有効な場合はレビュー依頼の作成者と承認者が、無効な場合はレビュー依頼の作成者のみが、アクションを実行できます。
「承認後に自動実行する」が有効なレビュー依頼では、承認が完了すると自動でアクションが実行されます。詳しくは承認後の自動実行をご覧ください。
取り下げ
レビューを依頼したユーザーは、画面右上の「取り下げる」ボタンから、レビュー依頼の取り下げができます。
取り下げたレビュー依頼は、承認・却下のいずれも行なえなくなります。
有効期限
レビューを依頼する際に、有効期限を設定できます。有効期限をすぎると保存されていたパラメーターの値の情報は破棄され、承認・却下のいずれも行なえなくなります。