Name
|
Enter a unique identifier for the script. The name can comprise up to 50 alphanumeric characters and can contain any combination
of spaces, periods (.), hyphens (-), and underscore characters (_).
|
Description
|
Enter a descriptive name for the script.
|
Content
|
This field displays the content of the imported script. You can edit the script in this text box.
|
Script Execution Error Recovery Action
|
Choose the action that you want the system to perform when an execution error gets detected while executing a script message
handler.
An execution error can occur due a number of issues, such as a script invokes one of the Cisco SIP Message APIs but passes
in the wrong number of arguments, or a script passes a nil string to a string library API.
When an execution error gets detected, the system automatically exits the message handler at the point of the failure, restores
the message to its original content prior to executing the message handler (in other words, performs message rollback), and
continues as if the message handler was never invoked.
After the automatic error message handling, the system performs the action that you choose from the drop-down list box:
- SIP Message Rollback Only—(Default) The script continues to execute for subsequent messages.
- SIP Disable Script—Cisco Unified Communications Manager closes the script and does not execute it for subsequent messages. The Lua state remains closed and the system reclaims all
of the memory. You must manually reset the trunk to re-enable the script.
- SIP Reset Script—Cisco Unified Communications Manager closes and immediately reloads the script. When the script is closed, the Lua state is closed and the system reclaims all
of the memory. Any state that the script maintains is lost. After the script reloads, Cisco Unified Communications Manager automatically uses the script for subsequent messages.
- SIP Script Reset Trunk—The system immediately resets the trunk, which affects existing calls. Cisco Unified Communications Manager closes the script while the trunk resets. After the trunk restarts, Cisco Unified Communications Manager automatically reopens the script.
|
System Resource Error Recovery Action
|
Choose the action that you want Cisco Unified Communications Manager to take when a script aborts during execution because Memory Threshold and Lua Instruction Threshold values were exceeded.
Resource errors can occur when the script is loading, initializing, or executing a message handler. If the script fails to
load or initialize, it is immediately disabled.
The configured System Resource Error Recovery Action does not apply to load and initialization errors. This action applies
only to execution errors. Execution errors occur only while executing message handlers.
When a resource error occurs while a script executes a message handler, the system automatically exits the message handler
at the point of the failure, restores the message to its original content prior to executing the message handler (in other
words, performs message rollback), and continues as if the message handler was never invoked.
After the automatic error message handling, the system performs the action that you choose from the drop-down list box:
- SIP Disable Script—(Default) The script closes and does not execute for subsequent messages. The Lua state remains closed
and the system reclaims all of the memory. You must manually reset the trunk to re-enable the script.
- SIP Reset Script—The script closes and then immediately reloads. When the script closes, the Lua state closes and the system
reclaims all of the memory. Any state that the script maintains is lost. After the script reloads, Cisco Unified Communications Manager automatically uses the script for subsequent messages.
- SIP Script Reset Trunk—The system immediately resets the trunk, which affects existing calls. The script closes while the
trunk resets. After the trunk restarts, the script reopens automatically.
|
Memory Threshold
|
Enter the memory threshold value in kilobytes. You must enter an integer into this field.
If memory usage exceeds 80 percent of this value, the SIPNormalizationScriptResourceWarning resource warning alarm gets generated.
The script continues to execute until the memory usage exceeds 100 percent of this value.
If memory usage exceeds 100 percent during script loading or initialization, a script error alarm gets generated, and the
script gets closed and disabled.
If memory usage exceeds 100 percent during script execution, a script error alarm gets generated, and Cisco Unified Communications Manager performs the action that the System Resource Error Recovery Action field specifies.
For example, if you enter 50 kilobytes into this field, the warning alarm gets generated if the script exceeds 40 kilobytes.
The script continues to run until memory usage exceeds 50 kilobytes.
The default value specifies 50 kilobytes.
|
Lua Instruction Threshold
|
This field specifies the maximum number of Lua instructions that a given message handler is allowed to invoke. If a script
exceeds 50 percent of this value, a resource warning alarm generates. The script continues to execute until the script exceeds
100 percent of this value.
If the script exceeds 100 percent of the Lua Instruction Threshold value during script loading or initialization script, the
SIPNormalizationScriptResourceWarning resource warning alarm gets generated and Cisco Unified Communications Manager closes and disables the script.
If the script exceeds 100 percent of the Lua Instruction Threshold value during script execution, the SIPNormalizationScriptResourceWarning
alarm gets generated and Cisco Unified Communications Manager performs the action that the System Resource Error Recovery Action field specifies.
For example, if you enter 1000 in this field, a warning alarm gets generated if the script exceeds 500 instructions. The script
continues to run until it exceeds 1000 instructions.
The default value specifies 1000 instructions per message handler invocation.
|
Reset
|
Click this button to shut down, then restart, the internal trunk device or devices with which this script associates.
|
Import File
|
Click this button to import a script.
In the Import File popup window that opens, search for the file by clicking the Browse... button to the right of the Import
File field. Use the File Upload popup window to navigate to the file to you want to upload. After you find the file, click
the desired filename and click Open. The path to the chosen script file displays in the Import File field of the Import File
popup window. To upload the specified script file, click Import File. To close the Import File popup window without taking
any action, click Close.
After the script file uploads, the Status area of the Import File window tells you the result of the upload. The contents
of the script file display in the Content field.
|