Siebel Scripting Best Practices Resource Document

This resource document contains detailed information regarding scripting best practices.

Siebel Systems, Inc.

SIEBEL SYSTEMS, INC. EMPLOYEE EDUCATION

1

PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED

SIEBEL SCRIPTING BEST PRACTICES

MARCH 23, 2004

Copyright © 2004 Siebel Systems, Inc., 2207 Bridgepoint Parkway, San Mateo, CA 94404. All rights reserved. No part of this publication may be stored in a retrieval system, transmitted, or reproduced in any way, including but not limited to photocopy, photographic, magnetic, or other record, without the prior agreement and written permission of Siebel Systems, Inc. Siebel Systems, Inc. considers information included in this document to be Confidential and Proprietary. Your access to and use of this Confidential and Proprietary Information is subject to the terms and conditions of the Siebel License Agreement or Non-Disclosure Agreement which has been executed and with which you agree to comply.

PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED

2

SIEBEL SYSTEMS, INC. EMPLOYEE EDUCATION

MARCH 23, 2004

SIEBEL SCRIPTING BEST PRACTICES

Table of Contents
In Acrobat, you can click on any lesson or topic to jump to that area of the resource document. You can also use the Bookmarks feature in Acrobat to quickly navigate.

SCRIPTING FUNDAMENTALS
Scripting: Where to Begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Basic Process Flow

Basic Process Flow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
1. 2. 3. 4. 5. 6. Explore Declarative Configuration Alternatives Determine Where to Put the Script: Which Object? Determine Where to Put the Script: Which Event? Add Error Handling Template Add Method Body Test

SCRIPTING BEST PRACTICES
When to Use Scripting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Use Scripting as a Last Resort

Follow Standard Naming Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Comment Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Know When to Use Browser versus Server Script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Place Code in the Correct Event Handler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Use Fast Script In Event Handlers that Fire Frequently. . . . . . . . . . . . . . . . . . . . . . . . . . . Runtime versus Compiled Business Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Use Option Explicit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Leverage Appropriate Debugging Techniques . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Debugging Siebel Applications Alert and RaiseErrorText Writing to a Text File Using the Debugger in Siebel Tools Using Object Manager Settings

10 11 13 14 15 16 17 18

Remove Unused Code from the Repository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Include Error Handling in All Scripts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Proper Error Handling Error Handling in eScript Error Handling in Siebel VB

Use RaiseError and RaiseErrorText Properly . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 Use Exception Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Purpose of Exception Handling Exception Information in eScript Exception Information in Siebel VB

Place Return Statements Correctly: eScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Centralize Browser Script Using the “Top” Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

SIEBEL SYSTEMS, INC. EMPLOYEE EDUCATION

3

PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED

SIEBEL SCRIPTING BEST PRACTICES

MARCH 23, 2004

Know When to Use the Current Context versus a New Context in Server Script. . . . . . . 31
Difference Between Current and New Context Guidelines for Choosing Context

Use Smallest Possible Scope for Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 Instantiate Objects Only As Needed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 Destroy Object Variables When No Longer Needed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 Use Conditional Blocks To Run Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 Verify Objects Returned . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Verify Object Returned is Expected One ActiveBusObject ActiveBusComp ParentBusComp

Verify Field is Active before Use . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 Leverage New Methods in Siebel 7. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
New Methods

Use Proper View Mode For Queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 Query Only Indexed Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 Use ForwardOnly Cursor Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 Verify Existence of Valid Record After Querying . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 Use Switch or Select Case Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 Compare the Same Condition In If/Else If . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 Use the Associate Method to Create Intersection Table Records . . . . . . . . . . . . . . . . . . . . 49 Use Dynamic Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 Use Logical Constants versus Literal Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 Avoid Exit Function and Exit Sub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 Place GotoView at the End of a Script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 Use DeleteRecord Method Properly . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED

4

SIEBEL SYSTEMS, INC. EMPLOYEE EDUCATION

MARCH 23, 2004

SIEBEL SCRIPTING BEST PRACTICES

Scripting Fundamentals
Scripting: Where to Begin
Basic Process Flow This flowchart outlines the basic process for developers to follow when writing script.

The objective is to minimize script—writing it only when necessary, and writing it once!

SIEBEL SYSTEMS, INC. EMPLOYEE EDUCATION

5

PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED

business components. 3. as they can be called by workflow processes. INC. developers must determine where to put the script. developers must determine the appropriate event within that object. Continued on next page SIEBEL SYSTEMS. Determine Where to Put the Script: Which Object? Before writing any script. This only makes sense if the method is specific to a particular business component. use the Pre. This is an important step! It ensures that developers write script only when there is no configuration alternative. thus minimizing the amount of script. Business component There are two ways to think of scripting a business component: proactively and reactively. workflow processes cannot call custom application level methods. Writing script at the business component level prevents developers from having to re-write it on applets that leverage the same underlying business component. Explore Declarative Configuration Alternatives 2. but do not need to change data in any record other than the current record. that business component is the most likely object for the script. and business services. if it is enabling a button or hiding/showing list columns or controls. A utility script that will be called from many locations such as applets.event (for example. PreWriteRecord). move the script to a business service and parameterize it. This enables developers to write the script once for use by many objects. Siebel Systems encourages developers to use business services. If the method facilitates interaction with the client’s desktop or communication with the user. This is a proactive approach: you are trying to stop or modify something the user is doing before it gets too far. make the script an applet browser script. If you need to perform some sort of validation. write the script at the applet server level. developers should explore all declarative configuration alternatives. After determining that the solution requires script. for example. PreSetFieldValue. If the method controls the behavior of an applet. Determine Where to Put the Script: Which Event? After determining the appropriate object. is best implemented as a business service. An alternative to writing a business service is to write the method at the application level. EMPLOYEE EDUCATION 6 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . If the method deals with data in a specific business component. If the same script is seen in many business components with only slight differences. PreQuery. 2004 SIEBEL SCRIPTING BEST PRACTICES Basic Process Flow 1.MARCH 23.

write the script on the applet. implement a reactive script. When taking a reactive approach. If the method deals with data specific to the business component. Rather. write a server script in the WebApplet_PreInvokeMethod event. Duplicating script is a common problem which frequently leads to thousands of pages of script! Since any script.event and does not roll back any changes to other objects. can call a business service. Determine Where to Put the Script: Which Event? Continued Never use Pre.event occurs before the Siebel application runs its own field-level validations and other processes in the underlying C++ class that might fail. This is quite often a workflow process or some sort of integration. for example. Applet Most scripting for applet browser functionality will originate in the Applet_PreInvokeMethod event. A reactive script typically applies to the WriteRecord event. break it into smaller scripts that the Service_PreInvokeMethod event of a business service can call.MARCH 23. even browser script. it is an ideal location for many situations. significantly simplifying maintenance efforts. the Siebel application exits the Pre. Ideally. however. This eliminates the need to duplicate code across objects and events. after the application writes a record. Continued on next page SIEBEL SYSTEMS. INC. it is acceptable to manipulate data in records other than the current record. write a method that can accept parameters to operate for a wide range of needs. 2004 SIEBEL SCRIPTING BEST PRACTICES Basic Process Flow. Rather. Business Service This is the best place to write script that will be called from anywhere. This is where developers can trap methods invoked on an applet. To perform further processing after a change has been applied.events to change data in a record other than the current record. If. the method deals with something specific to the applet. If the method accesses data in a record other than the current record or active business component. should originate in this event. The Pre. EMPLOYEE EDUCATION 7 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . Remember that you are trying to reduce the amount of script written. If these processes fail. or how the applet looks. the user. Siebel Systems recommends not putting all of the method script in the Service_PreInvokeMethod. Siebel Systems recommends not putting all of the method code in the Applet_PreInvokeMethod event. This could leave the application in an inconsistent state. Methods that interact with the user’s desktop. create custom methods and call those methods from this event. then the business component is the appropriate place for the method. Continued 3.

they have limited visibility: application-level browser script may only be called by other browser scripts. Therefore. Add Error Handling Template Put an error/exception handling strategy in place before writing any script. and application-level server script only works for server scripts. or to workflow processes. Applying the error handling skeleton to a method before writing the method.MARCH 23. Determine Where to Put the Script: Which Event? Continued The Application This is a good place for methods that need to fulfill the needs of many disparate calling scripts (as is a Business Service. This is the last and most important step of scripting. so that you can catch any runtime errors. as stated earlier). 5. Now you are ready to write the actual method. While application-level scripts do centralize methods. Workflow processes cannot access methods defined at the application level. 4. INC. “Sandwich” this code within the error handling code. When to use TheApplication event instead of a Business Service will depend on your requirements. assures two things: • error handling is present and • future manipulation of the method will not cause a runtime error that goes unnoticed. 2004 SIEBEL SCRIPTING BEST PRACTICES Basic Process Flow. Add Method Body 6. EMPLOYEE EDUCATION 8 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . covering all possible conditions. Continued 3. Failure to test completely results in more wasted time later trying to track down a bug. Test SIEBEL SYSTEMS. if requirements dictate that methods be visible to both server and browser script. implement the functionality as a business service. Make sure the tests are complete. This includes creating an error handling template that you can apply to all scripted events.

Declarative configuration is easier to maintain and upgrade. 2004 SIEBEL SCRIPTING BEST PRACTICES Scripting Best Practices When to Use Scripting Use Scripting as a Last Resort Do not write script if there is a way to implement the required functionality through configuration. Before writing any script.siebel. log on to Siebel University at http://siebeluniversity. INC. Preferred alternatives to scripting include • Field validation • User properties • Workflow • Personalization • Run-time events • State model SIEBEL SYSTEMS.MARCH 23. Siebel Systems highly recommends that you review the media-based training (MBT) titled Declarative Alternatives to Siebel Scripting. EMPLOYEE EDUCATION 9 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED .com. For more information about this MBT. leading to a lower total cost of ownership.

Data types Data Type Integer String Boolean Float Scope Scope Global Scope (only applicable for Siebel VB) Module/Instance Scope Function or Local Scope Modifier G_ M_ or i_ No modifier or l_ Prefix I S B f SIEBEL SYSTEMS. EMPLOYEE EDUCATION 10 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . INC.MARCH 23. This significantly simplifies maintenance and troubleshooting efforts. 2004 SIEBEL SCRIPTING BEST PRACTICES Follow Standard Naming Conventions Have the project team agree upon a standard way of naming variables so that the scope and data type are identified easily.

[BusComp_ChangeRecord] ' Evaluated and Reset here ' ' Static Vars: mintChecked Set to 0 in [Account]. comment lines that perform non-standard or complex behavior. If you do not maintain them along with the code.MARCH 23. EMPLOYEE EDUCATION 11 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . ' [BusComp_ChangeRecord] ' Evaluated and Set to 1 here ' ' NOTE: ' History Continued on next page Procedure might be called recursively!!! oBC1BusComp BusComp for ABC (positioned) oBC2BusComp BusComp for XYZ (not yet positioned) MyProcedure() BusComp [Account] ' SIEBEL SYSTEMS. project teams should agree upon standard commenting practice to ensure consistency. misleading. As well as adding a comment header. or incorrect. 2004 SIEBEL SCRIPTING BEST PRACTICES Comment Code Commenting code is a very good practice to explain the business purpose behind the code. Example of comment header: ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' ' Name: ' Module: ' Arguments: ' ' ' ' ' Return Value: Integer ContinueOperation -> Relationship is ' OK ' CancelOperation -> Relationship is ' not OK ' ' Used Globals: gintCheckIt Set to 1 in ' [Quote]. INC. Include a comment header at the top of a method with an explanation of the code and revision history. eventually they become confusing. Strictly maintain these headers so that they accurately reflect the script that they describe. At the onset of a project. and simplify the maintenance effort.

Continued ' Date AuthorPurpose ' 8/14/03SBoetigOriginal Creation ' ' Description: This procedure contacts Webline and retrieves ' a bunch of data that is stored on the ' Action BC in Siebel to maintain a sort of ' audit record. 2004 SIEBEL SCRIPTING BEST PRACTICES Comment Code. INC. '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' SIEBEL SYSTEMS.MARCH 23. EMPLOYEE EDUCATION 12 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED .

insert.MARCH 23. INC. EMPLOYEE EDUCATION 13 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . update. and delete operations • Access to data beyond the current record SIEBEL SYSTEMS. 2004 SIEBEL SCRIPTING BEST PRACTICES Know When to Use Browser versus Server Script 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.

without fearing orphaned records or an inconsistent state of the application. For example. therefore it is safe to create or modify data in other objects. PreSetFieldValue. (See “3. eScript examples BusComp_PreSetFieldValue BusComp_PreWriteRecord BusComp_SetFieldValue BusComp_WriteRecord Field level validation Record level validation Field triggered actions Record triggered actions Example: synchronizing two business components or creating activities BusComp_PreQuery Code control over SearchSpecs SIEBEL SYSTEMS. you know that the record exists. INC.events (such as PreQuery. EMPLOYEE EDUCATION 14 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . 2004 SIEBEL SCRIPTING BEST PRACTICES Place Code in the Correct Event Handler One of the most common issues identified during script reviews is the inappropriate use of object events. When this event fires.MARCH 23. and therefore are the appropriate events for such manipulation. and WriteRecord. the WriteRecord event fires after the record writes successfully. such as Query. occur after the internal and field-level validations succeed. Placing code in the wrong event handler can lead to corrupt data and may negatively impact performance. SetFieldValue. The companion events. and PreWriteRecord) to manipulate data in objects other than the one hosting the script. Do not use Siebel application Pre. Determine Where to Put the Script: Which Event?” on page 6 for more information).

Developers typically use script in the PreGetFieldValue event to return a value other than the one in the database. EMPLOYEE EDUCATION 15 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . and if none is available. to the user. look for a configuration alternative. as it may degrade application performance. This can amount to hundreds of calls to the event in rapid succession. the Siebel application exposes the calculated field. The PreGetFieldValue event fires at least once for every field that is retrieved. SIEBEL SYSTEMS. For other frequently fired events. More detail on this function and its suggested use can be found in the Siebel Bookshelf. As an alternative.MARCH 23. make the script as simple as possible. In this case. INC. Complex script in this event handler significantly degrades application performance. One alternative for complex calculations is to create a calculated field that uses the InvokeServiceMethod function. The calculated field holds the display value and the calculation performs the logic. developers can use a calculated field. not the actual field. such as BusComp_PreGetFieldValue. 2004 SIEBEL SCRIPTING BEST PRACTICES Use Fast Script In Event Handlers that Fire Frequently Avoid placing complex code in event handlers that fire frequently.

The drawback to a runtime business service is that anyone with access to the view can see the code. Because these business services are compiled. For clarity. the developer can choose whether the business service should remain as a runtime service or if it should be migrated to Siebel Tools. 2004 SIEBEL SCRIPTING BEST PRACTICES Runtime versus Compiled Business Services Business services may be defined in Siebel Tools and compiled with the .srf file. Runtime business services can be useful in a development environment to test frequent changes to scripts by using the business service simulator. Once the code is complete and tested through the simulator. The database stores them as records and you can change them at any time. This can pose a security problem. you should inactivate or delete the runtime version so that it is clear to all developers that the runtime version is no longer being used. You must compile and implement a new . Since no compiling is required. The decision on whether to make a business service compiled or runtime has no hard and fast rules. it uses the changes to the definition. Runtime business services are not compiled into the .srf file.srf file to implement any changes. or created as runtime business services in the client user interface. code development may be faster in the runtime environment. if you migrate a business service from a runtime version to a compiled version. the compiled version executes and the runtime version is ignored. The next time a runtime service executes. Note: If you define a business service called MyService as a runtime business service and as a compiled business service. It ultimately depends on what you intend the service to do and how frequently you expect the code in the business service to change. they provide more security than runtime services and they are faster to load. This makes them useful for logic that changes frequently and logic that you need to change without deploying a new . INC. Compiled business services are defined in Siebel Tools and represent a functionality that needs more security and is not likely to change.srf file.MARCH 23. SIEBEL SYSTEMS. EMPLOYEE EDUCATION 16 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED .

there is no performance impact. SIEBEL SYSTEMS. INC. EMPLOYEE EDUCATION 17 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . Example: if you defined a variable called ls_description. Option Explicit catches that a variable is being used that has not been defined. 2004 SIEBEL SCRIPTING BEST PRACTICES Use Option Explicit Include the Option Explicit in the <general> <declarations> section of every object containing Siebel VB code. Option Explicit requires that you explicitly declare every variable. thus simplifying debugging efforts. Without Option Explicit. the application defines a new variable as ls_dscription.MARCH 23. The compiler returns an error if the Siebel application uses a variable before declaration. the Siebel application defines and dimensions variables on the fly. and later reference the variable as ls_dscription (missing an ‘e’). Without Option Explicit. Since Option Explicit only evaluates during compile time.

Trace EL Events: traces which events are triggered (Set to 1) • OM . The RaiseErrorText method stops the execution of a script. developers or systems administrators can change settings in the object manager to trace events and SQL. INC. it is not always possible to add debugging statements to script.Trace EL SQL: traces the SQL generated by script (Set to 1) Continued on next page Alert and RaiseErrorText Using the Debugger in Siebel Tools Using Object Manager Settings SIEBEL SYSTEMS. In this situation. There are four basic techniques: • Use alerts or RaiseErrorText methods to pop up message boxes • Write to a file using Trace or custom methods • Use the Siebel Debugger • Use object manager level logging The alert method in browser script and the RaiseErrorText method in server script enable you to display message boxes to the user. Defined in the Component Parameters View: • OM . Writing to a Text File The most common way to debug a script is to write information to a text file. therefore. EMPLOYEE EDUCATION 18 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . Alerts do not stop the execution of browser scripts and therefore are a quick and easy way to debug browser scripts. it is only appropriate for a quick check of something and is not a good way to debug scripts where the source of the error is hard to determine. 2004 SIEBEL SCRIPTING BEST PRACTICES Leverage Appropriate Debugging Techniques Debugging Siebel Applications It is essential that you understand how to debug Siebel applications. SADMIN) • OM . When an application is in production. Accomplish this using the Trace function or an Siebel VB or eScript function. This is a useful tool for visually stepping through the code and looking at the values of variables real time.EL Tracing User Name: a comma separated list of logins to trace (for example. You can set break points anywhere until you isolate a problem. Using Trace.Trace EL Allocation: traces object memory allocation (Set to 1) • OM . you can write the actual SQL to a file.MARCH 23.

2004 SIEBEL SCRIPTING BEST PRACTICES Leverage Appropriate Debugging Techniques. Continued Using Object Manager Settings Continued Defined in the Component Event Configuration View: • Object Manager Extension Language Log: enables the scripting to be logged (Set to 1) This graphic shows the two locations in the Siebel client application where object manager logging is turned on.MARCH 23. modify the Current Value parameter. SIEBEL SYSTEMS. INC. For the log level changes to take effect immediately. EMPLOYEE EDUCATION 19 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED .

you can do an export from Siebel Tools to save a copy of the script.sif. with the object containing the script. INC. open the script editing window for the object in question.MARCH 23. empty methods can cause a small performance hit as the interpreter may run through the event handler unnecessarily. then choose File > Export. Remove Empty Methods Example of empty method in Siebel VB Sub Application_Start (CommandLine As String) End Sub The event handler for an empty method shows up as Active in Siebel Tools. Archive files contain all property definitions for the object. of file type .js or . whereas a . EMPLOYEE EDUCATION 20 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . SIEBEL SYSTEMS. The script for all methods on that object will be exported to a file of type . you can create an archive file. Also.sbl if it is written in Siebel VB. or .js if the script is written in eScript. This can be confusing to developers who think the event is scripted due to its Active status.sbl file only contains the script. To export a script to a text file. 2004 SIEBEL SCRIPTING BEST PRACTICES Remove Unused Code from the Repository Remove code that is: • Commented out • Set to Inactive • Never called If you want to keep a record of obsolete code before removing it. Alternatively.

• Finally block: performs any cleanup work such as destroying object references. • Catch block: captures the error. }//end try The try keyword precedes a block of normal processing code that may throw an exception... external COM objects or the OS Error Handling in eScript Implement eScript error handling through the try/catch/finally mechanism. which are difficult to understand. • Try block: contains the logic that you want performed. */ . covering all methods that access Siebel Objects.MARCH 23. Proper error handling: • Returns custom error messages that are easier for the user or developer to interpret • Is “bulletproof”. INC.executable code goes here. Continued on next page SIEBEL SYSTEMS... Example: function illustrateErrorHandling() { try { /*The try block encompasses all statements that could cause an exception. Without proper error handling. users may receive run-time errors from the interpreter. EMPLOYEE EDUCATION 21 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . 2004 SIEBEL SCRIPTING BEST PRACTICES Include Error Handling in All Scripts Proper Error Handling Proactive handling of errors or exceptions significantly streamlines debugging.

} else { TheApplication().errText)) { TheApplication(). After a try block throws an exception.toString()). control over the program flow switches to the first catch block following it.RaiseErrorText(“An exception occurred ” + “in the “ + arguments. EMPLOYEE EDUCATION 22 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . • arguments. “ + “ERROR: ” + e. Using these methods allows developers to copy this catch block into any eScript server script routine without changing it at all.RaiseErrorText(“An exception occurred ” + “in the “ + “ of the “ + } }//end catch arguments. Continued on next page SIEBEL SYSTEMS. The catch keyword precedes a block of exception handling code.Name() + “ object. 2004 SIEBEL SCRIPTING BEST PRACTICES Include Error Handling in All Scripts.callee + this.MARCH 23.callee + “ of the “ + this. “ + “ERROR: ” + e.Name() + “ object. Use two methods to avoid hard coding the object and method names. Continued Error Handling in eScript Continued catch(e) { if(defined(e.callee substitutes the method name in which the code is running.errText + “STACK: ” + e.toString()). • this. INC.Name() substitutes the object name in which the script is running.

boAccount = null. 2004 SIEBEL SCRIPTING BEST PRACTICES Include Error Handling in All Scripts. Continued on next page SIEBEL SYSTEMS. Siebel Systems recommends using On Error Goto <label> unless there is a compelling reason to use Resume Next. so it is an ideal location for the final release of resources. If no error handling is done immediately after Err object detects an error. INC. On Error Goto <label>: traps runtime errors in the Err object and transfers control immediately to the label specified. Continued Error Handling in eScript Continued finally { // // // This block will always be called whether an exception is thrown or not. Error Handling in Siebel VB There are two strategies for handling unexpected runtime errors in Visual Basic: 1. This is a dangerous form of error handling because it essentially ignores all errors.MARCH 23. EMPLOYEE EDUCATION 23 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . for example: bcContact = null. put the cleanup code here. 2. it will continue processing as if nothing happened. } The finally block always executes. after which the procedure may gracefully exit and inform the user of the error condition. It can perform code cleanup and write the error parameters to a log file. On Error Resume Next: traps the runtime error in the Err object and continues right along as though nothing happened.

GetBusComp(“Account”) errorhandler: Set lBC_test = Nothing Set lBO_test = Nothing If Err <> 0 Then TheApplication.RaiseErrorText “An error has occurred ”& _ “illustrateExceptionHandling method ” & Chr$(13) & _ "object.MARCH 23. or created by the Siebel application because of some runtime condition. Continued Error Handling in Siebel VB Continued Example of On Error Goto <Label> Sub illustrateExceptionHandling() ‘In the event of an error. 2004 SIEBEL SCRIPTING BEST PRACTICES Include Error Handling in All Scripts. raised by a function called in the script above. processing will immediately ‘transfer to the label “errorhandler” On Error GoTo errorhandler ‘Place code here that may experience an error Dim lBO_test Dim lBC_test As BusObject As BusComp Set lBO_test = TheApplication. SIEBEL SYSTEMS. INC. the Err variable will not contain zero. Whether created by developers in the script above. EMPLOYEE EDUCATION 24 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . Use the if condition to make sure that the Siebel application enters this error handling block only if an error occurred.GetBusObject(“Account”) Set lBC_test = lBO_test. " & Chr$(13) & _ "Error number: " & Err & Chr$(13) & _ "Error text: "Error line: End If " & Error$ & Chr$(13) & _ " & Erl Notice the use of Err object and Error function in the Application.RaiseErrorText function to retrieve error code and error text.

MARCH 23. which was available in version 6. EMPLOYEE EDUCATION 25 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . developers sometimes use RaiseError and RaiseErrorText to display message boxes via script. Therefore. RaiseError and RaiseErrorText methods generate a server script exception causing the script to stop executing at that point. SIEBEL SYSTEMS. however. it is important to place any code that must execute before calls to these methods. 2004 SIEBEL SCRIPTING BEST PRACTICES Use RaiseError and RaiseErrorText Properly In Siebel 7. these methods do not serve the same purpose as the MsgBox method. INC.x and earlier.

“STACK: ” SIEBEL SYSTEMS. • toString() method: exception.errText)) { TheApplication(). There are two types of information: • Error description: the description of what went wrong.callee + “ of the “ + this. EMPLOYEE EDUCATION 26 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED .callee + “ of the “ + this. you can obtain the method name dynamically from a native property of the method called “arguments”.MARCH 23. • Stack trace: the list of methods in the order in which they executed up to the line where the exception occurred. re-throw the exception Possibly. } else { TheApplication(). In eScript.toString()). “ + “ERROR: ” + e.errText • Populates when the Siebel application encounters an error during runtime or when the developer raises an exception using RaiseErrorText.Name() + “ object. “ + “ERROR: ” + e. INC.errText + + e.toString() • Provides exception information from a COM object or from an exception thrown by the developer using the throw statement. set a return code Exception Information in eScript In eScript. the exception object stores error information in the: • errText attribute: exception.toString()). Example: if(defined(e. This is an array of parameters specific to the method being invoked.RaiseErrorText(“An exception occurred ” + “in the “ + arguments. It • • • • • is the duty of the exception handling to Catch exceptions Stabilize the application Log exception information or notify the users of what happened Possibly. 2004 SIEBEL SCRIPTING BEST PRACTICES Use Exception Information Purpose of Exception Handling Do not ignore exceptions.Name() + “ object.RaiseErrorText(“An exception occurred ” + in the “ } Continued on next page + arguments. Ignoring them can cause other runtime errors to occur.

Continued Exception Information in Siebel VB In Siebel VB. INC.RaiseErrorText "An error has occurred " & _ “illustrateExceptionHandling method ” & Chr$(13) & _ "in the " & Me. Because Siebel VB does not include properties that store the method name. EMPLOYEE EDUCATION 27 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED .Name & _ " object. 2004 SIEBEL SCRIPTING BEST PRACTICES Use Exception Information. " & Chr$(13) & _ "Error number: " & Err & Chr$(13) & _ "Error text: "Error line: End If " & Error$ & Chr$(13) & _ " & Erl SIEBEL SYSTEMS. you must hard code the method name in the string passed to the RaiseErrorText method.MARCH 23. Example: If Err <> 0 Then TheApplication. the Err object stores the error information.

INC. When code in the finally clause causes an exception. null.Name() + " object. the exception information makes it out of the method.toString()). try { //executable code goes here myVar = 1.callee + " of the " + this. " + "ERROR: " + e. } else { TheApplication().RaiseErrorText("An exception occurred " + "in the " + " of the " + } }//end catch finally { //cleanup code goes here } return myVar. } catch(e) { if(defined(e.callee + this. SIEBEL SYSTEMS. These exceptions will not make it out of the method. EMPLOYEE EDUCATION 28 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . " + "ERROR: " + e. does something. and then returns a value. } arguments. A method takes input. Example: function illustrateReturnStatement() { var myVar. but the original exception information is lost. Ensure that the method itself contains the return statement.errText + "STACK: " + e. or an exception. 2004 SIEBEL SCRIPTING BEST PRACTICES Place Return Statements Correctly: eScript A return statement in the finally clause of a try/catch/finally block suppresses any exceptions generated in the method or thrown to the method.MARCH 23.toString()).RaiseErrorText("An exception occurred " + "in the " + arguments.errText)) { TheApplication().Name() + " object.

{ After adding the function to the (general) (declarations) section. Implement the method at the application level function trace_log(as_text) { . Assign a pointer for the method to the top object: • Include Top in (general) (declarations) of Application object top. can only be referenced from browser script. top is a shortcut to the top level document. This step assigns a function pointer to the top window object of the application. The following example provides a logging function in the top object: 1. Thus the top object.MARCH 23. being a browser script object.. 2. 2004 SIEBEL SCRIPTING BEST PRACTICES Centralize Browser Script Using the “Top” Object In browser script.. INC. Using the top object. This is useful for any function which needs to interact programmatically with a client application or desktop. developers can write a browser script function once and call it from anywhere within the browser aspect of objects. that would also need to be called from multiple places in the application. as shown below: Continued on next page SIEBEL SYSTEMS. EMPLOYEE EDUCATION 29 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . which any browser script can use. Note: Scripted objects have a server side aspect which can only call server script and a browser side aspect which can only call browser script.log = trace_log. you will see it appear as a separate function in the script window.include trace logic here.

EMPLOYEE EDUCATION 30 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . SIEBEL SYSTEMS. Call the method from any browser script. INC.MARCH 23. 2004 SIEBEL SCRIPTING BEST PRACTICES Centralize Browser Script Using the “Top” Object. Continued 3.

it may be preferable to use the UI context to avoid this message. bc = this. Note that when the current record is instantiated and modified in a non-UI context instance. 2004 SIEBEL SCRIPTING BEST PRACTICES Know When to Use the Current Context versus a New Context in Server Script Difference Between Current and New Context • • Current (or UI) context deals with objects that the Siebel application created to support data that are currently available to the user. bo = TheApplication. enabling data manipulation to occur outside of the current context. it is the business object that makes the difference.GetBusComp(“Contact”). This code returns a reference to the current instance of the Contact business component: bc = this. The difference here is the business object. In this previous code example. New (or Non-UI) context is a set of objects instantiated in script that have no tie to any objects or data that the user is currently viewing. If this code is executed while a user is watching the user interface. the application created a new instance of the Contact business object.BusObject().GetBusComp(“Contact”). Since all business components live within an enclosing business object’s context. Equivalent ways of getting a reference to the current Contact business component instance are bc = TheApplication().ActiveBusObject(). if the script is going to update the current record. the user sees any programmatic manipulations of the data. INC. instance of the Contact business component. To prevent users from seeing data manipulation that the script does. and a refresh is necessary for the user to see the current field values. For example. Therefore.GetBusComp(“Contact”).MARCH 23. or non-UI. This message appears because the script has modified the current record. the warning message “The selected record has been modified by another user since it was retrieved” will be displayed to the user. bc = bo. create a new. Keeping these two straight is important because the user may see programmatic manipulations of data if you use the wrong context. Continued on next page SIEBEL SYSTEMS. consider a script running in any event of the Contact business component that needs to get a reference to the Contact business component to do a comparison or lookup. EMPLOYEE EDUCATION 31 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED .GetBusComp(“Contact”).

INC. EMPLOYEE EDUCATION 32 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . Continued Guidelines for Choosing Context • Use the current context to • Access data with which the user is currently working • Perform processing that should be visible to the user Use a new context to • Invisibly query a visible business component • Use a business component in a different business object context • SIEBEL SYSTEMS.MARCH 23. 2004 SIEBEL SCRIPTING BEST PRACTICES Know When to Use the Current Context versus a New Context in Server Script.

While this is good for the purposes of instantiating an object only once. 3. Rules of encapsulation are usually violated. It is difficult to “understand” the scope or state of variables. Scripts often step on each other.MARCH 23. 2004 SIEBEL SCRIPTING BEST PRACTICES Use Smallest Possible Scope for Variables Developers frequently create instance level variables that can be accessed by many methods within an object. 1. This is done at the application level so that any script can access the objects. EMPLOYEE EDUCATION 33 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . INC. it is a bad practice for four reasons. 2. 4. because they are instantiated in one method and accessed in others. It is far better to declare and use objects where they are needed and pass them as parameters to other methods. There is no event that guarantees that the objects are always destroyed. SIEBEL SYSTEMS.

EMPLOYEE EDUCATION 34 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . Evaluate condition 2. INC. Use objects SIEBEL SYSTEMS.MARCH 23. Use objects Incorrect order 1. Create object instances that are needed based upon the outcome of an evaluation after that evaluation. 2004 SIEBEL SCRIPTING BEST PRACTICES Instantiate Objects Only As Needed Create object instances on an as-needed basis. your code may create unused object instances that can negatively impact performance. Otherwise. Evaluate condition 3. Create objects 2. Correct order 1. Create objects 3.

child objects first.MARCH 23. finally { ChildObject } = null. destroy an object by setting it to nothing (Set oBC = Nothing). that same script must destroy the object reference before leaving the method. SIEBEL SYSTEMS. In Siebel VB. EMPLOYEE EDUCATION 35 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . ParentObject = null. Object references are: • COM objects • Property Sets • Business Services • Business Components • Business Objects • Applets In eScript. Release objects in the reverse order in which the Siebel application created them. parent objects second. destroy an object by setting it to null (oBC = null). destroy objects in the finally clause as this clause always executes. INC. • Pick/Associate/MVG business components before the parent business component • Business components before business objects • No specific order for property sets and business services since they are independently created from the application Tightly couple object destruction with error handling to ensure that the Siebel application destroys objects in success and in failure. Therefore. regardless of whether the method exits successfully or with errors. so when a script creates an object reference. 2004 SIEBEL SCRIPTING BEST PRACTICES Destroy Object Variables When No Longer Needed Memory leaks are a common problem.

not all fields. Example: function BusComp_PreSetFieldValue(FieldName. … } … } SIEBEL SYSTEMS. EMPLOYEE EDUCATION 36 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . A typical example is in the BusComp_PreSetFieldValue event. INC. FieldValue) { switch(FieldName) { case “Status”: …do something… break. code should be run only as needed.MARCH 23. Code in this event is usually associated with a specific field. Check which field the code is modifying before going any further. 2004 SIEBEL SCRIPTING BEST PRACTICES Use Conditional Blocks To Run Code Just as objects should be instantiated only as needed.

Continued on next page ParentBusComp SIEBEL SYSTEMS. especially when calling methods such as ActiveBusObject. verify the active business component with a call to this method.BusObject (in an applet and in a business component) this. and ParentBusComp. INC. Always make sure that a business component reference obtained with the ParentBusComp method is valid and is the one expected. ActiveBusComp.ActiveBusObject. Script running in an applet or in a business component should use: • • Me. ParentBusComp returns the parent business component when given the child business component of a link. check which object is actually returned from a call to this method.Name = “some name” Then …code here……… End If ActiveBusComp ActiveBusComp returns the business component associated with the active applet. EMPLOYEE EDUCATION 37 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . When a business component can be the child of more than one business object.Name() == “some name”) { …code here… } Siebel VB Example: If TheApplication. The link that established a parent/child relationship in the business object has been removed or changed. ActiveBusObject only makes sense if used in a script running in the application object or in a business service. ActiveBusObject returns the business object for the business component of the active applet.ActiveBusObject(). (in an applet and in a business component) eScript Example: if(TheApplication().BusObject(). such as the Account business component in the Account business object. When running script outside of a business component.MARCH 23. Two situations could cause no reference to return: • • The business component is the parent and has no parent. 2004 SIEBEL SCRIPTING BEST PRACTICES Verify Objects Returned Verify Object Returned is Expected One ActiveBusObject Always verify that the object returned is the one expected.

the script is verifying that there is a reference before getting the Name attribute.MARCH 23. if(lBC_parent != null && lBC_parent. However. always verify the reference returned when calling ParentBusComp.Name = “some name” Then ………code…… End If In this example. Therefore.ParentBusComp If Not lBC_parent Is Nothing And lBC_Parent. SIEBEL SYSTEMS. no error is thrown.Name() == “some name”) { ……code…… } Siebel VB Example Set lBC_parent = Me. EMPLOYEE EDUCATION 38 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . Continued ParentBusComp Continued If no reference is returned from ParentBusComp. calling methods or referencing attributes on a null object will result in a runtime error.ParentBusComp(). INC. 2004 SIEBEL SCRIPTING BEST PRACTICES Verify Objects Returned. eScript Example var lBC_parent = this.

As a standalone statement. Created. GetFieldValue(<Name>). EMPLOYEE EDUCATION 39 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED .MARCH 23. ActivateField tells the Siebel application to include this database column in the next SQL statement it executes on the business component which just had a field activated. Server script field is Active if • System field (Id. ActivateField will not implicitly activate a nonactivated field. Created By. SIEBEL SYSTEMS. 2004 SIEBEL SCRIPTING BEST PRACTICES Verify Field is Active before Use Calling GetFieldValue or SetFieldValue on an inactive field may lead to lost data or logic going astray.⇓Incorrect use! after this. Updated By) • LinkSpec property on BC set to TRUE • Force Active property on BC set to TRUE • Included in applet definition on active view • Used in calculation of calculated field on active applet • Explicitly activated using BusComp. ExecuteQuery(ForwardOnly). The BC is not queried Correct Use ActivateField(<Name>). GetFieldValue(<Name>).ActivateField (strFldName) Browser script field is Active if • Id field • Fields visible in the UI Only use ActivateField if an ExecuteQuery statement succeeds it. Example: Incorrect Use ActivateField(<Name>). Updated. INC.

SetProperty(“Name". //activate the fields using the property set which has the //field names lbc_account. lPS_FieldNames. var ls_description. ""). var ls_name.SetProperty("Description".SetProperty("Agreement Name". lPS_FieldNames.SetProperty("Account Products". lPS_FieldNames. GetMultipleFieldValues.MARCH 23. ""). ""). EMPLOYEE EDUCATION 40 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . and the Mobile/ Dedicated Web Client Automation Server.NewPropertySet(). Example var lbc_account = this. lPS_FieldNames.NewPropertySet(). Continued on next page SIEBEL SYSTEMS. ""). var ls_account_products.SetProperty("Project Name". C++. Using these methods can help reduce redundant lines and make the program more readable. CORBA. These methods are best used when accessing Siebel applications through COM. Java. //set up the property set which will be used in all three //methods to hold the field names. lPS_FieldNames. ""). var ls_agreement_name. var lPS_FieldNames = TheApplication(). var lPS_FieldValues = TheApplication(). INC. 2004 SIEBEL SCRIPTING BEST PRACTICES Leverage New Methods in Siebel 7 New Methods ActivateMultipleFields.ActivateMultipleFields(lPS_FieldNames). var ls_project_name. and SetMultipleFieldValues are new methods in Siebel 7.

if (lbc_account. Continued on next page SIEBEL SYSTEMS. This method acts sort of like a business //service in that there is an input property set and an output //property set. "All My Products").GetProperty("Name").lPS_FieldValues). INC. lbc_account.FirstRecord()) { //retrieve the values. ls_agreement_name ls_project_name ls_description ls_name } //now set new values in the property set lPS_FieldNames. "Siebel Project #2").GetProperty("Project Name"). lPS_FieldNames. lPS_FieldNames.ExecuteQuery(ForwardOnly). //set the field values lbc_account.GetProperty("Agreement Name").SetProperty("Project Name". = lPS_FieldValues. = lPS_FieldValues. "This is the description"). //commit the data lbc_account. 2004 SIEBEL SCRIPTING BEST PRACTICES Leverage New Methods in Siebel 7.SetProperty("Description". = lPS_FieldValues. EMPLOYEE EDUCATION 41 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED .SetMultipleFieldValues(lPS_FieldNames). lPS_FieldNames. The field values will be in the second property set //passed in.GetProperty("Account Products"). //loop through property set to get values.GetMultipleFieldValues(lPS_FieldNames.WriteRecord().GetProperty("Description").SetProperty("Agreement Name". "Siebel Agreement").SetProperty(“Name". "Joey Joe Joe Junior Shabbidoo"). Continued New Methods Continued lbc_account.MARCH 23. lPS_FieldNames.SetProperty("Account Products". } = lPS_FieldValues. ls_account_products = lPS_FieldValues.

you would have to individually set the field values. INC. After calling the ExecuteQuery method. After setting the value using the SetProperty method. If you did not use SetMultipleFieldValues. 2004 SIEBEL SCRIPTING BEST PRACTICES Leverage New Methods in Siebel 7. SIEBEL SYSTEMS. If you did not use GetMultipleFields and ActivateMultipleFields. EMPLOYEE EDUCATION 42 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . you would have to individually activate or get each of the field values. Notice the use of SetMultipleFieldValues here. invoke GetMultipleFieldValues to get the field values. Continued New Methods Continued In this example.MARCH 23. the code creates lPS_FieldNames to hold the field names and lPS_FieldValues to hold the field values. invoke ActivateMultipleFields and the Siebel application passes the property set in as parameter.

causing a data integrity problem. Siebel VB Example: With bcAcct . EMPLOYEE EDUCATION 43 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . Setting view mode is especially important in an environment with mobile Web client users. For example.SetViewMode Me. Setting a query to AllView visibility mode gives the user access to all records. or should not be able to access. Mobile users have a subset of data in their local databases. the application may set the Primary ID to No Match Row ID if a child record does not exist on the local database. INC. such as resetting foreign keys. eScript Example: with (bcAcct) { SetViewMode(this.MARCH 23. unexpected behavior can occur. For example.GetViewMode()). which may be different than the view mode of the current view in the UI.GetViewMode SIEBEL SYSTEMS. This would give the user access to records the user might not need to access. This update has the potential to synchronize back up to the server. To avoid this issue. If you do not set the view mode correctly for limited visibility objects. 2004 SIEBEL SCRIPTING BEST PRACTICES Use Proper View Mode For Queries View mode settings control the formulation of the SQL WHERE clause that the Siebel application sends to the database by using team or position visibility to limit the records available in the business component queried in the script. use the GetViewMode method to determine the user’s visibility so that you can apply the same view mode in the query executed by the script. a user may have SalesRep visibility on the UI whereas the script will be giving the user All visibility.

as well as cover them in the exact index sequence order. as it produces table scans and temporary tables in the SQL execution plan. just as if they created them using configuration. INC. Sorting or searching on non-indexed fields can have detrimental effects on database performance. This encourages the database engine to use the index and may prevent unnecessary physical sorts in temporary tables. EMPLOYEE EDUCATION .SIEBEL SCRIPTING BEST PRACTICES MARCH 23. This is true of search and sort specifications that developers create in script. 2004 Query Only Indexed Columns To assist the database engine in efficiently retrieving and sorting data. especially on large tables. be sure that search and sort specs reference indexed columns whenever possible. ensure that such specifications cover the key columns of the desirable index. For best performance. PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED 44 SIEBEL SYSTEMS.

SIEBEL SYSTEMS. use ForwardOnly cursor mode. The system will not need to create the cache.MARCH 23. 2004 SIEBEL SCRIPTING BEST PRACTICES Use ForwardOnly Cursor Mode If you do not specify a cursor mode when querying with Siebel eScript or Siebel VB. This is particularly true if you perform a look up or if you access a pick list. Example: bcAccount.ExecuteQuery(ForwardOnly). INC. the Siebel application uses the default cursor mode of ForwardBackward. To support this cursor mode. the system creates a cache to maintain the entire record set. EMPLOYEE EDUCATION 45 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . improving performance. If you will traverse through the record set from FirstRecord using NextRecord and will not return to a previous record.

ClearToQuery().SetSearchSpec(“Id”. 2004 SIEBEL SCRIPTING BEST PRACTICES Verify Existence of Valid Record After Querying When performing a query.MARCH 23. EMPLOYEE EDUCATION 46 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED .ExecuteQuery(ForwardOnly). always check that a record is returned through the use of FirstRecord. sContactId). INC. bcContact. before attempting to retrieve or set a field value for the record. if (bcContact. Do this even if it seems impossible that a record will not return. bcContact. or LastRecord methods. NextRecord. Example: bcContact. //Check to see that a record was actually returned //by examining the return of FirstRecord().FirstRecord()) { //okay to perform data processing… } SIEBEL SYSTEMS.

sGrade = ‘B’. EMPLOYEE EDUCATION 47 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . then compared to different values. the fastest and most readable way of doing this is to use switch (eScript) or select case (Siebel VB). Using switch or select case statements can frequently compact multiple pages of script into a single page. case 2: else sGrade = ‘B’. When using switch or select case. if(iNum ==2) break. not just the most obvious ones. It is easier to read than a series of nested if…else if statements. SIEBEL SYSTEMS. • • It is more efficient because the expression is evaluated once. 2004 SIEBEL SCRIPTING BEST PRACTICES Use Switch or Select Case Statements When you need to evaluate and compare a single expression with many different possibilities. Logic errors can occur in code that does not consider all possible conditions. } Tip: In eScript. case 3: sGrade = ‘C’. break. if(iNum == 3) sGrade = ‘C’. Reaching the next keyword case will end the previous case. eScript Example: Instead of Use switch(iNum) If(iNum == 1) { sGrade = ‘A’. the keyword break is necessary to end a particular case. case 1: else sGrade = ‘A’. Otherwise. code falls through to the next case without stopping.MARCH 23. INC. Consider using default or case else to hold a default set of behaviors that should occur if none of the stated conditions is met. be sure to test all conditions. Siebel VB does not require a break statement.

if (ls_first == “first”) { ……do something…… } else if (ls_second == “second”) { …………do something else……… } In the example above. EMPLOYEE EDUCATION 48 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . but the logic of only the first condition will execute. Example: var ls_first var ls_second = “first”. INC. Both evaluate to true. more than one case could be true at the same time. but only one condition will execute. = “second”. Logic errors may occur in code if you do not consider all possibilities. Otherwise. not just the most obvious ones. be sure to test all conditions. the code evaluates two conditions: ls_first and ls_second. If/else if blocks evaluate every condition until the first one evaluates to true.MARCH 23. As with switch and select case. 2004 SIEBEL SCRIPTING BEST PRACTICES Compare the Same Condition In If/Else If Verify that if/else if conditions compare a single expression. SIEBEL SYSTEMS. Then that condition executes and the code ignores the others.

var lBC_associate = lBC_mvg.GetAssocBusComp(). if(FirstRecord()) Associate(NewAfter). 2004 SIEBEL SCRIPTING BEST PRACTICES Use the Associate Method to Create Intersection Table Records Use the Associate method to create records in an intersection table.MARCH 23. This method automatically and correctly creates new records. with(lBC_associate) { ClearToQuery(). SetSearchSpec(“Id”. Example: var lBC_mvg = this.GetMVGBusComp(“Sales Rep”). ExecuteQuery(ForwardOnly). unaware of this method. Developers. SomeRowId). } SIEBEL SYSTEMS. INC. frequently try to implement the functionality with many lines of script when a single call to the Associate method will work. EMPLOYEE EDUCATION 49 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED .

SIEBEL SCRIPTING BEST PRACTICES MARCH 23. if (bcLOV.GetProfileAttr() function. as opposed to hard coded values. bcLOV = boLOV. the LOV values are queried from the List Of Values buscomp. wherever possible. if you are writing an error handling script and want to pass the application name. while (moreRecords != 0) { statusList = statusList + " OR ". or a short list that will fit within one LOV entry.ClearToQuery(). you can store values in the List Of Values table or other database tables and query for them at runtime. EMPLOYEE EDUCATION . } } else { statusList = ""."Y"). This is particularly important for values that may change often. use the LookupValue function to retrieve the value. INC. bcLOV. In the following example.GetBusObject("List Of Values"). the script can query directly on the List Of Values business component. If you need to store multiple LOV values with a common LOV Type. boLOV = TheApplication(). bcLOV. boLOV. If you have one value.FirstRecord()) { statusList = bcLOV. moreRecords = bcLOV. bcLOV. because you must recompile and redeploy any changes to hard-coded values. 2004 Use Dynamic Values Use dynamic values. you can use: TheApplication.NextRecord(). } PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED 50 SIEBEL SYSTEMS.GetProfileAttr("ApplicationName") Alternatively.SetSearchSpec("Type".GetBusComp("List Of Values"). For example.GetFieldValue("Name"). bcLOV. bcLOV.NextRecord(). then concatenated together to form a query filter string. statusList = statusList + bcLOV.GetFieldValue("Name"). Many commonly used values in scripting are available as process properties which can be obtained with the TheApplication.ExecuteQuery(ForwardOnly). This is most appropriate when there is only one dynamic value or a short list of values which you need to query for in the script."SR_STATUS"). Example: var var var var statusList. moreRecords = bcLOV.SetSearchSpec("Active". moreRecords. Using LookupValue is especially important if you have implemented Multilingual List of Values (MLOV).

Literal values are prone to upgrade problems as Siebel applications could change the behavior behind a literal value. Type CursorMode: ViewMode: Logical Constant ForwardBackward ForwardOnly SalesRep View ManagerView PersonalView AllView OrganizationView ContactView GroupView CatalogView SubOrganizationView NewRecordLocation: NewBefore NewAfter NewBeforeCopy NewAfterCopy Value 0 (default) 1 0 1 2 3 5 6 7 8 9 0 (default) 1 2 3 SIEBEL SYSTEMS.NewRecord(1). EMPLOYEE EDUCATION 51 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . It makes your code easier to read and easier to upgrade. INC. future developers reading this script will have to look up what 1 means. Most likely. Also. Example: bc. Using the logical constant alleviates both of these issues.MARCH 23. These are the most commonly used logical constants and their literal values. 2004 SIEBEL SCRIPTING BEST PRACTICES Use Logical Constants versus Literal Values Always use logical constants where they are available. if Siebel Systems were to change what this literal value does in the NewRecord method in the C++ class. The above line of code is better implemented as: bc. this code may not behave as expected.NewRecord(NewAfter).

SIEBEL SYSTEMS. developers have to duplicate this code in many locations. INC. When a script exits abruptly. It is easier to follow and maintain a script with one exit point. object references are not released unless explicitly written that way. multiple exit points increase the chance of memory leaks from not properly destroying objects. it is difficult to follow the flow of a script with multiple exit points. 2004 SIEBEL SCRIPTING BEST PRACTICES Avoid Exit Function and Exit Sub There are two general objections to using Exit Sub or Exit Function in Siebel VB. First.MARCH 23. In methods where there are many exit points. Second. EMPLOYEE EDUCATION 52 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED .

For example. EMPLOYEE EDUCATION 53 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . the script executes the method regardless of where it appeared in the script. Therefore. Rather. the script holds the statement aside until the entire script executes. as the last statement. if the first statement in a script is a GotoView statement. it will not execute until all other code executes. Finally. 2004 SIEBEL SCRIPTING BEST PRACTICES Place GotoView at the End of a Script The GotoView statement does not immediately exit a script and navigate to the specified view. SIEBEL SYSTEMS. it is good practice to place GotoView statements at the end of a script.MARCH 23. INC. to represent what actually happens.

EMPLOYEE EDUCATION . INC. This means that the Siebel application skips a record in the result set. If it is deleting records within a loop. The following example illustrates the recommended approach for deleting records within a loop.DeleteRecord Wend PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED 54 SIEBEL SYSTEMS.SIEBEL SCRIPTING BEST PRACTICES MARCH 23.FirstRecord <> 0) BC. Siebel VB While(BC. 2004 Use DeleteRecord Method Properly DeleteRecord implicitly moves the record pointer to the next record in the record set. the Siebel application skips every other record. A call to NextRecord after DeleteRecord causes the record pointer to move twice.

Sign up to vote on this title
UsefulNot useful