Bookshelf Home | Contents | Index | PDF | ![]() ![]() |
Siebel Partner Relationship Management Administration Guide > Setting Up Application Services Interfaces > ASI Workflows > Business Services Used by ASIsA set of business services named PRM ANI Utility Services have been created to support both opportunity transfers and shopping cart transfers. Most of these service methods deal with the manipulation of integration objects, and rely on the Siebel Adapter Service on the internal side. Whenever possible, follow usage examples from the workflows provided. You can use the PRM ANI Utility Services in situations where there is only one instance of a component type in the hierarchy path. So if there are multiple instances of a contact under the opportunity, you cannot get the Contact element from the integration object because each hierarchy path provided (Account.Contact in this case) must be unique. If this constraint must be violated, then refer to each instance with a separate Integration Component Name. For example, if Person had the same type of data as Contact, then use a reference to Account.Person to store another contact. Conventions for Hierarchy PathsThe following convention is used for hierarchy paths in a number of service methods: Hierarchy paths are inputs of the form IC1.IC2.IC3..., where IC1, IC2, IC3, and so on, are Integration Component Names that tell the method how to traverse the object definition to find the right place to put the child. For example, when placing a business address under the account under the opportunity object, the path would read Opportunity.Account. For the Set Child Type method, a slightly different methodology in the hierarchy path is used, as follows: In the case of Set Child Type, refer to IC1, IC2, IC3, and so on as the actual structure of the Siebel hierarchy. The examples listed come from the ANI Shopping Cart Message (PRM ANI) Integration object. The first three substrings will appear as follows: ChildObject.ListOfMessageType.RootComponentName. An example is: SiebelMessage.ListOfANI Shopping Cart Message (PRM ANI).Message Details The following substrings will alternate between ListOf Component Names and the Component Names themselves. An example is: ListOfChannel Partner.Channel Partner.ListOfChannel Partner Business Address.Channel Partner Business Address Append HierarchyThis method appends a child integration object to a parent integration object. The parent object must contain the child object's full definition. See the notesabout calls to the Load Child Hierarchy method. There is a dependency in calls to Append Hierarchy on calls to Load Child Hierarchy, so the Load Child Hierarchy method must be called before calling this method. The following are inputs for Append Hierarchy:
Append Hierarchy has only one output:
Example: Transfer Cart Outbound Create Header Process, Append Header to Message Create Empty HierarchyThis method creates an empty integration object instance with the same structure as a normal integration object but with two notes. All data fields are present and empty (initialized to empty string). Each component in the definition of the integration object is instantiated once only in the exact structure that is prescribed by the definition. The following are inputs for Create Empty Hierarchy:
Create Empty Hierarchy has only one output:
Example: Transfer Cart Outbound Create Header Process, Create Header Instance Generate KeyThis method returns a string that you can use to uniquely identify a record in the service's business component. In the case of Workflow Processes, this refers to the primary business component of the processes' business object. Generate Key has only one input:
Generate Key has only one output: Example: Transfer Cart Inbound Create Cart Process, Create New Quote Key Get Child TypeThis method reports the child type of a property set. For integration objects, this is generally of type SiebelMessage. Get Child Type has only one input: Get Child Type has only one output:
Get Hierarchy ValueThis method returns a string field value in the integration object structure. The following are inputs for Get Hierarchy Value:
Get Hierarchy Value has only one output: Example: Transfer Cart Inbound Create Contact Process, Get Contact Street Address Get System PreferenceThis method looks up values in the system preferences. Get System Preference has only one input: Get System Preference has only one output: Example: Transfer Cart Outbound Request Process, Get Organization DUNS Isolate Integration IDThis method strips an integration object instance of everything except for the Integration ID, including child components. This method is not called by PRM ASIs, but is referenced by other ASIs. It is used to direct Siebel Adapter Operations to consider only the Integration ID to look for a record in some cases. Isolate Integration ID has only one input: Isolate Integration ID has only one output:
Load Child HierarchyThis method places a child hierarchy in memory to be used at a later time. It is used for operations that require two hierarchy type operands, such as Append Property Set. Load Child Hierarchy has only one input: Example: Transfer Cart Outbound Create and Append Process, Set the Child Hierarchy Parse KeyThis method generates a search specification from a given key and key description. The search specification can be fed into a query step (Siebel operation or otherwise) to look for the record that the key has specified. The following are inputs for Parse Key:
Parse Key has only one output:
Example: Transfer Cart Inbound Create Quote Process, Parse Quote Key Query Business ComponentThis method provides a way to query any business component in the business object. This gives you a bit more flexibility than the standard Siebel operation query, because you can search the entire business component without regard to the links to the primary business component. If both Search Spec and Query fields are provided, the Search Spec is chosen over the Query field arguments to execute the business component with. If neither is provided, then an error is returned. The following are inputs for Query Business Component:
The following are outputs for Query Business Component:
Example: PRM ANI Inbound Create Account Process, Find Account Detach HierarchyThis method is a complementary function to Append Hierarchy. It takes the specified integration object and extracts it from the parent object. The following are inputs for Detach Hierarchy:
Detach Hierarchy has only one output:
Example: PRM ANI Inbound Create Account Process, Get Account Object Set Child TypeThis method is a complementary function to Get Child Type. It sets the hierarchy type if you need to change something to the type Siebel Message. The following inputs are for Set Child Type:
Set Child Type has only one output: Example: Transfer Cart Outbound Request Process, Rename Root Object 1 Set Hierarchy ValueThis method is a complementary function to Get Hierarchy Value. It sets the value of a property in an object. The following are inputs for Set Hierarchy Value:
Set Hierarchy Value has only one output: Example: Transfer Cart Outbound Create Header Process, Set Message Time Stamp |
![]() |
![]() ![]() |
Siebel Partner Relationship Management Administration Guide |