Skip to content

Commit 9fe0ae8

Browse files
Update README.md
Updated the README.md file with below 3 following additions, 1. Under manageability category, - Always keep code/snippet in functions - Business Rules. - Update set In Progress/Completed previously Ignored. 2. Under performance category, - Catalog Client script with GlideRecord API calls.
1 parent 8bc15bb commit 9fe0ae8

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,15 @@ Tickets from tables such as Incident, Change Request, Problem, and other task-re
164164
### Check Inactive Business Rules over 90 days
165165
Inactive Business Rules which are not updated for more than 90 days and not created by glide.maint and not updated by admin should be identified to remove unnecessary overhead.
166166

167+
### Always keep code/snippet in functions - Business Rules
168+
In general, an advanced busiess rule will wrap your code in a function, and it is important that this guideline is followed. When code is not enclosed in a function, variable and other objects are avilable to all other server-side scripts. This availability can lead to unexpected consequences that are difficult to troubleshoot.
169+
170+
### Update set In Progress/Completed previously Ignored
171+
Usually, developers mark an updatesets as Ignore if the work done is not required to be promoted or incorrect or irrelavent or due to any other reasons.
172+
However, at times, some of the developers may use the ignored set for any active work instead of creating new one by updating the state from Ignore to In-Progress. It is not a good practice to do the same. It may case the deployment issues and also makes the troubleshooting process cumbersome.
173+
It may also impact the deployment and cause issues in case if the state is changed to In-Progress/Completed for the potential ignored sets.
174+
175+
167176
## Category: Upgradability
168177

169178
### Call GlideRecord using new
@@ -332,6 +341,9 @@ Unpublished knowledge articles may contain sensitive information that should not
332341
### Scripts in ACLs should be cleared when Advanced is not checked
333342
Scripts in ACLs ARE executed regardless of whether or not the Advanced checked box is checked off. As such, unnecessary scripts should be cleared from the field OR the Advanced checkbox should be checked in cases where scripts are required to provide better visibility to admins for troubleshooting purposes.
334343

344+
### Catalog Client script with GlideRecord API calls
345+
Catalog Client script should be using GlideAjax if you need to make asyc calls to Server to get data from Server. GlideRecord() API shouldn't be used to avoid performance issues.
346+
335347
## Category: User Experience
336348

337349
### Added a Number Prefix which already exists

0 commit comments

Comments
 (0)