Debugging Scripts

Debugging Scriptshttps://community.telligent.com/community/11/w/developer-training/67213/debugging-scriptsen-US14.0.0.586 14Debugging Scriptshttps://community.telligent.com/community/11/w/developer-training/67213/debugging-scriptsWed, 05 Aug 2020 16:18:51 GMT22b4aae7-0fb8-44fe-9908-4fc78b1ecd43Former Memberhttps://community.telligent.com/community/11/w/developer-training/67213/debugging-scripts#commentsCurrent Revision posted to Developer Training by Former Member on 08/05/2020 16:18:51<br /> <p>Sometimes, when developing a customization using [[Scripting|a scripted customization]], the script doesn't execute as expected. When this happens, it's time to start debugging. Verint Community provides a few tools to help diagnose issues.</p> <p>[toc]</p> <h2><a id="Review_the_Exceptions_Log" name="Review_the_Exceptions_Log"></a>Review the Exceptions Log</h2> <p>Errors that occur with parsing or execution of script are logged to the Exceptions Log (<strong>Administration > Monitoring > Exceptions</strong>). Script-based errors are logged under the type "ContentFragmentRenderingError" or "ContentFragmentConfigurationError." Most errors include the name of the scripted component and embedded file (if applicable). Look for the name of the scripted type you're developing and review the details to find information about the potential error.</p> <h2><a id="Log_intermediate_data" name="Log_intermediate_data"></a>Log intermediate data</h2> <p>If there is no syntax or application error, the bug you're encountering may be related to data expectations in your processing logic. You can add intermediate data logging by including calls to <code>core_v2_exceptions.Log('MESSAGE')</code> periodically within your code to identify where execution is getting and what data is being reviewed.</p> <p>Exceptions logged using this API will show in the Exceptions Log (<strong>Administration > Monitoring > Exceptions</strong>) as the exception type "ContentFragmentRenderingError." You can review the progress that is logged to determine what code to review in more depth or what data was received and compare that to what your code was expecting.</p> <h2><a id="Use_the_Script_Sandbox" name="Use_the_Script_Sandbox"></a>Use the Script Sandbox</h2> <p>If you are having trouble with a specific block of code or specific API call, you can use the script sandbox available in each of the script studios ([[Working with Widget Studio|Widget Studio]], [[Working with Theme Studio|Theme Studio]], and [[Working with Automation Studio|Automation Studio]]) to run snippets of code and review its output immediately.</p><div style="clear:both;"></div> <div style="font-size: 90%;">Tags: best practices</div> Debugging Scriptshttps://community.telligent.com/community/11/w/developer-training/67213/debugging-scripts/revision/2Thu, 11 Jul 2019 03:34:32 GMT22b4aae7-0fb8-44fe-9908-4fc78b1ecd43Former Memberhttps://community.telligent.com/community/11/w/developer-training/67213/debugging-scripts#commentsRevision 2 posted to Developer Training by Former Member on 07/11/2019 03:34:32<br /> <p>Sometimes, when developing a customization using [[Scripting|a scripted customization]], the script doesn't execute as expected. When this happens, it's time to start debugging. Verint Community provides a few tools to help diagnose issues.</p> <p>[toc]</p> <h2><a id="Review_the_Exceptions_Log" name="Review_the_Exceptions_Log"></a>Review the Exceptions Log</h2> <p>Errors that occur with parsing or execution of script are logged to the Exceptions Log (<strong>Administration > Monitoring > Exceptions</strong>). Script-based errors are logged under the type "ContentFragmentRenderingError" or "ContentFragmentConfigurationError." Most errors include the name of the scripted component and embedded file (if applicable). Look for the name of the scripted type you're developing and review the details to find information about the potential error.</p> <h2><a id="Log_intermediate_data" name="Log_intermediate_data"></a>Log intermediate data</h2> <p>If there is no syntax or application error, the bug you're encountering may be related to data expectations in your processing logic. You can add intermediate data logging by including calls to <code>core_v2_exceptions.Log('MESSAGE')</code> periodically within your code to identify where execution is getting and what data is being reviewed.</p> <p>Exceptions logged using this API will show in the Exceptions Log (<strong>Administration > Monitoring > Exceptions</strong>) as the exception type "ContentFragmentRenderingError." You can review the progress that is logged to determine what code to review in more depth or what data was received and compare that to what your code was expecting.</p> <h2><a id="Use_the_Script_Sandbox" name="Use_the_Script_Sandbox"></a>Use the Script Sandbox</h2> <p>If you are having trouble with a specific block of code or specific API call, you can use the script sandbox available in each of the script studios ([[Working with Widget Studio|Widget Studio]], [[Working with Theme Studio|Theme Studio]], and [[Working with Automation Studio|Automation Studio]]) to run snippets of code and review its output immediately.</p> <div style="clear:both;"></div> Debugging Scriptshttps://community.telligent.com/community/11/w/developer-training/67213/debugging-scripts/revision/1Mon, 08 Jul 2019 15:07:06 GMT22b4aae7-0fb8-44fe-9908-4fc78b1ecd43Ben Tiedthttps://community.telligent.com/community/11/w/developer-training/67213/debugging-scripts#commentsRevision 1 posted to Developer Training by Ben Tiedt on 07/08/2019 15:07:06<br /> <p>Sometimes, when developing a customization using [[Scripting|a scripted customization]], the script doesn't execute as expected. When this happens, it's time to start debugging. Verint Community provides a few tools to help diagnose issues.</p> <p>[toc]</p> <h2><a id="Review_the_Exceptions_Log" name="Review_the_Exceptions_Log"></a>Review the Exceptions Log</h2> <p>Errors that occur with parsing or execution of script are logged to the Exceptions Log (<strong>Administration > Monitoring > Exceptions</strong>). Script-based errors are logged under the type "ContentFragmentRenderingError" or "ContentFragmentConfigurationError." Most errors include the name of the scripted component and embedded file (if applicable). Look for the name of the scripted type you're developing and review the details to find information about the potential error.</p> <h2><a id="Log_intermediate_data" name="Log_intermediate_data"></a>Log intermediate data</h2> <p>If there is no syntax or application error, the bug you're encountering may be related to data expectations in your processing logic. You can add intermediate data logging by including calls to <code>core_v2_exceptions.Log('MESSAGE')</code> periodically within your code to identify where execution is getting and what data is being reviewed.</p> <p>Exceptions logged using this API will show in the Exceptions Log (<strong>Administration > Monitoring > Exceptions</strong>) as the exception type "ContentFragmentRenderingError." You can review the progress that is logged to determine what code to review in more depth or what data was received and compare that to what your code was expecting.</p> <h2><a id="Use_the_Script_Sandbox" name="Use_the_Script_Sandbox"></a>Use the Script Sandbox</h2> <p>If you are having trouble with a specific block of code or specific API call, you can use the script sandbox available in each of the script studios ([[Working with Widget Studio|Widget Studio]], [[Working with Theme Studio|Theme Studio]], and [[Working with Automation Studio|Automation Studio]]) to run snippets of code and review its output immediately.</p> <div style="clear:both;"></div>