8 Siebel Load Module

This chapter provides a complete listing and reference for the methods in the OpenScript SiebelService Class of Siebel Load Module Application Programming Interface (API).

8.1 SiebelService API Reference

The following section provides an alphabetical listing of the methods in the OpenScript SiebelService API.

8.1.1 Alphabetical Command Listing

The following table lists the SiebelService API methods in alphabetical order.

Table 8-1 List of SiebelService Methods

Method Description

siebel.getSettings

Gets the Siebel Settings object.

siebel.solve

Parse a Siebel value from the most recent navigation's contents and store it as a variable.


The following sections provide detailed reference information for each method and enum in the SiebelService Class of Siebel Load Module Application Programming Interface.

siebel.getSettings

Gets the Siebel Settings object.

Format

The siebel.getSettings method has the following command format(s):

siebel.getSettings( );

Returns

Settings pertaining to the Siebel Service.

Example

Gets the Siebel Settings object and check validation enabled.

import oracle.oats.scripting.modules.siebel.api.SiebelSettings;
//[...]
SiebelSettings settings = siebel.getSettings();
settings.setIsSiebelValidationEnabled(true);
boolean isvalidationEnabled = settings.getIsSiebelValidationEnabled();
info("isvalidationEnabled = " + isvalidationEnabled);

siebel.solve

Parse a Siebel value from the most recent navigation's contents and store it as a variable.

This method honors the "Solve Variable Failed" error recovery setting. If "Solve Variable Failed" error recovery is not set to fail, then the script will continue running even if a non-optional variable cannot be solved.

Format

The siebel.solve method has the following command format(s):

siebel.solve(varName, pattern, errorMsg, isOptional, sourceType);

Command Parameters

varName

a String specifying the name of the variable to create. Must not be null.

pattern

a String specifying the Siebel pattern specifying what to extract from the most recent navigation's contents. May contain a transform expression. Must not be null.

errorMsg

a String specifying an optional error message to display if the pattern cannot be solved. If null, a meaningful error message is automatically generated.

isOptional

a Boolean specifying true if the pattern does not have to be solved. If the pattern cannot be solved, the method quietly returns.

sourceType

a Source enum specifying the part of the most recent navigation's contents (i.e. body or headers) against which to solve the pattern. If null, this method will assume Source.Html.

Throws

Exception

if any failure.

SolveException

If the given pattern cannot be matched to the previous contents and the pattern is not optional.

Example

Parse a Siebel value from the most recent navigation's contents and store it as a variable.

http.post(107,
  "http://siebel005.example.com/callcenter_enu/start.swe",
  null, http.postdata(http.param("SWEC", "{{@SWECInc(1)}}"),
   http.param("SWERPC", "1"), 
   http.param("SWENeedContext", "false"), 
   http.param("SWEView", "Account List View"), 
   http.param("SWECmd", "GotoView"), 
   http.param("SWEKeepContext", "1")), null, true,
  "UTF8", "UTF8");
{
 siebel.solve(
  "_Siebel_CORRLIB_FIELD_1294336896147__S_BC1_S17_R01_F01_#_3 scripts co",
  "_Siebel_CORRLIB_FIELD__TEXT", null, false,
  Source.Html);
 siebel.solve(
  "_Siebel_CORRLIB_FIELD_1294336896147__S_BC1_S17_R01_F04_#_Qualified",
  "_Siebel_CORRLIB_FIELD__TEXT", null, false,
  Source.Html);
 siebel.solve(
  "_Siebel_CORRLIB_FIELD_1294336896147__S_BC1_S17_R01_F03_#_",
  "_Siebel_CORRLIB_FIELD__PHONE", null, false,
  Source.Html);
 siebel.solve(
  "_Siebel_CORRLIB_FIELD_1294336896147__S_BC1_S17_R01_F05_#_",
  "_Siebel_CORRLIB_FIELD__TEXT", null, false,
  Source.Html);
 siebel.solve(
  "_Siebel_CORRLIB_FIELD_1294336896147__S_BC1_S17_R01_F02_#_abc",
  "_Siebel_CORRLIB_FIELD__TEXT", null, false,
  Source.Html);
 siebel.solve(
  "_Siebel_CORRLIB_ROWID_1294336896147__S_BC1_S17_R01_FID_#_1-J8TZ",
  "_Siebel_CORRLIB_ROWID", null, false,
  Source.Html);
}
http.get(111,"http://siebel005.example.com/callcenter_enu/start.swe",
  http.querystring(
   http.param("SWECmd","GetViewLayout"),
   http.param("SWEView","Account List View"),
   http.param("SWEVI", ""),
   http.param("SWEVLC",
    "{{SWEVLC,0-1_Siebel+Universal+Agent_37%7c1119321220%7c0_0_19221_00_L}}")),
  null, true, "UTF8", "UTF8");