OnCallContactPrefTemplate - グローバル

OnCallContactPrefTemplate スクリプトインクルードは、連絡先設定テンプレートをエスカレーションセットに適用するメソッドを提供します。

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

このスクリプトインクルードには、オンコールスケジューリングプラグイン (com.snc.on_call_rotation) が必要です。

OnCallContactPrefTemplate - OnCallContactPrefTemplate()

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

表 : 1. パラメーター

名前	タイプ	説明
なし

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

var contactPrefTemp = new global.OnCallContactPrefTemplate();

OnCallContactPrefTemplate - copyContactPreferences(文字列 templateSysId, 文字列 escalationSetSysId)

連絡先設定テンプレートをエスカレーションセットに適用します。

テンプレートがエスカレーションセットに適用されると、連絡試行レコードがシフト連絡先設定 [cmn_rota_contact_preference] テーブルに作成されます。

このメソッドを呼び出す前に、 deleteContactPreferenceAttempts() メソッドを呼び出して、既存の連絡試行レコードを削除します。既存のレコードが最初に削除されていない場合、このメソッドはエラーを返します。

表 : 2. パラメーター

名前	タイプ	説明
templateSysId	文字列	オンコール連絡先設定テンプレート [on_call_template_contact_preference] テーブルの連絡先設定テンプレートのSys_id。
エスカレーションセット SysId	文字列	シフトエスカレーションセット [cmn_rota_escalation_set] テーブルのエスカレーションセットのSys_id。

表 : 3. 戻り値

タイプ	説明
オブジェクト	エラーメッセージと警告メッセージを含むオブジェクト。操作が成功した場合、このオブジェクトは空です。 注: エラーが発生した場合、操作は停止し、テンプレートは適用されません。警告が発生した場合、操作は続行され、一部のレコードは引き続き作成されます。 { "error": "String", "warning": "String" }
<Object>。エラー	エラーメッセージ 可能な値： 連絡設定テンプレートsys_idが正しくありません エスカレーションセットsys_idが正しくありません 連絡の試行設定は既に存在します データタイプ：文字列
<Object>。警告	警告メッセージ。 データタイプ：文字列

この例では、連絡設定テンプレートを [サービスデスク - デフォルト] エスカレーションセットに適用します。エラーや警告がないため、戻り値のオブジェクトは空です。

var escSetSysId = "a47ac1abeb5a6110249e8d835d5228aa";
var templateSysId = "f8dac9ebeb5a6110249e8d835d522873";

var contactPrefTemp = new global.OnCallContactPrefTemplate();

// delete existing contact attempt records before applying the template
contactPrefTemp.deleteContactPreferenceAttempts(escSetSysId); 

var result = contactPrefTemp.copyContactPreferences(templateSysId, escSetSysId);
gs.info(JSON.stringify(result));

出力:

{}

OnCallContactPrefTemplate - deleteContactPreferenceAttempts(文字列 escalationSetSysId)

エスカレーションセットに関連付けられているすべての連絡先設定を削除します。

エスカレーションセットのすべての連絡試行レコードがシフト連絡先設定 [cmn_rota_contact_preference] テーブルから削除されます。

表 : 4. パラメーター

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

表 : 5. 返される内容

タイプ	説明
なし

この例では、「サービスデスク - デフォルト」エスカレーションセットに関連付けられているすべての連絡先設定を削除します。

var escSetSysId = "a47ac1abeb5a6110249e8d835d5228aa";
var contactPrefTemp = new global.OnCallContactPrefTemplate();

contactPrefTemp.deleteContactPreferenceAttempts(escSetSysId);