Siebel Answers

Siebel eScript Coding Best Practices Cheat Sheet

April 29, 2008 – 11:38 am

The following is the Siebel eScript cheat sheet that I use on my current Siebel project. I ensure that all my developers have a copy of this cheat sheet printed out and posted up near their desk to ensure they adhere to the project Siebel coding standards.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

1.      Each script should contain a descriptive header providing an overview of the purpose of the function.

 

2.      Always remember to fill-up the revision history section of the code when you update the code. Also, add line or block comments on the part where the change or update was made.

 

3.      Declare all variables at the top of the code above the try statement.

 

4.      String variables must be initialized using and equal sign and two double quotes(“”).  Numerical variables on the other hand are initialized by equating it to zero.

 

5.      Use ActivateField for all fields that are not Force Active which will be used in the filter for the search expression or field value will be retrieved after ExecuteQuery. ActivateField should NOT be used with ‘this’.

 

6.      Use proper tabbing in coding for readability.  Code should be indented following the logical structure, so that all the statements in the same logical level are in the same indentation.

 

7.      Use InvokeMethod(“SetAdminMode”,”TRUE”) to ensure that all records will be returned.

 

8.      Use with statement when using many functions from an object this provides a performance improvement and presents the code better.

 

9.      Ensure to pass ForwardOnly to the ExecuteQuery function for performance purposes if records do not require deleting after the query has been made.

 

10.  Ensure a FirstRecord() function exists after the ExecuteQuery to verify records returned.

 

11.  If 2 or more else conditions in an if-else clause use a switch statement for performance reasons

 

12.  Place comment within the code so others will be able to easily understand the functions of the codes sections. 

 

13.  In the catch statement always raise the error using TheApplication().RaiseErrorText.

 

14.  Single function return statement outside the Try/Catch/Finally clause.

 

15.  All object type variables should be released in the finally clause. Objects should be released in the reverse order they were initialized.