Orchestrator でキューを管理する

キューを作成する

1. [キュー] ページで、[キューを追加] をクリックします。新しいキューを作成したり、他のフォルダーのキューをリンクしたりするための、2 つのオプションが表示されます。
2. [新しいキューを作成] をクリックします。[キューを作成] ウィンドウが表示されます。
3. [名前] フィールドに、キューの名前を入力します。
4. [説明] フィールドにキューの説明を追加します。
5. トランザクションの参照を一意にする場合は、[参照の重複を禁止] チェックボックスを選択します。
6. キュー アイテムのデータおよび出力をデータベースで暗号化する場合は、[暗号化された形式で保存] チェックボックスをオンにします。
   注:

   • 暗号化操作は取り消せません。
   • データは、アプリケーション レベルの暗号化を使用して暗号化されます。詳しくは、「アプリケーション レベルの暗号化 (ALE)」をご覧ください。
   • キュー アイテムの固有データおよび出力の値のみが暗号化されます。これらの値はデータベース内でのみ暗号化され、機密コンテンツがデータベース管理者から保護されます。Orchestrator の UI では復号されたコンテンツが引き続き表示されます。エンドツーエンドで暗号化を使用するには、キュー アイテムをキューに追加する前に暗号化する必要があります。
   • 既存のキューは暗号化できません。代わりに、キューを再作成して [暗号化された形式で保存] チェックボックスを選択できます。
   • 暗号化形式が原因で、データベース フィールド [固有データ] および [出力] の分析をレポートできなくなったほか、Insights の対応するダッシュボードを利用できなくなりました。
7. [自動リトライ] セクションには、次の 2 つのオプションがあります。
   • 失敗したアイテム - アクティブな場合、キューの作成後に失敗したキュー アイテムをリトライします。
   • 破棄されたアイテム - アクティブな場合、[リトライの最大数] フィールドが表示され、破棄されたキュー アイテムのリトライの最大数を設定できます。アクティブでない場合、トランザクションは非アクティブ状態が 24 時間続くと破棄されます。
     注:

     リトライされたキュー アイテムは、ユーザー インターフェイスで適宜マークされます。

8. 固有データ、出力データ、分析データのいずれかまたはそれぞれの JSON スキーマを、該当の [参照] ボタンを使用してアップロードします。
9. アイテムの処理時間の制御を向上させ、期限を満たすよう必要なリソースを評価する場合、SLA 予測を有効化します。SLA 予測が有効化されている場合は、次のフィールドを構成します。
   • [プロセス] ドロップダウンから、キュー アイテムを処理するプロセスを選択し、以下の SLA 値を入力します。最大値は 90 日です。
   • 実際の SLA より前のバッファー ゾーンを定義する場合は リスク SLA を有効化し、以下の値を入力します。リスク SLA は、SLA よりも小さくなければなりません。
10. [追加] をクリックします。中身が空の状態でキューが作成され、[キュー] ページに表示されます。

Studio を使用するか、[ アイテムをアップロード ] ウィンドウでキューに入力できます。キューのアイテムの処理は、Studio を使用してのみ実行できます。詳細については、「 Studio でキューを管理する」 をご覧ください。

キューを編集する

次のような既存のキュー設定を更新できます。

• キューの名前と説明
• [自動リトライ] セクション
• リトライの最大回数

キューの名前または説明を編集する

Orchestrator で既存のキュー名を編集するには、以下の手順を実行します。

1. [キュー] ページで、目的のキューに対応する [その他のオプション] ボタンを選択します。
2. [編集] を選択します[ キューを更新] ウィザードが表示されます。
3. [名前] フィールドに、選択したキューの新しい名前を入力します。
   注:

   • 必ず一意の名前を入力してください。同じ名前のキューがテナントに既に存在する場合は、The name <QueueName> is already used. (#1001) というエラー メッセージが表示されます。
   • この名前では大文字と小文字 が区別されません 。したがって、 NEW_QueueName と new_queuename は重複しています。
4. [説明] フィールドで、キューの説明を更新します。
5. [更新] を選択します。
   重要:

   Studio で、対応するワークフロー内のキュー名を必ず更新してください。Studio でキュー名を自動更新する方法はないので、手動で更新する必要があります。

自動リトライ オプションを変更する

既存のキューの [自動リトライ] セクションのオプションを変更するには、以下の手順を実行します。

1. [キュー] ページで、目的のキューに対応する [その他のオプション] ボタンを選択します。
2. [編集] を選択します次に、[ キューを更新] ウィザードが表示されます。
3. [自動リトライ] セクションで、必要なオプションを選択します。
4. [更新] を選択します。

最大リトライ回数を設定する

[破棄されたアイテム] チェックボックスが選択されています。

[破棄されたアイテム] オプションを選択した場合は、[最大リトライ回数] フィールドが表示されます。

失敗したトランザクションのリトライ回数として、1 ～ 50 の範囲の値を入力します。

重要

1. 既存の失敗したトランザクションはリトライされません。新しい値を設定した後に失敗したトランザクションだけが、リトライされます。
2. 手動リトライは、キュー アイテムに設定した最大リトライ回数に対してカウントされません。このような場合、API では RetryNumber が 0 に、AncestorId が null になります。

さらに、各キュー アイテムは、Key フィールドを介して、リトライ チェーンの元のキュー アイテムをポイントします。

以下のフィールドが含まれます。

• ManualRetryNumber - 手動によるキュー アイテムのリトライ回数です。
• ManualAncestorId - 手動でリトライされたキュー アイテムの ID です。
• ManualAncestorUniqueKey - 手動でリトライされたキュー アイテムの、グローバルな一意の GUID です。
• UniqueKey - 任意のキュー アイテムの GUID (グローバル一意識別子) です (各リトライが手動であったか自動であったかにより異なります)。
• AncestorUniqueKey - 自動でリトライされたキュー アイテムの、グローバルな一意の GUID です。
• RetryNumber - 自動によるキュー アイテムのリトライ回数です。
• AncestorId - 自動でリトライされたキュー アイテムの ID です。
• Key - リトライ チェーンの初期キュー アイテムの GUID

目的は、キュー アイテムのリトライを完全に追跡することです。

3. リトライされたキュー アイテムと削除されたキュー アイテムは、一意の参照チェックの対象になりません。したがって、最初のキュー アイテムをリトライ チェーンから削除しないことをお勧めします。削除すると、一意の参照を検証できなくなるためです。ただし、最初のキュー アイテムがデータ保持の対象として選択されている場合は、この検証は今までどおり実行されます。

たとえば、一度リトライされた失敗したトランザクションのリストがあるとします。Max # of retries の現在の値は 2です。値を 3 に更新すると、失敗したトランザクションは 1 回ではなくさらに 2 回リトライされます。

[破棄されたアイテム] チェックボックスを選択しない場合

[破棄されたアイテム] オプションを選択しなかった場合、[最大リトライ回数] フィールドは表示されません。

トランザクションはリトライされません。

キューのリンクを管理する

フォルダー間でキューを共有すると、基になるプロセスが同じキューをターゲットにしている場合、Studio でワークフローを再設計しなくても、複数のフォルダーでジョブを開始できます。キューをフォルダーにリンクすると、そのキューとキューに関連するすべてのオブジェクト (キュー アイテムなど) をそのフォルダーで使用できるようになります。

注:

複数のフォルダーにリンクされているキューは、 アイコンでマークされます。アイコンが表示されていない場合、現在のフォルダーは、キューが存在する唯一のフォルダーです。ここでキューを削除すると、キューは Orchestrator から完全に削除されます。 キューを追加するフォルダー (ターゲット フォルダー) のキュー - 作成権限と、現在キューが存在するフォルダー (元のフォルダー) のキュー - 表示が必要です。ターゲット フォルダーのキュー - 編集がある場合は、元のフォルダーのキュー - 編集も必要です。

現在のフォルダーに複数のキューをリンクする

1. キューをリンクするフォルダーの [キュー] ページで、[追加] をクリックします。キューを追加したり、他のフォルダーのキューをリンクしたり、オプションを非表示にするための、3 つのボタンが表示されます。
2. [他のフォルダーからリンク] をクリックします。[他のフォルダーのキューをリンク] ウィンドウに、キューの表示権限を持つフォルダー内のすべてのキューのリストが表示されます。
3. [キューを選択] セクションで、リストから 1 つまたは複数のキューを選択します。

図 1. キューを選択

4. [ 続行] を選択します。[フォルダーの検証] セクションに移動します。ここで、キューがすでにリンクされているフォルダーを確認できます。複数のフォルダーがある場合は、それらのフォルダーの名前が表示されます。

図 2. フォルダーの検証

5. 変更を元に戻すには、該当するキューの [削除] を選択し、操作を取り消すには [終了] を選択します。
6. 選択したキューと現在のフォルダーの間にリンクを作成するには、[リンク] を選択します。キューが [キュー] ページに表示されます。

図 3. [キュー] ページ

複数のフォルダーにキューをリンクする

1. リンクするキューが存在するフォルダーに移動します。
2. 目的のキューで [その他のアクション] > [リンクを管理] を選択して、[リンクを管理] ウィンドウを開きます。キューのリンクの管理ウィンドウが表示されます。

図 4. キューのリンクの管理ページ

3. [ 更新] を選択します。確認のウィンドウが表示されます。
4. 変更を中止する場合は [キャンセル] を選択し、変更を反映させる場合は [続行] を選択します。変更内容に応じて、Orchestrator に操作が反映されます。

フォルダーへのキューのリンクを解除する

フォルダーへのキューのリンクの解除は、リンク操作とほぼ同じ方法で実行できます。上記の手順のリンク管理領域に移動し、特定のキューと特定のフォルダー間の接続を削除します。

削除機能を使用してキューを削除することもできます。

重要:

複数のフォルダーに存在するキューを削除すると、キューは削除操作を実行したフォルダーからのみ削除され、他のフォルダーからは削除されません。キューを完全に削除するには、既存のリンクをすべて削除する必要があります。 以下の状況では、フォルダーへのキューのリンクを解除できません。

• そのフォルダーでキュー SLA が有効化されている。
• キューにキュー トリガーがアタッチされている。

トランザクションを表示する

[キュー] ページで、[その他のアクション] > [トランザクションを表示] をクリックします。[トランザクション] ページが表示されます。ここには、対象のキュー アイテムのみが含まれています。

レビュー リクエストを表示する

[キュー] ページで、[レビュー リクエスト] をクリックして、現在ログイン中のユーザーに、リビジョンに割り当てられているすべてのキューを表示します。このページではステータス変更とアイテム情報の管理ができます。

キューのグラフを表示する

特定のキューのチャートを確認するには、[その他のアクション] ボタンをクリックし、[チャートを表示] をクリックします。

線チャートには、特定の期間におけるトランザクション ステータスの推移が表示されます。時間フィルター (直前の 1 時間、1 週間、30 日) を変更することができ、平均実行時間や最大再試行数を表示できます。

図 5. キューのグラフ

CSV ファイルを使用してアイテムをキューにアップロードする

CSV ファイルを使用してキュー アイテムをアップロードする方法の詳細は、こちらをご覧ください。

キューを監視する

キューを監視するには、該当する [その他のアクション] ボタンをクリックし、次に [キューを監視] をクリックします。または、[キューの概要] ウィジェット ([監視] > [キュー]) で、ロボットを選択します。

ユーザーがキューを監視するには、キューおよび監視に関して表示権限を持つ必要があります。さらに、[監視] > [キュー] ページの [エラー フィード] ウィジェットでエラーを無効化するには、監視に関する編集権限が必要です。

キューにタグを追加する

注:

キューに既存のタグを追加するには、キューに対する [編集] 権限とアセットに対する [表示] 権限が必要です。 キューに新しいタグを追加するには、キューに対する [編集] 権限とアセットに対する [作成] 権限が必要です。

注:

• 各キューには、最大 100 万個のキー/値のペアを設定できます。
• ラベルおよびキー/値のプロパティに使用できる文字数は、最大 256 文字です。
• タグ名に使用できない文字は、<、>、%、&、\)\)、?、/、: です。

キューへのタグの適用は、キューの作成時または既存のキューの編集時に行うことができます。キューの編集時にキューにタグを追加するには、以下の手順に従います。

1. [キュー] ページで、対象のキューの横にある [その他のアクション] > [編集] をクリックします。キューが編集のために開かれます。
2. [ラベル] フィールドで、ラベル名の入力を開始します。既存のラベルを選択するか、新しいラベルを作成することができます。
3. [プロパティ (キーと値のペア)] フィールドで、[新規追加] をクリックします。
4. 新しいキーと値を追加します。既存のキーまたは値を選択するか、新しいキーまたは値を作成することができます。
5. 完了したら、[更新] をクリックします。キューが更新され、新たに作成したタグを (ある場合) 他のオブジェクトで使用できるようになります。

キューからタグを削除する

キューからタグを削除するには、以下の手順に従います。

1. [キュー] ページで、対象のキューの横にある [その他のアクション] > [編集] をクリックします。キューが編集のために開かれます。
2. [ラベル] フィールドで、削除するラベル名の横の X をクリックします。ラベルが削除されます。
3. [プロパティ (キーと値のペア)] フィールドで、削除するキーまたは値の横の X をクリックします。キーまたは値が削除されます。
4. キー/値のペアを削除するには、そのエントリに対応する削除アイコンをクリックします。キー/値のペアが削除されます。
5. 完了したら、[更新] をクリックします。キューが更新され、タグが削除されます。

キューを削除する

キューを削除するには、該当する [その他のアクション] ボタンをクリックし、次に [削除] をクリックします。

または、[キュー] ページからキューを選択して [削除] をクリックします。キューが [キュー] ページに表示されなくなります。

重要:

複数のフォルダーに存在するキューを削除すると、キューは削除操作を実行したフォルダーからのみ削除され、他のフォルダーからは削除されません。キューを完全に削除するには、既存のリンクをすべて削除する必要があります。

注:

キューが削除されると、そのキューに属する割り当てられたトランザクション アイテムは [レビュー リクエスト] ページに表示されなくなります。

失敗したキュー トランザクションを記録する

記録オプションが有効化されたプロセスに関連付けられた、失敗したキュー トランザクションを記録できます。これは、障害につながる問題の特定とトラブルシューティング、および監視と監査に役立ちます。

このオプションは、[ その他の設定] タブの [ ジョブの記録] セクションから、プロセス レベルで有効化されます。

図 6. ジョブの記録の追加設定

キューを含むプロセスが失敗すると、その実行が記録され、Orchestrator の以下の場所で使用できるようになります。

• キュー レベルの場合、影響を受けるキューのコンテキスト メニューで [記録を開く] をクリックします。 以下の場合、このオプションはアクティブではありません。
  • キューが、実行が失敗していないプロセスに関連付けられている。
  • そのキューが関連付けられているプロセスに対し、[失敗したキューのトランザクションを記録して保存] オプションが有効化されていない。
• トランザクション レベルで、影響を受けるトランザクションの [詳細を表示] ウィンドウで [記録を開く] をクリックする。

記録時間

最大記録時間は 3 分で、実行の最後の瞬間に適用されます。

最小記録長は 10 秒です。トランザクションの処理にかかる時間が 10 秒未満の場合、他のトランザクションも記録に含まれる場合があります。