Siebel Scripting 4

Siebel Scripting, Part Four Scripting Concepts: Advanced

Introduction BusComps and BusObjects PropertySets TheApplication Business Services Scripting In Applets Using Windows Script Popups Garbage Disposal Final Thoughts

BusComps And BusObjects The BusComp is a central object used in Siebel Scripting It represents a Siebel Business Component Has Child Objects, such as Fields Must have a BusObject to create a BusComp

BusObjects Represent the Siebel Business Object Two ways to create: – Both created using TheApplication object

ActiveBusObject – Any BusComps created from this way will have data in them

GetBusObject (“BusObjName”) – BusComps created from this will be empty, and must be filled before they can be used

ActiveBusObject Syntax eScript – –

var boContact = TheApplication().ActiveBusObject(); var bcContact = boContact.GetBusComp(“Contact”);

Siebel VB – – – –

Dim boContact As BusObject Dim bcContact As BusCOmp Set boContact = TheApplication.ActiveBusObject Set bcContact = boContact.GetBusComp(“Contact”)

bcContact will have data in it, because it is based on the Active Business Object Generally used only in script on an Applet

GetBusObject Syntax eScript – –

var boContact = TheApplication().GetBusObject(“Contact”); var bcContact = boContact.GetBusComp(“Contact”);

Siebel VB – – – –

Dim boContact As BusObject Dim bcContact As BusCOmp Set boContact = TheApplication.GetBusObject(“Contact”) Set bcContact = boContact.GetBusComp(“Contact”)

bcContact will not have data in it Must be filled by executing a Query on it

Querying a BusComp Sometimes, a BusComp does not have any data (as when using GetBusObject) or does not have the data you need- it is just an empty structure To get data into it, you must use the ExecuteQuery method of the BusComp However, there are other things you must also set before you can call ExecuteQuery

Query Prerequisites SetViewMode ActivateField ClearToQuery SetSearchSpec When you query a Business Component, you are building a SQL query behind the scenes

SetViewMode Method Used to filter data, similar to using the My Views, My Team’s Views, All Across All Organization’s View, and so on Most of the Time, you will be using the AllView Mode, which does not filter any data at all (All Across All Organizations) Syntax (eScript): – bcContact.SetViewMode(AllView);

In the SQL Query, this controls part of the where clause

ActivateField Method Must be done before ClearToQuery When a query is execute on a Business Component, it does not automatically query for every field, only the following: – – – –

Fields that are a part of the current Applet System Fields Fields that are set as Force Active Fields that are Activated via the ActivateField Method

Syntax (Siebel VB): – bcName.ActivateField “FieldName”

In the SQL Query, this controls the Select clause

ClearToQuery Mothod Clears any existing data from the Business Component about to be queried This includes any search spec included with the current Applet Does clear any sort spec In the SQL Query, this empties the where clause from previous queries

SetSearchSpec Method Can have multiple fields, but is usually only consists of one field Syntax and Example(eScript): – bcName.SetSearchSpec(“FieldName”, Value); – bcSR.SetSeachSpec(“Id”, “1-13G5T”);

In SQL, that translates to: – where ROW_ID = ‘1-13G5T’

In the SQL Query, this gives the main part of the where clause If you use the Id field, the record set will contain at most, one record

ExecuteQuery Method Once all the pieces are in place, you can execute the query Syntax (Siebel VB): – bcName.ExecuteQuery Mode

Mode Determines how you can transverse the data – ForwardOnly: You can only go through the data in one direction. You cannot go back to a record once you move to another – ForwardBackward: Allows you to go through the data any direction, or revisit any data already read. Slower and more taxing on the database than ForwardOnly

The with (With) statement With allows you to access many methods or sub-objects of an object without repeating the name of the object Since there are so many pre-requisites to executing a query, all of which are methods of the same business component, with is very useful in executing queries

ExecuteQuery With Siebel VB With bcContact – .SetViewMode AllView – .ActivateField “Last Name” – .ActivateField “Email Address” – .ClearToQuery – .SetSearchSpec “Id”, sRowId – .ExecuteQuery ForwardOnly

End With

ExecuteQuery with eScript with (bcContact) { – SetViewMode(AllView); – ActivateField(“Last Name”); – ActivateField(“Email Address”); – ClearToQuery(); – SetSearch Spec (“Id”, sRowId); – ExecuteQuery(ForwardOnly);

}

GetFieldValue As expected, used to retrieve the value of a field in a business component Example: – sLName = bcContact.GetFieldValue(“Last Name”)

Takes an argument of a field of the BC (same spelling and case) Returns the value in that field in the current record If the field is not active, will cause an error

SetFieldValue Sets a field in a BC to a specified value in the current record Field does NOT have to be active Takes two arguments, no return – The Field to be updated (same spelling and case as in the BC in Tools) – The value to update it with (in string format)

Transversing BusComp Data FirstRecord NextRecord PreviousRecord LastRecord

FirstRecord Method Moves the record pointer to the first record, if it exists If it does, returns non-zero in SiebelVB, true in eScript If no first record exists (which means that the query returned no records), returns 0 (zero) in Siebel VB and false in eScript If BusComp was queried in ForwardOnly mode, FirstRecord cannot be called once the record pointer moves to any other

NextRecord Method Moves record pointer to the next record in the data set If there are no more records, returns 0 or false If there are, returns non-zero or true

PreviousRecord Method Same as NextRecord, including return values, except it moves the record pointer to the previous record May only be used on BusComps that have been queried in ForwardBackward mode

LastRecord Method Moves the record pointer to the last record in the data set If there is a record, returns non-zero or true If there are no records in the record set, returns 0 or false Unless the query was made in ForwardBackward mode, cannot move to any other record after using this method

NewRecord Method Begins creating a new record in the Business Component – New record is not saved until WriteRecord method is used

Use SetFieldValue to assign values to whatever fields you need to in the new record – Fields that have a pre or post default value will also get values in them

Use WriteRecord to save the new record once all values have been set

NewRecord Arguments The NewRecord requires one argument that specifies where in the current data set to save the new record NewAfter saves the record after the current one NewBefore Saves the record before the current one

NewRecord Example with bcContact { – NewRecord NewAfter; – SetFieldValue(“Last Name”, “Harrison”); – SetFieldValue(“First Name”, “James”); – SetFieldValue(“Home Phone #”, “7195550234”); – WriteRecord();

}

NewAfter(Before)Copy You can also use NewAfterCopy or NewBeforeCopy to create a Copy of the current record Just like right clicking in the application and selecting “Copy Record” Must still use WriteRecord to Save the new record Example: – bcContact.newRecord(NewAfterCopy); – bcContact.WriteRecord();

Other Important BC Methods UndoRecord Pick DeleteRecord GetMVGBusComp GetPicklistBusComp GetUserProperty ParentBusComp

Property Sets Simple description: name-value pairs What that really means is that a property set can hold a number of separate string variables Name: name of the string variable – Name can be whatever you choose, it is also stored as a string – Just be sure to be consistent

Value: value of that variable

Passing Data Between Objects Can be used to pass information from one object to another – Set the values in one object – Retrieve them in the other, using the names you created when setting

Can pass all related data, such as different fields from the same BC record Can also pass unrelated data, such as some BC fields, the BC name, and the number of current records in the BC record set

Hierarchical Property Sets Property Sets not only contain name-value pairs, but can also contain other property sets This means that a property set hierarchy can be set up One of the most important uses for this is seen in it’s comparison with XML:

XML EXstensible Markup Language Like HTML, is made up of tags and values, but the similarity ends there With HTML, there is