This document provides best practices for Siebel eScripting. It recommends avoiding scripting when possible by using other configuration methods like user properties, calculated fields, state models, and workflows. When scripting is necessary, it provides tips for optimizing scripts such as caching frequently called values, delaying object instantiation, using indexed columns for search specs, avoiding scripts on frequently fired events, consolidating scripts, adding comments, and nullifying objects when no longer needed.

1. Siebel Best Practices
By
Satish Vemula

2. There a Golden Rule that every Siebel Developer should
follow when it comes to scripting.
This golden rule is to never script unless there is no
other choice on meeting your requirements.
Scripting is the highest level of customization and adds
complexity and cost to the configuration. So scripting
should be your last resort. So the first practice is to avoid
script. So to avoid scripting, below are some
configuration methods every developer should think
before attempting to work with eScripts

3. User Properties
• This is a major feature in Siebel. An
example of this is “On Field Update Set”.
This is used instead of scripting on Set
Field Value event to change some other
value.

4. Calculated Fields
• Calculated fields come very handy when
we need to do validation. With the help of
Calculated Fields and User properties lot
of functional requirements are achieved

5. State Models
• State models help in restricting transitions
from one field value to other. So there is
no need to script to check the status
change.

6. Runtime Events
• This was introduced in 7.7 and has been
of significant help to the developers to on
invoking Workflows & Business Services
based on events. So avoid Business
Component events.

7. Workflows
• Instead of writing a big script, we can
break that down to a series of workflow
steps. We have steps Like Write, Update,
if condition, Sub-Process, Invoke Business
Service and lot of other key stuff.
Workflows are very efficient and
promising.

8. Scripting
• Though scripting should be avoided, it is
often common that scripting would
become necessary to meet our
requirements. So if scripted, it should be
done the most efficient way. There are
several optimization techniques. Below
are some and I will post more in the future.

9. Tip 1
• Avoid repeated calling of a function if the
results returned are the same. Instead
cache the value in a variable. Especially
avoid repeated calling of the API function
like TheApplication().ActiveViewName() as
shown below.

11. Tip2
• Delay Object Instantiation. If the object
being used is under a conditional
expression then wait till the conditional
statement actually evaluates true. This
reduces the cost and burden on the
server. See the code below.

13. Scripting Contd..
• Scripting often gets complicated with
heavily customized applications. Not every
business requirement can be met with just
configuration. So developers resort to
scripting. But if not properly implemented,
this could cause a lot of mess. Below are
some more Siebel recommended best
practices.

14. Tip3
• Use SetSearchSpec only on Indexed column. Before we
do ExecuteQuery in the script, we use SetSearchSpec to
retrieve only relevant records. SetSearchSpec also limits
the number of records retrieved which makes the
ExecuteQuery faster. But on what type of column we do
SetSearchSpec on is also very important. We should
always do a SetSearchSpec on indexed column so that
the records are retrieved very fast. This saves a lot of
burden and time on both application and database
servers.

15. Tip4
• When we use ExecuteQuery, we need not do execute
query again on child BC. ExecuteQuery on parent BC
also forces a query on all active child BC defined using
Links. For example in the screenshot below, consider
Account Object. There is Link defined between Account
and Action BC. So if a query is executed on Account BC,
only relevant Activity records pertaining to the records
Account BC are retrieved. This behavior is very similar to
searching in the Siebel application UI where if you have
Account –Action view and if you query on Account
applet, only activities relevant to are shown in the bottom
list applet.

17. Scripting Contd.
• Also, if you need to do a use SetSearchSpec on child
BC, do it before the ExecuteQuery. This way,
ExecuteQuery is done only once. Again this is similar to
searching in the Siebel Application UI. Below is the
screenshot with a simple code to demonstrate this.
• There is definitely scripting involved in any Siebel
implementation but is safe not to clutter with scripting. As
a developer s/he has to always think about the
performance impact as it could result in significant
downgrade of the system.
So here are few more best practices on Siebel eScripting.

18. Tip5
• Totally Avoid Scripting on Frequently Fired Events like
PreGetFieldValue and ChangeRecord Event.
• PreGetFieldValue event is triggered for every column under every
record that is retrieved. For instance if there are 10 records retrieved
in an applet and there are 10 columns or values in each record then
this event will be fired 100 times. This is a big number and could
grow dramatically. So it is a big NO NO for scripting on this event.
• ChangeRecord event is triggered every time a user navigates to
the next record. This will slow down the user completely. Users
would complain and if somewhere this BC is used for scripting
anywhere else, then this event will impact the performance that
scripts. So be very careful as this is definitely not recommended.

19. Tip6
• Browser Script causes burden on the application
to load. So heavy browser scripting should be
avoided. Additionally use only for simple client
side functionalities like validating values. Also
avoid browser scripts that require server side
roundtrip to get fast response. For example,
fetching values from the server database back
into the browser script would take time and
would result in slow response.

20. Tip7
• When you use ExecuteQuery() in eScripting, by default it uses
ForwardBackward mode where in it remember the past record and
would use some resources. Instead use ForwardOnly cursor mode
wherever possible as it improves performance by not having to
remember the past records that have already passed. By default it is
ForwardBackward and you will have to specify the cursor mode to
use ForwardOnly like oAccountBC.ExecuteQuery(ForwardOnly).
• There are several other ways to optimize Siebel scripting but it is
also very important to write the code in a way as to reduce the
maintenance efforts, help future reference and for best
understanding. So in this blog post about Siebel eScripting best
practices I will mention tips to address these essential skills needed.

21. Tip 8
• Consolidate Scripts to BC level script or Business Service level
script.
There are cases where in a same set block of script is being used at
multiple places. A simple example would be a script used in toggle
applets where there are multiple applets involved and each applet
could be having the same block of script addressing the same
functionality. For a developer, a small change in functionality would
require him to change multiple objects. This overhead can be
reduced if possible, by moving the functionality to either at the
Business Component level or at the Business Service level. Then
the developer would have to make changes to only one object which
effectively saves a lot of overhead and time.
Also keep in mind that lesser the code in your repository better the
maintenance efforts and would also help the upgrade process.

22. Tip 9
• Self-Document the scripts with Comments
I can’t stress enough on this trip. There are
always times when we look at the other person’s
code and we would always wonder why this was
done. Also even there are times when a year
later or so, our own code would look alien to us.
So always use comments sparingly.
Commenting is a wonderful way of conveying
the meaning of the code.

23. • Each code should start with a commented header explaining the purpose of
the code. Then comment the code appropriately at every sections of the
code to make the whole script self explanatory. Below is the sample function
header.
function Service_PreInvokeMethod (MethodName, Inputs, Outputs)
{
/**********************************************************
* Name: AAG Service PreInvokeMethod
* Author: ABC
* Date Created: 01/25/2008
*
* Purpose/Description: Illustration of how comment header is used
*
* Inputs: Id, SR_ID
* Outputs: Returns status of BS
*
* Revision History:
* 9/9/09 — Satish — Added to update status of SR
* 9/10/09 — Satish — Added Email functionality, Enhancement SBL-320
************************************************************/
• The header shown above is the most common header used by many
developers. Feel free to use the above header in your code.

24. Tip 10
Browser Script versus Server Script
• The main purpose of Siebel Browser script is to extend the
functionality of the browser. So Browser script should be limited to
user based events. On the other side Server Side script is used for
data manipulation or anything beyond the capability of the browser.
• Browser script is recommended for:
• Communication with the user
• Interaction with desktop applications
• Data validation and manipulation limited to the current record
• Server script is recommended for:
• Query, insert, update, and delete operations
• Access to data beyond the current record
• So validate your requirement against this best practice.

25. Tip 11
Nullify Object Variables when no longer needed.
• Every variable under eScript that is referenced to an object (oBC =
TheApplication().GetBusComp(“Account”);) uses some memory to
hold that value. If the script exists abruptly the memory that is being
used to hold that value might not get released causing memory leak.
To avoid any kind memory leak it is a good practice to null those
variables (oBC = null;) after their use. Nulling those variables
releases the memory. Common object references that must be
nulled are
• Business Objects
• Property Sets
• Business Services
• Business Components
• Applets

26. The best spot to null these variables are under finally section of the
try-catch block of eScript as shown below.
try
{
oAccBO = TheApplication().GetBusObject(”Account”);
oAccBC = oAccBO.GetBusComp(”Account”);
sAccSerExpr = oAccBC. GetSearchExpr();
}
catch(e)
{
//Some Error Handling
}
finally
{
sAccSerExpr = null;
oAccBC = null;
oAccBO= null;
}
Observe that in the code I first null the child objects and then the
parent objects.

27. Tip 12
Get rid of unused code from the Repository
• Having a code that has been commented out or not being used
causes an unnecessary burden on the server to load the application
which could hit performance. If the code is no longer in use just
remove them from the objects. But before you delete them make
sure you archive (sif) or export it so that in future if you see realize
the need for it; you can just import them back into the application.
• Hope these tips helps. If you know of any tips and you would like me
to publish it over here, please write it and send it to me. I will be very
glad to post it over here.
• While I was working on eScript I came across the method
GetMVGBusComp which is one of Best Practices in eScripting and I
thought of posting it here. Details about this method below.

28. Tip 13
Use GetMVGBusComp Method to get the MVG records
• As the method name suggests it gets the Business Component of the record that MVG is
based on. This is a very helpful Method that would save a several lines of unnecessary code.
• For example, we have Accounts and there are Sales Reps associated to each of these
accounts. These Sales Reps are based on Position BC. Position BC is the MVG Business
Component of Account BC. The requirement is to get all the sales rep associated to the
details of all the sales rep associated to this account using eScript. Now a developer who is
writing this eScript and not aware of this Method would write an eScript something like this.
• Get Account Row ID
• Get Account Position BC
• Query for Account ID
• Get the corresponding Position Id
• Get Postion BC
• Query for that Postion Id from step 4
• Get Employee details from this Position BC
Instead we could write something like this
• Get Account RowId
• Get all the sales rep records using GetMVGBusComp
• Get Employee details from this Position BC.

29. Code for your reference
oAccBC = oAccBO.GetBusComp("Account");
//Get the corresponding Sales Rep Bus Comp — eScript Best practice
here.
var oAccPostnBC = oAccBC.GetMVGBusComp("Sales Rep");
//Add search spec to already filtered records
//No Need to get the Sales Rep that are associated to only this account
//The Method already gets sales rep that belongs to only this account
//Do not to use ClearToQuery here.
//You could add more Search Spec if you desire
oAccPostnBC.SetSearchSpec("Position Type","Partner Sales Rep");
oAccPostnBC.ExecuteQuery();
var rAccPostn = oAccPostnBC.FirstRecord();
//Here I am getting all the email Addresses
while(rAccPostn)
{
sEmailAddr = sEmailAddr + oAccPostnBC.GetFieldValue("Active
Email"a) + ";";
rAccPostn = oAccPostnBC.NextRecord();
}

30. Tip 14
Verify Existence of Valid Record after Querying
• After you execute the method ExecuteQuery()
make sure to check if there is at least one valid
record that you desire otherwise it might result in
an invalid scripting. For example in the code
above before I get the email addresses I check
there is a valid record returned from my
ExecuteQuery Method using the while
statement. Otherwise GetFieldValue on the BC
record will behave weird by throwing error. Also
you could use IF statement to check if you
expect the result to have just one record.

31. Views not visible – Reasons
I was implementing a new Siebel 8 application for my client and in
spite of everything working normal I realized that some views of
product configurator were missing. Then I started to investigate as
to why these views were not visible even for SADMIN. I checked few
different things and later we realized that the product configurator
functionality is an add-on license and which my client hasn’t bought.
So for this blog, I started to compile the Top 6 reasons as to why the
view is missing or might be not visible.
• The view does not include under your current Responsibility.
• View not registered.
• Missing or limited license keys
• View does not exist in the Siebel Repository. Forgot to compile?
• Personalization constraints (Profile Attributes)
• View might have been configured under a different Siebel Screen