P. 1
Technote-Scripting Best Practices

Technote-Scripting Best Practices

|Views: 17|Likes:
Published by Chandra Kanth

More info:

Published by: Chandra Kanth on Sep 14, 2010
Copyright:Attribution Non-commercial

Availability:

Read on Scribd mobile: iPhone, iPad and Android.
download as PDF, TXT or read online from Scribd
See more
See less

10/31/2011

pdf

text

original

Sections

  • Scripting: Where to Begin
  • Basic Process Flow
  • Scripting Best Practices
  • When to Use Scripting
  • 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
  • Remove Unused Code from the Repository
  • Include Error Handling in All Scripts
  • Use RaiseError and RaiseErrorText Properly
  • Use Exception Information
  • Place Return Statements Correctly: eScript
  • Centralize Browser Script Using the “Top” Object
  • Know When to Use the Current Context versus a New Context in Server Script
  • Use Smallest Possible Scope for Variables
  • Instantiate Objects Only As Needed
  • Destroy Object Variables When No Longer Needed
  • Use Conditional Blocks To Run Code
  • Verify Objects Returned
  • Verify Field is Active before Use
  • Leverage New Methods in Siebel 7
  • Use Proper View Mode For Queries
  • Query Only Indexed Columns
  • Use ForwardOnly Cursor Mode
  • Verify Existence of Valid Record After Querying
  • Use Switch or Select Case Statements
  • Compare the Same Condition In If/Else If
  • Use the Associate Method to Create Intersection Table Records
  • Use Dynamic Values
  • Use Logical Constants versus Literal Values
  • Avoid Exit Function and Exit Sub
  • Place GotoView at the End of a Script
  • Use DeleteRecord Method Properly

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

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

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

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

com. leading to a lower total cost of ownership. EMPLOYEE EDUCATION 9 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . 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. log on to Siebel University at http://siebeluniversity. INC. Declarative configuration is easier to maintain and upgrade. Before writing any script. Preferred alternatives to scripting include • Field validation • User properties • Workflow • Personalization • Run-time events • State model SIEBEL SYSTEMS. For more information about this MBT.MARCH 23.siebel. Siebel Systems highly recommends that you review the media-based training (MBT) titled Declarative Alternatives to Siebel Scripting.

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. 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. EMPLOYEE EDUCATION 10 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED .

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

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. INC. EMPLOYEE EDUCATION 13 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . update.MARCH 23. insert.

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

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

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

thus simplifying debugging efforts. the application defines a new variable as ls_dscription. EMPLOYEE EDUCATION 17 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . and later reference the variable as ls_dscription (missing an ‘e’). SIEBEL SYSTEMS. The compiler returns an error if the Siebel application uses a variable before declaration.MARCH 23. Since Option Explicit only evaluates during compile time. Without Option Explicit. 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. Option Explicit requires that you explicitly declare every variable. the Siebel application defines and dimensions variables on the fly. Without Option Explicit. Option Explicit catches that a variable is being used that has not been defined. there is no performance impact. Example: if you defined a variable called ls_description.

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

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

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

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

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

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

INC. or created by the Siebel application because of some runtime condition. 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.RaiseErrorText function to retrieve error code and error text.MARCH 23. the Err variable will not contain zero. EMPLOYEE EDUCATION 24 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED .GetBusComp(“Account”) errorhandler: Set lBC_test = Nothing Set lBO_test = Nothing If Err <> 0 Then TheApplication. Continued Error Handling in Siebel VB Continued Example of On Error Goto <Label> Sub illustrateExceptionHandling() ‘In the event of an error.RaiseErrorText “An error has occurred ”& _ “illustrateExceptionHandling method ” & Chr$(13) & _ "object.GetBusObject(“Account”) Set lBC_test = lBO_test. SIEBEL SYSTEMS. Use the if condition to make sure that the Siebel application enters this error handling block only if an error occurred. Whether created by developers in the script above. " & 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 25 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . 2004 SIEBEL SCRIPTING BEST PRACTICES Use RaiseError and RaiseErrorText Properly In Siebel 7. developers sometimes use RaiseError and RaiseErrorText to display message boxes via script.MARCH 23. it is important to place any code that must execute before calls to these methods. however. these methods do not serve the same purpose as the MsgBox method.x and earlier. Therefore. RaiseError and RaiseErrorText methods generate a server script exception causing the script to stop executing at that point. which was available in version 6. INC. SIEBEL SYSTEMS.

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

Example: If Err <> 0 Then TheApplication. Continued Exception Information in Siebel VB In Siebel VB. 2004 SIEBEL SCRIPTING BEST PRACTICES Use Exception Information.MARCH 23. 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. " & Chr$(13) & _ "Error number: " & Err & Chr$(13) & _ "Error text: "Error line: End If " & Error$ & Chr$(13) & _ " & Erl SIEBEL SYSTEMS. EMPLOYEE EDUCATION 27 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED .Name & _ " object.RaiseErrorText "An error has occurred " & _ “illustrateExceptionHandling method ” & Chr$(13) & _ "in the " & Me. the Err object stores the error information. INC.

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

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

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

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

INC. 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. EMPLOYEE EDUCATION 32 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED .

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

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

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

INC. Example: function BusComp_PreSetFieldValue(FieldName. not all fields. code should be run only as needed. Check which field the code is modifying before going any further. … } … } 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.MARCH 23. FieldValue) { switch(FieldName) { case “Status”: …do something… break. Code in this event is usually associated with a specific field. EMPLOYEE EDUCATION 36 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED .

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

Therefore. SIEBEL SYSTEMS. EMPLOYEE EDUCATION 38 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . the script is verifying that there is a reference before getting the Name attribute. always verify the reference returned when calling ParentBusComp. INC. calling methods or referencing attributes on a null object will result in a runtime error. if(lBC_parent != null && lBC_parent.MARCH 23.Name() == “some name”) { ……code…… } Siebel VB Example Set lBC_parent = Me. However.Name = “some name” Then ………code…… End If In this example. no error is thrown. 2004 SIEBEL SCRIPTING BEST PRACTICES Verify Objects Returned.ParentBusComp(). Continued ParentBusComp Continued If no reference is returned from ParentBusComp.ParentBusComp If Not lBC_parent Is Nothing And lBC_Parent. eScript Example var lBC_parent = 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. INC. ExecuteQuery(ForwardOnly). Created.MARCH 23. As a standalone statement. Server script field is Active if • System field (Id. Created By. Example: Incorrect Use ActivateField(<Name>). Updated. 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. GetFieldValue(<Name>). SIEBEL SYSTEMS. EMPLOYEE EDUCATION 39 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . 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. 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. ActivateField will not implicitly activate a nonactivated field.⇓Incorrect use! after this. The BC is not queried Correct Use ActivateField(<Name>).

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

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

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

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

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

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

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

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

the code evaluates two conditions: ls_first and ls_second. SIEBEL SYSTEMS. but the logic of only the first condition will execute. EMPLOYEE EDUCATION 48 PROPRIETARY & CONFIDENTIAL DUPLICATION PROHIBITED . more than one case could be true at the same time. INC. Otherwise. Both evaluate to true. Then that condition executes and the code ignores the others. not just the most obvious ones. 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. Example: var ls_first var ls_second = “first”. but only one condition will execute.MARCH 23. if (ls_first == “first”) { ……do something…… } else if (ls_second == “second”) { …………do something else……… } In the example above. be sure to test all conditions. If/else if blocks evaluate every condition until the first one evaluates to true. Logic errors may occur in code if you do not consider all possibilities. = “second”.

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

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

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

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

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

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

You're Reading a Free Preview

Download
scribd
/*********** DO NOT ALTER ANYTHING BELOW THIS LINE ! ************/ var s_code=s.t();if(s_code)document.write(s_code)//-->