OnCallEscalationTemplateSNC - グローバル

エスカレーションポリシーテンプレートをエスカレーションセットに適用するメソッドを提供します。

エスカレーションプロセスの詳細については、「」を参照してください Defining On-Call Scheduling escalation process。

この API には On-Call Scheduling プラグイン (com.snc.on_call_rotation) が必要です。

OnCallEscalationTemplateSNC:OnCallEscalationTemplateSNC()

OnCallEscalationTemplateSNC オブジェクトをインスタンス化します。

表 : 1. パラメーター

名前	タイプ	説明
なし

この例では、 OnCallEscalationTemplateSNC オブジェクトをインスタンス化します。

var escTemp = new global.OnCallEscalationTemplateSNC();

OnCallEscalationTemplateSNC - copyEscalationTemplatetoEscalationSet(文字列 templateSysId, 文字列 escalationSetSysId)

エスカレーションポリシーテンプレートをエスカレーションセットに適用します。

テンプレートをエスカレーションセットに適用すると、シフトエスカレーションステップ定義 [cmn_rota_esc_step_def] テーブルにエスカレーションステップ定義レコードが作成されます。

このメソッドを呼び出す前に、 deleteEscalationSetSteps() メソッドを呼び出して既存のエスカレーションステップ定義を削除します。既存のレコードを先に削除しない場合、このメソッドはエラーを返します。

表 : 2. パラメーター

名前	タイプ	説明
templateSysId	文字列	オンコールエスカレーションポリシーテンプレート [on_call_template_escalation_policy] テーブルのエスカレーションポリシーテンプレートのSys_id。
escalationSetSysID	文字列	シフトエスカレーションセット [cmn_rota_escalation_set] テーブル内のエスカレーションセットのSys_id。

表 : 3. 返される内容

タイプ	説明
オブジェクト	エラーメッセージと警告メッセージを含むオブジェクト。操作が成功した場合、このオブジェクトは空です。 注: エラーが発生した場合、操作は停止し、テンプレートは適用されません。警告が発生した場合、操作は続行され、一部のレコードは引き続き作成されます。 { "error": "String", "warning": {Object} }
<Object>。エラー	エラーメッセージ 考えられるエラー: エスカレーションポリシーテンプレートsys_idが正しくありません。 エスカレーションセットsys_idが正しくありません。 エスカレーションステップの定義は、エスカレーションセットに既に存在します。 データタイプ：文字列
<Object>。警告	警告に関する情報。 データタイプ: オブジェクト { "message": "String", "skipped_steps": [Array], "not_matching_steps": {Object}, }
<Object>.warning.message	警告メッセージ。 考えられる警告: 勤務表の位置がシフトの勤務表と一致しません エスカレーションステップテンプレートで対象者が定義されていません データタイプ：文字列
<Object>.warning.skipped_steps	スキップされたエスカレーションステップのインデックス (1 ベース)。 データタイプ：アレイ
<Object>.warning.not_matching_steps	利用可能な勤務表がないエスカレーションステップに関する情報を含むオブジェクト ({&quot;step number&quot;:[roster number]} 形式)。 たとえば、戻り値が {&quot;3 &quot;:[3]} の場合、エスカレーションステップ 3 では第 3 の勤務表は利用できません。 データタイプ: オブジェクト

この例では、[勤務表ローテーション] エスカレーションポリシーテンプレートを Service Desk - デフォルトのエスカレーションセットに適用します。エラーや警告がないため、返されるオブジェクトは空です。

var escSetSysId = "32820dc3eb422110249e8d835d5228c3";
var templateSysId = "a89e2982eb592110249e8d835d522825";
var escTemp = new global.OnCallEscalationTemplateSNC();

// delete existing escalation step definitions before applying the template
escTemp.deleteEscalationSetSteps(escSetSysId);

var result = escTemp.copyEscalationTemplatetoEscalationSet(templateSysId, escSetSysId);
gs.info(JSON.stringify(result));

出力:

{}

この例では、勤務表ローテーションエスカレーションポリシーテンプレートを作業時間 - デフォルトのエスカレーションセットに適用します。この場合、アプリケーション開発シフトには 2 つの勤務表しかありませんが、テンプレートは 3 番目の勤務表を割り当てようとします。勤務表の数が一致しないため、警告がスローされます。シフトエスカレーションステップ定義 [cmn_rota_esc_step_def] テーブルにはまだ 2 つのレコードが作成されます。

var escSetSysId = "e4f8f73deb562110249e8d835d522852";
var templateSysId = "a89e2982eb592110249e8d835d522825";
var escTemp = new global.OnCallEscalationTemplateSNC();

// delete existing escalation step definitions before applying the template
escTemp.deleteEscalationSetSteps(escSetSysId);

var result = escTemp.copyEscalationTemplatetoEscalationSet(templateSysId, escSetSysId);
gs.info(JSON.stringify(result));

出力:

{
   "warning": {
      "message": "Skipped copying templates for some of the steps since no audiences are defined",
      "not_matching_steps": {
         "3": [
            3
         ]
      },
      "skipped_steps": [
         "3"
      ]
   }
}

OnCallEscalationTemplateSNC - deleteEscalationSetSteps(文字列 escalationSetSysId)

エスカレーションセットに関連付けられたすべてのエスカレーションステップ定義レコードを削除します。

表 : 4. パラメーター

名前	タイプ	説明
escalationSetSysID	文字列	シフトエスカレーションセット [cmn_rota_escalation_set] テーブル内のエスカレーションセットのSys_id。

表 : 5. 返される内容

タイプ	説明
なし

この例は、Service Desk - デフォルトのエスカレーションセットに関連付けられているすべてのエスカレーションステップ定義を削除します。

var escSetSysId = "32820dc3eb422110249e8d835d5228c3";

var escTemp = new global.OnCallEscalationTemplateSNC();

escTemp.deleteEscalationSetSteps(escSetSysId);