本説明頁面上的資訊同時適用於 CXone Studio 和 Desktop Studio。
有些指令碼需要比 Studio 動作本身更複雜的動作。Studio 允許您在您的指令碼中新增自訂代碼。這使您可以自訂指令碼，以滿足貴組織需求。
自訂編碼需要一些指令碼或程式設計知識。Studio 使用一種名為 Snippet 的自訂程式設計語言。NICE CXone 開發了這種語言，將其用於 Studio。線上說明中提供了完整的技術參考指南，以讓您能學會使用這種語言。
有關 Snippet 的重要資訊
- Snippet 可以幫助提高指令碼的組織和效率。這些代碼片段增加了您對執行的進程，以及代碼片段何時和如何執行的控制。您可以建立自己的變數和物件，並使用
- 有些產品和功能需要 snippet，但即使不需要，您也可以在您的的指令碼中使用這些 snippet。
- 當一個產品或功能需要 snippet 時，線上說明提供了有關您需要包含的 snippet 的詳細資訊。提供了一些指令碼範例，以說明如何在指令碼中使用 snippet。可能需要額外的指令碼來實現產品或功能。
- Snippet 指令碼語言建立在 .NET 框架之上。該語言在伺服器端執行並編譯為 MSIL（Microsoft 中間語言），就像 C# 和 Visual Basic .NET 一樣。
Snippet 動作
要在您的指令碼中新增自訂代碼，需要
Snippet 動作的位置至關重要。如果 Snippet 為變數賦值，必須放在需要該值的動作之前。另一方面，如果 Snippet 包含基於獲得傳遞的值而執行動作的決策代碼，則 Snippet 必須放在提供該值的動作之後。
與行動相比的 Snippet
您在 Snippet 中可以做的一些事情也可以用 Studio 動作來完成。例如，
透過將代碼放在 Snippet 中，您的指令碼會更乾淨，更有條理，也更容易瀏覽。這使您更容易、更有效率地完成指令碼編寫員的工作。如果您養成習慣，總是在 Snippet 中聲明變數，那麼在將來，如果您需要找到某個特定的聲明，您僅需尋找更少的地方。
在指令碼中新增自訂代碼
Snippet 動作允許您向指令碼新增自訂代碼。此動作位於「工具」標籤上預設選擇區的「進階」部分。
- 在 Studio 中，打開指令碼。
- 在指令碼中需要代碼的地方放置 Snippet 動作，並將其與其他動作連接起來。
- 點擊兩下動作，打開編輯器視窗。這是您可以新增代碼的地方。
-
點擊您想用來新增代碼的標籤。每個標籤都提供了不同的新增代碼的方法。這些標籤是：
-
如果需要，請對代碼進行偵錯。
- 隨時點擊 Apply 來儲存您的變更，而不關閉編輯器視窗。
- 完成代碼編輯後，點擊 OK。
帶有文字視圖的代碼
Snippet 視窗中的「文字視圖」標籤允許您手寫 Snippet 代碼。線上說明中提供了完整的參考指南，以讓您能學會使用這種語言。
- 在 Studio 中，打開指令碼。
- 將 Snippet 動作新增到指令碼中，並點擊兩下來打開 Snippet 視窗。
- 在「樹狀視圖」標籤的左側，輸入您的代碼。您可以輸入代碼，或者從其他來源複製和貼上，例如此說明網站或其他指令碼。
- 隨時點擊 Tree View 標籤，從預先定義的關鍵字新增代碼。您可以使用向上和向下的箭頭按鈕，將與某個關鍵字相關的代碼移動到指令碼中的不同位置。
- 點擊 Check Syntax 圖示
來驗證您當前代碼的語法是否正確。如果沒有錯誤，「文字視圖」底部工具欄中的狀態列會顯示 Okay 狀態。如果有錯誤，會顯示關於錯誤的彈出訊息，工具欄上的狀態列會顯示訊息。例如，訊息可能是 Error at line 4。 - 點擊 Comment 圖示
將游標當前所在的行轉換成備註。 - 點擊 Uncomment 圖示
刪除當前游標所在行的備註字元。 - 隨時點擊 Apply 來儲存您的變更，而不關閉編輯器視窗。
- 完成代碼編輯後，點擊 OK。
帶有樹狀視圖的代碼
「Snippet 屬性」視窗中的「樹狀視圖」標籤會引導您完成建立自訂代碼的過程。有一組預先定義的關鍵字供您選擇。
- 在 Studio 中，打開指令碼。
- 將 Snippet 動作新增到指令碼中，並點擊兩下來打開 Snippet 視窗。
- 點擊「樹狀視圖」標籤底部的加號圖示
。 - 選擇您想新增到代碼中的關鍵字。
- 點擊視窗左側清單中顯示的關鍵字可查看其屬性。
-
在視窗右側的清單中配置關鍵字的屬性。您可以：
- 選擇每個屬性，在右側窗格下面的空間查看該屬性的定義。
- 請參閱本頁的 Snippet 關鍵字部分來了解配置每個命令的詳細資料。
- 根據需要，新增更多的關鍵字。
- 隨時點擊 Text View 標籤，以查看以傳統編碼格式寫出的代碼。
- 隨時點擊 Apply 來儲存您的變更，而不關閉編輯器視窗。
- 完成代碼編輯後，點擊 OK。
Snippet 程式碼偵錯
Snippet 動作有自己的偵錯程式，您可以用其來檢查代碼。您只能從「文字視圖」標籤中對代碼進行偵錯。
如果您在「樹形視圖」標籤上建立了代碼，當您切換到「文字視圖」標籤時，即可使用偵錯程式。如果偵錯程式發現任何問題，使用指定的行號來確定代碼的哪一部分包含此問題。然後，您可以返回到「樹狀視圖」標籤來糾正此問題。
可使用更多的偵錯選項，包括逐步執行代碼逐行偵錯和使用中斷點。您還可以使用 Snippet 程式碼中的
- 在 Studio 中，開啟一個包含 Snippet 動作的指令碼。
- 點擊兩下 Snippet 動作。
- Add Snippet code on the
- On the right side of the
- Click the down-arrow button on the right side of the Debug icon
and select Start
. -
If there are any syntax errors in the code, the
- Correct the errors.
- When the errors have been corrected, click the Close or Clear Trace Output icons
to close the error pane. - Start the debugger again.
- View the contents of the
- You can select one or more lines in the snippet code and click the Comment out selected lines icon
. This is helpful if you want to remove some code to see how the outcome of the debugging changes. - You can select one or more lines of commented-out code and click the Uncomment the selected lines icon
to add those lines back into the snippet.
樹狀視圖中的 Snippet 關鍵字
關鍵字，或命令，是 Snippet 語言中語句語法的一部分。它們是預定義的術語，是為指令碼中的特定用途而保留。編譯器可識別關鍵字並執行與之相關聯的行為。例如，當編譯器發現 ASSIGN 關鍵字時，它會建立一個新的變數，其名稱和值在關鍵字後面指定。例如：ASSIGN varName = 1。
因為關鍵字是保留詞，所以這些詞不能在您的指令碼中作為物件或變數的識別碼使用。
許多關鍵字也有與 Studio 動作
在 Studio 指令碼內執行一個流程，如收集客戶資料、播放訊息或音樂，或將聯絡人路由至客服專員。同名的情況。例如，有一個 IF 關鍵字和一個 IF 動作。兩者在指令碼中執行相同的行為。您可以使用 Snippet 動作與自訂代碼來減少指令碼中的動作數量。
下面部分介紹了「樹狀視圖」標籤中可用的關鍵詞選項。這些選項包含您可以在 Snippet中使用的大部分關鍵字。有關所有支援的關鍵字的完整清單，請參閱參考部分。
指派
描述：ASSIGN語句建立一個變數，變數名和變數值由您指定。
Studio動作：Assign
命名指南： 變數命名時應遵循以下指南：
-
使用字母數字字元 (
- 名稱的首個字元必須是字母。
- 在名稱的任何地方使用底線字元 (
- 如果變數名稱的最後一個字元是美元符號， 值將被視為文字。
- 請勿使用預定義變數或保留字的名稱。
了解更多資訊：變數説明頁面提供了有關變數的更多資訊。
樹狀視圖屬性
在樹狀視圖標籤上，ASSIGN 顯示為 newvar=""。需要配置的屬性如下：
- Comment：新增關於變數的備註。
- Line Number：編輯器中命令所在的行號。
- Type：值允許的資料類型 一種資訊屬性，用於定義在程式中的使用方式，例如整數（可以操縱的數值）或布爾值 (true/false)。。
- Value：輸入要指派給變數的值。您可以用大括號{ }將變數括起來。例如，{agentId}。
- Variable：輸入變數的新名稱。如果不變更，變數名稱仍為預設的 newvar。
範例
要在樹狀視圖中檢視此範例，請將其複製並貼上到「文字視圖」標籤，然後點擊「樹狀視圖」標籤。
ASSIGN varName = value1
varName2 = value2
//Including the ASSIGN keyword is optional.
//It's best practice to use this keyword every time you create a variable.
//When you use advanced search, you can quickly locate where a variable
//is created if it includes this keyword. 小休
描述：立即結束迴圈。
語法：BREAK
詳細資訊：當到達 BREAK 語句時，當前迴圈立即結束。指令碼繼續執行迴圈下方的 snippet 代碼，直至完成。
BREAK 為可選項。如果不包括，迴圈將繼續，直到滿足定義的停止條件。
Call Function
調用以前定義的功能。
樹狀視圖屬性
在樹狀視圖選項卡上，調用函數顯示為 newcall()。
需要配置的屬性如下：
- Arguments：輸入您需要傳遞到函數中的隱式參數。隱式參數顯示在函數名的括弧之間。例如，functionA (var1, var2)。
- Comment：新增關於變數的備註。
- Line Number：編輯器中命令所在的行號。
- Name：輸入您要調用的功能的名稱。
案例
描述：定義可能執行的語句集之一。與 SWITCH 或 SELECT 一起使用。
Studio 動作：
詳細資料：CASE必須在條件碼塊中使用 SWITCH或 SELECT 語句。新增一條或多條 CASE 語句，以確定指令碼可能執行的塊。至少需要一條 CASE。
相關：包括一項 DEFAULT 聲明，定義在指定的 CASE 聲明均不適用的情況下使用的案例。
備註
隱藏指令碼中的文字，以便編譯器不對其進行處理。
使用注釋來記錄您的指令碼。您可以為指令碼的每個部分提供解釋和說明，以便日後更加詳細。
樹狀視圖屬性
在樹狀視圖標籤上，
需要配置的屬性如下：
- Comment：新增註釋。
- Line Number：編輯器中命令所在的行號。
樹狀視圖中可用的每個關鍵字都有 Comment 屬性。這允許您新增有關該關鍵字特定情況的注釋。使用「樹狀視圖」選項卡上的
Declare Function
描述：建立自訂函數。
詳細資料：聲明函數，方法是在函數末尾使用一個帶有左括弧和右括弧的 <name>。例如，FUNCTION functionName()。在括弧之間新增可選的 [parameters]。參數允許將稱為隱式參數的資料傳入或傳出函數。
命名準則：命名函數時，請遵循這些準則：
-
使用字母數字字元 (
- 名稱的首個字元必須是字母。
- 在名稱的任何地方使用底線字元 (
- 請勿使用保留字或內建函數的名稱。
了解更多：有關函數的更多資訊，請前往 函數説明頁面。
樹狀視圖屬性
在樹狀視圖標籤上，FUNCTION 顯示為 FUNCTION newfunc()。
需要配置的屬性如下：
- Arguments：輸入您希望傳入函數的隱式參數。隱式參數顯示在函數名的括弧之間。例如，newfunc(var1, var2)。
- Comment：新增關於變數的備註。
- Line Number：編輯器中命令所在的行號。
- Name：輸入函數名稱。
要完成 FUNCTION，請右鍵點擊 SWITCH 0，然後為希望指令碼評估的每個條件新增
範例
要在樹狀視圖中檢視此範例，請將其複製並貼上到「文字視圖」標籤，然後點擊「樹狀視圖」標籤。
FUNCTION TimerRound(Timer)
{
IF Timer = "-1"
{
ASSIGN Timer = Timer
}
ELSE
{
ASSIGN PeriodLocation = Timer.indexof('.')
IF PeriodLocation = 0
{
ASSIGN Timer = Timer
}
ELSE
{
ASSIGN DataLength = Timer.length
IF DataLength - PeriodLocation <= 2
{
ASSIGN Timer = Timer
}
ELSE
{
ASSIGN DigitCheck = Timer.substr(PeriodLocation + 3, PeriodLocation + 3)
IF DigitCheck >=5 && DigitCheck <= 9
{
ASSIGN Timer = Timer + .01
}
ELSE
{
ASSIGN Timer = Timer
}
ASSIGN Timer = Timer.substr(1, PeriodLocation + 2)
}
}
}
TRACE "{Timer}"
RETURN Timer
}
IF TEST = 1
{
ASSIGN DC1 = "1.931876668494874"
}
ASSIGN DC1 = TimerRound(DC1)預設
描述：定義在指定的 CASE 均不適用時使用的 CASE 塊。與 SWITCH 和 SELECT 一起使用。
詳細資料：DEFAULT必須與 SWITCH 或 SELECT 塊一起使用，並且必須至少有一個 CASE 語句存在。不能單獨使用 DEFAULT。DEFAULT 始終是可選的。它必須是 CASE 語句清單中的最後一個子句。
用於
說描述：重複一條或一系列語句特定的次數。
樹狀視圖屬性
在樹狀視圖標籤上，
需要配置的屬性如下：
- Comment：新增關於
-
EndValue：輸入結束索引值。預設為 10。
-
Iterator：輸入儲存當前迴圈索引的變數名稱。
- Line Number：編輯器中命令所在的行號。
- StartValue：輸入起始索引值。預設為 1。
要完成
範例
要在樹狀視圖中查看這些範例，請複製並貼上到「文字視圖」標籤，然後按一下「樹狀視圖」標籤。
IF TEST = 1
{
ASSIGN Names = "Wes|Nate|Dan|Clay"
ASSIGN EyeColors = "Blue|Blue|Brown|Brown"
ASSIGN Signs = "Aquarius|Aries|Pisces|Leo"
ASSIGN Foods = "Spagetti|Pizza|Sushi|Deep Fried Twinkies"
}
DYNAMIC Persons
ASSIGN PeopleCount = Names.size
FOR i = 1 TO PeopleCount
{
ASSIGN Persons[i].Name = "{Names[i]}"
ASSIGN Persons[i].Eyecolor = "{EyeColors[i]}"
ASSIGN Persons[i].Sign = "{Signs[i]}"
ASSIGN Persons[i].Food = "{Foods[i]}"
}FOR i=1 TO 9
{
a = "{a}{i}"
}
//Result: a="123456789"
FOR i=9 TO 1
{
b = "{b}{i}"
}
//Result: b="987654321"
ForEach
描述：對指定字串陣列中的每個元素重複迴圈一次。
樹狀視圖屬性
在樹狀視圖標籤上，
需要配置的屬性如下：
- ArrayName：變數的名稱，其中包含指令碼要套用已定義行為的陣列。
- Comment：新增關於
-
Iterator：輸入儲存當前陣列元素的變數名稱。
- Line Number：編輯器中命令所在的行號。
要完成
範例
要在樹狀視圖中檢視此範例，請將其複製並貼上到「文字視圖」標籤，然後點擊「樹狀視圖」標籤。
IF TEST = 1
{
ASSIGN Names="Odin|Freya|Thor|Loki"
}
ASSIGN SubCounter=1
FOREACH Name IN Names
{
IF Name = "Odin" | Name = "Freya"
{
ASSIGN NewNames[SubCounter]= "{Name}"
ASSIGN SubCounter=SubCounter + 1
}
}
If
描述：評估一個運算式並根據評估的結果採用一個分支。
Studio 動作：If
了解有關布爾值運算子的更多資訊
除了用於乘法、除法、加法和減法的常規數學運算子外，您還可以使用這些運算子：
- 模運算子 (%)
- 冪/指數 (^)
- 整除 (\)
- 異或 (~)
常規數學運算順序適用於所有運算式。括號中的任何內容作為子單元首先進行運算。指數/冪運算子第二個被運算。先運算乘法和除法，再運算加法和減法。在完成所有數學運算後，比較運算子最後被運算。
布爾運算子
您可以在 Snippet 中使用以下布爾運算子。所有這些運算子都可以用於
| 運算子符號 | 運算子名稱 | 詳細資料 |
|---|---|---|
| = | 相等 | 如果運算式的兩邊相等，則運算式的結果為 |
| != | 不相等 | 如果運算式的兩邊不相等，則運算式的值為 |
| > | 大於 |
如果運算式的右邊小於左邊，則運算式的結果為 |
| >= | 大於或等於 |
如果運算式的右邊小於或等於左邊，則運算式的結果為 |
| < | 小於 |
如果運算式的左邊小於右邊，則運算式的結果為 |
| <= | 小於或等於 |
如果運算式的左邊小於或等於右邊，則運算式的結果為 |
| & | 和 | 如果全部子運算式的值都為 true，則整個運算式的結果為 |
| | | 或 | 如果任一個子運算式的值為 True，則運算式的結果為 |
樹狀視圖屬性
在樹狀視圖標籤上，IF 顯示為 >IF 0，下面是 >True 和 False。>IF 定義了需要求值的運算式。>True 定義了運算式求值為 true 時的情況。>False 定義了運算式求值為 false 時的情況。
需要配置的屬性如下：
- Comment：選擇關於 If 語句的備註。
- Expression：輸入希望指令碼評估的條件。
- Line Number：編輯器中命令所在的行號。
要完成 IF 語句，請右鍵點擊 True 和 False，然後根據 Expression 的評估結果選擇您希望指令碼執行的關鍵字或行為。您不必同時提供 True 和 False 選項。您可以新增多個關鍵字或行為。根據需要配置選定的關鍵字或行為。
範例
要在樹狀視圖中檢視此範例，請將其複製並貼上到「文字視圖」標籤，然後點擊「樹狀視圖」標籤。
IF TEST = 1
{
ASSIGN contactID = "123456780"
ASSIGN customerName = "XYZ International"
ASSIGN CBWindowStart = #"{date} 8:00 AM"
ASSIGN CBWindowEnd = #"{date} 4:30 PM"
}
//String Comparison
IF customerName = "ABC Corporation"
{
ASSIGN contractLevel = "Gold"
}
ELSE
{
ASSIGN contractLevel = "Silver"
}
//Numeric Comparision
IF contactID % 10 = 0
{
ASSIGN logCall = 1
}
ELSE
{
ASSIGN logCall = 0
}
//DateTime Comparison
ASSIGN myTime = #"{time}"
IF myTime >= CBWindowStart && myTime <= CBWindowEnd
{
ASSIGN offerCallback = "True"
}
ELSE
{
ASSIGN offerCallback = "False"
}
重複
描述：執行指定的命令指定次數。
樹狀視圖屬性
在樹狀視圖標籤上，
需要配置的屬性如下：
- Comment：新增關於重複的備註。
- Line Number：編輯器中命令所在的行號。
-
Repeat：輸入一個求值為數字值的運算式，以定義您想要重複指定行為的次數。
要完成
範例
要在樹狀視圖中檢視此範例，請將其複製並貼上到「文字視圖」標籤，然後點擊「樹狀視圖」標籤。
REPEAT 10
{
phone = "{phone}{random(10)}"
} 返回
描述：終止函數，並將函數中的變數傳遞給指令碼。使用
語法：RETURN 或 RETURN <var>
Studio 動作：Return
詳細資訊：必須在函數聲明的代碼中使用。在RETURN關鍵字後新增變數名稱 <var>，以便將資訊傳回指令碼。
選擇
描述：根據第一個運算式執行一組命令以評估值是否為 True。
樹狀視圖屬性
在樹狀視圖標籤上，
需要配置的屬性如下：
- Comment：新增關於
- Line Number：編輯器中命令所在的行號。
要完成
範例
要在樹狀視圖中檢視此範例，請將其複製並貼上到「文字視圖」標籤，然後點擊「樹狀視圖」標籤。
SELECT
{
CASE name="Odin" { agentid = 123 }
CASE name="Frigg" { agentid = 345 }
CASE name.length = 0
{
ASSIGN agentid = -1
ASSIGN error = "Invalid name"
}
DEFAULT { ASSIGN agentid = 999 }
} 切換
描述：評估指定變數並執行匹配CASE所定義的動作。
詳細資料：
SWITCH只能評估一個變數。無法評估運算式。如果使用運算式，指令碼將無法使用。
預計至少有一個CASE。所有CASE語句必須具有相同的
- CASE "john"
- CASE 512
- CASE #"5/15/2050"
- CASE #"6/1/2050 7:00am"
- CASE #"7am"
範例：
IF TEST = 1
{
ASSIGN MyDate = "07/03/2023" //This date falls on a Monday
}
ASSIGN MyDow = MyDate.asdatedow
SWITCH MyDow
{
CASE 0 { ASSIGN NewToday = "Sunday" }
CASE 1 { ASSIGN NewToday = "Monday" }
CASE 2 { ASSIGN NewToday = "Tuesday" }
CASE 3 { ASSIGN NewToday = "Wednesday" }
CASE 4 { ASSIGN NewToday = "Thursday" }
CASE 5 { ASSIGN NewToday = "Friday" }
CASE 6 { ASSIGN NewToday = "Saturday" }
}用例：SWITCH 允許您根據指定變數包含的內容獲得特定結果。例如，您可以讓指令碼評估一個包含區號的變數。您可以為每個可能的區號定義一個 CASE，然後讓指令碼為 state 變數新增一個與區號指派的狀態相匹配的值。範例：
SWITCH areaCode
{
CASE 603 { state = "New Hampshire" }
CASE 614 { state = "Ohio" }
CASE 628 { state = "California" }
CASE 646 { state = "New York" }
CASE 667 { state = "Maryland" }
}要在樹狀視圖中檢視此範例，請將其複製並貼上到「文字視圖」標籤，然後點擊「樹狀視圖」標籤。
樹狀視圖屬性
在樹狀視圖標籤上，
需要配置的屬性如下：
- Comment：新增關於
-
Expression：
- Line Number：編輯器中命令所在的行號。
要完成
追蹤
說明：當您在「文字視圖」標籤上使用偵錯程式時，將文字輸出到
語法：TRACE "<value>"
詳細資料：新增一個TRACE關鍵字，其中包含您希望在使用偵錯程式時出現在
此關鍵字僅用於
樹狀視圖屬性
在樹狀視圖標籤上，
- AllowEscapes：設定為 true 時，可以嵌入以反斜線字元 (
- Comment：新增有關追蹤的備註。
- Expression：要輸出到結果窗格的文字。您可以用大括弧{ }將變數括起來。例如，{agentId}。
- Line Number：編輯器中命令所在的行號。
範例
要在樹狀視圖中檢視此範例，請將其複製並貼上到「文字視圖」標籤，然後點擊「樹狀視圖」標籤。
TRACE "this is trace text"
//The text you specify with TRACE appears
//In the results window when you use the
//Debugger on the Text View tab.
描述：允許您在 snippet 中包含 SOAP 網路服務代理 DLL。DLL 必須由 WISDL 透過 NICE CXone 編譯。
語法：USES "<proxy>.dll"
Studio動作：Uses
詳細資料：要使用 用於管理 CXone 環境的技術支援、計費和全域設定的高級組織分組檔案伺服器的根資料夾中。您可以在 CXone 中的 瀏覽 ACD 檔案頁面檢視
了解更多：您可以在從 SNIPPET 動作中進行 API 調用說明頁面上了解有關透過 Studio 指令碼使用 Web 服務代理的更多資訊。
樹狀視圖屬性
在「樹狀視圖」標籤上，用途顯示為 USES ""。
需要配置的屬性如下：
- Comment：新增有關此關鍵字的注釋。
- FileName：在 snippet 中新增要使用的代理 DLL 檔案的名稱。
- Line Number：編輯器中命令所在的行號。
每個關鍵字都有一個 Comment 屬性。允許您新增有關該關鍵字的注釋。使用 Comment 選項新增與特定屬性無關的注釋。