Siebel Configurator Instance API (Doc ID 477688.1)

Last updated on SEPTEMBER 19, 2024

Applies to:

Siebel eConfigurator - Version 7.5.3 SIA [16157] and later
Information in this document applies to any platform.
The translated version of "Siebel Configurator Instance API" is available via the link given below (Doc ID 1488746.1).

Purpose

This document contains general information regarding API concepts and provides a .zip file that includes examples of how to use the API methods available to the Siebel eConfigurator versions 7.5.x and above. The examples are in the form of workflows that can be run within a standard Siebel environment and will demonstrate the manner in which the API can be used to accomplish some common business processes. It will also describe how to implement script within API-related business services to determine the API methods that are being called and the arguments that are being passed to them while invoking the eConfigurator. Such "sniffers" can be used as educational tools to gain further understanding of eConfigurator APIs and how they work.

Scope

This technical note is intended only as an introduction to APIs for advanced users and assumes knowledge of the eConfigurator and Siebel server architecture. Implementing an API solution also requires proficiency in the following areas:

Siebel Business Process Designer
Runtime Events (personalization) if invoked from the UI
Siebel Object Interfaces
A Siebel scripting language (Siebel VB or Siebel eScript)
Recursive programming techniques
Constraint satisfaction theory
Underlying behavior of the Siebel eConfigurator
Siebel product definition data model
Siebel Property Set representation of data (creation and transformation)
EAI Transports and Interfaces

The above list requires underlying fundamental knowledge beyond what is available in the Siebel Bookshelf. Therefore, it is strongly encouraged that you consult with the Customer Order Management (C-OM) competency group, Solution Support Engineering, or Professional Services in order to assist with any API implementations.

Note that this document does not provide extensive information about any single API (refer to the Product Administration guide in Siebel Bookshelf version 7.5 for information about each API specifically), nor does it discuss detailed criteria under which one API might be chosen in preference for another or what collection of APIs might be appropriate for a given business process. A consultant from the Siebel C-OM competency group, Solution Support Engineering, or Professional Services can assist you in deciding what the best approach would be to meet your business requirements.