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

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

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

covering all possible conditions. as stated earlier). Test SIEBEL SYSTEMS. This is the last and most important step of scripting. Therefore. 2004 SIEBEL SCRIPTING BEST PRACTICES Basic Process Flow. Add Error Handling Template Put an error/exception handling strategy in place before writing any script. EMPLOYEE EDUCATION 8 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . if requirements dictate that methods be visible to both server and browser script. Workflow processes cannot access methods defined at the application level. Make sure the tests are complete. “Sandwich” this code within the error handling code. implement the functionality as a business service. Now you are ready to write the actual method. 4. Applying the error handling skeleton to a method before writing the method. This includes creating an error handling template that you can apply to all scripted events. Failure to test completely results in more wasted time later trying to track down a bug. Continued 3. While application-level scripts do centralize methods. 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. they have limited visibility: application-level browser script may only be called by other browser scripts. 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. and application-level server script only works for server scripts. Add Method Body 6. so that you can catch any runtime errors.MARCH 23. 5. INC. or to workflow processes.

Before writing any script.MARCH 23. For more information about this MBT. 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.com.siebel. INC. Preferred alternatives to scripting include • Field validation • User properties • Workflow • Personalization • Run-time events • State model SIEBEL SYSTEMS. Declarative configuration is easier to maintain and upgrade. leading to a lower total cost of ownership. 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 . log on to Siebel University at http://siebeluniversity.

MARCH 23. 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. 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. This significantly simplifies maintenance and troubleshooting efforts. EMPLOYEE EDUCATION 10 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . INC.

comment lines that perform non-standard or complex behavior. At the onset of a project.MARCH 23. ' [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. 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]. EMPLOYEE EDUCATION 11 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED .[BusComp_ChangeRecord] ' Evaluated and Reset here ' ' Static Vars: mintChecked Set to 0 in [Account]. and simplify the maintenance effort. Include a comment header at the top of a method with an explanation of the code and revision history. misleading. project teams should agree upon standard commenting practice to ensure consistency. 2004 SIEBEL SCRIPTING BEST PRACTICES Comment Code Commenting code is a very good practice to explain the business purpose behind the code. eventually they become confusing. Strictly maintain these headers so that they accurately reflect the script that they describe. If you do not maintain them along with the code. INC. or incorrect. As well as adding a comment header.

'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' SIEBEL SYSTEMS.MARCH 23. EMPLOYEE EDUCATION 12 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . 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.

insert. INC.MARCH 23. 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. EMPLOYEE EDUCATION 13 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . and delete operations • Access to data beyond the current record SIEBEL SYSTEMS. update.

INC. SetFieldValue. 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. and WriteRecord. When this event fires. therefore it is safe to create or modify data in other objects. PreSetFieldValue. you know that the record exists. 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. and therefore are the appropriate events for such manipulation. the WriteRecord event fires after the record writes successfully. and PreWriteRecord) to manipulate data in objects other than the one hosting the script.events (such as PreQuery. (See “3. such as Query. occur after the internal and field-level validations succeed. EMPLOYEE EDUCATION 14 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . Do not use Siebel application Pre. Placing code in the wrong event handler can lead to corrupt data and may negatively impact performance. For example.MARCH 23. without fearing orphaned records or an inconsistent state of the application. Determine Where to Put the Script: Which Event?” on page 6 for more information). The companion events.

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

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

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

Writing to a Text File The most common way to debug a script is to write information to a text file. The RaiseErrorText method stops the execution of a script. INC. Accomplish this using the Trace function or an Siebel VB or eScript function. Using Trace. 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.Trace EL Events: traces which events are triggered (Set to 1) • OM . When an application is in production. therefore. 2004 SIEBEL SCRIPTING BEST PRACTICES Leverage Appropriate Debugging Techniques Debugging Siebel Applications It is essential that you understand how to debug Siebel applications.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. Defined in the Component Parameters View: • OM . Alerts do not stop the execution of browser scripts and therefore are a quick and easy way to debug browser scripts. You can set break points anywhere until you isolate a problem.EL Tracing User Name: a comma separated list of logins to trace (for example. EMPLOYEE EDUCATION 18 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . it is not always possible to add debugging statements to script. you can write the actual SQL to a file. This is a useful tool for visually stepping through the code and looking at the values of variables real time. SADMIN) • OM . 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.Trace EL Allocation: traces object memory allocation (Set to 1) • OM . In this situation. developers or systems administrators can change settings in the object manager to trace events and SQL.MARCH 23.

EMPLOYEE EDUCATION 19 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . SIEBEL SYSTEMS. INC.MARCH 23. For the log level changes to take effect immediately. 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. 2004 SIEBEL SCRIPTING BEST PRACTICES Leverage Appropriate Debugging Techniques. modify the Current Value parameter.

SIEBEL SYSTEMS. open the script editing window for the object in question. you can create an archive file.sbl if it is written in Siebel VB. then choose File > Export. This can be confusing to developers who think the event is scripted due to its Active status. The script for all methods on that object will be exported to a file of type . INC. 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. you can do an export from Siebel Tools to save a copy of the script.js or . To export a script to a text file. Also. of file type .sbl file only contains the script.sif. EMPLOYEE EDUCATION 20 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . Archive files contain all property definitions for the object. Alternatively. or . empty methods can cause a small performance hit as the interpreter may run through the event handler unnecessarily. with the object containing the script.MARCH 23. 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.js if the script is written in eScript. whereas a .

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

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

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

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

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

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

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

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

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

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

bc = this. instance of the Contact business component. This message appears because the script has modified the current record. EMPLOYEE EDUCATION 31 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED .MARCH 23. Note that when the current record is instantiated and modified in a non-UI context instance. bc = bo. INC. Therefore. Continued on next page SIEBEL SYSTEMS. bo = TheApplication. 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.BusObject(). The difference here is the business object. it is the business object that makes the difference.GetBusComp(“Contact”). it may be preferable to use the UI context to avoid this message. the warning message “The selected record has been modified by another user since it was retrieved” will be displayed to the user. For example. This code returns a reference to the current instance of the Contact business component: bc = this. Keeping these two straight is important because the user may see programmatic manipulations of data if you use the wrong context. and a refresh is necessary for the user to see the current field values. 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. if the script is going to update the current record. If this code is executed while a user is watching the user interface. Equivalent ways of getting a reference to the current Contact business component instance are bc = TheApplication(). the application created a new instance of the Contact business object. To prevent users from seeing data manipulation that the script does. create a new. In this previous code example. enabling data manipulation to occur outside of the current context. the user sees any programmatic manipulations of the data. or non-UI.GetBusComp(“Contact”).GetBusComp(“Contact”). 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.GetBusComp(“Contact”). Since all business components live within an enclosing business object’s context.ActiveBusObject().

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. 2004 SIEBEL SCRIPTING BEST PRACTICES Know When to Use the Current Context versus a New Context in Server Script. EMPLOYEE EDUCATION 32 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED .MARCH 23. INC.

MARCH 23. it is a bad practice for four reasons. 1. 2. 4. 3. EMPLOYEE EDUCATION 33 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . because they are instantiated in one method and accessed in others. Scripts often step on each other. INC. It is far better to declare and use objects where they are needed and pass them as parameters to other methods. It is difficult to “understand” the scope or state of variables. SIEBEL SYSTEMS. This is done at the application level so that any script can access the objects. Rules of encapsulation are usually violated. 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. There is no event that guarantees that the objects are always destroyed. While this is good for the purposes of instantiating an object only once.

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

Therefore. regardless of whether the method exits successfully or with errors. Object references are: • COM objects • Property Sets • Business Services • Business Components • Business Objects • Applets In eScript. destroy objects in the finally clause as this clause always executes. EMPLOYEE EDUCATION 35 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED .MARCH 23. destroy an object by setting it to null (oBC = null). In Siebel VB. child objects first. • 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. parent objects second. 2004 SIEBEL SCRIPTING BEST PRACTICES Destroy Object Variables When No Longer Needed Memory leaks are a common problem. so when a script creates an object reference. Release objects in the reverse order in which the Siebel application created them. ParentObject = null. INC. destroy an object by setting it to nothing (Set oBC = Nothing). SIEBEL SYSTEMS. finally { ChildObject } = null. that same script must destroy the object reference before leaving the method.

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

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

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

The BC is not queried Correct Use ActivateField(<Name>). SIEBEL SYSTEMS.MARCH 23. ActivateField will not implicitly activate a nonactivated field.ActivateField (strFldName) Browser script field is Active if • Id field • Fields visible in the UI Only use ActivateField if an ExecuteQuery statement succeeds it. GetFieldValue(<Name>). Created. Created By. Example: Incorrect Use ActivateField(<Name>). EMPLOYEE EDUCATION 39 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . INC. 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. GetFieldValue(<Name>). 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. 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. Updated. As a standalone statement. Server script field is Active if • System field (Id. ExecuteQuery(ForwardOnly).⇓Incorrect use! after this.

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

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

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

eScript Example: with (bcAcct) { SetViewMode(this. Setting view mode is especially important in an environment with mobile Web client users. INC. Mobile users have a subset of data in their local databases. For example. which may be different than the view mode of the current view in the UI. If you do not set the view mode correctly for limited visibility objects.MARCH 23. a user may have SalesRep visibility on the UI whereas the script will be giving the user All visibility. 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. EMPLOYEE EDUCATION 43 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED .SetViewMode Me.GetViewMode SIEBEL SYSTEMS. or should not be able to access. the application may set the Primary ID to No Match Row ID if a child record does not exist on the local database. 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. To avoid this issue. such as resetting foreign keys.GetViewMode()). unexpected behavior can occur. Siebel VB Example: With bcAcct . causing a data integrity problem. For example. This update has the potential to synchronize back up to the server. Setting a query to AllView visibility mode gives the user access to all records. This would give the user access to records the user might not need to access.

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

The system will not need to create the cache. SIEBEL SYSTEMS. 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. INC. EMPLOYEE EDUCATION 45 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . If you will traverse through the record set from FirstRecord using NextRecord and will not return to a previous record. improving performance. This is particularly true if you perform a look up or if you access a pick list. To support this cursor mode. Example: bcAccount.ExecuteQuery(ForwardOnly). use ForwardOnly cursor mode.MARCH 23. the Siebel application uses the default cursor mode of ForwardBackward. the system creates a cache to maintain the entire record set.

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

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

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

} SIEBEL SYSTEMS. SomeRowId). 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. if(FirstRecord()) Associate(NewAfter). with(lBC_associate) { ClearToQuery(). ExecuteQuery(ForwardOnly). var lBC_associate = lBC_mvg.GetMVGBusComp(“Sales Rep”). Example: var lBC_mvg = this. unaware of this method.MARCH 23. frequently try to implement the functionality with many lines of script when a single call to the Associate method will work.GetAssocBusComp(). This method automatically and correctly creates new records. Developers. INC. SetSearchSpec(“Id”. EMPLOYEE EDUCATION 49 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED .

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

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. Most likely.MARCH 23. this code may not behave as expected. Using the logical constant alleviates both of these issues.NewRecord(1). Also. if Siebel Systems were to change what this literal value does in the NewRecord method in the C++ class. Example: bc. future developers reading this script will have to look up what 1 means. It makes your code easier to read and easier to upgrade. These are the most commonly used logical constants and their literal values. EMPLOYEE EDUCATION 51 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . 2004 SIEBEL SCRIPTING BEST PRACTICES Use Logical Constants versus Literal Values Always use logical constants where they are available. Literal values are prone to upgrade problems as Siebel applications could change the behavior behind a literal value.NewRecord(NewAfter). The above line of code is better implemented as: bc. INC.

When a script exits abruptly. 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. multiple exit points increase the chance of memory leaks from not properly destroying objects. SIEBEL SYSTEMS. object references are not released unless explicitly written that way. developers have to duplicate this code in many locations. It is easier to follow and maintain a script with one exit point.MARCH 23. First. In methods where there are many exit points. INC. EMPLOYEE EDUCATION 52 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . Second. it is difficult to follow the flow of a script with multiple exit points.

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. EMPLOYEE EDUCATION 53 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . SIEBEL SYSTEMS.MARCH 23. Rather. the script executes the method regardless of where it appeared in the script. INC. Therefore. it is good practice to place GotoView statements at the end of a script. Finally. it will not execute until all other code executes. the script holds the statement aside until the entire script executes. if the first statement in a script is a GotoView statement. For example. to represent what actually happens. as the last statement.

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

Sign up to vote on this title
UsefulNot useful