Adds a new instance check to notify about the possible risk associated with the usage of setWorkflow(false) method in business rule (#119)

* Adds a new instance check to notify about the possible risk associated with the usage of setWorkflow(false) method in business rule

* Update README.md

Updated description of the instance scan definition

---------

Co-authored-by: admin <[email protected]>
Co-authored-by: Astrid Sapphire <[email protected]>

Author: 3 people

README.md

@@ -322,6 +322,9 @@ It is recommended to use an OOB library for modals in order to improve the user
 ### Use "last run datetime" for JDBC data loads
 In your JDBC data load configuration, ensure that the 'last run datetime' option is set to true and configure the target database field to serve as a timestamp, as this best practice enables incremental data loading and improves performance in data integration processes using JDBC.
 
+### Use of setWorkflow(false) in business rules will cause unexpected issues
+As setWorkflow(false) method will stop the execution of business rules on that particular GlideRecord object, this will result in unexpected behaviour where the execution of business rules skipped. Maintain caution while using this method and perform regression testing to avoid possible risk. It can have noticeable impact on Audit, Journal fields, notifications, SLA engine, workflow, flow engine etc.,
+
 # Additional resources
 
 Please check these additional links for more information and details:

ca8467c41b9abc10ce0f62c3b24bcbaa/checksum.txt

@@ -1 +1 @@
-CiJ15NYBQlN98r5DlixaQIenUXX1VhYfhj3Viqimn6xnWLRjm49eemoXHGUOks40yE_KLBqmaWSeV7OWtVNzeOh9-y1LiYIK1vybPlCkm7Vs17cPZilSdJm90QP6eYbjuA2REbx6CenCuljifa_GhgrTQQQTXhfLrK4AITqwSONkcpSIq_JtLnGAQ5LxsEDZVwVRiosBg6ub4RhGBA_Ty3QB1c8QTDX5jMJ0w5v26VVfKclro6vthJBcfD7zKGT2O4dChhUM1CqmvzAeXTXxnQ-ntin_vJQNdqJOcZBeadAqgdq7_wGAZ5K89oTnIEG8wIi-TtNYo6iETGMYNKNZFfnXdFoqYCs7eLzZwzAx01yNQuixM8q29qc-UpMDfeVSOd-0rTgZTfQqHwkv3NgRqf6iJOFD_M8LSftCrO03UJb9UIzExafd6uwgGej8knhd3WlC9L0WyE9jpvLnBilYuuu2dv1cubkoK4J8Nyy8gWo8AY25xbvex6elPi0be9ynkQDFNtOnTMZRSBKWqHTZxM6N5VA8E3B5ZCB2zjgp6MQMAu7l0EoXfA5jkZG47xuBIbmYZYB45JRQwS0pWqdHWF6Y1D83eFIoFQ6FyYBcbJYBEDN8k3juc1IACIdH6rl9JWBRK6mr0PhujD-MKedCLbvL2OVLm6EAQTPnQMnjyo0
+CuRfUCF5TEEar0o-4-1zN_c4AEm04tYOYyitzaQ_ex8I7N1JnJYMxjgZkKwGNaxquET4kyKZwNGgOGLwBZBGQqV0ad_q9I2iqmSUNivzapvftarN9j3ub-8HHtzDLdZBhLnOsB8_AjaPv-Eh_ggd7Hq1LXsfJR-l2YKbNaYWGEXz3eOtbbMEtaN3alsPdg5xSkjvK9JKAkrc5bGTECXU4roa_kZ-uGIFs-qEsoX2JLGSCx_aN3WFyHzUxK0G_TeT80_oLemMf-ZR5tSP0MOFefZs3yckoTXG35VZfAHf4Y7GLJ2ue-KUTTVyHcmBeXwWVAvAHqfZufjne18FtwGdyXbVMV2NmSYcIfMhjkRVvI-DFT1zbEVdkhZAfueYlHevUDcAbwJlY0d0jAe9XbcK_z8b0jdGgruv6aO-NQiekLsMi2uQtb2XsEs7ZNRpSJ_uMGL4SaEIJRjF-Tvcaw-Lls2ejcFD8cZGsUMlfOSHGkNL7N4gjjSZSayzWZSYAnFYGV85NzxJSHt9TDSD0k1TsUiFplvaPqh8sjPvhCk4CbsEadTIm73aWOwmakBfWH6uENaUgBxAwOFayH2fN4r0PkrjsP1Yj6kHxkWBZhIZT8nhMDGM1eTWhP6duu2uY3ANpE2Hl3tv_6LEqDQbZjFNa5o3mL2r7GHxwheQBmq-Cv4

ca8467c41b9abc10ce0f62c3b24bcbaa/update/scan_table_check_110515e547819210b8ca0b02d16d4308.xml

@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="UTF-8"?><record_update table="scan_table_check">
+    <scan_table_check action="INSERT_OR_UPDATE">
+        <active>true</active>
+        <advanced>false</advanced>
+        <category>manageability</category>
+        <conditions table="sys_script">scriptLIKEsetWorklfow(false)^EQ<item endquery="false" field="script" goto="false" newquery="false" operator="LIKE" or="false" value="setWorklfow(false)"/>
+            <item endquery="true" field="" goto="false" newquery="false" operator="=" or="false" value=""/>
+        </conditions>
+        <description>As setWorkflow(false) method will stop the execution of business rules on that particular GlideRecord object, this will result in unexpected behaviour where the execution of business rules skipped. Maintain caution while using this method and perform regression testing to avoid possible risk. It can have noticeable impact on Audit, Journal fields, notifications, SLA engine, workflow, flow engine etc.,</description>
+        <documentation_url>https://support.servicenow.com/kb?id=kb_article_view&amp;sysparm_article=KB0867584</documentation_url>
+        <finding_type>scan_finding</finding_type>
+        <name>Limit use of setWorkflow(false) in business rules</name>
+        <priority>2</priority>
+        <resolution_details>Based on the scenario or use case, think of alternative approach instead of using setWorkflow(false) especially in business rules. Reaserch about the system property trigger_engine.ignore.set_workflow</resolution_details>
+        <run_condition/>
+        <score_max>100</score_max>
+        <score_min>0</score_min>
+        <score_scale>1</score_scale>
+        <script><![CDATA[(function (engine) {
+
+    // Add your code here
+
+})(engine);]]></script>
+        <short_description>Use of setWorkflow(false) in business rules will cause unexpected issues</short_description>
+        <sys_class_name>scan_table_check</sys_class_name>
+        <sys_created_by>admin</sys_created_by>
+        <sys_created_on>2024-10-04 15:57:42</sys_created_on>
+        <sys_id>110515e547819210b8ca0b02d16d4308</sys_id>
+        <sys_mod_count>1</sys_mod_count>
+        <sys_name>Limit use of setWorkflow(false) in business rules</sys_name>
+        <sys_package display_value="Example Instance Checks" source="x_appe_exa_checks">ca8467c41b9abc10ce0f62c3b24bcbaa</sys_package>
+        <sys_policy/>
+        <sys_scope display_value="Example Instance Checks">ca8467c41b9abc10ce0f62c3b24bcbaa</sys_scope>
+        <sys_update_name>scan_table_check_110515e547819210b8ca0b02d16d4308</sys_update_name>
+        <sys_updated_by>admin</sys_updated_by>
+        <sys_updated_on>2024-10-04 16:00:33</sys_updated_on>
+        <table>sys_script</table>
+        <use_manifest>false</use_manifest>
+    </scan_table_check>
+    <sys_translated_text action="delete_multiple" query="documentkey=110515e547819210b8ca0b02d16d4308"/>
+</record_update>