1. Product Administration Guide
  2. Instance APIs for the Complex Object Manager

Instance APIs for the Complex Object Manager

Instance APIs for the Complex Object Manager follow these general rules:

  • The Remote Complex Object Instance Service (RCOIS) is a business service. It can be accessed by anything in the Siebel architecture that can use a business service. As a business service, it is used by invoking methods, passing in property sets with input arguments, and getting results from the Outputs property set.

    Note: Before 7.8 the RCOIS was the API for using remote Siebel Product Configurator while Complex Object Instance Service (COIS) was the API for the embedded Siebel Product Configurator. In 7.8 and later versions the COIS and RCOIS are both proxies to the internal business service Siebel Product Configurator Service. All previous scripting efforts are still supported. Do all future scripting on the RCOIS.

  • A session is uniquely identified by two ID values, the Object Id and the Root Id. In quotes, the Object Id is the Quote Id and the Root Id is the Quote Item Id for the top-level parent (the root). In assets, the Object Id and the Root Id are both the root Asset Id.

  • A session is unique only within its own user session on a given Object Manager.

  • A port is another name for a Relationship.

  • A complex product is another name for a customizable product.

  • The Port Id is the ID of the relationship as defined in the Complex Product Structure BusComp.

  • The Prod Item Id is the ID of the relationship item as defined in the Complex Product Structure BusComp.

  • The Path for an item is the Integration ID of the specific item.

  • Version arguments are used only when testing a customizable product version that is different from the currently released version.

  • RemoteCfgProfileAttrs, an optional property set to send and receive profile attributes to remote product configurator. This property set is appliable for only LoadInstance and SetInstance methods.

Note: The parameters are property set and, unless indicated, all properties are on the root level property set.

Instance APIs include the following methods: