Вы находитесь на странице: 1из 266

Siebel Application Services Interface Reference

Version 8.2 December 2009

Copyright 2005, 2009, Oracle. All rights reserved. The Programs (which include both the software and documentation) contain proprietary information; they are provided under a license agreement containing restrictions on use and disclosure and are also protected by copyright, patent, and other intellectual and industrial property laws. Reverse engineering, disassembly, or decompilation of the Programs, except to the extent required to obtain interoperability with other independently created software or as specified by law, is prohibited. The information contained in this document is subject to change without notice. If you find any problems in the documentation, please report them to us in writing. This document is not warranted to be errorfree. Except as may be expressly permitted in your license agreement for these Programs, no part of these Programs may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose. If the Programs are delivered to the United States Government or anyone licensing or using the Programs on behalf of the United States Government, the following notice is applicable: U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the Programs, including documentation and technical data, shall be subject to the licensing restrictions set forth in the applicable Oracle license agreement, and, to the extent applicable, the additional rights set forth in FAR 52.227-19, Commercial Computer Software--Restricted Rights (June 1987). Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA 94065. The Programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherently dangerous applications. It shall be the licensee's responsibility to take all appropriate fail-safe, backup, redundancy and other measures to ensure the safe use of such applications if the Programs are used for such purposes, and we disclaim liability for any damages caused by such use of the Programs. The Programs may provide links to Web sites and access to content, products, and services from third parties. Oracle is not responsible for the availability of, or any content provided on, third-party Web sites. You bear all risks associated with the use of such content. If you choose to purchase any products or services from a third party, the relationship is directly between you and the third party. Oracle is not responsible for: (a) the quality of third-party products or services; or (b) fulfilling any of the terms of the agreement with the third party, including delivery of products or services and warranty obligations related to purchased products or services. Oracle is not responsible for any loss or damage of any sort that you may incur from dealing with any third party. Oracle, JD Edwards, and PeopleSoft are registered trademarks of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Contents

Siebel Application Services Interface Reference 1

Chapter 1: Chapter 2:
Defining ASIs 9

Whats New in This Release Siebel Application Services Interfaces Overview


9

About the Two Types of ASIs ASI Usage Examples 11

Chapter 3:

Application Services Interfaces


13 13

About ASI Structure

About Integration Object Structure

Components and Fields in Integration Objects 14 List of Value Fields in Integration Objects 14 Related Business Component Selection in Database Updates Unique Keys in Integration Objects 15

15

ASI Data Synchronization Services

15
16

Data Mapping for ASI Release Independence Data Synchronization Methods for ASIs 19

Exposing ASIs with Interface Technologies About ASIs and Web Services
Protocols Used with ASIs Handling Errors for ASIs 24 25

24

24

Authentication and Security for ASIs

26

Chapter 4:
Using ASIs 27

Administering Application Services Interfaces

Configuring ASIs 27 Deactivating ASI Components and Fields 28 Real Time and Asynchronous Processing with ASIs

29

User Scenarios for ASI Administration

29

Siebel Application Services Interface Reference Version 8.2

Contents

Chapter 5:

Customizing an Application Services Interface


31 32 34
31

About ASI Framework


Extending an ASI

Customizing Workflows to Use ASIs User Scenarios for ASIs 36

Building Customized Interfaces Using the ASI Framework

Appendix A: Predefined Application Service Interfaces


About Prebuilt ASIs Siebel Account Siebel Action 41 55 61 63 40

Siebel Business Address Siebel Personal Address Siebel Asset Siebel Contact Siebel Cost List Siebel Employee Siebel Forecast Siebel Invoice 64 68

Siebel CUT Address MSAG Service 75 78 90 96 98

74

Siebel Financial Account

External Opportunity Create/External Opportunity Query/External Opportunity Update 109


ANI Opportunity Message (PRM ANI) 110 ANI Message Header (PRM ANI) 119 Opportunity (PRM ANI) 120 Destination Channel Partner (PRM ANI) 125 Source Organization (PRM ANI) 126 Opportunity Account (PRM ANI) 127

Siebel Order Siebel Position

129 146 147 150 165

Siebel Price List

Siebel Quote/External Quote

Siebel ATP Response/External ATP Check


4

Siebel Application Services Interface Reference Version 8.2

Contents

External Credit Check

173

Credit Check Request 173 Credit Check Response 175

External Shipment Tracking

176

Shipment Tracking Interface Request 177 Shipment Tracking Interface Response 178

Siebel SIA Service Request Siebel Service Request Siebel Simple Product 184 188

181

Appendix B: Siebel Communications, Media, and Energy ASIs


About Prebuilt Communications, Media, and Energy ASIs Order Management Siebel Order Siebel Account Siebel Invoice 199 218 218 228 235 239 241 242 228 199 198

Customer Lifecycle Management Billing Management

Siebel Invoice Adjustment

CUT Payment Interface Integration Object

CUT Account Balance Interface - Request Integration Object CUT Account Balance Interface - Response Integration Object Siebel Meter Reading Siebel Payment 247 249 257 257 243 244 Siebel Meter Usage Data Siebel Simple Product Siebel Trouble Ticket

Trouble Ticketing Management

Index

Siebel Application Services Interface Reference Version 8.2

Contents

Siebel Application Services Interface Reference Version 8.2

Whats New in This Release

No new features have been added to this guide for this release. This guide has been updated to reflect only product name changes.

Siebel Application Services Interface Reference Version 8.2

Whats New in This Release

Siebel Application Services Interface Reference Version 8.2

Siebel Application Services Interfaces Overview

This chapter provides general information about Oracles Siebel Application Services Interfaces (ASIs), the definition, benefits, and types of ASIs, and general examples of ASIs to give you an overview of this component. Topics include: Defining ASIs About the Two Types of ASIs ASI Usage Examples

Defining ASIs
An Application Services Interface (ASI) is a release-independent interface published by Oracle that allows you to integrate Siebel applications with external applications. An ASI is a collection of related methods; each method contains input and output parameters. The methods and parameters are listed on the business service definition. Simple method parameters (such as a string or number) are defined directly in the service definition. Hierarchical method parameters are defined using integration objects. NOTE: Web Services are used in ASI development, but they may not be apparent in the implementation on specific integration servers. ASIs are published in a standard metadata format such as Extensible Markup Language Document Type Definitions (XML DTD) and Web Services Descriptive Language/XML Schemas (WSDL/XSD)and are built using the ASI Framework. See About ASI Framework on page 31 for more information. Siebel ASIs are prebuilt and can be used immediately. ASIs provide a release-independent integration interface to the Siebel application, which remains unchanged with each upgrade to a new release. ASIs use the standard metadata format, which makes ASIs language-independent, so they return the same value type regardless of language setting.

About the Two Types of ASIs


There are two types of ASIsinbound and outbound.

Inbound ASI
An inbound ASI defines an interface for services provided by Oracle. External applications use this type of ASI to invoke Siebel-provided services.

Siebel Application Services Interface Reference Version 8.2

Siebel Application Services Interfaces Overview About the Two Types of ASIs

An external application makes an inbound request that the inbound dispatcher receives. Based on the information in the ASI, the dispatcher invokes one of several services to pass its data to the Siebel applicationeither a data synchronization service, other business services, or a workflow process. For further details about data synchronization services, see ASI Data Synchronization Services on page 15. For more information about business services and workflows, see Business Processes and Rules: Siebel Enterprise Application Integration. The dispatcher determines which service to invoke, according to the ASI configuration and transport protocols. The ASI determines whether the service request is a request-response operation (a response containing the status of the operation or the data retrieved) or a one-way request (where no response is required). ASIs are configured to have the same input and output argument (Siebel Message), and always return a response unless you change the ASI argument. External applications can use inbound ASIs, which can be exposed as a Web service, XML, or Java. Figure 1 on page 10 shows these processes.

Figure 1.

Inbound ASI

Outbound ASI
An outbound ASI defines an interface from a Siebel application to an external application and provides a proxy to the external application that can be called from within the Siebel application. The Siebel application invokes this proxy to make a service request to the external application, soliciting information from the external service, which the Siebel database updates or displays to the user.

10

Siebel Application Services Interface Reference Version 8.2

Siebel Application Services Interfaces Overview ASI Usage Examples

A workflow or a user interface event calls an outbound dispatcher. Based on the ASI configuration, the dispatcher invokes one of several services at runtimeSiebel Services, Partner Adapters, XML, or Web Services. The outbound dispatcher links a service name, interface, and transport or protocol binding to the ASI, which is also sent to the external application, as shown in Figure 2 on page 11.

Figure 2.

Outbound ASIs

ASI Usage Examples


The following example in Figure 3 on page 11 demonstrates how to use inbound and outbound ASIs in the workflow.

Inbound ASI Example


A customer using an external application needs to update an account within the Siebel database. As shown in Figure 3, an external application invokes an inbound ASI, Siebel Account, to retrieve the correct customer information from the Siebel database using the method, QueryById. In the External Account proxy step, an outbound ASI is called, and the account information is sent to the external systems for processing. After the update is completed in the external system, the response is passed to an inbound ASI, Siebel Account, to update the information in the Siebel database, using the Synchronize method.

Figure 3.

Update Account

Siebel Application Services Interface Reference Version 8.2

11

Siebel Application Services Interfaces Overview ASI Usage Examples

For a more detailed description of this example, see Customizing Workflows to Use ASIs on page 32.

Outbound ASI Example


The following example uses an outbound ASI to retrieve information and display it to the user. A customer using a Siebel application might need to check the inventory of a product, Request ATP Check, to fulfill an order. The Siebel application sends an outbound request to the external system, retrieves the information, and displays it to the user.

12

Siebel Application Services Interface Reference Version 8.2

Application Services Interfaces

This chapter describes the underlying structure of an Application Services Interface (ASI) and the specialized types of ASIs used by business services. It also explains the relationship between ASIs, EAI, and Web services, as well as authentication and security issues. Topics include the following: About ASI Structure About Integration Object Structure ASI Data Synchronization Services Exposing ASIs with Interface Technologies About ASIs and Web Services Authentication and Security for ASIs

About ASI Structure


As defined earlier, an ASI is an interface whose implementation is defined by a business service or workflow. A specialized class of business services is implemented as data synchronization services. Figure 4 on page 13 shows an example of the structure of the Account ASI. For information regarding specific ASIs, see Appendix A, Predefined Application Service Interfaces and Appendix B, Siebel Communications, Media, and Energy ASIs.

Figure 4.

Account ASI

About Integration Object Structure


Integration objects are metadata structures that represent hierarchical objects using components and fields. For example, the Contact integration object might have the following components Personal Address, Account, and Opportunity. Figure 5 on page 14 shows a sample of the Contact integration object, and the integration object instance containing the data for Contact. The structure of integration objects includes: Components and Fields in Integration Objects on page 14

Siebel Application Services Interface Reference Version 8.2

13

Application Services Interfaces About Integration Object Structure

List of Value Fields in Integration Objects on page 14 Related Business Component Selection in Database Updates on page 15 Unique Keys in Integration Objects on page 15

For data synchronization services, there are two types of integration objects. For more information about data synchronization services, see ASI Data Synchronization Services on page 15. For more information about integration objects, see Integration Platform Technologies: Siebel Enterprise Application Integration.

Figure 5.

Integration Object and Integration Object Instance

Components and Fields in Integration Objects


Components define the hierarchy of an integration object, and a component contains one or more fields and child components. In Figure 5, the Contact integration object has these components: Contact_Personal Address, Contact_Account, and Contact_Opportunity; Personal Address has the additional fields, PersonalAddressState and PersonalAddressZip. By default, all fields are active. However, you can deactivate these fields to satisfy the different requirements for each ASI and to increase performance of the ASI. For more information about deactivating field components, see Deactivating ASI Components and Fields on page 28.

List of Value Fields in Integration Objects


Fields can map to a Siebel predefined List of Values (LOV). The fields in the integration components that are based on such fields can take values only from that listthe fields are bound to the values of that LOV. For example, in Figure 5 on page 14, PersonalAddressState can map to an LOV of the different states in the U.S. (such as AZ, CA, FL, and so on).

14

Siebel Application Services Interface Reference Version 8.2

Application Services Interfaces ASI Data Synchronization Services

These LOV fields should use a language-independent representation. For each LOV field, the internal integration object returns a Language Independent Code (LIC) if the user property, AllLangIndependentVals, is set to Y at the object level. The integration object can expose the Siebel LIC or map the field to an industry standard code.

Related Business Component Selection in Database Updates


When a row is inserted or updated in the Siebel database, it is often necessary to create relationships with other business components through a foreign key. For example, an account has a many-to-one relationship with Price Listan account is associated with one price list; the same price list can be used with different accounts. The correct price list is identified by the foreign key Price List Id, which exists in the Account component. This relationship is implemented through the picklist. For this type of integration, a pointer to the appropriate price list row is stored in the account row, where it is identified by a foreign key.

Unique Keys in Integration Objects


Internal integration objects implement user keys that the Siebel application creates for each component, based on the user primary key defined for the underlying table. User keys are a group of fields whose values uniquely identify only one Siebel record. When an ASI executes, it searches the list of user keys to find the first key present in the component instance and uses it to determine whether the record has a match in the Siebel database. You can deactivate, modify, or create additional keys for an ASI depending on your business and application needs. However, it is recommended that each component contain a set of three unique keys: Row ID. The Siebel Row ID. Integration ID. A cross-reference that links the Siebel application to the corresponding record in the external application. User Key. Corresponds to the U1 index of the underlying table.

ASI Data Synchronization Services


A data synchronization service is a specialized type of business service used by a class of ASIs. Data synchronization services import and export data from Siebel applications and are based on the framework provided by the EAI Siebel adapter. For more information about the EAI Siebel adapter, see Integration Platform Technologies: Siebel Enterprise Application Integration. The components of a data synchronization service include: Data Mapping for ASI Release Independence on page 16 Data Synchronization Methods for ASIs on page 19

Siebel Application Services Interface Reference Version 8.2

15

Application Services Interfaces ASI Data Synchronization Services

Many inbound ASIs are built using data synchronization services, and can also be used to populate the parameters of an outbound ASI. The inbound ASI isolates the interface of the outbound ASI and provides an interface that is independent from the data model by isolating the underlying data model through the use of a data map. NOTE: Data mapping cannot be specified for outbound ASIs using the internal integration object and data map business service user properties. These user properties are only for use by the data synchronization business service. Data synchronization services use a pair of integration objectsthe internal integration object and the interface integration objectthat define the schema of the release-independent interface. Both objects must be provided, even if they are exactly the same, for the ASI to be upgraded at a later date. An internal integration object mirrors the schema of the Siebel business object, while an interface integration object defines the external representation of the data. Figure 6 on page 16 illustrates these concepts.

Figure 6.

Data Synchronization Services

Component and field names of the internal integration object must match the names of the underlying Siebel business objects components and fields. The interface integration objects components and fields do not need to match; you determine them based on your business requirements.

Data Mapping for ASI Release Independence


Within data synchronization, a data map translates the data in the form of integration objects between an internal integration object and an interface integration object, making ASIs releaseindependent.

16

Siebel Application Services Interface Reference Version 8.2

Application Services Interfaces ASI Data Synchronization Services

Data synchronization services use data mapping to translate data between integration objects and support a subset of methods that are used by the EAI Siebel adapter, such as Insert, Update, and Delete. See Data Synchronization Methods for ASIs on page 19 for more information. An ASI usually requires two types of data mapsone for each direction, as shown in Figure 7 on page 17. For more information about data mapping, see Business Processes and Rules: Siebel Enterprise Application Integration.

Figure 7.

Mapping Between Integration Objects

For ASIs using data synchronization services, there are two types of data mappingimplicit data mapping and explicit data mapping.

Implicit Data Mapping for Integration Objects


Data synchronization services support implicit data mapping when the internal integration object is a subset or exactly the same as the interface integration object; the reverse also holds true. Implicit mapping occurs when: A source component maps to a target component with the same name. A source component maps to a target component and both components have fields with the same name. Data synchronization service does not specific a data map.

Every component, field, and child component is mapped between integration objects. Figure 8 on page 18 shows an example of implicit mapping between two integration objects. In this diagram, components and fields with the same name are automatically mapped; data synchronization services map these fields when a data map is not specified.

Siebel Application Services Interface Reference Version 8.2

17

Application Services Interfaces ASI Data Synchronization Services

In Figure 8, the child component, Organization, which appears on the interface integration object only, is not mapped because it is not considered important to the ASI. Consequently, the two integration objects are sufficiently similar, and a data map is not necessary. Implicit mapping ignores any components and fields unique only to the interface or internal integration object, but not both. NOTE: Implicit data mapping requires that the root components of the internal and interface integration objects have the same name.

Figure 8.

Implicit Data Mapping

Explicit Data Mapping for Integration Objects


You must define an explicit data map whenever a component or field name of an interface integration object does not exactly match the component or field name of the internal interface object. Oracle provides prebuilt explicit data maps for its ASIs. These data maps make sure that the ASIs are release-independent. NOTE: To preserve the release-independent properties of fields, do not alter Siebel-defined explicit data maps except when you deactivate fields.

18

Siebel Application Services Interface Reference Version 8.2

Application Services Interfaces ASI Data Synchronization Services

Automatic Mapping for Integration Objects


You can automatically extend a data map for an integration object whenever new components and fields have been added to an existing ASI. Within the Data Map Administration screen, the Auto-Map feature enables you to automatically create submaps for these new components and fields. The AutoMap feature checks the definition of the internal integration object and the interface integration object, finds components and fields of the same name with no current map, and creates the data map for it. You can use automatic mapping and explicit mapping together.

Upgrading Data Maps for Integration Objects


When the Siebel application is upgraded, a three-way merge is performed on the internal and interface integration objects. This merge makes sure that the customer's extensions to these objects carry forward to the new version. If an explicit data map exists in the previous version of the ASI, a new version of the map replaces the old with the Siebel application upgrade. Any automatic mapping is regenerated. The automatic mapping exposes the customer's extensions through the new version of the interface.

Data Synchronization Methods for ASIs


Data synchronization services use a subset of methods supported by the EAI Siebel Adapter, as listed in Table 1. However, an ASI might not use all of the methods listed; you can define which methods an ASI uses. For more information, see Integration Platform Technologies: Siebel Enterprise Application Integration.

Table 1. Method

Data Synchronization Methods Description Queries for objects based on the example object provided. Queries for objects based on the primary row ID. Input Interface Integration Object Primary Row ID Output One or more integration objects that matches the query. An integration object that matches the specific row ID. If no row ID exists, no object is returned.

QueryByExample

QueryById

Siebel Application Services Interface Reference Version 8.2

19

Application Services Interfaces ASI Data Synchronization Services

Table 1. Method

Data Synchronization Methods Description Queries for a given number of objects based on the example object. Input Interface Integration Object PageSize StartRowNum ViewMode Output One or more integration objects up to <pagesize> number of integration objects that match the query. Boolean LastPage argument indicates whether the last record is returned.

QueryPage

Insert

Creates the object in the database.

Interface Integration Object

The status key of all the objects created. If the object exists, this request errors out. See Using Status Keys on page 21 for information about status keys. The status key of all objects updated.

Update

Updates the object in the database. If the object does not exist, the request returns an error. Merges the object with the same object in the database or creates a new object if none exists in the database. Synchronizes the database object to exactly match the input object. Deletes the object.

Interface Integration Object Interface Integration Object Interface Integration Object Interface Integration Object

InsertOrUpdate

The status key of all objects created or updated. The status key of all objects created or updated. The status key of all objects deleted.

Synchronize

Delete

20

Siebel Application Services Interface Reference Version 8.2

Application Services Interfaces ASI Data Synchronization Services

Data Synchronization Input Method Arguments for ASIs


Table 2 describes the arguments of the various methods. For more information about the input arguments, see Integration Platform Technologies: Siebel Enterprise Application Integration.

Table 2.

Input Method Arguments Display Name None Type Input/ Output DataType Integration Object Description The integration object or set of integration objects that is either passed to or returned to the method. The name of the method argument can be anything, but you should use SiebelMessage if the ASI is to be used in a workflow process with other EAI services. The integration object attribute must specify the name of the interface integration object.

Argument Interface Integration Object

LastPage PageSize

Last Page Page Size

Output Input

Boolean Number

Indicates whether the last record has been returned by the QueryById method. The default is 10. This argument indicates the number of records to be returned for the QueryPage method. The ID that corresponds to the Siebel business component row ID for the primary integration component. This argument is only applicable to the QueryById method. The default is 0. The row number to start retrieving records for the QueryPage method. See Using Status Keys on page 21 for more information about this output argument. Specifies the visibility mode applied to the parent integration object. Applicable only to the QueryPage method.

PrimaryRowID

Object ID

Input

String

StartRowNum

Starting Row Number None

Input

Number

RowID IntegrationId UserKey ViewMode

Output

Status key

None

Input

String

Using Status Keys A status key is an integration component key of the type Status key. Status keys are similar to unique keys (see Unique Keys in Integration Objects on page 15), and need to be defined for the output arguments. It is recommended that each component contain a set of these three unique keys:

Siebel Application Services Interface Reference Version 8.2

21

Application Services Interfaces ASI Data Synchronization Services

Row ID. The Siebel Row ID. Integration ID. A cross-reference that links the Siebel application to the corresponding record in the external application. User Key. Corresponds to the U1 index of the underlying table.

For more information about status keys, see Integration Platform Technologies: Siebel Enterprise Application Integration.

Handling Error Messages If a method cannot find the integration object as specified by the method arguments, a SiebelMessage returns containing an empty list of integration objects. However, if an error occurs during the execution of a method: The Business Service returns an error. A SOAP message is returned if the method is invoked as a Web service. See Handling Errors for ASIs on page 25 for more information about Web services error messages.

Business Service User Properties for ASIs


User properties, as listed in Table 3, control the behavior of an ASI. These values become input arguments to the service that invokes the ASI. For example, an ASI using the Synchronize method can specify that an input data map for Synchronize is usedfor example, Input Data Map (Synchronize). If Input Data Map (Synchronize) is not specified, the default data map, Input Data Map, is used instead. If a default data map is not specified, implicit mapping is used. For more information about Business Service User Properties, see Integration Platform Technologies: Siebel Enterprise Application Integration.

Table 3.

Business Service User Properties Required Yes No Description Name of the integration object defining the business object to expose. Name of the default data map for the input arguments. If no map or method is specified, implicit mapping occurs between the internal and input interface objects. Name of the default data map for the output arguments. If no map and method are specified, implicit mapping occurs between the internal and output interface objects.

Argument Internal Integration Object Input Data Map

Output Data Map

No

22

Siebel Application Services Interface Reference Version 8.2

Application Services Interfaces ASI Data Synchronization Services

Table 3.

Business Service User Properties Required No Description Name of the data map for the input arguments for the specified methodfor example, Input Data Map (Synchronize). Name of the data map for the output arguments for the specified methodfor example, Output Data Map (Update).

Argument Input Data Map (name of method) Output Data Map (name of method)

No

XML Method Example


The following XML example demonstrates an upsert-and-delete operation: <SiebelMessage MessageId="" MessageType="Integration Object" IntObjectName="Sample Account"> <ListofSampleAccount> <Account operation="upsert"> <Name>A. K. Parker Distribution</Name> <Location>HQ-Distribution</Location> <Organization>North American Organization</Organization> <Division/> <CurrencyCode>USD</CurrencyCode> <Description>This is the key account in the AK Parker Family</Description> <HomePage>www.parker.com</HomePage> <LineofBusiness>Manufacturing</LineofBusiness> <ListOfContact> <Contact operation="delete"> <FirstName>Stan</FirstName> <JobTitle>Senior Mgr of MIS</JobTitle> <LastName>Graner</LastName> <MiddleName>A</MiddleName> <PersonalContact>N</PersonalContact> <Account>A. K. Parker Distribution</Account> <AccountLocation>HQ-Distribution</AccountLocation> </Contact> </ListOfContact> </Account> </ListofSampleAccount> </SiebelMessage>

Siebel Application Services Interface Reference Version 8.2

23

Application Services Interfaces Exposing ASIs with Interface Technologies

Exposing ASIs with Interface Technologies


ASIs can be exposed through any of Siebel's interface technologies, which includes the Web Services Framework as well as the broader EAI Framework. The Web Services Framework supports Web service-related standards, including SOAP, WSDL, and XML Schema. You can use the broader EAI Framework for more flexibility in XML formatting and in choice of transport. ASIs use supported transport technologies including HTTP, MQSeries from IBM, and MSMQ from Microsoft. For more information about XML processing, see XML Reference: Siebel Enterprise Application Integration. For more information about transports, see Transports and Interfaces: Siebel Enterprise Application Integration.

About ASIs and Web Services


Web services can make ASIs externally available by using information protocols (such as HTTP) and data formats (such as XML), and other communication protocols, such as SOAP, Universal Description Discovery and Integration (UDDI), and WSDL. Because ASIs are business services, ASIs can be exposed externally as Web services. However, while ASIs can be published as Web services, not all Web services are ASIs. For more information about Web services and how to use them, see Integration Platform Technologies: Siebel Enterprise Application Integration. Topics in this section include: Protocols Used with ASIs Handling Errors for ASIs

Protocols Used with ASIs


ASIs support the standard XML envelope for Web services and SOAP. Siebel applications support two types of SOAP protocolsSOAP-Remote Call Procedure (RPC) and SOAP-DOC. If an inbound ASI supports an industry standard other than the protocols that Oracle supports, the ASI cannot be defined as an inbound Web service. The ASI must be defined and supported through the existing EAI framework.

24

Siebel Application Services Interface Reference Version 8.2

Application Services Interfaces About ASIs and Web Services

Table 4 lists the various types of transport and protocols available. The Null Protocol implements a loopbacka call back into the Siebel servers. Any method arguments passed using the Null Protocol or that are not directly specified are forwarded to the local business service or local workflow. When testing an ASI, you can use the File protocol.

Table 4.

Protocols SOAP-RPC Inbound/Outbound Inbound/Outbound Inbound/Outbound Inbound/Outbound Outbound Outbound Outbound SOAP-DOC Inbound/ Outbound Outbound Outbound Not Applicable Outbound Outbound Outbound Null Not Applicable Not Applicable Not Applicable Not Applicable Outbound Outbound Outbound

Transport HTTP MQ MSMQ Local Business Service Local Web Service Local Workflow File

Handling Errors for ASIs


The SOAP fault message returns any errors for inbound and outbound ASIs.

Errors for Inbound ASIs


The SOAP fault block returns any inbound error messages, as defined by the SOAP 1.1 specification. The faultcode contains either a Client or Server value, and the faultstring contains a description of the error. The error message <siebel:errormsg> details the problems with the request. The information in the SOAP fault block can be extracted and displayed to the user. The following XML shows an example of a fault message. <?xml version="1.0" encoding="UTF-8" ?> <?Siebel-Property-Set EscapeNames="false"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <SOAP-ENV:Body> <SOAP-ENV:Fault xmlns:siebelf="http://www.oracle.com/ws/fault"> <faultcode>Client</faultcode> <faultstring> Supplied input is not well formed or does not contain the expected data. </faultstring>

Siebel Application Services Interface Reference Version 8.2

25

Application Services Interfaces Authentication and Security for ASIs

<detail> <siebelf:errorstack> <siebelf:error> <siebelf:errorsymbol /> <siebelf:errormsg>Supplied input is not well formed or does not contain the expected data. </siebelf:errormsg> </siebelf:error> <siebelf:error> <siebelf:errorsymbol> IDS_XMLCNV_ERR_EMPTYMSG </siebelf:errorsymbol> <siebelf:errormsg>XML Hierarchy Converter error - empty input message, expecting an XML document in <Value> of input arguments </siebelf:errormsg> </siebelf:error> </siebelf:errorstack> </detail> </SOAP-ENV:Fault> </SOAP-ENV:Body> </SOAP-ENV:Envelope>

Errors for Outbound ASIs


If an error occurs during an outbound ASI that has been exposed as a Web service, the business service raises the error and returns the SOAP fault message as the output method argument, soap:fault, for the application to process. The error is represented as an XML hierarchy property set.

Authentication and Security for ASIs


The authentication and security for ASIs depend on the underlying transport used to access the ASI and standard Siebel login logic. HTTP enables the authentication of individual Siebel users, while the MQ Series and MSMQ rely on the operating systems level of security of the underlying transport. For more information about authentication and security, see the Siebel Security Guide. NOTE: The Siebel Bookshelf is available on Oracle Technology Network (OTN) and Oracle E-Delivery. It might also be installed locally on your intranet or on a network location.

26

Siebel Application Services Interface Reference Version 8.2

4
Using ASIs

Administering Application Services Interfaces

This chapter describes how to implement ASIs and how to apply them to your workflows. Some user scenarios are described for you to better understand how to administer ASIs. Topics include:

User Scenarios for ASI Administration

Using ASIs
Siebel ASIs are prebuilt and ready to use for integration between Siebel applications and external applications. ASIs require no change to the actual interface to be deployed and include prebuilt data maps that require no customization. You can deactivate fields and components within ASIs with no loss of their release-independence or upgradeability. You can customize ASIs by adding new components and fields. For more information about customizing, see Chapter 5, Customizing an Application Services Interface. NOTE: For other, customized interfaces (that is, not prebuilt ASIs) that you build, upgradeability across releases is not guaranteed. The key activities when using ASIs include: Configuring ASIs on page 27 Deactivating ASI Components and Fields on page 28 Real Time and Asynchronous Processing with ASIs on page 29

Configuring ASIs
Although ASIs are prebuilt, for them to be exposed to external applications, you must configure them to the requirements of the IT application environment.

To configure an inbound data synchronization ASI 1


Open Siebel Tools and select the integration object you want to update and deactivate the components and fields you do not require for your business service. NOTE: If an inbound ASI needs to be invoked through a workflow process, you need to define a named subsystem. See Integration Platform Technologies: Siebel Enterprise Application Integration for more information about named subsystems and how to define them. See Deactivating ASI Components and Fields on page 28 for more information. If you only deactivated fields and no map is specified in the ASI, a data map is unnecessary. Implicit data mapping still applies.

Siebel Application Services Interface Reference Version 8.2

27

Administering Application Services Interfaces Using ASIs

Recompile the project into an SRF file. The ASI is now ready to use as a business service.

(Optional) If the ASI is to be made into a Web service, create a new entry in the Inbound Web Services Administration view.

To configure an outbound ASI 1


Open Siebel Tools and select the integration object you want to change and deactivate the components and fields you do not require for the ASI. See Deactivating ASI Components and Fields on page 28 for more information. NOTE: Skip steps 3 through 5 of this procedure if a WSDL file exists for the internal interface. You can run the WSDL Wizard to import the necessary information. If a WSDL file does not exist, complete steps 2 through 4 of this procedure.

Open the Siebel Client, choose the Administration - Web Services menu, select the Outbound Web Services screen, and define an entry for the outbound ASI. The port type should reference the business service created for the outbound ASI. The name of the business service and port must match the default names set on the business services definition.

Open Siebel Tools, select Business User Properties, and configure the following properties:

Transport. The service to send the request. See Exposing ASIs with Interface Technologies on page 24 for more information. Protocol. Defines the formatting of the data. See Protocols Used with ASIs on page 24 for more information. Address. The location to send the request. Use the URL or queue name associated with the transport.

Recompile the projects with the integration objects and business services definition into the SRF file.

Deactivating ASI Components and Fields


By default, all fields are active for use. You can deactivate fields for your particular business needs. In general, if you are deactivating the fields of an inbound ASI, you must also deactivate the corresponding outbound ASI fields; if you deactivate the fields for an outbound ASI, you must also deactivate the inbound ASI fields.

To deactivate a component or field 1 2 3


Open Siebel Tools. Navigate to Integration Object, and choose the integration object you want to modify. Select the components or fields you want to deactivate.

28

Siebel Application Services Interface Reference Version 8.2

Administering Application Services Interfaces User Scenarios for ASI Administration

4 5

Check the Inactive column to make that component or field inactive. Deactivate the map for the component, if an explicit map exists.

NOTE: Setting all fields as active slows the performance time. By deactivating fields, the amount of data sent decreases. For high-volume ASIs, deactivating fields might significantly reduce the performance and physical considerations surrounding a given integration object. Deactivate unnecessary fields to help increase performance time.

Real Time and Asynchronous Processing with ASIs


After an ASI request has been submitted, it executes immediately for the Siebel application or the external application in real time (synchronously). However, you can model asynchronous requests by creating two ASI methods.

To create an asynchronous process 1 2 3


Create an outbound ASI to provide the request arguments. See To define an inbound interface on page 34. Create an inbound ASI to accept the result from the external application. See To define an external interface on page 35. Create an explicit correlation ID in the outbound and inbound ASI to link the result to the original request.

Batch Processing
You can perform batch processing on ASIs by customizing the workflows to call an ASI at a specific time.

To create a batch process 1 2


Create the workflow process to call an ASI. Schedule a Server Component Request to invoke the Workflow Process Batch Manager to run the workflow process.

See the application-specific documentation for information about customizing workflows.

User Scenarios for ASI Administration


The following scenario describes ASI administration. John is an integration administrator at ABC Company who must configure the prebuilt Siebel ASIs. The key activities in this scenario are: Deactivating ASI Components and Fields Exposing an Inbound ASI Specifying an ASI Implementation

Siebel Application Services Interface Reference Version 8.2

29

Administering Application Services Interfaces User Scenarios for ASI Administration

A back-office application is sending customer information to be synchronized from the Siebel application to a back-office system. John needs to expose an existing inbound ASI, Sync Siebel Product, to receive the customer information, which uses data synchronization services. He also needs to use an existing outbound ASI, Sync External Account, to send the updated information to another system. In addition, John must also deactivate fields in the integration objects that are not being used for these particular ASIs.

Deactivating Fields in the Integration Object


John needs to deactivate various fields in the integration objects for the inbound ASI, AccountReceive, and the outbound ASI, AccountSend, that are not relevant for his companys business object. For each ASI, John: Chooses the internal integration object for the specific ASI and deactivates the unnecessary fields in Siebel Tools. Chooses the interface integration object for the specific ASI and deactivates the same fields he deactivated in the internal integration object. He deactivates these fields in Siebel Tools.

Exposing an Inbound ASI


John needs to expose the inbound ASI, AccountReceive, to receive the customer information from the back-office system. He wants the inbound ASI to be available over HTTP. In the Inbound Web Services screen in the Siebel Client, he specifies the port binding information: transport, protocol, and address. He publishes the WSDL file to advertise the inbound ASI and its address.

Specifying an ASI Implementation


For the outbound ASI, AccountSend, John wants to send the customer information as SOAP over HTTP. In the Outbound Web Services screen in the Siebel Client, he specifies the following for AccountSend: TransportHTTP ProtocolSOAP File addresshttp://ABCcompany/sendRequests/customer

30

Siebel Application Services Interface Reference Version 8.2

Customizing an Application Services Interface

This chapter describes the ASI framework, extending existing ASIs, and building your own interfaces. Also included is an in-depth description of how to customize your workflows to use ASIs. Topics include: About ASI Framework Customizing Workflows to Use ASIs Building Customized Interfaces Using the ASI Framework User Scenarios for ASIs

About ASI Framework


As defined in Defining ASIs on page 9, an ASI is a release-independent interface published by Oracle in a standard metadata format and built using the ASI Framework. The ASI Framework provides the technology in which ASIs are implemented. You can use this framework to extend existing ASIs or to define your own Web service and proxies in a Siebel application for externally defined services. Other interfaces can be built using the ASI Framework, but are not considered to be ASIs. Only Siebel prebuilt ASIs are supported across releases. NOTE: For other, customized interfaces (that is, not prebuilt ASIs) that you build using the ASI Framework, upgradeability across releases is not guaranteed.

Extending an ASI
The following procedure describes extending an existing Siebel ASI to meet specific business needs.

To extend an ASI 1 2 3 4 5
Identify the integration objects to modifythe internal integration object and the interface integration object. Open Siebel Tools, select the internal integration object, and add the required components and fields. Select the interface integration object and add the required components and fields, matching the component and field names from the internal integration object. Choose the Tools menu and select Validate Object to check the definition of the integration objects. Recompile the project into an SRF file, and replace the SRF file on the application server with the new SRF file.

Siebel Application Services Interface Reference Version 8.2

31

Customizing an Application Services Interface Customizing Workflows to Use ASIs

Open the Siebel Client, select the Administration - Integration menu, choose the Data Maps screen, query for the data map, and click Auto-Map if an explicit map exists for this service. Clicking Auto-Map automatically creates an explicit map for the newly added components and fields to the ASI. Auto-Map maps the matching root components, fields, and child components between the integration objects, if the names are the same and no current mapping exists. For more information about the Auto-Map feature, see Automatic Mapping for Integration Objects on page 19.

7 8

Click Validate in the Data Map screen to check any changes to the data map before testing. If you are using a data map for the ASI, make sure you purge the Data Map cache to remove any traces of the current data map and enable the correct data map to be used. CAUTION: Purge the data map only during the development and testing phases of the ASI. NOTE: To purge the Data Map cache, you need to define a workflow under Business Process Administration. For more information about creating this workflow, see Business Processes and Rules: Siebel Enterprise Application Integration.

Test the ASI to make sure it is accurate and correct.

For instructions about defining your own Web service and proxies in a Siebel application for externally defined services, see Integration Platform Technologies: Siebel Enterprise Application Integration.

Customizing Workflows to Use ASIs


Workflows can invoke some ASIs for their processes. You can customize workflows to use the ASIs in the individual Siebel applications. In the following scenario, Figure 9 on page 32 illustrates a workflow to Synchronize Account, invoking different ASI methods, QuerybyID and Synchronize. NOTE: For more information about customizing workflows, see the application-specific documentation.

Customized Workflow Example


A customer using an external application needs to update an account within the Siebel database. The following scenario demonstrates how this customized workflow operates. In the scenario illustrated in Figure 9, the object ID is used to query for the account being sent. The QueryById method returns the account, which is stored in the SiebelMessage property. The account information is passed to the External Account Proxy, which sends the account information to the external system through Web services. The external system synchronizes the information and returns any new account information. The Synchronize method takes that new account information and synchronizes the information on the internal system.

Figure 9.

Synchronize Account Workflow

32

Siebel Application Services Interface Reference Version 8.2

Customizing an Application Services Interface Customizing Workflows to Use ASIs

The QueryById method contains the method arguments shown in Table 5.

Table 5. Name

QueryById Method Arguments Display Name ID Account Interface Integration Object None Account Interface Data Type String Integration Object Type Input Output Storage Type Property Hierarchy

PrimaryRowID SiebelMessage

The Synchronize method contains the method argument shown in Table 6.

Table 6. Name

Synchronize Method Argument Display Name Account Interface Integration Object Account Interface Data Type Integration Object Type Input/ Output Storage Type Hierarchy

SiebelMessage

In this example, an interface integration object with the name Account Interface is created to define the external representation of the account. An internal integration object with the name Internal Account Interface is created to describe the structure of the Account business object. The workflow process properties are used to store data in the workflow. The Object ID property (data type String) is included in each workflow by default. Account Message (data type Integration Object) is defined to store the output of the Query by Account ID step. The Query by Account step calls the QueryById method of the Siebel Account data synchronization service. The process property Object ID is passed as an input argument. Account Interface is passed as an output argument to the process property Account Message. The External Account Proxy step calls the Synchronize method of the External Account outbound ASI. For the input argument, the process property, Account Message, is passed to the input argument, Account Interface. For the output argument, the method output argument, Account Interface, is passed to the process property, Account Message. Table 7 shows the input arguments.

Table 7.

Input Arguments Type Process Property Process Property Property Name Object ID Account Message Property Data Type String Integration Object

Input Argument ID Account Interface

Siebel Application Services Interface Reference Version 8.2

33

Customizing an Application Services Interface Building Customized Interfaces Using the ASI Framework

Table 8 shows the output argument.

Table 8.

Output Argument Type Output Argument Output Argument Account Interface

Property Name Account Message

Building Customized Interfaces Using the ASI Framework


You can build your own interfaces using the ASI Framework.

To define an inbound interface 1 2


Determine the schema and fields of the integration objects based on your business needs. Open Siebel Tools, create the internal integration object using the Integration Object Wizard, and deactivate the components and fields that are not required. NOTE: Deleting fields is not recommended. For more information about creating integration objects, see Integration Platform Technologies: Siebel Enterprise Application Integration.

Create the interface integration object in Siebel Tools using one of the following methods:

Copy the internal integration object, if the internal and interface objects are the same. Use the DTD or XML schema wizard. For more information about using the XML schema wizard, see Integration Platform Technologies: Siebel Enterprise Application Integration. Create the object manually.

4 5 6 7

Deactivate the components and fields that are not required. Deleting fields is not recommended. Choose the Tools menu and select Validate Object to check the definition of the integration objects. Compile the SRF file, and import it to the Siebel Server. Open Siebel Client, select the Administration - Integration menu, and select the Data Maps screen. NOTE: Do not create an explicit data map if an object is a subset of another or if the objects are the same. The data synchronization service automatically maps the subsets if the root integration components have the same name.

Open the Integration Administration menu and choose the Data Map editor to create an explicit data map if the two objects contain different component or field names. A map is required for each direction:

From Interface Object to Internal Object

34

Siebel Application Services Interface Reference Version 8.2

Customizing an Application Services Interface Building Customized Interfaces Using the ASI Framework

From Internal Object to Interface Object

Click Validate in the Data Map editor to check the data map changes before testing. CSSEAIDataSyncService. Within the business service:

10 Open Siebel Tools, define the business service, and set the class property to

a b

Define the methods needed for this service. See Data Synchronization Methods for ASIs on page 19 for more details. Define the Business Service User Properties to configure the internal object and the data map names. See Business Service User Properties for ASIs on page 22 for more details.

11 Recompile the projects with the integration objects and business services definition into the SRF
file.

12 Open Siebel Client, select the Administration - Web Services menu, and choose the Inbound Web
Services screen. Create an entry if the inbound interface is to be made available as a Web service. To create an outbound interface, you must publish it as a Web service to use it externally.

To define an external interface 1


Open Siebel Tools and define the integration objects manually or by using the Integration Object Wizard.

a b

Deactivate components and fields that are not required. Deleting fields is not recommended. Create interface integration objects manually by copying and changing the internal object, or by importing an XML DTD.

NOTE: Skip to Step 5 of this procedure if a WSDL file exists for the internal interface. You can run the WSDL Wizard to automatically import the information that is created manually in Step 3 through Step 5. If a WSDL file does not exist, complete Step 2 through Step 4. For more information about using the WSDL Wizard, see Integration Platform Technologies: Siebel Enterprise Application Integration.

Open Siebel Tools and define the business service to describe the interface to the ASI, including all methods and parameters for each method. This business service references the integration objects created in Step 1.

a b 3

Set the business services class to CSSWSOutboundDispatcher. Set the parameters on methods to type Integration Object and refer to the specified interface object.

Define the Business Service User Properties in Siebel Tools:

a b

Choose a name for the default service, siebel_web_service_name. Choose the properties for the default port, siebel_port_name.

Siebel Application Services Interface Reference Version 8.2

35

Customizing an Application Services Interface User Scenarios for ASIs

Register the name on the business service as a user property, and define the service and port name as the proxys default service name, siebel_web_service_namespace.

NOTE: The user property, ApplicationServicesInterface, is set to Y for each ASI Business Service. You can use it for visual identification to differentiate this business service from other business services. The user property has no functional implication.

Open Siebel Client, choose the Outbound Web Services screen, and select a name for the default service. Configure the following properties:

Port types are all the published proxy business services used to define the outbound ASI interface. The port name is the business service you created in Siebel Tools in Step 2 on page 35. Transports describe the transport type for your particular platform and system. For more information, see Exposing ASIs with Interface Technologies on page 24. Protocols describes the formatting of the integration object being sent. For more information, see Protocols Used with ASIs on page 24. Address is the physical location of the touchpoint files.

5 6

Recompile the projects with the integration objects and business services definition into the SRF file. Define an entry for the outbound ASI in the Outbound Services Administration View. The port type should reference the business service created for the outbound ASI. The name of the business service and port must match the default names set on the business services definition.

To define the data map


An inbound and outbound data map need to be created for each interface. In Siebel Client, use the Data Maps view under the Administration - Integration menu to create a new data map for new or customized integration objects. See Data Mapping for ASI Release Independence on page 16 for more information about data mapping.

For more information about creating a data map for the ASI, see Business Processes and Rules: Siebel Enterprise Application Integration.

User Scenarios for ASIs


The Siebel prebuilt ASIs might not be sufficient, depending on your business needs. You can extend existing ASIs for further customization, or you can create new interfaces using the ASI Framework. The following scenarios describe an integration developer who needs to customize the interface to reflect her companys business needs, rules, and processes. The key activities in these scenarios are: Defining an Outbound ASI Defining an Outbound ASI

36

Siebel Application Services Interface Reference Version 8.2

Customizing an Application Services Interface User Scenarios for ASIs

Extending an ASI
At the ABC company, Jane needs to extend an existing ASI by adding a new field, LifeTimeValue, to the business component, Account, and expose the new field in the ASI, Siebel Account, which uses data synchronization services. To accomplish these tasks, Jane must:

1 2 3 4 5

Create the new field, LifeTimeValue, in the Account business component using Siebel Tools. Add LifeTimeValue to Accounts internal integration object using Siebel Tools. Add LifeTimeValue to Accounts interface integration object using Siebel Tools. She must make sure that the two fields in the internal and interface integration objects have matching names. Recompile the integration objects and project into an SRF file, and test the new ASI. Use the Auto-Map function in the Siebel Data Mapper to automatically map the new field in the internal integration object to the new field in the interface integration object.

After completing these tasks, the new field is available to the business component, Account, and all ASIs based on it, including Siebel Account.

Defining an Outbound ASI


Jane needs to define an outbound ASI for her company, ABC Company, that submits an order to a back-office system using data synchronization services. She calls the ExternalOrder ASI. To create this ASI, Jane must do the following in Siebel Tools:

1 2

Create an internal integration object, ExternalOrder Internal, with the necessary components and fields based on ABC Companys business needs. Create an interface integration object, ExternalOrder Interface, with the same components and field names as the ExternalOrder Internal integration object. Because both integration objects have the same component and field names, Jane does not need to create a data map, because she uses the data synchronization services implicit mapping function. Define a new Business Service, named ExternalOrder, as an outbound ASI, by specifying CSSWSOutboundDispatcher as Class. Define all the methods used by this ASI. For each method, create the method argument parameters as Integration Object, String, Hierarchy, Number, or Date, and specify the Type as input or output. Specify the implementation for the ASI by setting the Business Service User Properties, because she does not have a current WSDL template to import. Consequently, Jane must create the following Business Service User Properties: Business Service User Property siebel_web_service_namespace siebel_web_services_name siebel_port_name Value ExternalOrder ExternalOrder Default

3 4 5 6

Siebel Application Services Interface Reference Version 8.2

37

Customizing an Application Services Interface User Scenarios for ASIs

7 8 9

Compile all integration objects and business services into an SRF file for the Siebel Server. In the Siebel Client, navigate to the Administration - Web Services screen, and then Outbound Web Services. Define a new outbound ASI called ExternalOrder, provide a namespace, and make it Active. Order that she created and compiled in Siebel Tools.

10 For the outbound ASI, create the Service Port External Order and reference it to the External 11 Select the correct transport, WSDL address, and binding. 12 Under Operations, list the methods needed for this ASI. The new ExternalOrder ASI is created
and ready to use.

38

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces

This appendix provides a list of the prebuilt ASIs that are provided with Siebel applications. You can use these ASIs to receive, send, or request data from other applications. An ASI consists of a business service, which implements various methods and integration objects, and holds whatever data is present in run time. An integration object can consist of multiple integration components, each with multiple fields. All these fields are active by default and are used by the ASI. You can deactivate unnecessary fields. For more information, see Deactivating ASI Components and Fields on page 28. Each ASI is based on an integration object and can be used to integrate data for all fields of that integration object. This appendix includes the following topics: About Prebuilt ASIs Siebel Account Siebel Action Siebel Business Address Siebel Personal Address Siebel Asset Siebel Contact Siebel CUT Address MSAG Service Siebel Cost List Siebel Employee Siebel Financial Account Siebel Forecast Siebel Invoice External Opportunity Create/External Opportunity Query/External Opportunity Update Siebel Order Siebel Position Siebel Price List Siebel Quote/External Quote Siebel ATP Response/External ATP Check External Credit Check External Shipment Tracking

Siebel Application Services Interface Reference Version 8.2

39

Predefined Application Service Interfaces About Prebuilt ASIs

Siebel SIA Service Request Siebel Service Request Siebel Simple Product

NOTE: Required is abbreviated as Req. and Not Applicable is abbreviated as NA in the following tables.

About Prebuilt ASIs


Table 9 lists the prebuilt ASIs provided by Oracle. Table 9. ASI Siebel Account Siebel Action Siebel Business Address Siebel Personal Address Siebel Asset Siebel Contact Siebel Cost List Siebel Employee Prebuilt Application Services Interfaces Description ASI to facilitate the inbound and outbound transfer of account data from the Siebel application. For details, see Siebel Account on page 41. ASI to facilitate the inbound and outbound transfer of activity data from the Siebel application. For details, see Siebel Action on page 55. ASI to facilitate the inbound and outbound transfer of business address data from the Siebel application. For details, see Siebel Business Address on page 61. ASI to facilitate the inbound and outbound transfer of personal address data from the Siebel application. For details, see Siebel Personal Address on page 63 ASI that associates a customer with a unique product. For details, see Siebel Asset on page 64. ASI to facilitate the inbound and outbound transfer of contact data from the Siebel application. For details, see Siebel Contact on page 68. ASI to enable the synchronization and update of a cost list and the cost list items. For details, see Siebel Cost List on page 75. ASI to facilitate the inbound and outbound transfer of employee data from the Siebel application. For details, see Siebel Employee on page 78. ASI to facilitate the inbound and outbound financial account data synchronization between the Siebel application and the UCM system. For details, see Siebel Financial Account on page 90. ASI to facilitate the outbound data synchronization between the Siebel application and an external back-office system. For details, see Siebel Forecast on page 96. ASI to facilitate the inbound and outbound transfer of invoice data from the Siebel application. For details, see Siebel Invoice on page 98.

Siebel Financial Account Siebel Forecast

Siebel Invoice

40

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Account

Table 9. ASI

Prebuilt Application Services Interfaces Description ASI to facilitate the inbound and outbound transfer of opportunity data from the Siebel application. For details, see External Opportunity Create/ External Opportunity Query/External Opportunity Update on page 109.

External Opportunity Create/External Opportunity Query/ External Opportunity Update Siebel Order Siebel Position Siebel Price List Siebel ATP Response/ External ATP Check External Credit Check Siebel SIA Service Request Siebel Service Request

ASI to facilitate the inbound and outbound transfer of order data from the Siebel application. For details, see Siebel Order on page 129. ASI to facilitate the inbound and outbound transfer of position data from the Siebel application. For details, see Siebel Position on page 146. ASI to enable the synchronization and update of a price list and the price list items. For details, see Siebel Price List on page 147. ASI to facilitate request of availability-to-promise data. For details, see Siebel ATP Response/External ATP Check on page 165. ASI to facilitate the request for a credit check from an external system. For details, see External Credit Check on page 173. ASI to create an SIA service request within the Siebel application. For details, see Siebel SIA Service Request on page 181. ASI to synchronize service requests in the Siebel application with an external target application. For details, see Siebel Service Request on page 184. ASI to facilitate the inbound and outbound transfer of simple product data from the Siebel application. For details, see Siebel Simple Product on page 188.

Siebel Simple Product

Siebel Account
Use this ASI for customer information management-related business processes. This ASI facilitates inbound and outbound account data synchronization between a Siebel application and any external system. Figure 10 describes the Siebel Account ASI structure.

Figure 10. Siebel Account ASI

Siebel Application Services Interface Reference Version 8.2

41

Predefined Application Service Interfaces Siebel Account

Table 10 lists the user keys of the Siebel Account ASI.

Table 10.

Siebel Account Integration Components XML Tag Account User Keys

Integration Component Account

1 2 3

Account Id Integration Id Location, Name, Primary Organization Address Id Address Integration Id City, State, Street Address Credit Profile Id Credit Profile Integration Id Credit Area Id Integration Id Bill To Account, Location CSN Person UId, Primary Organization Contact Id Contact Integration Id First Name, Last Name, Middle Name Credit Control Area Code Industry Id Industry Integration Id Industry SIC Code Organization Id Organization Integration Id Organization

Business Address

BusinessAddress

1 2 3

Credit Profile

CreditProfile

1 2 3

Related Bill To Account

RelatedBillToAccount

1 2 3 4

Related Contact

RelatedContact

1 2 3 4

Related Credit Profile Related Industry

RelatedCreditProfile RelatedIndustry

1 1 2 3 4

Related Organization

RelatedOrganization

1 2 3

42

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Account

Table 10.

Siebel Account Integration Components XML Tag RelatedPayerAccount User Keys

Integration Component Related Payer Account

1 2 3 4

Id Integration Id Payer Account, Location CSN Organization Id Position Id Position Integration Id Division, Position Login Id Integration Id Ship To Account, Location CSN Id Integration Id Sold To Account, Location CSN

Related Sales Organization Related Sales Rep

RelatedSalesOrganization RelatedSalesRep

1 1 2 3 4

Related Ship To Account

RelatedShipToAccount

1 2 3 4

Related Sold To Account

RelatedSoldToAccount

1 2 3 4

Table 11 lists the fields and attributes of this ASI.

Table 11. Name Account

Siebel Account ASI Fields XML Tag Data Type Length Req. Notes

Account Id Account Organization Integration Id Account Status Alias Assignment Area Code

AccountId AccountOrganizationIntegratio nId AccountStatus Alias AssignmentAreaCode

DTYPE_ID DTYPE_TEXT

30 30

No No

None None

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

24 50 5

No No No

None None None

Siebel Application Services Interface Reference Version 8.2

43

Predefined Application Service Interfaces Siebel Account

Table 11. Name

Siebel Account ASI Fields XML Tag AssignmentCountryCode BackOfficeOrderQueryEndDt BackOfficeOrderQueryStartDt BackOfficeSalesAreaDivisionCo de CSN CompetitorFlag Created CreditAutoApprovalLimit CreditStatusDate CurrencyCode Data Type DTYPE_TEXT DTYPE_DATE TIME DTYPE_DATE TIME DTYPE_TEXT Length 5 NA NA 30 Req. No No No No Notes None None None None

Assignment Country Code Back Office Order Query End Dt Back Office Order Query Start Dt Back Office Sales Area Division Code CSN Competitor Flag Created Credit Auto Approval Limit Credit Status Date Currency Code

DTYPE_TEXT DTYPE_BOOL DTYPE_DATE TIME DTYPE_CUR RENCY DTYPE_UTCD AYETIME DTYPE_TEXT

30

No No

None None None None None Used for picking a related entity. None None None None None None None None None

30 NA 7 15

No No No No

Customer Account Group Description Disable Data Cleansing Division DUNS Number Domestic Ultimate DUNS EAI Sync Date EAI Sync Error Text EAI Sync Status Code

CustomerAccountGroup Description DisableDataCleansing Division DUNSNumber DomesticUltimateDUNS EAISyncDate EAISyncErrorText EAISyncStatusCode

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

30 255 NA 30 15 15 NA 2000 30

No No No No No No No No No

44

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Account

Table 11. Name Expertise

Siebel Account ASI Fields XML Tag Expertise Data Type DTYPE_TEXT Length 30 Req. No Notes Bound by ACCOUNT_EX PERTISE LOV. None None None None User key field. None None None None None User key field. None None None Used for picking a related entity. None None None None None

Freight Terms Freight Terms Info Global Ultimate DUNS Home Page Integration Id Internal Org Flag Language Code Location Main Fax Number Main Phone Number Name Number of Employees operation PO Approved Flag PO Auto Approval Currency Code PO Auto Approval Date PO Auto Approval Limit Parent Account Division Parent Account Id Parent Account Integration Id

FreightTerms FreightTermsInfo GlobalUltimateDUNS HomePage IntegrationId InternalOrgFlag LanguageCode Location MainFaxNumber MainPhoneNumber Name NumberofEmployees operation POApprovedFlag POAutoApprovalCurrencyCode

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_PHO NE DTYPE_PHO NE DTYPE_TEXT DTYPE_NUM BER DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

30 100 15 100 30 NA NA 50 NA NA 100 NA 30 NA 20

No No No No No No No No No No No No No No No

POAutoApprovalDate POAutoApprovalLimit ParentAccountDivision ParentAccountId ParentAccountIntegrationId

DTYPE_DATE TIME DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT

NA NA NA NA 30

No No No No No

Siebel Application Services Interface Reference Version 8.2

45

Predefined Application Service Interfaces Siebel Account

Table 11. Name

Siebel Account ASI Fields XML Tag ParentAccountLocation ParentAccountLocationLevel ParentAccountName ParentAccountRegion ParentHQDUNS PartnerFlag Partners PartyName PartyTypeCode PartyUId PriceList PriceListEndDate PriceListId PriceListIntegrationId PriceListStartDate PrimaryAccountCity PrimaryAccountCountry PrimaryAccountPostalCode PrimaryAccountState PrimaryAccountStreetAddress PrimaryAddressId Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID Length 50 30 100 30 15 1 100 30 30 30 NA NA NA 30 NA 50 30 30 10 200 NA Req. No No No No No No No No No No No No No No No No No No No No No Notes None None None None None None None None None None None None None None None None None None None None None

Parent Account Location Parent Account Location Level Parent Account Name Parent Account Region Parent HQ DUNS Partner Flag Partners Party Name Party Type Code Party UId Price List Price List End Date Price List Id Price List Integration Id Price List Start Date Primary Account City Primary Account Country Primary Account Postal Code Primary Account State Primary Account Street Address Primary Address Id

46

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Account

Table 11. Name

Siebel Account ASI Fields XML Tag PrimaryAssignmentDenormFla g PrimaryAssignmentManualFlag Data Type DTYPE_TEXT Length NA Req. No Notes None

Primary Assignment Denorm Flag Primary Assignment Manual Flag Primary Assignment System Flag Primary Assignment Type Primary Bill To Address Id Primary Bill To City Primary Bill To Country Primary Bill To First Name Primary Bill To Job Title Primary Bill To Last Name Primary Bill To Person Id Primary Bill To Postal Code Primary Bill To State Primary Bill To Street Address Primary Fulfill InvLoc Integration Id Primary Fulfillment InvLoc Id

DTYPE_TEXT

NA

No

None

PrimaryAssignmentSystemFlag

DTYPE_TEXT

NA

No

None

PrimaryAssignmentType PrimaryBillToAddressId PrimaryBillToCity PrimaryBillToCountry PrimaryBillToFirstName PrimaryBillToJobTitle PrimaryBillToLastName PrimaryBillToPersonId PrimaryBillToPostalCode PrimaryBillToState PrimaryBillToStreetAddress PrimaryFulfillInvLoc IntegrationId PrimaryFulfillmentInvLocId

DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

30 NA 50 30 50 75 50 NA 30 10 200 30

No No No No No No No No No No No No

None None None None None None None None None None None None

DTYPE_TEXT

NA

No

None

Siebel Application Services Interface Reference Version 8.2

47

Predefined Application Service Interfaces Siebel Account

Table 11. Name

Siebel Account ASI Fields XML Tag PrimaryFulfillment InventoryLocation Data Type DTYPE_TEXT Length NA Req. No Notes None

Primary Fulfillment Inventory Location Primary Industry Id Primary Organization Primary Organization Id Primary Payer Account Primary Payer Account Id Primary Position Id Primary Service Agreement Id Primary Ship To Address Id Primary Ship To City Primary Ship To Country Primary Ship To First Name Primary Ship To Job Title Primary Ship To Last Name Primary Ship To Person Id Primary Ship To Postal Code Primary Ship To State

PrimaryIndustryId PrimaryOrganization PrimaryOrganizationId PrimaryPayerAccount PrimaryPayerAccountId PrimaryPositionId PrimaryServiceAgreementId PrimaryShipToAddressId PrimaryShipToCity PrimaryShipToCountry PrimaryShipToFirstName PrimaryShipToJobTitle PrimaryShipToLastName PrimaryShipToPersonId PrimaryShipToPostalCode PrimaryShipToState

DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_ID DTYPE_ID DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT

NA 100 NA 100 NA NA NA NA 50 30 50 75 50 NA 30 10

No No No No No No No No No No No No No No No No

None User key field. None None None None None None None None None None None None None None

48

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Account

Table 11. Name

Siebel Account ASI Fields XML Tag PrimaryShipToStreetAddress PrimaryTerritoryId PrimaryTypeId Region RelationshipType RevenueGrowth SkipCreditCheck StartDate Strategies Strategy SuccessFactors TerritoryItemType Type Updated VATregistrationnumber Data Type DTYPE_TEXT DTYPE_ID DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_NUM BER DTYPE_TEXT DTYPE_DATE TIME DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_DATE TIME DTYPE_TEXT Length 200 NA NA 30 30 NA NA NA 500 2000 500 30 255 30 30 Req. No No No No No No No No No No No No No No No Notes None None None None None None None None None None None None None None None

Primary Ship To Street Address Primary Territory Id Primary Type Id Region Relationship Type Revenue Growth Skip Credit Check Start Date Strategies Strategy Success Factors Territory Item Type Type Updated VAT registration number Business Address Address Active Status Address Id Address Integration Id Address Name Bill Address Flag City Country County

AddressActiveStatus AddressId AddressIntegrationId AddressName BillAddressFlag City Country County

DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

NA 30 30 100 NA 50 50 50

No No No No No No No No

None None None None None None None None

Siebel Application Services Interface Reference Version 8.2

49

Predefined Application Service Interfaces Siebel Account

Table 11. Name

Siebel Account ASI Fields XML Tag DisableDataCleansing EmailAddress FaxNumber MainAddressFlag operation PhoneNumber IsPrimaryMVG PostalCode Province ShipAddressFlag State StreetAddress Street Address2 Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT NA DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length NA 50 NA NA 30 NA 1 30 50 NA 10 200 100 Req. No No No No No No No No No No No No No Notes None None None None None None None None None None None None None

Disable Data Cleansing Email Address Fax Number Main Address Flag operation Phone Number IsPrimaryMVG Postal Code Province Ship Address Flag State Street Address Street Address 2 Credit Profile Credit Area Credit Available Credit Currency Code Credit Limit Credit Profile Id Credit Profile Integration Id Credit Reporting Group Credit Status Code Credit Status Message

CreditArea CreditAvailable CreditCurrencyCode CreditLimit CreditProfileId CreditProfileIntegrationId CreditReportingGroup CreditStatusCode CreditStatusMessage

DTYPE_TEXT DTYPE_NUM BER DTYPE_TEXT DTYPE_NUM BER DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

30 NA 20 NA 30 30 50 30 NA

No No No No No No No No No

None None None None None None None None None

50

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Account

Table 11. Name

Siebel Account ASI Fields XML Tag CreditUsed IsPrimaryMVG RiskCategoryCode operation Data Type DTYPE_NUM BER DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length NA 1 30 30 Req. No No No No Notes None None None None

Credit Used IsPrimaryMVG Risk Category Code operation Related Contact Alternate Phone # Assistant Phone # Cellular Phone # Conflict Id Contact Id Contact Integration Id Email Address Employee Number Fax Phone # First Name Home Phone # Job Title Last Name M/F M/M Middle Name Organization Person UId Primary Organization Work Phone #

AlternatePhone AssistantPhone CellularPhone ConflictId ContactId ContactIntegrationId EmailAddress EmployeeNumber FaxPhone FirstName HomePhone JobTitle LastName MF MM MiddleName Organization PersonUId PrimaryOrganization WorkPhone

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

NA NA NA 30 30 30 50 30 NA 50 NA 75 50 255 15 50 50 100 100 NA

No No No No No No No No No No No No No No No No No No No No

None None None None None None None None None None None None None None None None None None None None

Siebel Application Services Interface Reference Version 8.2

51

Predefined Application Service Interfaces Siebel Account

Table 11. Name

Siebel Account ASI Fields XML Tag WorkPhoneExtension Data Type DTYPE_TEXT Length 10 Req. No Notes None

Work Phone Extension Related Industry Industry Industry Id Industry Integration Id IsPrimaryMVG SIC Code

Industry IndustryId IndustryIntegrationId IsPrimaryMVG SICCode

DTYPE_TEXT

50 30

No No No No No

None None None None None

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

30 1 30

Related Organization IsPrimaryMVG Organization Organization Id Organization Integration Id IsPrimaryMVG Organization OrganizationId OrganizationIntegrationId DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT 1 50 15 30 No No No No None None None None

Related Sales Rep Division IsPrimaryMVG Login Position Position Id Position Integration Id Division IsPrimaryMVG Login Position PositionId PositionIntegrationId DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT 255 1 50 50 30 30 No No No No No No None None None None None None

Related Sales Organization Account Status Back Office Distribution Channel Back Office Sales Area Division Code Back Office Sales Organization Conflict Id AccountStatus BackOfficeDistributionChannel DTYPE_TEXT DTYPE_TEXT 30 30 No No None None

BackOfficeSalesAreaDivisionCo de BackOfficeSalesOrganization ConflictId

DTYPE_TEXT

30

No

None

DTYPE_TEXT DTYPE_ID

30 30

No No

None None

52

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Account

Table 11. Name Created

Siebel Account ASI Fields XML Tag Created CurrencyCode FreightTerms FreightTermsInfo Id IntegrationId LanguageCode ModId Organization OrganizationId ParentAccountId PartyId PaymentTerms PaymentTermsIntegrationId PaymentTermsName PriceListType PrimaryBillToAccountId PrimaryFulfillmentInvLoc Data Type DTYPE_DATE TIME DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_ID DTYPE_ID DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_ID DTYPE_TEXT Length 30 20 30 100 30 30 NA 30 100 NA NA NA NA NA NA NA NA NA Req. No No No No No No No No No No No No No No No No No No Notes None None None None None None None None None None None None None None None None None None

Currency Code Freight Terms Freight Terms Info Id Integration Id Language Code Mod Id Organization Organization Id Parent Account Id Party Id Payment Terms Payment Terms Integration Id Payment Terms Name Price List Type Primary Bill To Account Id Primary Fulfillment InvLoc Primary Fulfillment InvLoc ID Primary Fulfillment InvLoc Integration Id Primary Payer Account Id

PrimaryFulfillmentInvLocID

DTYPE_ID

NA

No

None

PrimaryFulfillmentInvLocIntegr ationId

DTYPE_TEXT

NA

No

None

PrimaryPayerAccountId

DTYPE_ID

NA

No

None

Siebel Application Services Interface Reference Version 8.2

53

Predefined Application Service Interfaces Siebel Account

Table 11. Name

Siebel Account ASI Fields XML Tag PrimaryShipToAccountId ShippingConditions Type Updated Data Type DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_DATE TIME Length NA 30 30 30 Req. No No No No Notes None None None None

Primary Ship To Account Id Shipping Conditions Type Updated

Related Bill To Account Bill To Account CSN Id Integration Id IsPrimaryMVG Location BillToAccount CSN Id IntegrationId IsPrimaryMVG Location DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 100 30 30 30 1 50 No No No No No No None None None None None None

Related Payer Account CSN Id Integration Id IsPrimaryMVG Location Payer Account CSN Id IntegrationId IsPrimaryMVG Location PayerAccount DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 30 30 30 1 50 100 No No No No No No None None None None None None

Related Ship To Account CSN Id Integration Id IsPrimaryMVG Location Ship To Account CSN Id IntegrationId IsPrimaryMVG Location ShipToAccount DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 30 30 30 1 50 100 No No No No No No None None None None None None

Related Sold To Account CSN Id Integration Id CSN Id IntegrationId DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 30 30 30 No No No None None None

54

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Action

Table 11. Name

Siebel Account ASI Fields XML Tag IsPrimaryMVG Location SoldToAccount Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length 1 50 100 Req. No No No Notes None None None

IsPrimaryMVG Location Sold To Account

Related Credit Profile Block Credit Flag Credit Control Area Code BlockCreditFlag CreditControlAreaCode DTYPE_TEXT DTYPE_TEXT NA 30 No No None None

Siebel Action
The Siebel Action ASI is based on the Siebel Action Business Component. It is an ASI for business processes related to Activity management (for example, a Calendar event such as an appointment). This ASI facilitates inbound and outbound activity data synchronization between Siebel 6.3 applications and Siebel 7.5 applications. Figure 11 describes the Siebel Action ASI structure.

Figure 11. Siebel Action ASI

Siebel Application Services Interface Reference Version 8.2

55

Predefined Application Service Interfaces Siebel Action

Table 12 lists the integration components and user keys of the Siebel Action ASI.

Table 12.

Siebel Action Integration Components XML Tag Action User Keys

Integration Component Action

1 2 1 1 1 1 1 1 1 2 1 2 1 1 1 1 1 2

Id Activity UID Contact Id Prospective Contact UID Party UId Party UId Expense Item Number, Owner Id PartMvtNum Name Item Type Name Expertise Code, Low Char 1 Low Char 2, Low Number 1 SeqNum, Step Type Id Instruction, Instruction Type Id Message Number Id Item Date, Owner Id, Time Sheet Item Num

Action_Contact Activity Prospects Contact(All) Employee (MM) Expense Item FS Activity Parts Movement FS Activity Skill

Action_Contact ActivityProspects ContactAll EmployeeMm ExpenseItem FsactivityPartsMovement FsActivitySkill

FS Activity Skill Item

FsActivitySkillItem

FS Activity Step FS Instruction Internal Product Messaging Time Sheet Daily Hours

FsActivityStep FsInstruction InternalProduct Messaging TimeSheetDailyHours

Table 13 lists the fields and their attributes. Fields without a length specified do not have a maximum length associated with them.

Table 13. Name Action

Siebel Action ASI Fields XML Tag Data Type Length Req.

Account Id Activity SR Id Activity UID

AccountId ActivitySRId ActivityUID

DTYPE_ID DTYPE_ID DTYPE_TEXT

Not applicable Not applicable 30

No No No

56

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Action

Table 13. Name Alarm

Siebel Action ASI Fields XML Tag Alarm ApptAlarmTimeMin AssetId AssignmentExcluded AssociatedCost Audience BillableFlag CallId Class Comment CurrencyCode Description Display Done Due EstWorkTimeRemaining ExchangeDate Id MeetingLocation NoSoonerThanDate OpportunityId PercentComplete Planned PlannedCompletion PreviousActivityId PriceListId PrimaryOwnerId Priority Private Data Type DTYPE_TEXT DTYPE_NUMBER DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_NUMBER DTYPE_DATETIME DTYPE_ID DTYPE_TEXT DTYPE_DATETIME DTYPE_ID DTYPE_NUMBER DTYPE_DATETIME DTYPE_DATETIME DTYPE_ID DTYPE_ID DTYPE_ID DTYPE_TEXT DTYPE_TEXT Length Not applicable Not applicable Not applicable Not applicable Not applicable 30 Not applicable 30 30 1,500 Not applicable 100 30 Not applicable Not applicable Not applicable Not applicable 30 100 Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable 30 Not applicable Req. No No No No No No No No No No No No No No No No No No No No No No No No No No No No No

Appt Alarm Time Min Asset Id Assignment Excluded Associated Cost Audience Billable Flag Call Id Class Comment Currency Code Description Display Done Due Est Work Time Remaining Exchange Date Id Meeting Location No Sooner Than Date Opportunity Id Percent Complete Planned Planned Completion Previous Activity Id Price List Id Primary Owner Id Priority Private

Siebel Application Services Interface Reference Version 8.2

57

Predefined Application Service Interfaces Siebel Action

Table 13. Name

Siebel Action ASI Fields XML Tag RateListId RepeatingExpires RepeatingType ResolutionCode Started Status StatusReportFlag Type operation searchspec Data Type DTYPE_ID DTYPE_DATETIME DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length Not applicable Not applicable 30 30 Not applicable 30 Not applicable 30 30 250 Req. No No No No No No No No No No

Rate List Id Repeating Expires Repeating Type Resolution Code Started Status Status Report Flag Type operation searchspec Action_Contact Contact Id IsPrimaryMVG Activity_Prospects Prospective Contact UID Contact Party UId Employee (MM) Party UId Expense Item Account Id Amount Billable Flag Comments Currency Code Description End Date Establishment Exchange Date Exchange Rate

Contact Id IsPrimaryMVG

DTYPE_ID DTYPE_TEXT

30 1

No No

ProspectiveContactUID

DTYPE_TEXT

100

No

PartyUId

DTYPE_TEXT

30

No

PartyUId

DTYPE_TEXT

30

No

AccountId Amount BillableFlag Comments CurrencyCode Desc EndDate Establishment ExchangeDate ExchangeRate

DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_DATETIME DTYPE_NUMBER

Not applicable Not applicable Not applicable 250 20 250 Not applicable 50 Not applicable Not applicable

No No No No No No No No No No

58

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Action

Table 13. Name

Siebel Action ASI Fields XML Tag ExpenseItemNumber ExpenseItemTypeName InternalComments ItemRoomAmount ItemRoomOtherTaxAmount ItemRoomTaxAmount MileageDistance MileageRate MileageRoute OptyId OwnerId PaymentType ProjectBillingClass ReimbursablFlag StartDate Data Type DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME Length Not applicable 50 250 Not applicable Not applicable Not applicable Not applicable Not applicable 100 Not applicable Not applicable 30 30 Not applicable Not applicable Req. No No No No No No No No No No No No No No No

Expense Item Number Expense Item Type Internal Comments Item Room Amount Item Room Other Tax Amount Item Room Tax Amount Mileage Distance Mileage Rate Mileage Route Opty Id Owner Id Payment Type Project Billing Class Reimbursable Flag Start Date

FS Activity Parts Movement Asset Id Billable Flag Commit Txn Flag Destination Movement Date Order Id Order Item Id PartMvtNum Product Id Product Name Source Status Trunk Invloc Id AssetId BillableFlag CommitTxnFlag Destination MovementDate OrderId OrderItemId PartMvtNum ProductId ProductName Source Status TrunkInvlocId DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_ID DTYPE_ID DTYPE_ID DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID Not applicable Not applicable Not applicable 30 Not applicable Not applicable Not applicable Not applicable Not applicable 100 30 30 Not applicable No No No No No No No No No No No No No

Siebel Application Services Interface Reference Version 8.2

59

Predefined Application Service Interfaces Siebel Action

Table 13. Name

Siebel Action ASI Fields XML Tag UsedQuantity Data Type DTYPE_NUMBER Length Not applicable Req. No

Used Quantity FS Activity Skill Comments Item Type Name Name

Comments ItemTypeName Name

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

250 75 50

No No No

FS Activity Skill Item Expertise Code Low Char 1 Low Char 2 Low Number 1 Product Id FS Activity Step Comments End Date Performed Performed by SeqNum Start Date Step Type Id FS Instruction Instruction Instruction Type Messaging Account Id Alert Type CD Comments Contact Last Name Creation Time Message Number Message Status CD Message Text AccountId AlertTypeCD Comments ContactLastName CreationTime MessageNumber MessageStatusCD Message Text DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Not applicable 30 2000 50 Not applicable 30 30 2000 No No No No No No No No Instruction InstructionType DTYPE_NOTE DTYPE_TEXT Not applicable 30 No No Comments EndDate Performed Performedby SeqNum StartDate StepTypeId DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_ID DTYPE_NUMBER DTYPE_DATETIME DTYPE_ID 250 Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable No No No No No No No ExpertiseCode LowChar1 LowChar2 LowNumber1 ProdId DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT 30 50 50 Not applicable Not applicable No No No No No

60

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Business Address

Table 13. Name

Siebel Action ASI Fields XML Tag OpportunityId Priority PrivateFlag Recipient Id SenderId ServiceRequestId Data Type DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_ID DTYPE_ID Length Not applicable 30 Not applicable Not applicable Not applicable Not applicable Req. No No No No No No

Opportunity Id Priority Private Flag Recipient Id Sender Id Service Request Id

Time Sheet Daily Hours Billable Flag Billing Class Billing Rate Type Created End Time External Comments Id Internal Comments Item Date Oppty Id Owner Id Project Id Service Request Id Start Time Time Sheet Item Num BillableFlag BillingClass BillingRateType Created EndTime ExternalComments Id InternalComments ItemDate OpptyId OwnerId ProjectId ServiceRequestId StartTime TimeSheetItemNum DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_DATETIME DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_DATETIME DTYPE_ID DTYPE_ID DTYPE_ID DTYPE_ID DTYPE_DATETIME DTYPE_TEXT Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable No No No No No No No No No No No No No No No

Siebel Business Address


Siebel Business Address is part of the Customer Order Lifecycle business process. The Customer Address is a business address associated with a specific customer. This ASI facilitates inbound and outbound address data synchronization between Siebel applications and external systems.

Siebel Application Services Interface Reference Version 8.2

61

Predefined Application Service Interfaces Siebel Business Address

Figure 12 describes the Siebel Business Address ASI structure.

Figure 12. Siebel Business Address ASI Table 14 lists the integration components and user keys of this ASI.

Table 14.

Siebel Business Address Integration Components XML Tag Address User Keys

Integration Component Address

1 2

Id Integration Id

Table 15 lists the fields and their attributes. Fields without a length specified do not have a maximum length associated with them.

Table 15. Name Address

Siebel Business Address ASI Fields XML Tag Data Type Length Required

Address Line 1 Address Line 2 City Country Id Integration Id operation Postal Code State

AddressLine1 AddressLine2 City Country Id IntegrationId operation PostalCode State

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

200 200 50 50 30 30 30 50 10

No No No No No No No No No

62

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Personal Address

Siebel Personal Address


Siebel Personal Address is part of the Customer Order Lifecycle business process. The Customer Address is a personal address associated with a specific customer. This ASI facilitates inbound and outbound address data synchronization between Siebel applications and external systems. Figure 13 describes the Siebel Personal Address ASI structure.

Figure 13. Siebel Personal Address ASI Table 16 lists the integration components and user keys of the Siebel Personal Address ASI.

Table 16.

Siebel Personal Address Integration Components XML Tag Address User Keys

Integration Component Address

1 2

Id Integration Id

Table 17 lists the fields and their attributes. Fields without a length specified do not have a maximum length associated with them.

Table 17. Name Address

Siebel Personal Address ASI Fields XML Tag Data Type Length Required

Address Line 1 Address Line 2 City Country Id Integration Id operation

AddressLine1 AddressLine2 City Country Id IntegrationId operation

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

200 200 50 50 30 30 30

No No No No No No No

Siebel Application Services Interface Reference Version 8.2

63

Predefined Application Service Interfaces Siebel Asset

Table 17. Name

Siebel Personal Address ASI Fields XML Tag PostalCode State Data Type DTYPE_TEXT DTYPE_TEXT Length 50 10 Required No No

Postal Code State

Siebel Asset
Siebel Asset is part of the Customer Order Lifecycle business process. The Customer Asset is a serialized product or service that a customer has purchased from a company. When a customer creates an order, the seller removes the product from the finished goods inventory, and upon shipment, the item becomes a customer asset with a unique serial number. The asset is only associated with that specific customer. Figure 14 describes the Siebel Asset ASI structure.

Figure 14. Siebel Asset ASI

64

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Asset

Table 18 lists the integration components and user keys of this ASI.

Table 18.

Siebel Asset Integration Components XML Tag Asset User Keys

Integration Component Asset Mgmt - Asset

1 2 3

Id Integration Id Asset Number, Product Id Id Integration Id Asset Number, Product Id Integration Id Name

Asset Mgmt - Asset - Header

AssetHeader

1 2 3

Asset Mgmt - Asset XA

AssetXA

1 2

Table 19 lists the fields and their attributes. Fields without a length specified do not have a maximum length associated with them.

Table 19. Name

Siebel Asset ASI Fields XML Tag Data Type Length Req.

Asset Mgmt - Asset XA Data Type Description Display Name Id Integration Id Name Required Unit of Measure Value operation DataType AttributeDescription DisplayName Id IntegrationId AttributeName Required UnitofMeasure AttributeValue operation DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 30 250 100 15 30 75 1 30 100 30 No No No No No No No No No No

Asset Mgmt - Asset - Header Asset Currency Code Asset Description Asset Number AssetCurrencyCode AssetDescription AssetNumber DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 20 250 100 No No No

Siebel Application Services Interface Reference Version 8.2

65

Predefined Application Service Interfaces Siebel Asset

Table 19. Name

Siebel Asset ASI Fields XML Tag Comments Id InstallDate IntegrationId InventoryLocationId ProductName OrganizationId OriginalCost OriginalOrderId OwnerAccountId ParentAssetId PrimaryContactId ProductId PurchaseDate Quantity RootAssetId SerialNumber ProductSerializedFlag Status Version operation Data Type DTYPE_TEXT DTYPE_ID DTYPE_DATETIME DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_NUMBER DTYPE_ID DTYPE_ID DTYPE_ID DTYPE_ID DTYPE_ID DTYPE_DATETIME DTYPE_NUMBER DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length 255 15 Not applicable 30 15 100 15 NA 15 15 15 15 15 Not applicable Not applicable 15 100 1 30 30 30 Req. No No No No No No No No No No No No No No No No No No No No No

Comments Id Install Date Integration Id Inventory Location Id Name Organization Id Original Cost Original Order Id Owner Account Id Parent Asset Id Primary Contact Id Product Id Purchase Date Quantity Root Asset Id Serial Number Serialized Flag Status Version operation Asset Mgmt - Asset Asset Currency Code Asset Description Asset Number Comments Customizable Flag Extended Quantity Id Install Date Integration Id

AssetCurrencyCode AssetDescription AssetNumber Comments CustomizableFlag ExtendedQuantity Id InstallDate IntegrationId

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER DTYPE_ID DTYPE_DATETIME DTYPE_TEXT

20 250 100 255 1 Not applicable 15 Not applicable 30

No No No No No No No No No

66

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Asset

Table 19. Name

Siebel Asset ASI Fields XML Tag InventoryLocationId Name operation OperatingStatus OrderIntegrationId OrganizationId OriginalCost OriginalOrderId Owner OwnerAccountId ParentAssetId PriceListId PrimaryContactId ProdItemId ProductDescription ProductId ProductName ProductSerializedFlag PurchaseDate Quantity RootAssetId RootProductId SerialNumber Status Version Data Type DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_NUMBER DTYPE_ID DTYPE_ID DTYPE_ID DTYPE_ID DTYPE_ID DTYPE_ID DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_NUMBER DTYPE_ID DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length 15 100 30 30 30 15 Not applicable 15 15 15 15 15 15 15 255 15 100 1 Not applicable Not applicable 15 15 100 30 30 Req. No No No No No No No No No No No No No No No No No No No No No No No No No

Inventory Location Id Name operation Operating Status Order Integration Id Organization Id Original Cost Original Order Id Owner Owner Account Id Parent Asset Id Price List Id Primary Contact Id Prod Item Id Product Description Product Id Product Name Product Serialized Flag Purchase Date Quantity Root Asset Id Root Product Id Serial Number Status Version

Siebel Application Services Interface Reference Version 8.2

67

Predefined Application Service Interfaces Siebel Contact

Siebel Contact
The Siebel Contact ASI is an ASI for customer information management-related business processes. This ASI facilitates inbound and outbound contact data synchronization between a Siebel application and any external system. Figure 15 describes the Siebel Contact ASI structure.

Figure 15. Siebel Contact ASI Table 20 lists the integration component and user keys of this ASI. Table 20. Siebel Contact Integration Components XML Tag Contact User Keys

Integration Component Contact

1 2 3

Contact ID Integration ID Person UId Id Integration Id Account, Account Organization Id Integration Id Id Integration Id Alternate Email Address, Communication Address Medium Type, Communication Address Name

Related Account

RelatedAccount

1 2 3

Personal Address

PersonalAddress

1 2 1 2 3

Communication Address

CommunicationAddress

68

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Contact

Table 20.

Siebel Contact Integration Components XML Tag AlternatePhone User Keys

Integration Component Alternate Phone

1 2 3

Id Integration Id Alternate Phone #, Alternate Phone Medium Type, Alternate Phone Name Id Integration Id Id Integration Id Organization Id Integration Id Division, Position Login

Related Households

RelatedHouseholds

1 2 1 2 3

Related Organization

RelatedOrganization

Related Sales Rep

RelatedSalesRep

1 2 3 4

Table 21 lists the fields and their attributes.

Table 21. Name Contact Alias Assistant Birth Date

Siebel Contact ASI Fields XML Tag Data Type Length Req. Note

Alias Assistant BirthDate CellularPhone Comment DisableDataCleansing EmailAddress FaxPhone FirstName Gender HomePhone

DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

50 50 7 NA 255 NA 50 NA 50 255 NA

No No No No No No No No No No No

None None None None None None None None None None None

Cellular Phone # Comment Disable Data Cleansing Email Address Fax Phone # First Name Gender Home Phone #

Siebel Application Services Interface Reference Version 8.2

69

Predefined Application Service Interfaces Siebel Contact

Table 21. Name Id Income

Siebel Contact ASI Fields XML Tag Id Income IncomeCurrencyCode IncomeExchangeDate IntegrationId JobTitle LastName ManagerFirstName ManagerId ManagerIntegrationId ManagerLastName ManagerMiddleName ManagerPrimaryOrganiz ation ManagerUId MiddleName operation PersonUId PersonalTitle PreferredCommunicatio ns PreferredLanguageCode PrimaryAddressId SocialSecurityNumber Data Type DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT Length 30 NA 20 NA 30 75 50 50 15 30 50 50 100 100 50 30 100 15 30 3 NA NA Req. No No No No No No No No No No No No No No No No No No No No No No Note None None None None User key field None None None None None None None None None None None None None None None None None

Income Currency Code Income Exchange Date Integration Id Job Title Last Name Manager First Name Manager Id Manager Integration Id Manager Last Name Manager Middle Name Manager Primary Organization Manager UId Middle Name operation Person UId Personal Title Preferred Communications Preferred Language Code Primary Address Id Social Security Number

70

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Contact

Table 21. Name Status

Siebel Contact ASI Fields XML Tag Status Data Type DTYPE_TEXT Length 30 Req. No Note Bound by CONTACT_ST ATUS LOV. None None None None None None None None

Suppress All Calls Suppress All Emails Suppress All Faxes Suppress All Mailings Time Zone Id Time Zone Name Work Phone # Work Phone Extension Personal Address Id Integration Id IsPrimaryMVG operation Personal City Personal Country Personal Postal Code Personal State Personal Street Address Personal Street Address 2 searchspec

SuppressAllCalls SuppressAllEmails SuppressAllFaxes SuppressAllMailings TimeZoneId TimeZoneName WorkPhone WorkPhoneExtension

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

1 1 NA 1 NA 100 NA 10

No No No No No No No No

Id IntegrationId IsPrimaryMVG operation PersonalCity PersonalCountry PersonalPostalCode PersonalState PersonalStreetAddress PersonalStreetAddress2 searchspec

DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

30 30 1 30 50 50 30 10 200 100 250

No No No No No No No No No No No

None None None None None None None None None None None

Communication Address Alternate Email Address AlternateEmailAddress DTYPE_TEXT 100 No None

Siebel Application Services Interface Reference Version 8.2

71

Predefined Application Service Interfaces Siebel Contact

Table 21. Name

Siebel Contact ASI Fields XML Tag CommunicationAddress MediumType CommunicationAddress Name Id IntegrationId IsPrimaryMVG operation searchspec Data Type DTYPE_TEXT Length 30 Req. No Note None

Communication Address Medium Type Communication Address Name Id Integration Id IsPrimaryMVG operation searchspec Alternate Phone Alternate Phone # Alternate Phone Medium Type Alternate Phone Name Id Integration Id IsPrimaryMVG operation searchspec Related Account Account Account Location Account Organization Id Integration Id IsPrimaryMVG operation searchspec

DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

50 30 30 1 30 250

No No No No No No

None None None None None None

AlternatePhone AlternatePhoneMedium Type AlternatePhoneName Id IntegrationId IsPrimaryMVG operation searchspec

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

100 30 50 30 30 1 30 250

No No No No No No No No

None None None None None None None None

Account AccountLocation AccountOrganization Id IntegrationId IsPrimaryMVG operation searchspec

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

100 50 100 30 30 1 30 250

No No No No No No No No

None None None None None None None None

Related Households HouseHold Name HouseHoldName DTYPE_TEXT 50 No None

72

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Contact

Table 21. Name

Siebel Contact ASI Fields XML Tag HouseholdNumber Id IntegrationId IsPrimaryMVG operation searchspec Data Type DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length 100 30 30 1 30 250 Req. No No No No No No Note None None None None None None

Household Number Id Integration Id IsPrimaryMVG operation searchspec

Related Organization Id Integration Id Organization IsPrimaryMVG operation searchspec Related Sales Rep Division Id Integration Id IsPrimaryMVG Login operation Position searchspec Division Id IntegrationId IsPrimaryMVG Login operation Position searchspec DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 255 30 30 1 50 30 50 250 No No No No No No No No None None None None None None None None Id IntegrationId Organization IsPrimaryMVG operation searchspec DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 30 30 50 1 30 250 No No No No No No None None None None None None

Siebel Application Services Interface Reference Version 8.2

73

Predefined Application Service Interfaces Siebel CUT Address MSAG Service

Siebel CUT Address MSAG Service


The Siebel CUT Address MSAG Service ASI is an ASI for address validation business processes. This ASI facilitates inbound and outbound address data synchronization between a Siebel application and any external system. Figure 16 describes the Siebel CUT Address MSAG Service ASI structure.

Figure 16. Siebel CUT Address MSAG Service ASI Table 22 lists the integration component and user keys of this ASI. Table 22. Siebel CUT Address MSAG Service Integration Components XML Tag CutMsagProfile User Keys

Integration Component CUT MSAG Profile

1 2

Id Address Id, Profile Type

Table 23 lists the fields and their attributes.

Table 23. Name

Siebel CUT Address MSAG Service ASI Fields XML Tag Data Type Length Req.

CUT MSAG Profile Address Id Conflict Id Created Id Internal Validation Flag Mod Id Profile Type SA Access Instruction SA City SA Country AddressId ConflictId Created Id InternalValidationFlag ModId ProfileType SAAccessInstruction SACity SACountry DTYPE_ID DTYPE_ID DTYPE_DATETIME DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 30 30 30 Not applicable 30 30 255 50 50 No No No No No No No No No No

74

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Cost List

Table 23. Name

Siebel CUT Address MSAG Service ASI Fields XML Tag SACounty SADescriptiveLocation SADirectional SADrivingInstruction SAHouseNumber SAHousePrefix SAHouseSuffix SALocationDesignator1 SALocationDesignator2 SALocationDesignator3 SALocationValue1 SALocationValue2 SALocationValue3 SAState SAStreetName SAStreetSuffix SAThoroughfare SAZipcode Updated operation searchspec Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_NOTE DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_TEXT Length 50 30 10 Not applicable 8 5 5 50 50 50 50 50 50 10 50 4 20 30 30 30 250 Req. No No No No No No No No No No No No No No No No No No No No No

SA County SA Descriptive Location SA Directional SA Driving Instructions SA House Number SA House Prefix SA House Suffix SA Location Designator 1 SA Location Designator 2 SA Location Designator 3 SA Location Value 1 SA Location Value 2 SA Location Value 3 SA State SA Street Name SA Street Suffix SA Thoroughfare SA Zipcode Updated operation searchspec

Siebel Cost List


Standard product costs that exist in external systems are created in the Siebel application based on the costs existing in the external manufacturing and accounting systems. The initial cost types include standard costs, base costs, and the variable costs for a given product.

Siebel Application Services Interface Reference Version 8.2

75

Predefined Application Service Interfaces Siebel Cost List

This inbound ASI enables the synchronization and update of a cost list and the cost list items. Figure 17 describes the Siebel Cost List ASI structure.

Figure 17. Siebel Cost List ASI Table 24 lists the integration components and user keys of this ASI.

Table 24.

Siebel Cost List Integration Components XML Tag CostList User Keys

Integration Component Cost List

1 2 3

Name, Type Id Integration Id Product Id Id Integration Id

Cost List Item

CostListItem

1 2 3

Table 25 lists the fields and their attributes. Fields without a length specified do not have a maximum length associated with them.

Table 25. Name Cost List

Siebel Cost List ASI Fields XML Tag Data Type Length Req. Note

Cost Method Currency Code Description End Date

CostMethod CurrencyCode Description EndDate

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

30 20 255 NA

No No No No

None None None None

76

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Cost List

Table 25. Name Id

Siebel Cost List ASI Fields XML Tag Id Data Type DTYPE_ID Length 30 Req. No Note Used for picking a related entity. This read-only field is automatically populated by the Siebel application on insertion and cannot be updated. None User key field. None User key field. None None

Integration Id Name Start Date Type operation searchspec Cost List Item Average Cost Currency Code Description End Date Ext OT Pct Increase Id

IntegrationId Name StartDate Type operation searchspec

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

30 50 NA 30 30 250

No No No No No No

AverageCost CurrencyCode Description EndDate ExtOTPctIncrease Id

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER DTYPE_ID

NA 20 255 NA NA 30

No No No No No No

None None None None None Used for picking a related entity. This read-only field is automatically populated by the Siebel application on insertion and cannot be updated. User key field.

Integration Id Last Cost Next Cost IntegrationId LastCost NextCost DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 30 NA NA No No No

User key field. None None

Siebel Application Services Interface Reference Version 8.2

77

Predefined Application Service Interfaces Siebel Employee

Table 25. Name

Siebel Cost List ASI Fields XML Tag ProductId Data Type DTYPE_ID Length NA Req. No Note Used for picking a related entity. This read-only field is automatically populated by the Siebel application on insertion and cannot be updated. User key field.

Product Id

Standard Cost Start Date Std OT Pct Increase operation searchspec StandardCost StartDate StdOTPctIncrease operation searchspec DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT NA NA NA 30 250 No No No No No

None None None None None

Siebel Employee
The Siebel Employee ASI is an ASI for employee-related business processes. The Employee Integration Object enables inbound and outbound data integration between Siebel applications and third-party applications that process employee data. This can include employee core data, jobrelated data, responsibilities, position, or resume data. The integration business services are included to perform the basic Create, Update, Delete, and Query functions on Employee objects in the Siebel application. Figure 18 shows the Siebel Employee ASI structure.

Figure 18. Siebel Employee ASI

78

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Employee

Table 26 lists the Siebel Employee integration components.

Table 26.

Siebel Employee Integration Components XML Tag CmsCertificationsQualifications User Keys

Integration Component CMS Certifications Qualifications

1 2 3

Id Integration Id Certification Id Integration Id Education Competency Id Employee Id Id Integration Id Honor Award Id Integration Id Membership Id Integration Id Company Name Id Integration Id Login Domain, Login Name Login Name First Name, Last Name, Middle Name Employee Organization Id Employee Organization Integration Id Employee Organization

CMS Education

CmsEducation

1 2 3

CMS Employee Competency Administration CMS Honors Awards

CmsEmployeeCompetencyAdmin istration CmsHonorsAwards

1 2 1 2 3

CMS Memberships

CmsMemberships

1 2 3

CMS Past Work Experience

CmsPastWorkExperience

1 2 3

Employee

Employee

1 2 3 4 5

Employee_Employee Organization

EmployeeEmployeeOrganization

1 2 3

Siebel Application Services Interface Reference Version 8.2

79

Predefined Application Service Interfaces Siebel Employee

Table 26.

Siebel Employee Integration Components XML Tag EmployeePersonalAddress User Keys

Integration Component Employee_Personal Address

1 2

Personal Address Id Personal Address Integration Id Position Id Position Integration Id Division, Position Subcontractor Account Id Subcontractor Integration Id Subcontractor Name Responsibility Id Responsibility Integration Id Responsibility Personal Address Id Personal Address Integration Id Employee Organization Id Employee Organization Integration Id Employee Organization Position Id Position Integration Id Division, Position Address Id

Employee_Position

EmployeePosition

1 2 3

Employee_Subcontractor

EmployeeSubcontractor

1 2 3

Employee_Responsibility

EmployeeResponsibility

1 2 3

Personal Address

PersonalAddress

1 2

Related Employee Organization

RelatedEmployeeOrganization

1 2 3

Related Position

RelatedPosition

1 2 3

Related Position Business Address

RelatedPositionBusinessAddress

80

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Employee

Table 26.

Siebel Employee Integration Components XML Tag RelatedResponsibility User Keys

Integration Component Related Responsibility

1 2 3

Responsibility Id Responsibility Integration Id Responsibility Subcontractor Account Id Subcontractor Integration Id Subcontractor Name

Related Subcontractor

RelatedSubcontractor

1 2 3

Table 27 lists the fields and their attributes.

Table 27. Name

Siebel Employee ASI Fields XML Tag Data Type Length Req.

CMS Certifications Qualifications Certification Comments Date of Certification Id Institution Integration Id operation CMS Education Comments Country Degree Education Grade Graduation Date Id Institution Comments Country Degree Education Grade GraduationDate Id Institution DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT 250 30 30 30 30 Not applicable 30 30 No No No No No No No No Certification Comments DateofCertification Id Institution IntegrationId operation DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 30 250 Not applicable 30 30 30 30 No No No No No No No

Siebel Application Services Interface Reference Version 8.2

81

Predefined Application Service Interfaces Siebel Employee

Table 27. Name

Siebel Employee ASI Fields XML Tag IntegrationId Major NumberofYears Scale TypeofEducation operation Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length 30 30 Not applicable 30 30 30 Req. No No No No No No

Integration Id Major Number of Years Scale Type of Education operation

CMS Employee Competency Administration Competency Id Skill Name Current Skill Level Current Skill Level Id Current Skill Level Value Date of Accomplishment Employee Id Id Required Skill Level Value Required Skill Level Id Parent Skill Rating Scale Id Required Skill Level operation Updated Status Skill Gap Skill Description Root Category Id Root Category CompetencyId SkillName CurrentSkillLevel CurrentSkillLevelId CurrentSkillLevelValue DateOfAccomplishment EmployeeId Id RequiredSkillLevelValue RequiredSkillLevel Id ParentSkill RatingScaleId Required Skill Level operation Updated Status SkillGap SkillDescription RootCategoryId RootCategory DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_NUMBER DTYPE_DATETIME DTYPE_ID DTYPE_ID DTYPE_NUMBER DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_ID DTYPE_TEXT Not applicable 50 100 Not applicable Not applicable Not applicable Not applicable 30 Not applicable Not applicable 50 Not applicable 100 30 30 30 Not applicable 250 Not applicable 50 No No No No No No No No No No No No No No No No No No No No

82

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Employee

Table 27. Name

Siebel Employee ASI Fields XML Tag searchspec ManagerComments EmployeeComments DeleteRecordFlag Criticality Created ConflictId CategoryId AssessmentType ApprovedById ModId Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_ID DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_ID Length 250 2000 2000 Not applicable 30 30 30 Not applicable 30 Not applicable 30 Req. No No No No No No No No No No No

searchspec Manager Comments Employee Comments Delete Record Flag Criticality Created Conflict Id Category Id Assessment Type Approved By Id Mod Id

CMS Honors Awards Comments Honor Award Id Institution Integration Id Received Date Relevance to Company operation CMS Memberships Active Status Comments End Date Id Institution Integration Id Membership ActiveStatus Comments EndDate Id Institution IntegrationId Membership DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Not applicable 250 Not applicable 30 30 30 30 No No No No No No No Comments HonorAward Id Institution IntegrationId ReceivedDate RelevancetoCompany operation DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 250 30 30 30 30 Not applicable 30 30 No No No No No No No No

Siebel Application Services Interface Reference Version 8.2

83

Predefined Application Service Interfaces Siebel Employee

Table 27. Name

Siebel Employee ASI Fields XML Tag RelevancetoCompany StartDate operation Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length 30 Not applicable 30 Req. No No No

Relevance to Company Start Date operation

CMS Past Work Experience Business Title Business Unit Comments Company Name End Date First Name Id Industry Integration Id Last Name Position Start Date operation Employee Alias Availability Status Availability Status Until Bonus Target % Building Number CP Region CP Region Id CP Region Integration Id Cell Phone # Cost Currency Code Alias AvailabilityStatus AvailabilityStatusUntil BonusTarget BuildingNumber CPRegion CPRegionId CPRegionIntegrationId CellPhone CostCurrencyCode DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 50 30 Not applicable Not applicable 30 50 Not applicable 30 Not applicable 30 No No No No No No No No No No BusinessTitle BusinessUnit Comments CompanyName EndDate FirstName Id Industry IntegrationId LastName Position StartDate operation DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 50 30 250 30 Not applicable 50 30 Not applicable 30 50 50 Not applicable 30 No No No No No No No No No No No No No

84

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Employee

Table 27. Name

Siebel Employee ASI Fields XML Tag CostPerHour CubicleNumber EMailAddr EmergencyNotification Emp EmployeeFlag EmployeeTypeCode EmploymentStatus EndShiftto Fax FirstName HireDate HomePhone Id IntegrationId JobCodeId JobCodeIntegrationId JobCodeName JobTitle LastName LastPromotionDate LicensePlateNumber LoginDomain LoginName MF MaidenName MiddleName Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length Not applicable 20 50 30 30 Not applicable 30 30 30 Not applicable 50 Not applicable Not applicable 30 30 Not applicable 30 30 75 50 Not applicable 50 50 50 1 50 50 Req. No No No No No No No No No No No No No No No No No No No No No No No No No No No

Cost Per Hour Cubicle Number EMail Addr Emergency Notification Emp # Employee Flag Employee Type Code Employment Status End Shift to Fax # First Name Hire Date Home Phone # Id Integration Id Job Code Id Job Code Integration Id Job Code Name Job Title Last Name Last Promotion Date License Plate Number Login Domain Login Name M/F Maiden Name Middle Name

Siebel Application Services Interface Reference Version 8.2

85

Predefined Application Service Interfaces Siebel Employee

Table 27. Name

Siebel Employee ASI Fields XML Tag NextAnnualReviewDate NextAvailabilityStatus NickName OvertimeCode PagerPIN PagerPhone PagerType PersonalTitle Phone PreferredCommunications Private Readiness SeniorityDate ShareAddressFlag ShareHomePhoneFlag ShiftId ShiftIntegrationId ShiftName StandardNotification StartShiftFrom SubcontractorFlag TerminationDate TimeZoneId TimeZoneName operation Data Type DTYPE_DATETIME DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_ID DTYPE_TEXT DTYPE_TEXT Length Not applicable 30 50 30 10 Not applicable 30 15 Not applicable 30 Not applicable 30 Not applicable Not applicable Not applicable Not applicable 30 100 30 30 Not applicable Not applicable Not applicable 100 30 Req. No No No No No No No No No No No No No No No No No No No No No No No No No

Next Annual Review Date Next Availability Status Nick Name Overtime Code Pager PIN Pager Phone # Pager Type Personal Title Phone # Preferred Communications Private Readiness Seniority Date Share Address Flag Share Home Phone Flag Shift Id Shift Integration Id Shift Name Standard Notification Start Shift From Subcontractor Flag Termination Date Time Zone Id Time Zone Name operation

86

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Employee

Table 27. Name

Siebel Employee ASI Fields XML Tag Data Type Length Req.

Employee_Employee Organization Employee Organization Employee Organization Id Employee Organization Integration Id IsPrimaryMVG EmployeeOrganization EmployeeOrganizationId EmployeeOrganizationIntegraitionI d IsPrimaryMvg DTYPE_TEXT DTYPE_ID DTYPE_TEXT 50 30 30 No No No

DTYPE_TEXT

No

Employee_Personal Address IsPrimaryMVG Personal Address Id Personal Address Integration Id Personal City Personal Country Personal County Personal Postal Code Personal Province Personal State Personal Street Address Personal Street Address 2 operation IsPrimaryMvg PersonalAddressId PersonalAddressIntegrationId PersonalCity PersonalCountry PersonalCounty PersonalPostalCode PersonalProvince PersonalState PersonalStreetAddress PersonalStreetAddress2 operation DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 1 30 30 50 50 50 30 50 10 200 100 30 No No No No No No No No No No No No

Employee_Position Division Division Id Division Integration Id Employee End Date Division DivisionId DivisionIntegrationId EmployeeEndDate DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_DATETIME 255 Not applicable 30 NA No No No No

Siebel Application Services Interface Reference Version 8.2

87

Predefined Application Service Interfaces Siebel Employee

Table 27. Name

Siebel Employee ASI Fields XML Tag EmployeeStartDate IsPrimaryMvg Position PositionId PositionIntegrationId Data Type DTYPE_DATETIME DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT Length Not applicable 1 50 30 30 Req. No No No No No

Employee Start Date IsPrimaryMVG Position Position Id Position Integration Id

Employee_Responsibility IsPrimaryMVG Responsibility Responsibility Id Responsibility Integration Id IsPrimaryMVG Responsibility ResponsibilityId ResponsibilityIntegrationId DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT 1 50 30 30 No No No No

Employee_Subcontractor IsPrimaryMVG Subcontractor Account Id Subcontractor Integration Id Subcontractor Name Personal Address IsPrimaryMVG Personal Address Id Personal Address Integration Id Personal City Personal Country Personal County Personal Postal Code Personal Province Personal State IsPrimaryMVG PersonalAddressId PersonalAddressIntegrationId PersonalCity PersonalCountry PersonalCounty PersonalPostalCode PersonalProvince PersonalState DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 1 30 30 50 50 50 30 50 10 No No No No No No No No No IsPrimaryMVG SubcontractorAccountId SubcontractorIntegrationId Subcontractor Name DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT 1 30 30 100 No No No No

88

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Employee

Table 27. Name

Siebel Employee ASI Fields XML Tag PersonalStreetAddress PersonalStreetAddress2 operation Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length 200 100 30 Req. No No No

Personal Street Address Personal Street Address 2 operation

Related Employee Organization Employee Organization Employee Organization Id Employee Organization Integration Id IsPrimaryMVG Related Position Division Division Id Division Integration Id Employee End Date Employee Start Date IsPrimaryMVG Position Position Id Position Integration Id Division DivisionId DivisionIntegrationId EmployeeEndDate EmployeeStartDate IsPrimaryMVG Position PositionId PositionIntegrationId DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_DATETIME DTYPE_DATETIME DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT 255 Not applicable 30 Not applicable Not applicable 1 50 30 30 No No No No No No No No No EmployeeOrganization EmployeeOrganizationId EmployeeOrganizationIntegrationId DTYPE_TEXT DTYPE_ID DTYPE_TEXT 50 30 30 No No No

IsPrimaryMVG

DTYPE_TEXT

No

Related Position Business Address Address Id Address Integration Id Address Name City AddressId AddressIntegrationId AddressName City DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 30 30 100 50 No No No No

Siebel Application Services Interface Reference Version 8.2

89

Predefined Application Service Interfaces Siebel Financial Account

Table 27. Name Country

Siebel Employee ASI Fields XML Tag Country IsPrimaryMVG PostalCode State StreetAddress Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length 30 1 30 10 200 Req. No No No No No

IsPrimaryMVG Postal Code State Street Address

Related Responsibility IsPrimaryMVG Responsibility Responsibility Id Responsibility Integration Id IsPrimaryMVG Responsibility ResponsibilityId ResponsibilityIntegrationId DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT 1 50 30 30 No No No No

Related Subcontractor IsPrimaryMVG Subcontractor Account Id Subcontractor Integration Id Subcontractor Name IsPrimaryMVG SubcontractorAccountId SubcontractorIntegrationId SubcontractorName DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT 1 30 30 100 No No No No

Siebel Financial Account


The Siebel Financial Account ASI is an ASI for privacy data management-related business processes. This ASI facilitates inbound and outbound financial account data synchronization between a Siebel application and a UCM system. Figure 19 describes the Siebel Financial Account ASI structure.

Figure 19. Siebel Financial Account ASI

90

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Financial Account

Table 28 lists the integration components and user keys of the Siebel Financial Account ASI.

Table 28.

Siebel Financial Account Integration Components XML Tag FincorpAccount User Keys

Integration Component FINCORP Account

1 2 3

Integration Id Row Id Account Number, Primary Organization Name Status Key: Account Number, Id, Integration Id, operation

Contact

Contact

1 2 3 4 5

Integration Id Party UId Row Id Account Integration Id, Employee Number, Personal Contact Person Uid, Personal Contact, Primary Organization Status Key: Id, Integration Id, operation

FINCORP Account Contact

FincorpAccountContact

1 2

Asset Id, Contact Id Contact Id

Table 29 lists the fields and their attributes. Fields without a length specified do not have a maximum length associated with them.

Table 29. Name

Siebel Financial Account ASI Fields XML Tag Data Type Length Req.

FINCORPAccount ABA Number Account Alias Account Branch ABA Account Branch Id Account Branch Name Account Branch Number Account Holder ABANumber AccountAlias AccountBranchABA AccountBranchId AccountBranchName AccountBranchNumber AccountHolder DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 50 100 50 Not applicable 100 30 Not applicable No No No No No No No

Siebel Application Services Interface Reference Version 8.2

91

Predefined Application Service Interfaces Siebel Financial Account

Table 29. Name

Siebel Financial Account ASI Fields XML Tag AccountName AccountNumber AccountRowId AccountStatus AccountType AcctGen-AccountId AcctGen-AverageBalance AcctGen-BranchId AcctGenOrganizationAddressId AcctGen-PersAddr-City AcctGen-PersAddrCountry AcctGen-PersAddr-Id AcctGen-PersAddr-State AcctGen-PersAddr-Street AcctGen-PersAddrZipCode AcctGenPrimaryContactId AcctGen-ProductLineId AvailableBalance Balance BankNumber BillingOption Branch BranchNumber CANextStatementDate Comments Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_CURRENCY DTYPE_ID DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_ID DTYPE_CURRENCY DTYPE_CURRENCY DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_DATE DTYPE_TEXT Length 100 100 Not applicable 30 30 Not applicable Not applicable Not applicable Not applicable 50 30 Not applicable 10 200 30 Not applicable Not applicable Not applicable Not applicable 50 30 50 50 Not applicable 250 Req. No Yes No No No No No No No No No No No No No No No No No No No No No No No

Account Name Account Number Account Row Id Account Status Account Type Acct Gen - Account Id Acct Gen - Average Balance Acct Gen - Branch Id Acct Gen - Organization Address Id Acct Gen - Pers Addr City Acct Gen - Pers Addr Country Acct Gen - Pers Addr - Id Acct Gen - Pers Addr State Acct Gen - Pers Addr Street Acct Gen - Pers Addr Zip Code Acct Gen - Primary Contact Id Acct Gen - Product Line Id Available Balance Balance Bank Number Billing Option Branch Branch Number CA Next Statement Date Comments

92

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Financial Account

Table 29. Name

Siebel Financial Account ASI Fields XML Tag CommitmentAmount ConflictId ContactAddressId Created Currency CurrentBalance CustomerNumber CustomerType FirstName Id IntegrationId LastName ModId Name OrganizationId ParentABANumber ParentAccountBranchABA ParentAccountBranchId ParentAccountId ParentAccountNumber ParentAssetID ParentAssetNumber ParentBank PaymentType PreviousBalance PrimaryAccountId PrimaryEmployeeId PrimaryOrgId PrimaryOrganizationName Data Type DTYPE_CURRENCY DTYPE_ID DTYPE_ID DTYPE_DATETIME DTYPE_TEXT DTYPE_CURRENCY DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_CURRENCY DTYPE_ID DTYPE_ID DTYPE_ID DTYPE_TEXT Length Not applicable 30 Not applicable 30 20 Not applicable 50 30 50 30 30 50 30 100 Not applicable 50 50 Not applicable Not applicable 100 Not applicable 100 50 30 Not applicable Not applicable Not applicable Not applicable 100 Req. No No No No No No No No No No No No No No No No No No No No No No No No No No No No No

Commitment Amount Conflict Id Contact Address Id Created Currency Current Balance Customer Number Customer Type First Name Id Integration Id Last Name Mod Id Name Organization Id Parent ABA Number Parent Account Branch ABA Parent Account Branch Id Parent Account Id Parent Account Number Parent Asset ID Parent Asset Number Parent Bank Payment Type Previous Balance Primary Account Id Primary Employee Id Primary Org Id Primary Organization Name

Siebel Application Services Interface Reference Version 8.2

93

Predefined Application Service Interfaces Siebel Financial Account

Table 29. Name

Siebel Financial Account ASI Fields XML Tag PrimaryPositionId ProductId StartDate Type Updated operation searchspec Data Type DTYPE_ID DTYPE_ID DTYPE_DATE DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_TEXT Length Not applicable Not applicable Not applicable 30 30 30 250 Req. No Yes No No No No No

Primary Position Id Product Id Start Date Type Updated operation searchspec Contact Account Id Account Integration Id Assistant Assistant Email Address Assistant Phone # Cellular Phone # Created Employee Number Fax Phone # First Name Home Phone # Id Integration Id Job Title Last Name Login Name M/F M/M Market Cap Pref Middle Name Mod Id Party Type Code Party UId

AccountId AccountIntegrationId Assistant AssistantEmailAddress AssistantPhone CellularPhone Created EmployeeNumber FaxPhone FirstName HomePhone Id IntegrationId JobTitle LastName LoginName MF MM MarketCapPref MiddleName ModId PartyTypeCode PartyUId

DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_PHONE DTYPE_PHONE DTYPE_DATETIME DTYPE_TEXT DTYPE_PHONE DTYPE_TEXT DTYPE_PHONE DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT

Not applicable 30 50 100 Not applicable Not applicable 30 30 Not applicable 50 Not applicable 30 30 75 50 50 30 15 30 50 30 30 100

No No No No No No No No No Yes No No No No Yes No No No No No No Yes Yes

94

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Financial Account

Table 29. Name

Siebel Financial Account ASI Fields XML Tag PersonUId PersonalContact PreferredCommunication Method PrimaryOrganization PrivacyCode SSN ShortName Status Type Updated UpdatedByName UserType WorkPhone operation searchspec Data Type DTYPE_TEXT DTYPE_BOOL DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_TEXT DTYPE_PHONE DTYPE_TEXT DTYPE_TEXT Length 100 Not applicable 20 50 30 11 50 30 30 30 50 30 Not applicable 30 250 Req. Yes No No No Yes No No No No No No No No No No

Person UId Personal Contact Preferred Communication Method Primary Organization Privacy Code SSN Short Name Status Type Updated Updated By Name User Type Work Phone # operation searchspec

FINCORPAccountContact Account Account Id Asset Id Cellular Phone Number Conflict Id Contact Id Created Currency Email Address Fax Number First Name Home Phone Number Id Job Title Account AccountId AssetId CellularPhoneNumber ConflictId ContactId Created Currency2 EmailAddress3 FaxNumber FirstName HomePhoneNumber Id JobTitle DTYPE_TEXT DTYPE_ID DTYPE_ID DTYPE_PHONE DTYPE_ID DTYPE_ID DTYPE_DATETIME DTYPE_TEXT DTYPE_TEXT DTYPE_PHONE DTYPE_TEXT DTYPE_PHONE DTYPE_ID DTYPE_TEXT 100 Not applicable Not applicable Not applicable 30 Not applicable 30 Not applicable 100 Not applicable 50 Not applicable 30 75 No No No No No No No No No No No No No No

Siebel Application Services Interface Reference Version 8.2

95

Predefined Application Service Interfaces Siebel Forecast

Table 29. Name

Siebel Financial Account ASI Fields XML Tag LastName MiddleInitial ModId MothersMaidenName Mr.Ms. PrimaryPersonalAddressId ShortName SocialSecurityNumber2 Title Updated WorkPhone operation searchspec Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_PHONE DTYPE_TEXT DTYPE_TEXT Length 50 50 30 50 Not applicable Not applicable 50 11 75 30 Not applicable 30 250 Req. Yes No No No No No No No No No No No No

Last Name Middle Initial Mod Id Mother's Maiden Name Mr./Ms. Primary Personal Address Id Short Name Social Security Number Title Updated Work Phone # operation searchspec

Siebel Forecast
The Siebel Forecast ASI consists of internal and external integration objects and a business service. This ASI facilitates the outbound data synchronization between the Siebel application and an external back-office system. This ASI is used by the Export Forecast business process, which queries the Siebel application for data on a given forecast and returns the data to a back-office system. Figure 20 describes the Siebel Forecast ASI structure.

Figure 20. Siebel Forecast ASI

96

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Forecast

Table 30 lists the integration components and user keys of the Siebel Forecast ASI.

Table 30.

Siebel Forecast Integration Components XML Tag Forecast ForecastItemDetailFlat User Keys

Integration Component Forecast Forecast Item Detail Flat

1 1 2 3

Forecast Number Detail Date Forecast Item Id Owner Forecast Id

Table 31 lists the fields and their attributes. Fields without a length specified do not have a maximum length associated with them.

Table 31. Name Forecast

Siebel Forecast ASI Fields XML Tag Data Type Length Req.

Archive Timestamp Created By Login Forecast Base Period Type Forecast Date Forecast End Date Forecast Id Forecast Name Forecast Number Forecast Start Date operation Owner Organization Id Owner Position Id Forecast Item Detail Flat Account Id Amount Revenue Best Case Commit Flag Cost

ArchiveTimestamp CreatedByLogin ForecastBasePeriodType ForecastDate ForecastEndDate ForecastId ForecastSeriesName ForecastNumber ForecastStartDate operation OwnerOrganizationId OwnerPositionId

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_ID

Not applicable 50 30 Not applicable Not applicable 15 20 30 Not applicable 30 15 15

No No No No No No No No No No No No

AccountId Revenue BestCase CommitFlag Cost

DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

15 Not applicable Not applicable 1 Not applicable

No No No No No

Siebel Application Services Interface Reference Version 8.2

97

Predefined Application Service Interfaces Siebel Invoice

Table 31. Name Currency

Siebel Forecast ASI Fields XML Tag CurrencyCode DetailDate DUNSNumber ForecastId ForecastItemId Id LinkType operation OpportunityId OrganizationId OwnerForecastId ProductLineId ProductId ProductPrice ProductQuantity SalesRepPositionId ServiceRequestId UnitOfMeasure WorstCase Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_ID DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_ID DTYPE_ID DTYPE_ID DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_ID DTYPE_TEXT DTYPE_TEXT Length Not applicable Not applicable 15 15 15 15 30 30 15 15 15 15 15 Not applicable Not applicable 15 15 30 Req. No No No No No No No No No No No No No No No No No No No

Detail Date DUNS Number Forecast Id Forecast Item Id Id Link Type operation Opportunity Id Organization Id Owner Forecast Id Primary Product Line Id Product Id Product Price Product Quantity Sales Rep Id Service Request Id Unit of Measure Worst Case

Siebel Invoice
The Siebel Invoice ASI enables the implementation of replication of invoices from back-office accounting systems to the Siebel application, which allows sales professionals, call center agents, partners, as well as the customer, to access invoice information in the Siebel application for related inquiries. A typical process involves the creation of the invoice in the back-end system after the fulfillment of an order, which is then followed by the replication of this invoice (as well as all of its updates) in the front-end systems. The Siebel Invoice ASI enables the creation, update, deletion and queries of invoice information for inbound and outbound directions in Siebel applications.

98

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Invoice

Figure 21 describes the structure of the Siebel Invoice ASI.

Figure 21. Siebel Invoice ASI Table 32 lists the integration components of this ASI.

Table 32.

Siebel Invoice Integration Components XML Tag Invoice User Keys

Integration Component FS Invoice (primary)

1 2 3

Id Integration Id Document Type, Document Number Id Integration Id Line Number

FS Invoice Line Items

FSInvoiceLineItems

1 2 3

The Siebel Invoice ASI uses the same user keys as the FS Invoice integration component. You can use the fields for the integration, which means that values for each of these fields may be written to an XML file for transport. Table 33 lists the fields and their attributes.

Table 33. Name

Siebel Invoice ASI Fields XML Tag Data Type Length Req. Note

FS Invoice Account Id AccountId DTYPE_ID 15 No Used for picking from Picklist Account. User key field.

Siebel Application Services Interface Reference Version 8.2

99

Predefined Application Service Interfaces Siebel Invoice

Table 33. Name

Siebel Invoice ASI Fields XML Tag AccountIntegrationId Data Type DTYPE_TEXT Length 30 Req. No Note Used for picking from Picklist Account. User key field.

Account Integration Id

Account Location AccountLocation DTYPE_TEXT 30 No

Used for picking from Picklist Account. Used for picking from Picklist Account. Used for picking from Picklist Account. Used for picking from FS Activity Pick List. Used for picking from FS Activity Pick List. None None Used for picking from Service Agreement. Used for picking from Service Agreement.

Account Name

AccountName

DTYPE_TEXT

50

No

Account Organization Name Activity Id

AccountOrganizationName

DTYPE_TEXT

100

No

ActivityId

DTYPE_ID

15

No

Activity User Defined Unique Id Amount Paid Balance Forward Contract Id

ActivityUserDefinedUniqueId

DTYPE_TEXT

30

No

AmountPaid BalanceForward ContractId

DTYPE_CURRENCY DTYPE_CURRENCY DTYPE_ID

22 22 15

No No No

Contract Integration Id

ContractIntegrationId

DTYPE_TEXT

30

No

100

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Invoice

Table 33. Name Contract Name

Siebel Invoice ASI Fields XML Tag ContractName Data Type DTYPE_TEXT Length 50 Req. No Note Used for picking from Service Agreement. Used for picking from Service Agreement. Used for picking from Service Agreement. Used for picking from Picklist Currency. None None None User key field for Invoice. Used for picking from Picklist Period. Used for picking from Picklist Period. Used for picking from Picklist Period. None

Contract Organization Name Contract Revision Number Currency Code

ContractOrganizationName

DTYPE_TEXT

100

No

ContractRevisionNumber

DTYPE_NUMBER

22

No

CurrencyCode

DTYPE_TEXT

20

Yes

Delinquent Flag Document Date Document Description Document Number Document Period Id

DelinquentFlag DocumentDate DocumentDescription DocumentNumber DocumentPeriodId

DTYPE_BOOL DTYPE_UTCDATET IME DTYPE_TEXT DTYPE_TEXT DTYPE_ID

1 7 250 50 15

No No No Yes No

Document Period Name

DocumentPeriodName

DTYPE_TEXT

50

No

Document Period Organization Name Document Revision Number

DocumentPeriodOrganizatio nName

DTYPE_TEXT

100

No

DocumentRevisionNumber

DTYPE_NUMBER

15

No

Siebel Application Services Interface Reference Version 8.2

10 1

Predefined Application Service Interfaces Siebel Invoice

Table 33. Name Document Status Document Sub Type Document Type

Siebel Invoice ASI Fields XML Tag DocumentStatus Data Type DTYPE_TEXT Length 30 Req. No Note Bound by FS_INVOICE_ TYPE LOV. Bound by FS_INVOICE_ CODE LOV. Bound by FS_INVOI CE_TYPE LOV. User key field.

DocumentSubType

DTYPE_TEXT

30

No

DocumentType

DTYPE_TEXT

30

No

Id Integration Id Order Id Id IntegrationId OrderId DTYPE_ID DTYPE_TEXT DTYPE_ID 30 30 15 No No No

None None Used for picking from Order Entry Picklist. Used for picking from Order Entry Picklist. Used for picking from Order Entry Picklist. Used for picking from Order Entry Picklist. Used for picking from Order Entry Picklist. Used for picking from Picklist Payment Term.

Order Integration Id

OrderIntegrationId

DTYPE_TEXT

30

No

Order Number

OrderNumber

DTYPE_TEXT

30

No

Order Organization Name Order Type

OrderOrganizationName

DTYPE_TEXT

100

No

OrderType

DTYPE_TEXT

50

No

Payment Term

PaymentTerm

DTYPE_TEXT

50

No

102

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Invoice

Table 33. Name

Siebel Invoice ASI Fields XML Tag PaymentTermId Data Type DTYPE_ID Length 15 Req. No Note Used for picking from Picklist Payment Term. Used for picking from Picklist Project. Used for picking from Picklist Project. Used for picking from Picklist Project. Used for picking from Picklist Project. None

Payment Term Id

Project Id

ProjectId

DTYPE_ID

15

No

Project Integration Id

ProjectIntegrationId

DTYPE_TEXT

30

No

Project Number

ProjectNumber

DTYPE_TEXT

30

No

Project Organization Name STORED Adjustment Amount STORED Discount Amount STORED Gross Amount STORED Surcharge Amount STORED Tax Amount Service Request Id

ProjectOrganizationName

DTYPE_TEXT

100

No

STOREDAdjustmentAmount

DTYPE_CURRENCY

22

No

STOREDDiscountAmount

DTYPE_CURRENCY

22

No

None

STOREDGrossAmount STOREDSurchargeAmount

DTYPE_CURRENCY DTYPE_CURRENCY

22 22

No No

None None

STOREDTaxAmount ServiceRequestId

DTYPE_CURRENCY DTYPE_ID

22 15

No No

None Used for picking from Service Request Picklist.

Siebel Application Services Interface Reference Version 8.2

10 3

Predefined Application Service Interfaces Siebel Invoice

Table 33. Name Service Request Number

Siebel Invoice ASI Fields XML Tag ServiceRequestNumber Data Type DTYPE_TEXT Length 64 Req. No Note Used for picking from Service Request Picklist. Used for picking from Service Request Picklist.

Service Request Organization Name

ServiceRequestOrganization Name

DTYPE_TEXT

100

No

FS Invoice Line Items Activity Id ActivityId DTYPE_ID 15 No Used for picking from FS Activity Picklist. Used for picking from FS Activity Picklist. Used for picking from FS PickList Agreement Item - All. Used for picking from FS PickList Agreement Item - All. Used for picking from FS PickList Agreement Item - All. Used for picking from FS PickList Agreement Item - All.

Activity User Defined Unique Id Contract Id

ActivityUserDefinedUniqueId

DTYPE_TEXT

30

No

ContractId

DTYPE_ID

15

No

Contract Integration Id

ContractIntegrationId

DTYPE_TEXT

30

No

Contract Line Id

ContractLineId

DTYPE_ID

15

No

Contract Name

ContractName

DTYPE_TEXT

50

No

104

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Invoice

Table 33. Name

Siebel Invoice ASI Fields XML Tag ContractOrganizationName Data Type DTYPE_TEXT Length 100 Req. No Note Used for picking from FS PickList Agreement Item - All. Used for picking from FS PickList Agreement Item - All. Used for picking from Picklist Currency. None None None User key field for Line Item. User key field for Line Item. User key field for Line Item. None Used for picking from FS Invoice Line Item Type Picklist. Used for picking from Order Entry Picklist. Used for picking from Order Entry Picklist.

Contract Organization Name

Contract Revision Number

ContractRevisionNumber

DTYPE_NUMBER

22

No

CurrencyCode

CurrencyCode

DTYPE_TEXT

20

Yes

Description Discount Amount Gross Amount Id Integration Id Line Number Line Quantity Line Type

Description DiscountAmount GrossAmount Id IntegrationId LineNumber LineQuantity LineType

DTYPE_TEXT DTYPE_CURRENCY DTYPE_CURRENCY DTYPE_ID DTYPE_TEXT DTYPE_NUMBER DTYPE_NUMBER DTYPE_TEXT

250 22 22 30 30 22 22 30

No No No No No Yes Yes No

Order Id

OrderId

DTYPE_ID

15

No

Order Integration Id

OrderIntegrationId

DTYPE_TEXT

30

No

Siebel Application Services Interface Reference Version 8.2

10 5

Predefined Application Service Interfaces Siebel Invoice

Table 33. Name

Siebel Invoice ASI Fields XML Tag OrderItemId Data Type DTYPE_ID Length 15 Req. No Note Used for picking from Order Entry Line Item Picklist. Used for picking from Order Entry Line Item Picklist. Used for picking from Order Entry Line Item Picklist. Used for picking from Order Entry Line Item Picklist. Used for picking from Order Entry Line Item Picklist. Used for picking from Order Entry Line Item Picklist. Used for picking from PS PickList Project Resource. Used for picking from Order Entry Product PickList.

Order Item Id

Order Item Integration Id

OrderItemIntegrationId

DTYPE_TEXT

30

No

Order Line Number

OrderLineNumber

DTYPE_NUMBER

22

No

Order Number

OrderNumber

DTYPE_TEXT

30

No

Order Organization Name

OrderOrganizationName

DTYPE_TEXT

100

No

Order Type

OrderType

DTYPE_TEXT

50

No

Person Id

PersonId

DTYPE_ID

15

No

Product Id

ProductId

DTYPE_ID

15

No

106

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Invoice

Table 33. Name

Siebel Invoice ASI Fields XML Tag ProductIntegrationId Data Type DTYPE_TEXT Length 30 Req. No Note Used for picking from Order Entry Product PickList. Used for picking from Order Entry Product PickList. Used for picking from Order Entry Product PickList. Used for picking from Order Entry Product PickList. Used for picking from Picklist Project. Used for picking from Picklist Project. Used for picking from Project Item PickList. Used for picking from Project Item PickList. Used for picking from Picklist Project.

Product Integration Id

Product Name

ProductName

DTYPE_TEXT

100

No

Product Organization Name

ProductOrganizationName

DTYPE_TEXT

100

No

Product Vendor Organization Name Project Id

ProductVendorOrganizationN ame

DTYPE_TEXT

100

No

ProjectId

DTYPE_ID

15

No

Project Integration Id

ProjectIntegrationId

DTYPE_TEXT

30

No

Project Item Id

ProjectItemId

DTYPE_ID

15

No

Project Item Number

ProjectItemNumber

DTYPE_TEXT

30

No

Project Number

ProjectNumber

DTYPE_TEXT

30

No

Siebel Application Services Interface Reference Version 8.2

10 7

Predefined Application Service Interfaces Siebel Invoice

Table 33. Name

Siebel Invoice ASI Fields XML Tag ProjectOrganizationName Data Type DTYPE_TEXT Length 100 Req. No Note Used for picking from Picklist Project. Used for picking from PS PickList Project Resource. Used for picking from PS PickList Project Resource. Used for picking from Service Request Picklist. Used for picking from Service Request Picklist. Used for picking from Service Request Picklist. None None Bound by UNIT_OF_ME ASURE LOV.

Project Organization Name Project Resource Id

ProjectResourceId

DTYPE_ID

15

No

Project Resource Number

ProjectResourceNumber

DTYPE_TEXT

30

No

Service Request Id

ServiceRequestId

DTYPE_ID

15

No

Service Request Number

ServiceRequestNumber

DTYPE_TEXT

64

No

Service Request Organization Name Surcharge Amount Tax Amount Unit of Measure

ServiceRequestOrganization Name

DTYPE_TEXT

100

No

SurchargeAmount TaxAmount UnitofMeasure

DTYPE_CURRENCY DTYPE_CURRENCY DTYPE_TEXT

22 22 30

No No Yes

108

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces External Opportunity Create/External Opportunity Query/External Opportunity Update

External Opportunity Create/External Opportunity Query/External Opportunity Update


The External Opportunity Create/External Opportunity Query/External Opportunity Update ASI facilitates the inbound and outbound transfer of opportunity data and associated child-level data such as contacts, notes, revenues, and activities. It is based on the Opportunity business object and supports the create, update, and query functions. The Opportunity Sharing ASIs are as follows: ANI Opportunity Message (PRM ANI) on page 110 ANI Message Header (PRM ANI) on page 119 Opportunity (PRM ANI) on page 120 Destination Channel Partner (PRM ANI) on page 125 Source Organization (PRM ANI) on page 126 Opportunity Account (PRM ANI) on page 127

Figure 22 describes the structure of the External Opportunity Create/External Opportunity Query/ External Opportunity Update ASI.

Figure 22. Opportunity Sharing ASI

Siebel Application Services Interface Reference Version 8.2

10 9

Predefined Application Service Interfaces External Opportunity Create/External Opportunity Query/External Opportunity Update

ANI Opportunity Message (PRM ANI)


The ANI Opportunity Message (PRM ANI) ASI is the main interface for the Opportunity Sharing ASI, which encapsulates these ASIs (Opportunity, Opportunity Account, ANI Message Header, Destination Channel Partner, and Source Organization) and the associated data contained in the ASIs. Table 34 lists the primary integration components of ANI Opportunity Message (PRM ANI).

Table 34.

ANI Opportunity Message (PRM ANI) Integration Components XML Tag Account Account_BusinessAddress User Keys No user keys.

Integration Component Account Account_Business Address

City, Country, Postal Code, State, Street Address, Street Address 2 Address Name, City, Postal Code, State, Street Address City, Postal Code, State Address Name Due, Id, Type Comment, Description, Due, Type Comment, Description, Due, Type Location, Name City, Country, Postal Code, State, Street Address, Street Address 2 Account Id, Address Name, City, Postal Code, State, Street Address City, Postal Code, State Account Id, Address Name

2 3 4
Action Action

1 2 3

Channel Partner Channel Partner Business Address

ChannelPartner ChannelPartnerAddress

1 1

3 4

110

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces External Opportunity Create/External Opportunity Query/External Opportunity Update

Table 34.

ANI Opportunity Message (PRM ANI) Integration Components XML Tag Contact User Keys

Integration Component Contact

1 2 3

First Name, Id, Last Name First Name, Last Name, Middle Name, Primary Account Name Account Integration Id, First Name, Last Name, Middle Name First Name, Last Name, Middle Name First Name, Last Name Account Integration Id, First Name, Last Name, Middle Name First Name, Last Name, Middle Name, Primary Account Name First Name, Last Name, Middle Name Account, Account Location City, Country, Postal Code, State, Street Address, Street Address 2 Address Name, City, Postal Code, State, Street Address City, Postal Code, State Address Name City, Country, Postal Code, State, Street Address, Street Address 2 City, Country, Postal Code, State, Street Address, Street Address 2 City, Postal Code, State Integration Id

4 5 6

7 8
Contact_Account Contact_Account_Business Address Contact_Account Contact_Account_BusinessA ddress

1 1

2 3 4
Contact_Personal Address Contact_PersonalAddress

3 4
Message Details MessageDetails

No user keys.

Siebel Application Services Interface Reference Version 8.2

11 1

Predefined Application Service Interfaces External Opportunity Create/External Opportunity Query/External Opportunity Update

Table 34.

ANI Opportunity Message (PRM ANI) Integration Components XML Tag Opportunity User Keys

Integration Component Opportunity

1 2 3 4

Name Account Integration Id, Name Account, Account Location, Name Name Id, Note, Note Type, Oppty Name Note Type, Oppty Name Note, Note Type Note Type, Oppty Name Id, Note, Note Type, Oppty Name City, Country, Postal Code, State, Street Address, Street Address 2 City, Postal Code, State, Street Address City, Postal Code, State City, Postal Code, State City, Country, Postal Code, State, Street Address, Street Address 2 Integration Id DUNS Number City, Country, Postal Code, State, Street Address, Street Address 2 City, Postal Code, State, Street Address City, Postal Code, State Account Id, Address Name Revenue Item Number

Opportunity Note

OpportunityNote

1 2 3 4 5

Opportunity_Business Address

OpportunityBusinessAddress

2 3 4 5

6
Organization Organization Business Address Organization OrganizationAddress

1 1

2 3 4
Revenue Transfer Details Revenue TransferDetails

No user keys.

112

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces External Opportunity Create/External Opportunity Query/External Opportunity Update

Table 35 lists the fields and their attributes.

Table 35. Name Account

ANI Opportunity Message (PRM ANI) ASI Fields XML Tag Data Type Length Req.

Currency Code Customer Account Group DUNS Number Group Type Code Id Location Name Party Type Code

CurrencyCode CustomerAccountGroup DUNSNumber GroupTypeCode Id Location Name PartyTypeCode

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

15 30 15 30 30 50 100 30

No No No No No No No No

Account_Business Address Address Name City Country Email Address IsPrimaryMVG Phone Number Postal Code State Street Address Street Address 2 Action Comment Description Done Due Id Planned Planned Completion Comment Description Done Due Id Planned PlannedCompletion DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT 1,500 100 50 50 30 50 50 No No No No No No No AddressName City Country EmailAddress IsPrimaryMVG PhoneNumber PostalCode State StreetAddress StreetAddress2 DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 100 50 50 50 1 40 30 10 200 100 No No No No No No No No No No

Siebel Application Services Interface Reference Version 8.2

11 3

Predefined Application Service Interfaces External Opportunity Create/External Opportunity Query/External Opportunity Update

Table 35. Name Priority Started Status Type

ANI Opportunity Message (PRM ANI) ASI Fields XML Tag Priority Started Status Type Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length 30 50 50 30 Req. No No No No

Channel Partner DUNS Number Location Name DUNSNumber Location Name DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 15 50 100 No No No

Channel Partner Business Address Account Id Address Name City Country County Email Address Phone Number Postal Code Province State Street Address Street Address 2 Contact Account Id Account Integration Id Cellular Phone # Comment DUNS Number Email Address Fax Phone # First Name Home Phone # AccountId AccountIntegrationId CellularPhone Comment DUNSNumber EmailAddress FaxPhone FirstName HomePhone DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 15 30 40 255 15 50 40 50 40 No No No No No No No No No AccountId AddressName City Country County EmailAddress PhoneNumber PostalCode Province State StreetAddress StreetAddress2 DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 15 100 50 50 50 50 40 30 50 10 200 100 No No No No No No No No No No No No

114

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces External Opportunity Create/External Opportunity Query/External Opportunity Update

Table 35. Name Id Job Title

ANI Opportunity Message (PRM ANI) ASI Fields XML Tag Id JobTitle LastName MM MiddleName PrimaryAccountName WorkPhone Data Type DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length 30 75 50 15 50 100 40 Req. No No No No No No No

Last Name M/M Middle Name Primary Account Name Work Phone # Contact_Account Account Account Location Currency Code Customer Account Group DUNS Number Group Type Code IsPrimaryMVG Party Type Code

Name Location CurrencyCode CustomerAccountGroup DUNSNumber GroupTypeCode IsPrimaryMVG PartyTypeCode

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

100 50 15 30 15 30 1 30

No No No No No No No No

Contact_Account_Business Address Address Name City Country Email Address IsPrimaryMVG Phone Number Postal Code State Street Address Street Address 2 AddressName City Country EmailAddress IsPrimaryMVG PhoneNumber PostalCode State StreetAddress StreetAddress2 DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 100 50 50 50 1 40 30 10 200 100 No No No No No No No No No No

Contact_Personal Address Address Name Integration Id AddressName IntegrationId DTYPE_TEXT DTYPE_TEXT 100 30 No No

Siebel Application Services Interface Reference Version 8.2

11 5

Predefined Application Service Interfaces External Opportunity Create/External Opportunity Query/External Opportunity Update

Table 35. Name

ANI Opportunity Message (PRM ANI) ASI Fields XML Tag IsPrimaryMVG PersonalCity PersonalCountry PersonalPostalCode PersonalState PersonalStreetAddress PersonalStreetAddress2 Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length 1 50 50 30 10 200 100 Req. No No No No No No No

IsPrimaryMVG Personal City Personal Country Personal Postal Code Personal State Personal Street Address Personal Street Address 2 Message Details External Id External Id Description Internal Id Internal Id Description Message Generation Time Stamp Method Redirection URL Opportunity Account Account Id Account Integration Id Account Location Currency Code DUNS Number Description Id Name Parent Opportunity Name Primary Revenue Amount

ExternalId ExternalIdDescription InternalId InternalIdDescription MessageGenerationTimeStamp Method RedirectionURL

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_TEXT

250 50 250 50 50 50 50

No No No No No No No

AccountName AccountId AccountIntegrationId AccountLocation CurrencyCode DUNSNumber Description Id Name ParentOpportunityName PrimaryRevenueAmount

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

100 30 30 50 15 15 255 30 100 100 22

No No No No No No No No No No No

116

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces External Opportunity Create/External Opportunity Query/External Opportunity Update

Table 35. Name

ANI Opportunity Message (PRM ANI) ASI Fields XML Tag PrimaryRevenueClass PrimaryRevenueCloseDate PrimaryRevenueType PrimaryRevenueWinProbability SalesMethod SalesStage Data Type DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT Length 30 50 30 22 30 30 Req. No No No No No No

Primary Revenue Class Primary Revenue Close Date Primary Revenue Type Primary Revenue Win Probability Sales Method Sales Stage Opportunity Note Id Note Note Type Opportunity Name

Id Note NoteType OpportunityName

DTYPE_ID DTYPE_NOTE DTYPE_TEXT DTYPE_TEXT

30 1,000 30 100

No No No No

Opportunity_Business Address City Country Integration Id IsPrimaryMVG Postal Code State Stree Address Line 2 Street Address Organization DUNS Number Id Name DUNSNumber Id Name DTYPE_TEXT DTYPE_ID DTYPE_TEXT 15 15 100 No No No City Country IntegrationId IsPrimaryMVG PostalCode State StreetAddressLine2 StreetAddress DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 50 50 30 1 30 10 100 200 No No No No No No No No

Organization Business Address City Country Integration Id IsPrimaryMVG City Country Integration Id IsPrimaryMVG DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 50 50 30 1 No No No No

Siebel Application Services Interface Reference Version 8.2

11 7

Predefined Application Service Interfaces External Opportunity Create/External Opportunity Query/External Opportunity Update

Table 35. Name

ANI Opportunity Message (PRM ANI) ASI Fields XML Tag PostalCode State StreetAddress StreetAddress2 Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length 30 10 200 100 Req. No No No No

Postal Code State Street Address Street Address 2 Revenue Account Account Location Committed Currency Code Date Description Id Part Number Price Product Quantity Revenue Revenue Class Revenue Item Number Revenue Type Summary Win Probability Transfer Details Transfer Date Transfer Recipient Transfer Status Transfer Status Message

Account AccountLocation Committed CurrencyCode4 Date Description Id PartNumber Price Product Quantity Revenue RevenueClass RevenueItemNumber RevenueType Summary WinProbability

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER

100 50 1 20 50 100 30 50 22 50 22 22 30 30 30 1 22

No No No No No No No No No No No No No No No No No

TransferDate TransferRecipient TransferStatus TransferStatusMessage

DTYPE_DATETIME DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

50 20 50 200

No No No No

118

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces External Opportunity Create/External Opportunity Query/External Opportunity Update

ANI Message Header (PRM ANI)


The ANI Message Header ASI (PRM ANI) encapsulates information related to the exchange of the Opportunity Sharing message, such as whether the creation or update of the opportunity was successful. Table 36 lists the primary integration components of ANI Message Header (PRM ANI).

Table 36.

ANI Message Header (PRM ANI) Integration Components XML Tag MessageDetails TransferDetails User Keys No user keys. No user keys.

Integration Component Message Details Transfer Details

Table 37 lists the fields and their attributes.

Table 37. Name

ANI Message Header (PRM ANI) ASI Fields XML Tag Data Type Length Req.

Message Details External Id External Id Description Internal Id Internal Id Description Message Generation Time Stamp Method Redirection URL Transfer Details Transfer Date Transfer Recipient TransferDate TransferRecipient DTYPE_DATETIME DTYPE_TEXT Not applicable Not applicable No No ExternalId ExternalIdDescription InternalId InternalIdDescription MessageGenerationTimeStamp Method RedirectionURL DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_TEXT Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable No No No No No No No

Siebel Application Services Interface Reference Version 8.2

11 9

Predefined Application Service Interfaces External Opportunity Create/External Opportunity Query/External Opportunity Update

Table 37. Name

ANI Message Header (PRM ANI) ASI Fields XML Tag TransferStatus TransferStatusMessage Data Type DTYPE_TEXT DTYPE_TEXT Length Not applicable Not applicable Req. No No

Transfer Status Transfer Status Message

Opportunity (PRM ANI)


The Opportunity (PRM ANI) ASI encapsulates all the data that is directly related to the Opportunity object. This data includes fields such as Opportunity Name, Status, and so on. Table 38 lists the primary integration components of Opportunity (PRM ANI).

Table 38.

Opportunity (PRM ANI) Integration Components XML Tag Action User Keys

Integration Component Action

1 2 3

Due, Id, Type Comment, Description, Due, Type Comment, Description, Due, Type DUNS Number, First Name, ID, Last Name, Middle Name DUNS Number, First Name, Last Name, Middle Name First Name, Last Name, Middle Name, Primary Account Name First Name, Last Name, Middle Name, Primary Account Name First Name, Last Name Account, Account Location

Contact

Contact

5
Contact_Account Contact_Account

120

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces External Opportunity Create/External Opportunity Query/External Opportunity Update

Table 38.

Opportunity (PRM ANI) Integration Components XML Tag Contact_Account_BusinessAddress User Keys

Integration Component Contact_Account_Business Address

City, Country, Postal Code, State, Street Address, Street Address 2 Address Name, City, Postal Code, State, Street Address City, Postal Code, State Address Name City, Country, Postal Code, State, Street Address, Street Address 2 Address Name, City, Postal Code, State, Street Address City, Integration Id, Postal Code, State Integration Id Name Note, Note Type, Oppty Name Note Type, Oppty Name Note, Note Type Note Type Id Address Name, City, Country, Postal Code, State, Street Address, Street Address 2 City, Postal Code, State, Street Address City, Integration Id, Postal Code, State Integration Id Revenue Item Number

3 4
Contact_Personal Address Contact_PersonalAddress

3 4
Opportunity Opportunity Note Opportunity OpportunityNote

1 1 2 3 4 5

Opportunity_Business Address

OpportunityBusinessAddress

2 3 4
Revenue Revenue

Siebel Application Services Interface Reference Version 8.2

12 1

Predefined Application Service Interfaces External Opportunity Create/External Opportunity Query/External Opportunity Update

Table 39 lists the fields and their attributes.

Table 39. Name Action Comment

Opportunity (PRM ANI) ASI Fields XML Tag Data Type Length Req.

Comment Description Done Due Id Planned PlannedCompletion Priority Started Status Type

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

1,500 100 50 50 30 50 50 30 50 30 30

No No No No No No No No No No No

Description Done Due Id Planned Planned Completion Priority Started Status Type Contact Account Id Account Integration Id Cellular Phone # Comment DUNS Number Email Address Fax Phone # First Name Home Phone # Id Job Title Last Name M/M Middle Name Primary Account Name Work Phone #

AccountId AccountIntegrationId CellularPhone Comment DUNSNumber EmailAddress FaxPhone FirstName HomePhone Id JobTitle LastName MM MiddleName PrimaryAccountName WorkPhone

DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

15 30 40 255 15 50 40 50 40 30 75 50 15 50 100 40

No No No No No No No No No No No No No No No No

122

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces External Opportunity Create/External Opportunity Query/External Opportunity Update

Table 39. Name

Opportunity (PRM ANI) ASI Fields XML Tag Data Type Length Req.

Contact_Account Account Account Location Currency Code Customer Account Group DUNS Number Group Type Code IsPrimaryMVG Party Type Code Name Location CurrencyCode CustomerAccountGroup DUNSNumber GroupTypeCode IsPrimaryMVG PartyTypeCode DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 100 50 15 30 15 30 1 30 No No No No No No No No

Contact_Account_Business Address Address Name City Country Email Address IsPrimaryMVG Phone Number Postal Code State Street Address Street Address 2 Contact_Personal Address Address Name Integration Id IsPrimaryMVG Personal City Personal Country Personal Postal Code Personal State Personal Street Address Personal Street Address 2 AddressName IntegrationId IsPrimaryMVG PersonalCity PersonalCountry PersonalPostalCode PersonalState PersonalStreetAddress PersonalStreetAddress2 DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 100 30 1 50 50 30 10 200 100 No No No No No No No No No AddressName City Country EmailAddress IsPrimaryMVG PhoneNumber PostalCode State StreetAddress StreetAddress2 DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 100 50 50 50 1 40 30 10 200 100 No No No No No No No No No No

Siebel Application Services Interface Reference Version 8.2

12 3

Predefined Application Service Interfaces External Opportunity Create/External Opportunity Query/External Opportunity Update

Table 39. Name

Opportunity (PRM ANI) ASI Fields XML Tag Data Type Length Req.

Opportunity Account Account Integration Id Account Location Currency Code DUNS Number Description Id Name Parent Opportunity Name Primary Revenue Amount Primary Revenue Class Primary Revenue Close Date Primary Revenue Type Primary Revenue Win Probability Sales Method Sales Stage Opportunity Note Id Note Note Type Opportunity Name Id Note NoteType OpportunityName DTYPE_ID DTYPE_NOTE DTYPE_TEXT DTYPE_TEXT 30 1,000 30 100 No No No No AccountName AccountIntegrationId AccountLocation CurrencyCode DUNSNumber Description Id Name ParentOpportunityName PrimaryRevenueAmount PrimaryRevenueClass PrimaryRevenueCloseDate PrimaryRevenueType PrimaryRevenueWinProbability SalesMethod SalesStage DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT 100 30 50 15 15 255 30 100 100 22 30 50 30 22 30 30 No No No No No No No No No No No No No No No No

Opportunity_Business Address Address Name City Country Integration Id IsPrimaryMVG Postal Code AddressName City Country IntegrationId IsPrimaryMVG PostalCode DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 50 50 50 30 1 30 No No No No No No

124

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces External Opportunity Create/External Opportunity Query/External Opportunity Update

Table 39. Name State

Opportunity (PRM ANI) ASI Fields XML Tag State StreeAddressLine2 StreetAddress Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length 10 100 200 Req. No No No

Stree Address Line 2 Street Address Revenue Account Account Location Committed Currency Code Date Description Id Part Number Price Product Quantity Revenue Revenue Class Revenue Item Number Revenue Type Summary Win Probability

Account AccountLocation Committed CurrencyCode Date Description Id PartNumber Price Product Quantity Revenue RevenueClass RevenueItemNumber RevenueType Summary WinProbability

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER

100 50 1 20 50 100 30 50 22 50 22 22 30 30 30 1 22

No No No No No No No No No No No No No No No No No

Destination Channel Partner (PRM ANI)


The Destination Channel Partner (PRM ANI) ASI encapsulates information related to the partner company with which the opportunity is being shared. Examples of this information include Partner DUNS Number and Company Name.

Siebel Application Services Interface Reference Version 8.2

12 5

Predefined Application Service Interfaces External Opportunity Create/External Opportunity Query/External Opportunity Update

Table 40 lists the primary integration components of Destination Channel Partner (PRM ANI).

Table 40.

Destination Channel Partner (PRM ANI) Integration Components XML Tag ChannelPartner ChannelPartnerAddress User Keys

Integration Component Channel Partner Channel Partner Business Address

1 1

Location, Name Account Id, Address Name

Table 41 lists the fields and their attributes.

Table 41. Name

Destination Channel Partner (PRM ANI) ASI Fields XML Tag Data Type Length Required

Channel Partner DUNS Number Location Name DUNSNumber Location Name DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 15 50 100 No No No

Channel Partner Business Address Account Id Address Name City Country County Email Address Phone Number Postal Code Province State Street Address Street Address 2 AccountId AddressName City Country County EmailAddress PhoneNumber PostalCode Province State StreetAddress StreetAddress2 DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 30 50 10 200 100 15 100 50 50 50 50 No No No No No No No No No No No No

Source Organization (PRM ANI)


The Source Organization (PRM ANI) ASI encapsulates information related to the source company that is initiating the create or update opportunity message. Examples of this information include Partner DUNS Number, Company Name, and so on.

126

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces External Opportunity Create/External Opportunity Query/External Opportunity Update

Table 42 lists the primary integration components of Source Organization (PRM ANI).

Table 42.

Source Organization (PRM ANI) Integration Components XML Tag Organization OrganizationAddress User Keys

Integration Component Organization Organization Business Address

1 1

DUNS Number Account Id, Address Name

Table 43 lists the fields and their attributes.

Table 43. Name

Source Organization (PRM ANI) ASI Fields XML Tag Data Type Length Required

Organization DUNS Number Id Name DUNSNumber Id Name DTYPE_TEXT DTYPE_ID DTYPE_TEXT 15 15 100 No No No

Organization Business Address Account Id Address Name City Country County Email Address Phone Number Postal Code Province State Street Address Street Address 2 AccountId AddressName City Country County EmailAddress PhoneNumber PostalCode Province State StreetAddress StreetAddress2 DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 15 100 50 50 50 50 Not applicable 30 50 10 200 100 No No No No No No No No No No No No

Opportunity Account (PRM ANI)


The Opportunity Account (PRM ANI) ASI encapsulates account-related information for all the opportunity accounts identified in the opportunity message.

Siebel Application Services Interface Reference Version 8.2

12 7

Predefined Application Service Interfaces External Opportunity Create/External Opportunity Query/External Opportunity Update

Table 44 lists the primary integration components of Opportunity Account (PRM ANI).

Table 44.

Opportunity Account (PRM ANI) Integration Components XML Tag Account Account_BusinessAddress User Keys

Integration Component Account Account Business Address

1 1 2 3 4

Location, Name City, Country, Postal Code, State, Street Address, Street Address 2 Address Name, City, Postal Code, State, Street Address City, Postal Code, State Address Name

Table 45 lists the fields and their attributes.

Table 45. Name Account

Opportunity Account (PRM ANI) ASI Fields XML Tag Data Type Length Required

Currency Code Customer Account Group DUNS Number Group Type Code Id Location Name Party Type Code

CurrencyCode CustomerAccountGroup DUNSNumber GroupTypeCode Id Location Name PartyTypeCode

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

15 30 15 30 30 50 100 30

No No No No No No No No

Account Business Address Address Name City Country Email Address IsPrimaryMVG Phone Number Postal Code AddressName City Country EmailAddress IsPrimaryMVG PhoneNumber PostalCode DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 100 50 50 50 1 40 30 No No No No No No No

128

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Order

Table 45. Name State

Opportunity Account (PRM ANI) ASI Fields XML Tag State StreetAddress StreetAddress2 Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length 10 200 100 Required No No No

Street Address Street Address 2

Siebel Order
The Siebel Order ASI allows customers to accurately capture and validate orders in order to submit them to a fulfillment system. Figure 23 describes the structure of the Siebel Order ASI.

Figure 23. Siebel Order ASI Table 46 lists the integration components of this ASI.

Table 46.

Siebel Order Integration Components XML Tag Attributes User Keys

Integration Component Attributes

1 2 3

Id Integration Id Name Id Integration Id Line Number

Line Items

LineItems

1 2 3

Siebel Application Services Interface Reference Version 8.2

12 9

Predefined Application Service Interfaces Siebel Order

Table 46.

Siebel Order Integration Components XML Tag Orders User Keys

Integration Component Orders

1 2 3 4 5

Id Integration Id Order Number, Order Type, Primary Organization, Revision External Order Number Order Number, Order Type, Organization DUNS Number, Revision Id Integration Id Payment Number, Payment Type Id Integration Id Line Item Action Number Id Integration Id Name Id Integration Id Position Name Login Id Integration Id Shipment Number Id Integration Id Line Number Id Integration Id Line Number

Payments

Payments

1 2 3

Promised Schedule Lines

PromisedScheduleLines

1 2 3

Related Organization

RelatedOrganization

1 2 3

Related Sales Rep

RelatedSalesRep

1 2 3 4

Related Shipment

RelatedShipment

1 2 3

Requested Schedule Lines

RequestedScheduleLines

1 2 3 1 2 3

Shipment Item

ShipmentItem

130

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Order

The Siebel Order ASI uses the same user keys as the Orders integration component. You can use the component fields for the integration, which means that values for each of these fields can be written to an XML file for transport. Table 47 lists the fields and their attributes.

Table 47. Name

Siebel Order ASI Fields XML Tag Data Type Length Req.

Attributes Action Code Attribute Id Data Type Description Hidden Id Integration Id LOV Type Name Object Id Read Only Required Sequence Validation Value operation Line Items Action Code Asset Id Asset Integration Id Asset Number Available Date Available Quantity Available Status Available Status As Of Date ActionCode AssetId AssetIntegrationId AssetNumber AvailableDate AvailableQuantity AvailableStatus AvailableStatusAsOfDate DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT 30 NA 30 NA NA NA 30 NA No No No No No No No No ActionCode AttributeId DataType Description Hidden Id IntegrationId ListOfValueType Name ObjectId ReadOnly Required Sequence Validation Value operation DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 30 NA 30 255 NA 30 30 30 75 NA NA NA NA 250 100 30 No No No No No No No No No No No No No No No No

Siebel Application Services Interface Reference Version 8.2

13 1

Predefined Application Service Interfaces Siebel Order

Table 47. Name

Siebel Order ASI Fields XML Tag BasePrice BillableFlag BillingAccountId CancelledQuantity CarrierPriority CoveredProductUnitPrice DeliveryStatus Description DestinationInventoryLocation DestinationInventoryLocationId Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID Length NA NA NA NA 30 NA 30 NA 100 NA Req. No No No No No No No No No No

Base Price Billable Flag Billing Account Id Cancelled Quantity Carrier Priority Covered Product Unit Price Delivery Status Description Destination Inventory Location Destination Inventory Location Id Destination Inventory Location Integration Id Discount Amount Extended Quantity Freight Amount Has Children Hold Flag Hold Reason Id Integration Id Integration Status Integration Status As Of Date Invoiced Quantity IsComplexProduct Item Price Line Number Loaner Flag

DestinationInventoryLocationIntegrati onId DiscountAmount ExtendedQuantity FreightAmount HasChildren HoldFlag HoldReason Id IntegrationId IntegrationStatus IntegrationStatusAsOfDate InvoicedQuantity IsComplexProduct ItemPrice LineNumber LoanerFlag

DTYPE_TEXT

30

No

DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT

NA NA NA NA NA 30 30 30 30 NA NA NA NA NA NA

No No No No No No No No No No No No No No No

132

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Order

Table 47. Name Net Price Note

Siebel Order ASI Fields XML Tag NetPrice Note OrderHeaderId OrderNumber PackageNameInbound PackageNameOutbound ParentOrderItemId ParentOrderItemNumber PartNumber PartialShip Product ProductGlobalIdentifier ProductId ProductIntegrationId ProductPortId RequestedDate RequestedQuantity ReturnToAccountDUNSNumber ReturnToAccountId ReturnToAccountIntegrationId ReturnToAccountName ReturnToAccountSite ReturnToAddressId Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID Length NA 1,500 NA 30 50 NA NA NA 50 NA 100 50 NA 30 15 NA NA 9 NA 30 100 50 NA Req. No No No No No No No No No No No No No No No No No No No No No No No

Order Header Id Order Number Package Name (Inbound) Package Name (Outbound) Parent Order Item Id Parent Order Item Number Part Number Partial Ship Product Product Global Identifier Product Id Product Integration Id Product Port Id Requested Date Requested Quantity Return To Account DUNS Number Return To Account Id Return To Account Integration Id Return To Account Name Return To Account Site Return To Address Id

Siebel Application Services Interface Reference Version 8.2

13 3

Predefined Application Service Interfaces Siebel Order

Table 47. Name

Siebel Order ASI Fields XML Tag ReturnToAddressIntegrationId ReturnToContactId ReturnToContactIntegrationId ReturnToFirstName ReturnToLastName RollupItemPrice RootOrderItemId SalesUnitofMeasure ShipComplete ShipDate ShipInstruction ShipQuantity ShipToAccount ShipToAccountDUNSNumber ShipToAccountId ShipToAccountIntegrationId ShipToAccountSite ShipToAddress ShipToAddress2 ShipToAddressId ShipToCity ShipToContact-FirstName ShipToContact-LastName Data Type DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length 30 NA 30 50 50 NA NA 30 NA NA 250 NA 100 9 NA 30 50 50 50 NA 30 50 50 Req. No No No No No No No No No No No No No No No No No No No No No No No

Return To Address Integration Id Return To Contact Id Return To Contact Integration Id Return To First Name Return To Last Name Rollup Item Price Root Order Item Id Sales Unit of Measure Ship Complete Ship Date Ship Instruction Ship Quantity Ship To Account Ship To Account DUNS Number Ship To Account Id Ship To Account Integration Id Ship To Account Site Ship To Address Ship To Address 2 Ship To Address Id Ship To City Ship To Contact First Name Ship To Contact Last Name

134

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Order

Table 47. Name

Siebel Order ASI Fields XML Tag ShipToContactId ShipToContactIntegrationId ShipToCountry ShipToState ShipToZip ShiptoAddressIntegrationId ShippingCarrier ShippingCharges ShippingMethod ShippingTerms SingleSource SmartPartNumber SourceInventoryLocationIntegrationId SourceInventoryLocation SourceInventoryLocationId StartPrice Status StatusAsOfDate TaxAmount UnitPrice UnitofMeasure Volume VolumeUnitofMeasure Weight WeightUnitofMeasure operation Data Type DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT Length NA 30 15 15 15 30 30 NA 30 30 NA 250 30 100 NA NA 30 NA NA NA 30 NA 30 NA 30 30 Req. No No No No No No No No No No No No No No No No No No No No No No No No No No

Ship To Contact Id Ship To Contact Integration Id Ship To Country Ship To State Ship To Zip Ship to Address Integration Id Shipping Carrier Shipping Charges Shipping Method Shipping Terms Single Source Smart Part Number Source Inventory Loc Integration Id Source Inventory Location Source Inventory Location Id Start Price Status Status As Of Date Tax Amount Unit Price Unit of Measure Volume Volume Unit of Measure Weight Weight Unit of Measure operation

Siebel Application Services Interface Reference Version 8.2

13 5

Predefined Application Service Interfaces Siebel Order

Table 47. Name Orders Account

Siebel Order ASI Fields XML Tag Data Type Length Req.

Account AccountDUNSNumber AccountId AccountIntegrationId AccountSite Active Approved ApprovedBy ApprovedByDate AvailableDate AvailableStatus AvailableStatusAsOfDate BillTo-FirstName BillTo-LastName BillToAccount BillToAccountDUNSNumber BillToAccountId BillToAccountIntegrationId BillToAccountSite BillToAddress BillToAddress2 BillToAddressId BillToAddressIntegrationId BillToCity BillToContactId

DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_ID

100 9 NA 30 100 NA NA NA NA NA 30 NA 50 50 100 9 NA 30 50 50 50 NA 30 30 NA

No No No No No No No No No No No No No No No No No No No No No No No No No

Account DUNS Number Account Id Account Integration Id Account Site Active Approved Approved By Approved By Date Available Date Available Status Available Status As Of Date Bill To - First Name Bill To - Last Name Bill To Account Bill To Account DUNS Number Bill To Account Id Bill To Account Integration Id Bill To Account Site Bill To Address Bill To Address 2 Bill To Address Id Bill To Address Integration Id Bill To City Bill To Contact Id

136

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Order

Table 47. Name

Siebel Order ASI Fields XML Tag BillToContactIntegrationId BillToCountry BillToState BillToZip BillableFlag BillingBlock CampaignId CampaignIntegrationId CampaignName Carrier CarrierPriority Comments ContactFirstName ContactId ContactIntegrationId ContactLastName ContractId ContractIntegrationId ContractName CreditStatus CurrencyCode DeliveryStatus Description DestinationInventoryLocationId DestinationInventoryLocation Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT Length 30 15 30 15 NA 30 NA 30 100 30 30 250 50 NA 30 50 NA 30 50 NA 20 30 255 NA 100 Req. No No No No No No No No No No No No No No No No No No No No No No No No No

Bill To Contact Integration Id Bill To Country Bill To State Bill To Zip Billable Flag Billing Block Campaign Id Campaign Integration Id Campaign Name Carrier Carrier Priority Comments Contact First Name Contact Id Contact Integration Id Contact Last Name Contract Id Contract Integration Id Contract Name Credit Status Currency Code Delivery Status Description Destination Inventory Id Destination Inventory Location

Siebel Application Services Interface Reference Version 8.2

13 7

Predefined Application Service Interfaces Siebel Order

Table 47. Name

Siebel Order ASI Fields XML Tag DestinationInventoryLocationIntegrati onId DiscountAmount EntitlementId EntitlementName ExternalOrderNumber HoldFlag HoldReason Id IntegrationId IntegrationMessage IntegrationStatus IntegrationStatusAsOfDate OpportunityId OpportunityIntegrationId OpportunityName OrderDate OrderNumber OrderPriority OrderType OrderTypeId OrganizationDUNSNumber ParentOrderId PartialShip PayToAccount PayToAccountDUNSNumber Data Type DTYPE_TEXT Length 30 Req. No

Destination Inventory Location Integration Id Discount Amount Entitlement Id Entitlement Name External Order Number Hold Flag Hold Reason Id Integration Id Integration Message Integration Status Integration Status As Of Date Opportunity Id Opportunity Integration Id Opportunity Name Order Date Order Number Order Priority Order Type Order Type Id Organization DUNS Number Parent Order Id Partial Ship Pay To Account Pay To Account DUNS Number

DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

NA NA 50 NA NA 30 30 30 2,000 30 NA NA 30 100 NA 30 30 30 NA 9 NA NA 100 9

No No No No No No No No No No No No No No No No No No No No No No No No

138

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Order

Table 47. Name

Siebel Order ASI Fields XML Tag PayToAccountId PayToAccountIntegrationId PayToAccountSite PayToAddressId PayToAddressIntegrationId PayToContactFirstName PayToContactId PayToContactIntegrationId PayToContactLastName PaymentTerm PaymentTermId PaymentTermIntegrationId PriceList PriceListId PriceListIntegrationId PricingDate PrimaryOrganization PrimaryOrganizationId ProjectId ProjectIntegrationId ProjectName PromotionId PurchaseOrderNumber Data Type DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT Length NA 30 50 NA 30 50 NA 30 50 50 NA 30 50 NA 30 NA 100 NA NA 30 100 NA 50 Req. No No No No No No No No No No No No No No No No No No No No No No No

Pay To Account Id Pay To Account Integration Id Pay To Account Site Pay To Address Id Pay To Address Integration Id Pay To Contact First Name Pay To Contact Id Pay To Contact Integration Id Pay To Contact Last Name Payment Term Payment Term Id Payment Term Integration Id Price List Price List Id Price List Integration Id Pricing Date Primary Organization Primary Organization Id Project Id Project Integration Id Project Name Promotion Id Purchase Order Number

Siebel Application Services Interface Reference Version 8.2

13 9

Predefined Application Service Interfaces Siebel Order

Table 47. Name Quote Id

Siebel Order ASI Fields XML Tag QuoteId QuoteIntegrationId QuoteNumber RequestedDate ReturnReason ReturnToAccount ReturnToAccountDUNSNumber ReturnToAccountId ReturnToAccountIntegrationId ReturnToAccountSite ReturnToAddressId ReturnToAddressIntegrationId ReturnToContactFirstName ReturnToContactId ReturnToContactIntegrationId ReturnToContactLastName Revision ServiceRequestId ServiceRequestNumber ShipComplete ShipInstructions ShipTo-FirstName Data Type DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length NA 30 30 NA 30 100 9 NA 30 50 NA 30 50 NA 30 50 NA NA NA NA 250 50 Req. No No No No No No No No No No No No No No No No No No No No No No

Quote Integration Id Quote Number Requested Date Return Reason Return To Account Return To Account DUNS Number Return To Account Id Return To Account Integration Id Return To Account Site Return To Address Id Return To Address Integration Id Return To Contact First Name Return To Contact Id Return To Contact Integration Id Return To Contact Last Name Revision Service Request Id Service Request Number Ship Complete Ship Instructions Ship To - First Name

140

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Order

Table 47. Name

Siebel Order ASI Fields XML Tag ShipTo-LastName ShipToAccount ShipToAccountDUNSNumber ShipToAccountId ShipToAccountIntegrationId ShipToAccountSite ShipToAddress ShipToAddress2 ShipToAddressId ShipToAddressIntegrationId ShipToCity ShipToContactId ShipToContactIntegrationId ShipToCountry ShipToState ShipToZip ShippingCharges ShippingMethod ShippingTerms FreightTermsInfo SourceInventoryLocationId SourceInventoryLocationIntegrationId SourceInventoryLocation Status Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length 50 100 9 NA 30 50 50 50 NA 30 30 NA 30 15 30 15 NA 30 30 100 NA 30 100 30 Req. No No No No No No No No No No No No No No No No No No No No No No No No

Ship To - Last Name Ship To Account Ship To Account DUNS Number Ship To Account Id Ship To Account Integration Id Ship To Account Site Ship To Address Ship To Address 2 Ship To Address Id Ship To Address Integration Id Ship To City Ship To Contact Id Ship To Contact Integration Id Ship To Country Ship To State Ship To Zip Shipping Charges Shipping Method Shipping Terms Shipping Terms Info Source Inventory Id Source Inventory Loc Integration Id Source Inventory Location Status

Siebel Application Services Interface Reference Version 8.2

14 1

Predefined Application Service Interfaces Siebel Order

Table 47. Name

Siebel Order ASI Fields XML Tag StatusAsOfDate SubmitDate TaxAmount TaxExempt TaxExemptCode TaxExemptId TaxRate TotalVolume TotalVolumeUoM TotalWeight TotalWeightUoM operation Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER DTYPE_NUMBER DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT Length NA NA NA NA 80 30 NA NA 30 NA 30 30 Req. No No No No No No No No No No No No

Status As Of Date Submit Date Tax Amount Tax Exempt Tax Exempt Code Tax Exempt Id Tax Rate Total Volume Total Volume UoM Total Weight Total Weight UoM operation Payments Account Number Authorization Code Bill To Address Id Bill To Address Integration Id Card Holder Credit Card Expiration Month Credit Card Expiration Year Credit Check Message Credit Check Status Credit Check Status As Of Date Encryption Key Encryption Key Reference Id Integration Id

AccountNumber AuthorizationCode BillToAddressId BillToAddressIntegrationId CardHolder CreditCardExpirationMonth CreditCardExpirationYear CreditCheckMessage CreditCheckStatus CreditCheckStatusAsOfDate EncryptionKey EncryptionKeyReference Id IntegrationId

DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT

50 40 NA 30 50 30 30 250 30 NA 30 30 30 30

No No No No No No No No No No No No No No

142

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Order

Table 47. Name

Siebel Order ASI Fields XML Tag IssuingBankCustomerId IssuingBankName IssuingBankPhoneNumber MerchantId Payment PaymentAccountId PaymentAccountIntegrationId PaymentAccountName PaymentAccountSite PaymentMethod PaymentStatus PaymentStatusAsOfDate PaymentType TransactionAmount TransactionId TransactionTime VerificationNumber operation Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length 30 30 40 30 30 NA 30 100 50 30 30 NA 30 NA 30 30 10 30 Req. No No No No No No No No No No No No No No No No No No

Issuing Bank Customer Id Issuing Bank Name Issuing Bank Phone Number Merchant Id Payment # Payment Account Id Payment Account Integration Id Payment Account Name Payment Account Site Payment Method Payment Status Payment Status As Of Date Payment Type Transaction Amount Transaction Id Transaction Time Verification Number operation

Promised Schedule Lines Available Status Available Status As Of Date Id Integration Id AvailableStatus AvailableStatusAsOfDate Id IntegrationId DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT 30 NA 30 30 No No No No

Siebel Application Services Interface Reference Version 8.2

14 3

Predefined Application Service Interfaces Siebel Order

Table 47. Name

Siebel Order ASI Fields XML Tag LineItemActionNumber OrderItemId OrderItemIntegrationId PartNumber ProductId ProductIntegrationId ProductName PromisedDate PromisedQuantity SourceInventoryLocation SourceInventoryLocationId SourceInventoryLocationIntegrationId Data Type DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_ID DTYPE_TEXT Length NA NA 30 50 NA 30 100 NA NA 100 NA 30 Req. No No No No No No No No No No No No

Line Item Action Number Order Item Id Order Item Integration Id Part Number Product Id Product Integration Id Product Name Promised Date Promised Quantity Source Inventory Location Source Inventory Location Id Source Inventory Location Integration Id operation

operation

DTYPE_TEXT

30

No

Related Organization Integration Id IsPrimaryMVG Organization Organization Id Related Sales Rep Id Integration Id IsPrimaryMVG Login Position Id IntegrationId IsPrimaryMVG Login Position DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 30 30 1 50 50 No No No No No IntegrationId IsPrimaryMVG Organization OrganizationId DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID 30 1 50 NA No No No No

Requested Schedule Lines Id Id DTYPE_ID 30 No

144

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Order

Table 47. Name

Siebel Order ASI Fields XML Tag IntegrationId LineNumber OrderItemId RequestedDate RequestedQuantity SourceInventoryLocation SourceInventoryLocationId SourceInventoryLocationIntegrationId Data Type DTYPE_TEXT DTYPE_NUMBER DTYPE_ID DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_ID DTYPE_TEXT Length 30 NA NA NA NA 100 NA 30 Req. No No No No No No No No

Integration Id Line Number Order Item Id Requested Date Requested Quantity Source Inventory Location Source Inventory Location Id Source Inventory Location Integration Id operation Related Shipment Carrier Destination Inventory Location Id Id Integration Id Shipment Number Source Inventory Location Id Waybill Number operation Shipment Item Confirmed Qty Delivery Date Delivery Qty Id Integration Id Order Line Id Product Id

operation

DTYPE_TEXT

30

No

Carrier DestinationInventoryId

DTYPE_TEXT DTYPE_ID

30 15

No No

Id IntegrationId ShipmentNumber SourceInventoryId WaybillNumber operation

DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT

30 30 30 15 50 NA

No No No No No No

ConfirmedQty DeliveryDate DeliveryQty Id IntegrationId OrderLineId ProductId

DTYPE_NUMBER DTYPE_DATETIME DTYPE_NUMBER DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_ID

NA NA NA NA NA NA NA

No No No No No No No

Siebel Application Services Interface Reference Version 8.2

14 5

Predefined Application Service Interfaces Siebel Position

Table 47. Name

Siebel Order ASI Fields XML Tag ShipmentDate ShipmentLineNumber ShipmentQty operation Data Type DTYPE_DATETIME DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT Length NA NA NA NA Req. No No No No

Shipment Date Shipment Line Number Shipment Qty operation

Siebel Position
The Siebel Position ASI is based on the Position Interface integration object, which is based on the Position integration component and the Position business component. Figure 24 describes the Siebel Position ASI structure.

Figure 24. Siebel Position ASI Table 48 lists the integration components and user keys of this ASI.

Table 48.

Siebel Position Integration Components Business Component Position XML Tag Position User Keys

Integration Component Position

1 2 3 4

App Id Integration Id Division Name

146

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Price List

The Siebel Position ASI uses the same user keys as the Position Interface integration component and has 19 fields. You can use these fields for the integration, which means that values for each of these fields may be written to an XML file for transport. Table 49 lists the fields and their attributes.

Table 49. Name

Siebel Position ASI Fields XML Tag BillingProduct BillingProductId BillingProductIntegrationId Compensatable Description Division DivisionId DivisionIntegrationId Id IntegrationId Name Organization OrganizationId OrganizationIntegrationId ParentPositionId ParentPositionIntegrationId ParentPositionName PositionType operation Data Type DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length 100 Not applicable 30 Not applicable 255 255 Not applicable 30 30 30 50 255 Not applicable 30 Not applicable 30 50 30 30 Req. No No No No No Yes Yes No No No Yes No No No No No No No No

Billing Product Billing Product Id Billing Product Integration Id Compensatable Description Division Division Id Division Integration Id Id Integration Id Name Organization Organization Id Organization Integration Id Parent Position Id Parent Position Integration Id Parent Position Name Position Type operation

Siebel Price List


A price list is a set of standard prices for products and services. Price lists contain the prices a buyer first sees, before any pricing adjustments have occurred. A product must be assigned a price in a given price list in order to appear in a catalog and to become visible to customers. A products price, as defined in the price list, is commonly used as a starting price for other prices generated by the Siebel Pricer application.

Siebel Application Services Interface Reference Version 8.2

14 7

Predefined Application Service Interfaces Siebel Price List

This inbound ASI enables the synchronization and update of a price list and the price list items. Figure 25 describes the Siebel Price List ASI structure.

Figure 25. Siebel Price List ASI Table 50 lists the integration components and user keys of this ASI.

Table 50.

Siebel Price List Integration Components XML Tag PriceList User Keys

Integration Component Price List

1 2 3

Integration Id Id Name, Type Integration Id Id List Price Type Code, Price List Id, Product Id Integration Id Division Id

Price List Item

PriceListItem

1 2 3

Price List_Organization

PriceList_Organization

1 2

Table 51 lists the fields and their attributes. Fields without a length specified do not have a maximum length.

Table 51. Name

Siebel Price List ASI Fields XML Tag Data Type Length Req. Note

Price List Currency Code Description End Date CurrencyCode Description EndDate DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 15 255 No No No None None None

148

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Price List

Table 51. Name

Siebel Price List ASI Fields XML Tag FreightTerms Id Data Type DTYPE_TEXT DTYPE_ID Length 30 30 Req. No No Note None Used for picking a related entity. This read-only field is automatically populated by the Siebel application on insertion and cannot be updated. None None None Used for picking a related entity. None Used for picking a related entity. None None None None

Freight Terms Id

Integration Id Name Payment Term Payment Term Id Primary Organization Primary Organization Id Shipping Method Start Date Type operation Price List Item End Date Id

IntegrationId Name PaymentTerm PaymentTermId PrimaryOrganization PrimaryOrganization Id ShippingMethod StartDate Type operation

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_ID

30 50 50

No No No No

50

No No

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

30

No No

30 30

No No

EndDate Id

DTYPE_TEXT DTYPE_ID 30

No No

None Used for picking a related entity. This read-only field is automatically populated by the Siebel application on insertion and cannot be updated. None None None

Integration Id List Price Type Code Original List Price

IntegrationId ListPriceTypeCode OriginalListPrice

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

30 30

No No No

Siebel Application Services Interface Reference Version 8.2

14 9

Predefined Application Service Interfaces Siebel Quote/External Quote

Table 51. Name

Siebel Price List ASI Fields XML Tag PriceListId Data Type DTYPE_ID Length Req. No Note Used for picking a related entity. This read-only field is automatically populated by the Siebel application on insertion and cannot be updated. Used for picking a related entity. None None None

Price List Id

Product Id Promotional Price Start Date operation

ProductId PromotionalPrice StartDate operation

DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 30

No No No No

Price List_Organization Division Id Integration Id operation DivisionId IntegrationId operation DTYPE_ID DTYPE_TEXT DTYPE_TEXT 30 30 30 No No No None None None

Siebel Quote/External Quote


The Siebel Quote/External Quote ASI is an ASI for quote and order management-related business processes. This ASI facilitates the transfer of quote data between the Siebel application and any external system. Figure 26 shows the Siebel Quote/External Quote ASI structure.

Figure 26. Siebel Quote/External Quote ASI

150

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Quote/External Quote

Table 52 lists the integration components and user keys for this ASI.

Table 52. Siebel Quote/External Quote Integration Components Integration Component Quote XML Tag Quote User Keys

1 2 3

Id Integration Id Quote Number, Primary Organization Name, Revision Id Integration Id Name Integration Id Line Item Id Line Number, Line Number 2 Parent Quote Item Id Root Quote Item Id Id Integration Id Line Number Order Number Order Type Primary Organization Revision Integration Id Organization Organization Id

Attributes

Attribute

1 2 3

Line Items

LineItems

1 2 3 4 5

Promised Schedule Lines

PromisedScheduleLines

1 2 3

Related Order

RelatedOrder

1 2 3 4

Related Organization

RelatedOrganization

1 2 3

Siebel Application Services Interface Reference Version 8.2

15 1

Predefined Application Service Interfaces Siebel Quote/External Quote

Table 52. Siebel Quote/External Quote Integration Components Integration Component Related Service Agreement XML Tag RelatedServiceAgreement User Keys

1 2 3 4 5

Account Id Integration Id Primary Organization Revision Id Integration Id Line Number

Requested Schedule Lines

RequestedScheduleLines

1 2 3

Table 53 lists the fields and their attributes for this ASI.

Table 53. Siebel Quote/External Quote ASI Fields Name Quote Account Account Id Account Integration Id Account Site Active Available Date Available Status Available Status As Of Date Bill To Account Bill To Account Id Bill To Account Integration Id Account AccountId AccountIntegrationId AccountSite Active AvailableDate AvailableStatus AvailableStatusAsOfDate DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_BOOL DTYPE_UTCDAT ETIME DTYPE_TEXT DTYPE_UTCDAT ETIME DTYPE_TEXT DTYPE_ID DTYPE_TEXT 100 15 30 50 1 7 30 7 No No No No No No No No Used for picking a related entity. None Used for picking a related entity. Used for picking a related entity. None None None None XML Tag Data Type Length Req. Note

BillToAccount BillToAccountId BillToAccountIntegrationId

100 15 30

No No No

None None Used for picking a related entity.

152

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Quote/External Quote

Table 53. Siebel Quote/External Quote ASI Fields Name Bill To Account Site Bill To Address Id Bill To Address Integration Id Bill To Contact Last Name Bill To Contact First Name Bill To Contact Id XML Tag BillToAccountSite BillToAddressId BillToAddressIntegrationId BillToContactLastName BillToContactFirstName BillToContactId Data Type DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID Length 50 15 30 50 50 15 Req. No No No No No No Note None None Used for picking a related entity. None None Used for picking a related entity. This read-only field is automatically populated by the Siebel application on insertion and cannot be updated. Used for picking a related entity. Bound by FS_CARRIER LOV. Bound by CARRIER_PRIORI TY LOV. None None Used for picking a related entity. Used for picking a related entity. Bound by MONTH_NUMBER LOV.

Bill To Contact Integration Id Carrier Carrier Priority Contact First Name Contact Id Contact Integration Id Contact Last Name Credit Card Expiration Month

BillToContactIntegrationId Carrier CarrierPriority

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

30 30 30

No No No

ContactFirstName ContactId ContactIntegrationId ContactLastName CreditCardExpirationMonth

DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

50 15 30 50 30

No No No No No

Siebel Application Services Interface Reference Version 8.2

15 3

Predefined Application Service Interfaces Siebel Quote/External Quote

Table 53. Siebel Quote/External Quote ASI Fields Name Credit Card Expiration Year Credit Card Holder Credit Card Name Credit Card Number Credit Status XML Tag CreditCardExpirationYear Data Type DTYPE_TEXT Length 30 Req. No Note Bound by YEAR LOV. None Used for picking a related entity. Used for picking a related entity. Bound by ACCT_CRDT_STAT _TYPE LOV. None None Used for picking a related entity. None None None None None This read-only field is automatically populated by the Siebel application on insertion and cannot be updated. User key field for Quote. Integration Id IntegrationId DTYPE_TEXT 30 No User key field for Quote.

CreditCardHolder CreditCardName CreditCardNumber CreditStatus

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

50 50 50 30

No No No No

Credit Status As Of Date Credit Status Message Currency Code Description Discount Amount Due Date Effective Date Expiration Date Id

CreditStatusAsOfDate CreditStatusMessage CurrencyCode Description DiscountAmount DueDate EffectiveDate ExpirationDate Id

DTYPE_UTCDAT ETIME DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_CURREN CY DTYPE_DATE DTYPE_DATE DTYPE_DATE DTYPE_ID

7 250 20 255 22, 7 7 7 7 15

No No Yes No No No No No No

154

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Quote/External Quote

Table 53. Siebel Quote/External Quote ASI Fields Name Integration Message Integration Status Integration Status As Of Date Name Opportunity Id Opportunity Integration Id Opportunity Name Payment Method Payment Term Payment Term Id Payment Term Integration Id Price List Price List Id XML Tag IntegrationMessage IntegrationStatus Data Type DTYPE_TEXT DTYPE_TEXT Length 2,000 30 Req. No No Note None Bound by EAI_ORDER_SYN C_STATUS LOV. None

IntegrationStatusAsOfDate

DTYPE_UTCDAT ETIME DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_ID

No

Name OpportunityId OpportunityIntegrationId OpportunityName PaymentMethod PaymentTerm PaymentTermId PaymentTermIntegrationId PriceList PriceListId

50 15 30 100 30 50 15 30 50 15

Yes No No No No No No No No No

None None Used for picking a related entity. Used for picking a related entity. Used for picking a related entity. Used for picking a related entity. None Used for picking a related entity. Used for picking a related entity. Used for picking a related entity. This read-only field is automatically populated by the Siebel application on insertion and cannot be updated. Used for picking a related entity. User key field for Quote.

Price List Integration Id Primary Organization

PriceListIntegrationId PrimaryOrganization

DTYPE_TEXT DTYPE_TEXT

30 100

No No

Siebel Application Services Interface Reference Version 8.2

15 5

Predefined Application Service Interfaces Siebel Quote/External Quote

Table 53. Siebel Quote/External Quote ASI Fields Name Quote Number Quote Type Requested Date Revision Ship Complete Ship To Account Ship To Account Id Ship To Account Integration Id Ship To Account Site Ship To Address Id XML Tag QuoteNumber QuoteType RequestedDate Revision ShipComplete ShipToAccount ShipToAccountId ShipToAccountIntegrationId Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_UTCDAT ETIME DTYPE_INTEGER DTYPE_BOOL DTYPE_TEXT DTYPE_ID DTYPE_TEXT Length 30 30 7 22, 7 1 100 15 30 Req. No No No No No No No No Note User key field for Quote. Used for picking a related entity. None User key field for Quote. None Used for picking a related entity. None Used for picking a related entity. None Used for picking a related entity. This read-only field is automatically populated by the Siebel application on insertion and cannot be updated. Used for picking a related entity. None

ShipToAccountSite ShipToAddressId

DTYPE_TEXT DTYPE_ID

50 15

No No

Ship To Address Integration Id Ship To Contact First Name

ShipToAddressIntegrationId

DTYPE_TEXT

30

No

ShipToContactFirstName

DTYPE_TEXT

50

No

156

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Quote/External Quote

Table 53. Siebel Quote/External Quote ASI Fields Name Ship To Contact Id XML Tag ShipToContactId Data Type DTYPE_ID Length 15 Req. No Note Used for picking a related entity. This read-only field is automatically populated by the Siebel application on insertion and cannot be updated. Used for picking a related entity. None

Ship To Contact Integration Id Ship To Contact Last Name Shipping Charges Shipping Info Shipping Terms Source Inventory Location Source Inventory Location Id Source Inventory Location Integration Id Status

ShipToContactIntegrationId

DTYPE_TEXT

30

No

ShipToContactLastName

DTYPE_TEXT

50

No

ShippingCharges ShippingInfo ShippingTerms

DTYPE_CURREN CY DTYPE_TEXT DTYPE_TEXT

22, 7 250 30

No No No

None None Bound by FREIGHT_TERMS LOV. Used for picking a related entity. None

SourceInventoryLocation

DTYPE_TEXT

100

No

SourceInventoryLocationId

DTYPE_ID

15

No

SourceInventoryLocationInt egrationId

DTYPE_TEXT

30

No

Used for picking a related entity.

Status

DTYPE_TEXT

30

Yes

Bound by FS_ORDER_STAT US LOV. None None None

Status As Of Date Tax Amount Tax Exempt

StatusAsOfDate TaxAmount TaxExempt

DTYPE_UTCDAT ETIME DTYPE_CURREN CY DTYPE_BOOL

7 22, 7 1

No No No

Siebel Application Services Interface Reference Version 8.2

15 7

Predefined Application Service Interfaces Siebel Quote/External Quote

Table 53. Siebel Quote/External Quote ASI Fields Name Tax Exemption Code Tax Exemption Id Tax Rate Operation Attributes Action Code Attribute Id Data Type ActionCode AttributeId DataType DTYPE_TEXT DTYPE_ID DTYPE_TEXT 30 15 30 No No No None None Bound by XA_ATTR_DTYPE LOV. None This read-only field is automatically populated by the Siebel application on insertion and cannot be updated. User key field for Attributes. Integration Id List Of Value Type Name Value Operation Line Items Action Code ActionCode DTYPE_TEXT 30 No Bound by DELTA_ACTION_C ODE LOV. IntegrationId ListOfValueType Name Value Operation DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 30 30 75 100 30 No No No No No User key field for Attributes. Bound by LOV._TYPE LOV. User key field for Attributes. Bound by Type. System field. XML Tag TaxExemptionCode Data Type DTYPE_TEXT Length 80 Req. No Note Bound by GLOBAL_TAX_EXE MPTION LOV. None None System field.

TaxExemptionId TaxRate Operation

DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT

30 22, 7 30

No No No

Description Id

Description Id

DTYPE_TEXT DTYPE_ID

250 30

No No

158

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Quote/External Quote

Table 53. Siebel Quote/External Quote ASI Fields Name Available Date Available Quantity Base Price Discount Amount Extended Quantity Integration Id Line Item Id XML Tag AvailableDate AvailableQuantity BasePrice DiscountAmount ExtendedQuantity IntegrationId LineItemId Data Type DTYPE_UTCDAT ETIME DTYPE_NUMBER DTYPE_CURREN CY DTYPE_CURREN CY DTYPE_NUMBER DTYPE_TEXT DTYPE_ID Length 7 22, 7 22, 7 22, 7 22, 7 30 15 Req. No No No No No No No Note None None None None None User key field for Line Items. This read-only field is automatically populated by the Siebel application on insertion and cannot be updated. User key field for Line Items. Line Number Line Number 2 Note Package Name External Package Name Siebel Parent Quote Item Id Product Product Id LineNumber LineNumber2 Note PackageNameExternal DTYPE_NUMBER DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT 22, 7 22, 7 1500 100 Yes No No No User key field for Line Items. User key field for Line Items. None None

PackageNameSiebel ParentQuoteItemId Product ProductId

DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_ID

50 15 100 15

No No No No

None User key field for Line Items. Used for picking a related entity. None

Siebel Application Services Interface Reference Version 8.2

15 9

Predefined Application Service Interfaces Siebel Quote/External Quote

Table 53. Siebel Quote/External Quote ASI Fields Name Product Integration Id Requested Date Requested Quantity Root Quote Item Id Ship To Account Ship To Account Id Ship To Account Site Ship To Address Id Ship To Address Integration Id Ship to Account Integration Id Shipping Charges Single Source Source Inventory Location Source Inventory Location Id Source Inventory Location Integration Id Start Price XML Tag ProductIntegrationId RequestedDate RequestedQuantity RootQuoteItemId ShipToAccount ShipToAccountId ShipToAccountSite ShipToAddressId ShipToAddressIntegrationId Data Type DTYPE_TEXT DTYPE_DATE DTYPE_NUMBER DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_TEXT Length 30 7 22, 7 15 100 15 50 15 30 Req. No No Yes No No No No No No Note Used for picking a related entity. None The default is 1. User key field for Line Items. Used for picking a related entity. None None None Used for picking a related entity. Used for picking a related entity. None None Used for picking a related entity. None

ShiptoAccountIntegrationId

DTYPE_TEXT

30

No

ShippingCharges SingleSource SourceInventoryLocation

DTYPE_CURREN CY DTYPE_BOOL DTYPE_TEXT

22, 7 1 100

No No No

SourceInventoryLocationId

DTYPE_ID

15

No

SourceInventoryLocationInt egrationId

DTYPE_TEXT

30

No

Used for picking a related entity.

StartPrice

DTYPE_CURREN CY

22, 7

No

None

160

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Quote/External Quote

Table 53. Siebel Quote/External Quote ASI Fields Name Tax Amount Unit of Measure Operation XML Tag TaxAmount UnitofMeasure Operation Data Type DTYPE_CURREN CY DTYPE_TEXT DTYPE_TEXT Length 22, 7 30 30 Req. No No No Note None None System field.

Promised Schedule Lines Available Status Available Status As Of Date Id AvailableStatus AvailableStatusAsOfDate DTYPE_TEXT DTYPE_UTCDAT ETIME DTYPE_ID 30 7 No No None None

Id

30

No

This read-only field is automatically populated by the Siebel application on insertion and cannot be updated. User key field for Promised Schedule Lines.

Integration Id

IntegrationId

DTYPE_TEXT

30

No

User key field for Promised Schedule Lines. User key field for Promised Schedule Lines. None None Used for picking a related entity. None

Line Number

LineNumber

DTYPE_NUMBER

22, 7

No

Promised Date Promised Quantity Source Inventory Location Source Inventory Location Id

PromisedDate PromisedQuantity SourceInventoryLocation

DTYPE_DATE DTYPE_NUMBER DTYPE_TEXT

7 22, 7 100

No No No

SourceInventoryLocationId

DTYPE_ID

15

No

Siebel Application Services Interface Reference Version 8.2

16 1

Predefined Application Service Interfaces Siebel Quote/External Quote

Table 53. Siebel Quote/External Quote ASI Fields Name Source Inventory Location Integration Id Operation Related Order Id Id DTYPE_ID 30 No This read-only field is automatically populated by the Siebel application on insertion and cannot be updated. XML Tag SourceInventoryLocationInt egrationId Data Type DTYPE_TEXT Length 30 Req. No Note Used for picking a related entity.

Operation

DTYPE_TEXT

30

No

System field.

Integration Id Order Number Order Type Primary Organization Revision Operation

IntegrationId OrderNumber OrderType PrimaryOrganization Revision Operation

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_INTEGER DTYPE_TEXT

30 30 30 100 22, 7 30

No Yes Yes No No No User key field for Related Order. Used for picking a related entity. User key field for Related Order. User key field for Related Order. System field.

Related Organization Integration Id IntegrationId DTYPE_TEXT 30 No User key field for Related Organization. This field determines whether this child record is the primary one. The value is determined in run time. User key field for Related Organization.

IsPrimaryMVG

IsPrimaryMVG

DTYPE_TEXT

No

Organization

Organization

DTYPE_TEXT

50

No

162

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Quote/External Quote

Table 53. Siebel Quote/External Quote ASI Fields Name Organization Id XML Tag OrganizationId Data Type DTYPE_ID Length 15 Req. No Note User key field for Related Organization.

Related Service Agreement Account Account DTYPE_TEXT 100 No Used for picking a related entity. User key field for Related Service Agreement. This read-only field is automatically populated by the Siebel application on insertion and cannot be updated. User key field for Related Service Agreement. Integration Id IntegrationId DTYPE_TEXT 30 No User key field for Related Service Agreement. User key field for Related Service Agreement. User key field for Related Service Agreement. User key field for Related Service Agreement. System field.

Id

Id

DTYPE_ID

30

No

Name

Name

DTYPE_TEXT

50

Yes

Primary Organization Revision

PrimaryOrganization

DTYPE_TEXT

100

No

Revision

DTYPE_NUMBER

22, 7

Yes

Operation

Operation

DTYPE_TEXT

30

No

Requested Schedule Lines

Siebel Application Services Interface Reference Version 8.2

16 3

Predefined Application Service Interfaces Siebel Quote/External Quote

Table 53. Siebel Quote/External Quote ASI Fields Name Id XML Tag Id Data Type DTYPE_ID Length 30 Req. No Note This read-only field is automatically populated by the Siebel application on insertion and cannot be updated. User key field for Requested Schedule Lines. Integration Id IntegrationId DTYPE_TEXT 30 No User key field for Requested Schedule Lines. User key field for Requested Schedule Lines. None None Used for picking a related entity. None

Line Number

LineNumber

DTYPE_NUMBER

22, 7

Yes

Requested Date Requested Quantity Source Inventory Location Source Inventory Location Id Source Inventory Location Integration Id Operation

RequestedDate RequestedQuantity SourceInventoryLocation

DTYPE_UTCDAT ETIME DTYPE_NUMBER DTYPE_TEXT

7 22, 7 100

No No No

SourceInventoryLocationId

DTYPE_ID

15

No

SourceInventoryLocationInt egrationId

DTYPE_TEXT

30

No

Used for picking a related entity.

Operation

DTYPE_TEXT

30

No

System field.

164

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel ATP Response/External ATP Check

Siebel ATP Response/External ATP Check


The Siebel ATP Response/External ATP Check ASI enables a customer to check for a quantity of goods that is available for delivery in the desired time frame, and for the price of these goods in the external system. Siebel ATP Response/External ATP Check uses two ASIs for request and response, which use the same components and field definitions. Figure 27 describes the structure of this ASI.

Figure 27. Siebel ATP Response/External ATP Check ASI Table 54 lists the XML tags and user keys for this ASI.

Table 54.

Siebel ATP Response/External ATP Check Integration Components XML Tag ATPHeader User Keys

Integration Component ATP Header

1 2

Id Order Number, Organization Type, Revision Order Number, Revision Id Line Number Id Id Id Integration Id

3 4
ATP Line Items ATPLineItems

1 2 1 1 1

Attributes Payments Promised Schedule Line

Attributes Payments PromisedScheduleLine

Siebel Application Services Interface Reference Version 8.2

16 5

Predefined Application Service Interfaces Siebel ATP Response/External ATP Check

Table 55 lists the fields and definitions of the Siebel ATP Response/External ATP Check ASI. Fields without a length specified do not have a maximum length associated with them.

Table 55. Name

Siebel ATP Response/External ATP Check ASI Fields XML Tag Data Type Length Req.

ATPHeader Account Account Id Account Integration Id Available Date Available Message Available Status Available Status As Of Date Carrier Contact First Name Contact Id Contact Last Name Currency Code Document Type Id Header Number Id Integration Id Account AccountId AccountIntegrationId AvailableDate AvailableMessage AvailableStatus AvailableStatusAsOfDate Carrier ContactFirstName ContactId ContactLastName CurrencyCode DocumentTypeId HeaderNumber HeaderRowId IntegrationId DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable No No No No No No No No No No No No No No No No

166

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel ATP Response/External ATP Check

Table 55. Name Name

Siebel ATP Response/External ATP Check ASI Fields XML Tag Name OrderDate OrderPriority Organization OrganizationDUNSNumber OrganizationId OrganizationIntegrationId RequestedDate Revision ShipCompleteFlag ShipToAccount ShipToAccountId ShipToAccountIntegrationId ShipToAddress ShipToAddressId ShipToAddressIntegrationId ShipToCity ShipToCountry Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Req. No No No No No No No No No No No No No No No No No No

Order Date Order Priority Organization Organization DUNS Number Organization Id Organization Integration Id Requested Date Revision Ship Complete Flag Ship To Account Ship To Account Id Ship To Account Integration Id Ship To Address Ship To Address Id Ship To Address Integration Id Ship To City Ship To Country

Siebel Application Services Interface Reference Version 8.2

16 7

Predefined Application Service Interfaces Siebel ATP Response/External ATP Check

Table 55. Name

Siebel ATP Response/External ATP Check ASI Fields XML Tag ShipToFirstName ShipToLastName ShipToSite ShipToState ShipToZip ShippingMethod ShippingTerms ShippingTermsInfo SingleDelivery SourceInventoryLocId SourceInventoryLocIntegrationId SourceInventoryLocation TimeToReserve TimeToReserveUOM operation Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable 30 Req. No No No No No No No No No No No No No No No

Ship To First Name Ship To Last Name Ship To Site Ship To State Ship To Zip Shipping Method Shipping Terms Shipping Terms Info Single Delivery Source Inventory Loc Id Source Inventory Loc Integration Id Source Inventory Location Time To Reserve Time To Reserve UOM operation ATPLineItems ATP Message Line Available Date Available Quantity

ATPMessageLine AvailableDate AvailableQuantity

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

Not applicable Not applicable Not applicable

No No No

168

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel ATP Response/External ATP Check

Table 55. Name

Siebel ATP Response/External ATP Check ASI Fields XML Tag AvailableStatus AvailableStatusAsOfDate Carrier ExtendedQuantity RowId IntegrationId ItemPrice LineNumber MinimumLotSize NetPrice Package ParentRowId ParentRowLineNumber PartNumber ProductGlobalIdentifier ProductId ProductIntegrationId ProductStatusCode Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Req. No No No No No No No No No No No No No No No No No No

Available Status Available Status As Of Date Carrier Extended Quantity Id Integration Id Item Price Line Number Minimum Lot Size Net Price Package Parent Row Id Parent Row Line Number Part Number Product Global Identifier Product Id Product Integration Id Product Status Code

Siebel Application Services Interface Reference Version 8.2

16 9

Predefined Application Service Interfaces Siebel ATP Response/External ATP Check

Table 55. Name

Siebel ATP Response/External ATP Check ASI Fields XML Tag ProductUnitOfMeasure RequestedDate RequestedQuantity RollupItemPrice SalesUnitOfMeasure ShipCompleteFlag ShipToAccountId ShipToAccountIntegrationId ShipToAddress ShipToAddressId ShipToAddressIntegrationId ShipToCity ShipToContactFirstName ShipToContactLastName ShipToCountry ShipToState ShipToZip ShippingMethod Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Req. No No No No No No No No No No No No No No No No No No

Product Unit Of Measure Requested Date Requested Quantity Rollup Item Price Sales Unit Of Measure Ship Complete Flag Ship To Account Id Ship To Account Integration Id Ship To Address Ship To Address Id Ship To Address Integration Id Ship To City Ship To Contact First Name Ship To Contact Last Name Ship To Country Ship To State Ship To Zip Shipping Method

170

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel ATP Response/External ATP Check

Table 55. Name

Siebel ATP Response/External ATP Check ASI Fields XML Tag ShippingTerms SingleDelivery SmartPartNumber SourceInventoryLocId SourceInventoryLocation SourceInventoryLocIntegrationId Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable 30 Req. No No No No No No

Shipping Terms Single Delivery Smart Part Number Source Inventory Loc Id Source Inventory Location Source Inventory Location Integration Id Start Price Time To Reserve Time To Reserve UOM Unit Of Measure Unit Price operation Attributes Description Id Name Value operation

StartPrice TimeToReserve TimeToReserveUOM UnitOfMeasure UnitPrice operation

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

No No No No No No

AttributeDescription AttributeId AttributeName AttributeValue operation

DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

Not applicable Not applicable Not applicable Not applicable 30

No No No No No

Siebel Application Services Interface Reference Version 8.2

17 1

Predefined Application Service Interfaces Siebel ATP Response/External ATP Check

Table 55. Name

Siebel ATP Response/External ATP Check ASI Fields XML Tag Data Type Length Req.

Payments Credit Check Message Credit Check Status Credit Check Status As Of Date Id Payment Method Transaction Amount operation CreditCheckMessage CreditCheckStatus CreditCheckStatusAsOfDate Id PaymentMethod TransactionAmount operation DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable No No No No No No No

PromisedScheduleLine Available Date Available Quantity Available Status Available Status As Of Date Id Line Number Part Number Product Id Product Integration Id Source Inventory Loc Id AvailableDate AvailableQuantity AvailableStatus AvailableStatusAsOfDate Id LineNumber PartNumber ProductId ProductIntegrationId SourceInventoryLocId DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable No No No No No No No No No No

172

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces External Credit Check

Table 55. Name

Siebel ATP Response/External ATP Check ASI Fields XML Tag SourceInventoryLocIntegrationId SourceInventoryLocation operation Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length Not applicable Not applicable 30 Req. No No No

Source Inventory Loc Integration Id Source Inventory Location operation

External Credit Check


The External Credit Check ASI is an ASI for quote and order management-related business processes. This ASI enables the Siebel application to request a credit check from a back-office or credit management system. There are two ASIs for External Credit Checkone for requests and one for responses.

Credit Check Request


The Credit Check Request ASI is an outbound call that triggers the back-office credit limit check business service in an order, and populates the credit status check result in the Siebel application. The Siebel application issues a warning; if a customer does have a sufficient credit limit, the status shown indicates failure. Figure 28 describes the structure of this ASI.

Figure 28. Credit Check Request Table 56 lists the integration component of this ASI.

Table 56.

Credit Check Request Integration Components XML Tag LineItems RequestCreditCheck User Keys No user keys No user keys

Integration Component Line Items Request Credit Check

Siebel Application Services Interface Reference Version 8.2

17 3

Predefined Application Service Interfaces External Credit Check

Table 57 lists the fields and definitions. Fields without a length specified do not have a maximum length associated with them.

Table 57. Name

Credit Check Request ASI Fields XML Tag Data Type Length Req. Note

Request Credit Check Amount Bill To Account Id Bill To Account Integration Id Bill To Account Location Bill To Account Name Bill To Address Id Bill To Alias Bill To City Bill To Country Bill To County Bill To DUNS Number Bill To Postal Code Bill To Primary Organization Id Bill To Primary Organization Name Bill To Province Bill To State Bill To Street Address Bill To Street Address 2 Bill To VAT Registration Number Currency Amount BillToAccountId BillToAccountIntegrationId BillToAccountLocation BillToAccountName BillToAddressId BillToAlias BillToCity BillToCountry BillToCounty BillToDUNSNumber BillToPostalCode BillToPrimaryOrganization Id BillToPrimaryOrganization Name BillToProvince BillToState BillToStreetAddress BillToStreetAddress2 BillToVATRegistrationNum ber Currency DTYPE_NUMBER DTYPE_ID DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT 15 30 50 100 15 50 50 50 50 15 30 15 100 No No No No No No No No No No No No No No None None None None None None None None None None None None None None

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

50 10 200 100 30

No No No No No

None None None None None

DTYPE_TEXT

20

No

None

174

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces External Credit Check

Table 57. Name

Credit Check Request ASI Fields XML Tag DocumentId DocumentIntegrationId DocumentType Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length 30 30 10 Req. Yes No Yes Note None None Contains either Quote or Order value. Applicable only if Document Type is Order.

Document Id Document Integration Id Document Type

Order Type Id

OrderTypeId

DTYPE_ID

15

No

Line Items Extended Quantity Id Item Price Line Number Net Price Parent Order Item Number Product Id Quantity Requested Rollup Item Price Start Price Unit Price ExtendedQuantity Id ItemPrice LineNumber NetPrice ParentOrderItemNumber ProductId QuantityRequested RollupItemPrice StartPrice UnitPrice DTYPE_NUMBER DTYPE_ID DTYPE_NUMBER DTYPE_NUMBER DTYPE_NUMBER DTYPE_NUMBER DTYPE_ID DTYPE_NUMBER DTYPE_NUMBER DTYPE_NUMBER DTYPE_NUMBER 22 15 22 22 22 22 15 22 22 22 22 No No No No No No No No No No No None None None None None None None None None None None

Credit Check Response


Table 58 lists the integration component of this ASI.

Table 58.

Credit Check Response Integration Components XML Tag RequestCreditCheckResponse User Keys No user keys

Integration Component Request Credit Check Response

Siebel Application Services Interface Reference Version 8.2

17 5

Predefined Application Service Interfaces External Shipment Tracking

Table 59 lists the fields and attributes of this ASI.

Table 59. Name

Credit Check Response ASI Fields XML Tag Data Type Length Req.

Request Credit Check Response Bill To Account Id Bill To Account Integration Id Bill To Account Location Bill To Account Name Bill To Primary Organization Id Bill To Primary Organization Name Credit Status As Of Credit Status Code Credit Status Message Document Id Document Integration Id Document Type Error Status Error Text BillToAccountId BillToAccountIntegrationId BillToAccountLocation BillToAccountName BillToPrimaryOrganizationId BillToPrimaryOrganizationName CreditStatusAsOf CreditStatusCode CreditStatusMessage DocumentId DocumentIntegrationId DocumentType ErrorStatus ErrorText DTYPE_ID DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 15 30 50 100 15 100 Not applicable 30 250 15 15 10 30 250 No No No No No No No No No Yes No Yes Yes No

External Shipment Tracking


The External Shipment Tracking ASI enables a customer to check the location and status of an order after it leaves the seller. There are two ASIs for External Shipment Trackingone for requests and one for responses.

176

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces External Shipment Tracking

Shipment Tracking Interface Request


The Shipment Tracking Interface Request uses the Shipment Information Business Component. Table 60 lists the components of this ASI.

Table 60.

Shipment Tracking Interface Request Integration Components XML Tag ShipmentInformation User Keys No user keys

Integration Component Shipment Information

Table 61 lists the fields and their attributes.

Table 61. Name Carrier

Shipment Tracking Interface Request ASI Fields XML Tag Carrier CountryCode Language PackageTrackingNumber Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length 30 10 10 40 Req. No No No C1 Note Used for picking a related entity. None None Package tracking number (required if Shipment Identification Number or Shipment Reference Number is not provided). None None Shipment tracking number (required if Package Tracking Number or Shipment Reference Number is not provided).

Country Code Language Package Tracking Number

Request Action Request Option Shipment Identification Number

RequestAction RequestOption ShipmentIdentificationN umber

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

20 20 50

Yes No C1

Siebel Application Services Interface Reference Version 8.2

17 7

Predefined Application Service Interfaces External Shipment Tracking

Table 61. Name Shipment Reference Number

Shipment Tracking Interface Request ASI Fields XML Tag ShipmentReferenceNum ber Data Type DTYPE_TEXT Length 30 Req. C1 Note Shipment Reference number is defined by the seller (required if Package Tracking Number or Shipment Identification Number is not provided). Required if Shipment Reference Number is provided.

Shipper Number
1. Conditional.

ShipperNumber

DTYPE_TEXT

60

C1

Shipment Tracking Interface Response


Figure 29 describes the structure for Shipment Tracking Interface Response.

Figure 29. Shipment Tracking Interface Response ASI Table 62 lists all the integration components of this ASI.

Table 62.

Shipment Tracking Interface Response ASI Integration Components XML Tag ShipmentInformation PackageInformation User Keys No user keys No user keys

Integration Component Shipment Information Package Information

178

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces External Shipment Tracking

Table 63 lists the fields and their attributes. Fields without a length specified do not have a maximum length associated with them.

Table 63. Name

Shipment Tracking Interface Response ASI Fields XML Tag Data Type Length Req. Notes

Shipment Information Response Code Response Message Shipment Identificati on Number ResponseCode ResponseMessage ShipmentIdentificationNumber DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 10 100 50 Yes Yes C1 None None Tracking number at the shipment level (logical construct). Conditionally required if Shipment Reference Number not provided. None

Shipment Pickup Date Shipment Reference Number

ShipmentPickupDate

DTYPE_UTCDA TETIME DTYPE_TEXT

10

No

ShipmentReferenceNumber

30

C1

Conditionally required if Shipment Identification Number not provided. None

Shipment Scheduled Delivery Date Shipment Service Description Shipment Ship To Address Line 1

ShipmentScheduledDeliveryDate

DTYPE_UTCDA TETIME

10

No

ShipmentServiceDescription

DTYPE_TEXT

100

No

None

ShipmentShipToAddressLine1

DTYPE_TEXT

200

No

None

Siebel Application Services Interface Reference Version 8.2

17 9

Predefined Application Service Interfaces External Shipment Tracking

Table 63. Name Shipment Ship To Address Line 2 Shipment Ship To City Shipment Ship To Country Shipment Ship To Postal Code Shipment Ship To State Shipper Number

Shipment Tracking Interface Response ASI Fields XML Tag ShipmentShipToAddressLine2 Data Type DTYPE_TEXT Length 100 Req. No Notes None

ShipmentShipToCity

DTYPE_TEXT

50

No

None

ShipmentShipToCountry

DTYPE_TEXT

30

No

None

ShipmentShipToPostalCode

DTYPE_TEXT

30

No

None

ShipmentShipToState

DTYPE_TEXT

10

No

None

ShipperNumber

DTYPE_TEXT

60

None

Package Information Comments Package Activity Date Package Activity Location City Package Activity Location Country Package Activity Location Description Comments PackageActivityDate DTYPE_TEXT DTYPE_DATE 100 20 No No None None

PackageActivityLocationCity

DTYPE_TEXT

20

No

None

PackageActivityLocationCountry

DTYPE_TEXT

20

No

None

PackageActivityLocationDescription

DTYPE_TEXT

20

No

None

180

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel SIA Service Request

Table 63. Name

Shipment Tracking Interface Response ASI Fields XML Tag PackageActivityLocationSignedForB yName Data Type DTYPE_TEXT Length 20 Req. No Notes None

Package Activity Location Signed For By Name Package Activity Status Description Package Activity Time Package Tracking Number Response Code Response Message
1. Conditional

PackageActivityStatusDescription

DTYPE_TEXT

20

No

None

PackageActivityTime

DTYPE_TIME

20

No

None

PackageTrackingNumber

DTYPE_TEXT

20

Yes

None

ResponseCode ResponseMessage

DTYPE_TEXT DTYPE_TEXT

10 100

No No

None None

Siebel SIA Service Request


This ASI enables an application to create an SIA service request within the Siebel application. Figure 30 describes the Siebel SIA Service Request ASI structure.

Figure 30. Siebel SIA Service Request ASI

Siebel Application Services Interface Reference Version 8.2

18 1

Predefined Application Service Interfaces Siebel SIA Service Request

Table 64 lists the integration components of this ASI.

Table 64. Name Action

Siebel SIA Service Request Integration Components XML Tag Action User Keys

1 2 1 2

Id Activity UId Id AEP Account Id, AEP Product Id, Version Name, Version Id Primary Organization Id, SR Number

Related Account External Product

AccountExternalProduct

SR External Product Service Request

SRExternalProduct ServiceRequest

1 1 2

Table 65 lists the integration components and field attributes.

Table 65. Name Action Abstract

Siebel SIA Service Request ASI Fields XML Tag Data Type Length Required

Abstract ActivitySRId ActivityUID AssetId AssetNumber Audience Comment Description Done DurationHours DurationMinutes Id Planned PlannedCompletion

DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER DTYPE_NUMBER DTYPE_ID DTYPE_TEXT DTYPE_TEXT

100 15 30 15 100 30 1,500 100 30 22 22 30 30 30

No No No No No No No No No No No No No No

Activity SR Id Activity UID Asset Id Asset Number Audience Comment Description Done Duration Hours Duration Minutes Id Planned Planned Completion

182

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel SIA Service Request

Table 65. Name

Siebel SIA Service Request ASI Fields XML Tag PrimaryOwnerId ResolutionCode Started Type Data Type DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length 15 30 30 30 Required No No No No

Primary Owner Id Resolution Code Started Type

Related Account External Product AEP Account Id AEP Product Id Id Version SR External Product Name Version Service Request Abstract Account Account Id Account Location Agreement Id Asset Id Closed Date Commit Time Contact Business Phone Contact Created Contact First Name Contact Id Contact Last Name Customer Ref Number Description Entitlement Id Abstract Account AccountId AccountLocation AgreementId AssetId ClosedDate CommitTime ContactBusinessPhone ContactCreated ContactFirstName ContactId ContactLastName CustomerRefNumber Description EntitlementId DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID 100 100 15 50 15 15 30 30 30 30 50 15 50 64 2,000 15 No No No No No No No No No No No No No No No No Name Version DTYPE_TEXT DTYPE_TEXT 100 30 No No AEPAccountId AEPProductId Id Version DTYPE_ID DTYPE_ID DTYPE_ID DTYPE_TEXT 30 30 30 30 No No No No

Siebel Application Services Interface Reference Version 8.2

18 3

Predefined Application Service Interfaces Siebel Service Request

Table 65. Name

Siebel SIA Service Request ASI Fields XML Tag EntitlementName GroupId Id OwnedById Owner PrimaryOrganizationId PrimaryServiceAgreementId Priority Product ProductId SRNumber SRType SerialNumber ServiceRequestType Severity Source Status Subarea Sub-Status Type operation searchspec Data Type DTYPE_TEXT DTYPE_ID DTYPE_ID DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length 50 15 30 15 50 15 15 30 100 15 64 30 100 30 30 30 30 30 30 30 30 250 Required No No No No No No No No No No No No No No No No No No No No No No

Entitlement Name Group Id Id Owned By Id Owner Primary Organization Id Primary Service Agreement Id Priority Product Product Id SR Number SR Type Serial Number Service Request Type Severity Source Status Sub-Area Sub-Status Type operation searchspec

Siebel Service Request


The Siebel Service Request ASI is part of the Manage Service Request business process. Use this ASI to synchronize service requests in the Siebel application with an external target application. This ASI facilitates both outbound and inbound data synchronization between the Siebel application and an external target application.

184

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Service Request

Figure 31 describes the Siebel Service Request ASI structure.

Figure 31. Siebel Service Request ASI Table 66 lists the integration components and user keys of this ASI.

Table 66.

Siebel Service Request Integration Components XML Tag Action User Keys

Integration Component Action

1 2 1 2

Id Activity UID Id AEP Account Id, AEP Product Id, Version Id Primary Organization Id, SR Number Name, Version

Account External Product

AccountExternalProduct

Service Request

ServiceRequest

1 2

SR External Product

SrExternalProduct

Table 67 lists the fields and their attributes. Fields without a length specified do not have a maximum length associated with them.

Table 67. Name

Siebel Service Request ASI Fields XML Tag Data Type Length Required

Account External Product AEP Account Id AEP Product Id Id Version Action AEPAccountId AEPProductId Id Version DTYPE_ID DTYPE_ID DTYPE_ID DTYPE_TEXT 30 30 30 30 No No No No

Siebel Application Services Interface Reference Version 8.2

18 5

Predefined Application Service Interfaces Siebel Service Request

Table 67. Name Abstract

Siebel Service Request ASI Fields XML Tag Abstract ActivitySRId ActivityUID AssetId AssetNumber Audience Comment Description3 Done DurationHours DurationMinutes Id Planned PlannedCompletion PrimaryOwnerId ResolutionCode Started Type Data Type DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER DTYPE_NUMBER DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length 100 15 30 15 100 30 1,500 100 30 22 22 30 30 30 15 30 30 30 Required No No No No No No No No No No No No No No No No No No

Activity SR Id Activity UID Asset Id Asset Number Audience Comment Description Done Duration Hours Duration Minutes Id Planned Planned Completion Primary Owner Id Resolution Code Started Type Service Request Abstract Account Account Id Account Location Agreement Id Area Asset Id Closed Date Commit Time Contact Business Phone Contact Created

Abstract Account AccountId AccountLocation AgreementId Area AssetId ClosedDate CommitTime ContactBusinessPhone ContactCreated

DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

100 100 15 50 15 30 15 30 30 NA 30

No No No No No No No No No No No

186

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Service Request

Table 67. Name

Siebel Service Request ASI Fields XML Tag ContactFirstName ContactId ContactLastName CustomerReferenceNumber Description EntitlementId EntitlementName GroupId Id OwnedById Owner PrimaryOrganizationId PrimaryServiceAgreementId Priority Product ProductId SRNumber SRType SerialNumber ServiceRequestType Severity Source Status Sub-Area Sub-Status Type operation searchspec Data Type DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_ID DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length 50 15 50 64 2,000 15 50 NA 30 30 50 15 15 30 100 15 64 30 NA 30 30 30 30 30 30 30 30 250 Required No No No No No No No No No No No No No No No No No No No No No No No No No No No No

Contact First Name Contact Id Contact Last Name Customer Reference Number Description Entitlement Id Entitlement Name Group Id Id Owned By Id Owner Primary Organization Id Primary Service Agreement Id Priority Product Product Id SR Number SR Type Serial Number Service Request Type Severity Source Status Sub-Area Sub-Status Type operation searchspec SR External Product

Siebel Application Services Interface Reference Version 8.2

18 7

Predefined Application Service Interfaces Siebel Simple Product

Table 67. Name Name Version

Siebel Service Request ASI Fields XML Tag Name Version Data Type DTYPE_TEXT DTYPE_TEXT Length 100 30 Required No No

Siebel Simple Product


This ASI receives information about simple products created in third-party systems and enables users to create, update, and query a product in the Siebel application. The Siebel Simple Product ASI is intended to synchronize the Siebel application to external product masters, and does not support the receipt of information for customized products or bundles. Figure 32 describes the structure of the Siebel Simple Product ASI.

Figure 32. Siebel Simple Product ASI

188

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Simple Product

Table 68 lists the integration components and user keys for this ASI.

Table 68.

Siebel Simple Product ASI Integration Components XML Tag InternalProduct User Keys

Integration Component Internal Product

1 2 3

Id Integration Id Product Name, Primary Organization, Primary Vendor, Vendor Site, Vendor Primary Organization Id Integration Id Inventory Type, Product Name Id Product Name, Inventory Location Id Id Integration Id Equivalent Product, Equivalent Product Primary Organization, Equivalent Product Vendor, Equivalent Product Vendor Location, Equivalent Product Vendor Organization Id Integration Id Inventory Name, Primary Organization Id Integration Id Organization Id Integration Id Product Name, Vendor, Vendor Location, Organization

Inventory Options

InventoryOptions

1 2 3

Product Inventory

ProductInventory

1 2 1 2 3

Related Equivalent Product

RelatedEquivalentProduct

Related Inventory Location

RelatedInventoryLocation

1 2 3

Related Organization

RelatedOrganization

1 2 3

Related Product

RelatedProduct

1 2 3

Siebel Application Services Interface Reference Version 8.2

18 9

Predefined Application Service Interfaces Siebel Simple Product

Table 68.

Siebel Simple Product ASI Integration Components XML Tag RelatedProductLine User Keys

Integration Component Related Product Line

1 2 3

Id Integration Id Product Line Id Integration Id Name, Primary Organization Id Integration Id Warranty Name, Warranty Provider Name, Warranty Provider Primary Organization, Warranty Provider Site

Related Sales Tool by Product

RelatedSalesToolByProduct

1 2 3

Related Warranty

RelatedWarranty

1 2 3

Table 69 lists the fields and their attributes. Fields without a length specified do not have a maximum length associated with them.

Table 69. Name

Siebel Simple Product ASI Fields XML Tag Data Type Length Req.

Internal Product Allocate Below Safety Flag Auto Allocate Flag Auto Substitute Flag Class Id Class Integration Id Class Name Class Type Compensable Description Division Code Effective End Date Effective Start Date Field Replacable AllocateBelowSafetyFlag AutoAllocateFlag AutoSubstituteFlag ClassId ClassIntegrationId ClassName ClassType CompensableFlag Description DivisionCode EffectiveEndDate EffectiveStartDate FieldReplacable DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_DATETIME DTYPE_TEXT 30 30 30 NA 30 75 30 NA 255 30 NA NA NA No No No No No No No No No No No No No

190

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Simple Product

Table 69. Name

Siebel Simple Product ASI Fields XML Tag GlobalAssemblyLevelCode GlobalProductClassificationCode GlobalProductIdentifier GlobalProductLifecycleStatusCode GlobalSupplyChainCode Id ImageName ImagePrimaryOrganizationName ImageFileName IntegrationId IsAdminMode ItemSize LeadTime MTBF MTTR MaximumQuantity MinimumQuantity Orderable ParentInternalProductId ParentInternalProductIntegrationId Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_NUMBER DTYPE_NUMBER DTYPE_NUMBER DTYPE_NUMBER DTYPE_TEXT DTYPE_ID DTYPE_TEXT Length 50 50 50 50 50 30 100 100 200 30 NA NA 30 NA NA NA NA NA NA 30 Req. No No No No No No No No No No No No No No No No No No No No

Global Assembly Level Code Global Product Classification Code Global Product Identifier Global Product Lifecycle Status Code Global Supply Chain Code Id Image Name Image Primary Organization Name ImageFileName Integration Id IsAdminMode Item Size Lead Time MTBF MTTR Maximum Quantity Minimum Quantity Orderable Parent Internal Product Id (Joined) Parent Internal Product Integration Id Parent Internal Product Name Parent Internal Product Primary Organization

ParentInternalProductName ParentInternalProductPrimaryOrga nization

DTYPE_TEXT DTYPE_TEXT

100 100

No No

Siebel Application Services Interface Reference Version 8.2

19 1

Predefined Application Service Interfaces Siebel Simple Product

Table 69. Name

Siebel Simple Product ASI Fields XML Tag ParentInternalProductVendor ParentInternalProductVendorLocati on ParentInternalProductVendorOrgan ization PartNumber PrimaryOrganization PrimaryVendor ProductImageId ProductImageIntegrationId ProductLevel ProductName ProductThumbnailImageId ProductType ReturnifDefective Version SalesProduct Serialized ServiceProduct Carrier ShippingVia Status TargetedCountry TargetedIndustry TargetedMaxAge TargetedMinAge TargetedPostalCode ToolFlag Data Type DTYPE_TEXT DTYPE_TEXT Length 100 50 Req. No No

Parent Internal Product Vendor Parent Internal Product Vendor Location Parent Internal Product Vendor Organization Part Number Primary Organization Primary Vendor Product Image Id Product Image Integration Id Product Level Product Name Product Thumbnail Image Id Product Type Return if Defective Revision Sales Product Serialized Service Product Ship Carrier Shipping Via Status Targeted Country Targeted Industry Targeted Max Age Targeted Min Age Targeted Postal Code Tool Flag

DTYPE_TEXT

100

No

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT

50 50 100 NA 30 NA 100 NA 30 NA 30 NA NA NA 30 30 30 250 250 NA NA 250 NA

No No No No No No No No No No No No No No No No No No No No No No No

192

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Simple Product

Table 69. Name

Siebel Simple Product ASI Fields XML Tag UnitofMeasure UnitsInInventory UnitsInInventoryAsOf VendorId VendorIntegrationId VendorPartNumber VendorPrimaryOrganization VendorSite operation searchspec Data Type DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length 30 NA NA NA 30 50 100 50 30 250 Req. No No No No No No No No No No

Unit of Measure Units In Inventory Units In Inventory As Of Vendor Id Vendor Integration Id Vendor Part Number Vendor Primary Organization Vendor Site operation searchspec Inventory Options Allocate Below Safety Flag Auto Allocate Flag Auto Substitute Flag Class ABC Class XYZ Id Integration Id Inventory Type Product Name operation searchspec Product Inventory Allocate Below Safety Stock Flag Auto Allocate Flag Auto Substitute Flag Id

AllocateBelowSafetyFlag AutoAllocateFlag AutoSubstituteFlag ClassABC ClassXYZ Id IntegrationId InventoryType ProductName operation searchspec

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

30 30 30 30 30 30 30 30 100 30 250

No No No No No No No No No No No

AllocateBelowSafetyStockFlag AutoAllocateFlag AutoSubstituteFlag Id

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID

30 30 30 30

No No No No

Siebel Application Services Interface Reference Version 8.2

19 3

Predefined Application Service Interfaces Siebel Simple Product

Table 69. Name

Siebel Simple Product ASI Fields XML Tag InventoryLocationId MaximumInventoryLevel MinimumInventoryLevel MovementClass ProductId ProductName SafetyStockLevel ValueClass operation searchspec Data Type DTYPE_ID DTYPE_NUMBER DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length 30 22 22 30 30 100 22 30 30 250 Req. No No No No No No No No No No

Inventory Location Id Maximum Inventory Level Minimum Inventory Level Movement Class Product Id Product Name Safety Stock Level Value Class operation searchspec

Related Equivalent Product Equivalent Product Equivalent Product Primary Organization Equivalent Product Vendor Equivalent Product Vendor Location Equivalent Product Vendor Organization Id Integration Id IsPrimaryMVG operation searchspec EquivalentProduct EquivalentProductPrimaryOrganiza tion EquivalentProductVendor EquivalentProductVendorLocation EquivalentProductVendorOrganizat ion Id IntegrationId IsPrimaryMVG operation searchspec DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 100 50 100 50 100 30 30 1 30 250 No No No No No No No No No No

Related Inventory Location Id Integration Id Inventory Name Primary Organization Name Id IntegrationId InventoryName PrimaryOrganizationName DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 30 30 100 100 No No No No

194

Siebel Application Services Interface Reference Version 8.2

Predefined Application Service Interfaces Siebel Simple Product

Table 69. Name operation

Siebel Simple Product ASI Fields XML Tag operation searchspec Data Type DTYPE_TEXT DTYPE_TEXT Length 30 250 Req. No No

searchspec Related Organization Id Integration Id IsPrimaryMVG Organization Sales Unit of Measure operation searchspec Related Product Id Integration Id IsPrimaryMVG Organization Product Name Vendor Vendor Location operation searchspec Related Product Line Id Integration Id IsPrimaryMVG Product Line operation searchspec

Id IntegrationId IsPrimaryMVG Organization SalesUnitofMeasure operation searchspec

DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

30 30 1 50 30 30 250

No No No No No No No

Id IntegrationId IsPrimaryMVG Organization ProductName Vendor VendorLocation operation searchspec

DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

30 30 1 50 100 100 50 30 250

No No No No No No No No No

Id IntegrationId IsPrimaryMVG ProductLine operation searchspec

DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

30 30 1 100 30 250

No No No No No No

Related Sales Tool by Product Id Integration Id Literature Type Id IntegrationId LiteratureType DTYPE_ID DTYPE_TEXT DTYPE_TEXT 30 30 30 No No No

Siebel Application Services Interface Reference Version 8.2

19 5

Predefined Application Service Interfaces Siebel Simple Product

Table 69. Name

Siebel Simple Product ASI Fields XML Tag LitFileName Name PrimaryOrganization operation searchspec Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length 220 50 50 30 250 Req. No No No No No

LitFileName Name Primary Organization operation searchspec Related Warranty Id Integration Id Warranty Name Warranty Provider Name Warranty Provider Primary Organization Warranty Provider Site operation searchspec

Id IntegrationId WarrantyName WarrantyProviderName WarrantyProviderPrimaryOrganizat ion WarrantyProviderSite operation searchspec

DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

30 30 100 100 100 50 30 250

No No No No No No No No

196

Siebel Application Services Interface Reference Version 8.2

Siebel Communications, Media, and Energy ASIs

This appendix provides a list of the prebuilt Siebel Communications, Media, and Energy ASIs that are provided with Siebel applications. You can use these ASIs to receive, send, or request data from other applications. This appendix includes the following topics: About Prebuilt Communications, Media, and Energy ASIs Order Management Siebel Order Customer Lifecycle Management Siebel Account Billing Management Siebel Invoice CUT Account Balance Interface - Request Integration Object CUT Account Balance Interface - Response Integration Object Siebel Meter Reading Siebel Meter Usage Data Siebel Simple Product Trouble Ticketing Management Siebel Trouble Ticket

NOTE: Required is abbreviated as Req. and Not Applicable is abbreviated as NA in the following tables.

Siebel Application Services Interface Reference Version 8.2

19 7

Siebel Communications, Media, and Energy ASIs About Prebuilt Communications, Media, and Energy ASIs

About Prebuilt Communications, Media, and Energy ASIs


Table 70 lists all the Communications, Media, and Energy ASIs and integration objects that Oracle provides. Each ASI is based on an integration object and can be used to integrate data for all the fields of that integration object.

Table 70.

Prebuilt Communications, Media, and Energy ASIs and Integration Objects Description

ASI, Integration Object Order Management Siebel Order Customer Life Cycle Management Siebel Account Siebel Contact

For details, see Siebel Order on page 199.

For details, see Siebel Account on page 218. ASI to facilitate the inbound and outbound transfer of contact data from the Siebel application. For details, see Siebel Contact on page 68. For details, see Siebel CUT Address MSAG Service on page 74.

Siebel CUT Address MSAG Service Billing Management Siebel Invoice Siebel Invoice Adjustment CUT Payment Interface Integration Object CUT Account Balance Interface Request Integration Object CUT Account Balance Interface Response Integration Object Siebel Meter Reading

For details, see Siebel Invoice on page 228. For details, see Siebel Invoice Adjustment on page 235. For details, see on page 236. For details, see CUT Account Balance Interface - Request Integration Object on page 241. For details, see CUT Account Balance Interface Response Integration Object on page 242. ASI to facilitate the inbound and outbound transfer of meter reading data from the Siebel application. For details, see Siebel Meter Reading on page 243. ASI to facilitate the inbound and outbound transfer of meter usage data from the Siebel application. For details, see Siebel Meter Usage Data on page 244. For details, see Siebel Payment on page 247.

Siebel Meter Usage Data

Siebel Payment Product and Pricing Administration Siebel Simple Product

For details, see Siebel Simple Product on page 249.

198

Siebel Application Services Interface Reference Version 8.2

Siebel Communications, Media, and Energy ASIs Order Management

Table 70.

Prebuilt Communications, Media, and Energy ASIs and Integration Objects Description ASI to enable the synchronization and update of a price list and the price list items. For details, see Siebel Price List on page 147. ASI that associates a customer with a unique product. For details, see Siebel Asset on page 64.

ASI, Integration Object Siebel Price List

Siebel Asset Trouble Ticketing Management Siebel Trouble Ticket

ASI that results in the use of a trouble ticket in the Siebel application when an external application detects an outage or network fault. For details, see Siebel Trouble Ticket on page 257.

Order Management
Order Management uses a single ASI, Siebel Order, to enable the submission and processing of orders and the update of order line items.

Siebel Order
The Siebel Order ASI enables customers to capture and validate orders so that they can successfully submit the orders to a fulfillment system. Figure 33 describes the Siebel Order ASI structure.

Figure 33. Siebel Order ASI

Siebel Application Services Interface Reference Version 8.2

19 9

Siebel Communications, Media, and Energy ASIs Siebel Order

Table 71 lists the integration components and XML tags of this ASI.

Table 71.

Siebel Order ASI Integration Components XML Tag Attributes User Keys

Integration Component Attributes

1 2 3

Id Integration Id Name, Object Id Id Integration Id Line Number Id Integration Id Order Number, Revision, Primary Organization, Order Type Order Number, Revision, Organization DUNS Number, Order Type Id Integration Id Payment #, Payment Type Id Integration Id Line Item Action Number Id Integration Id Organization Id Integration Id Position Login Id Integration Id Shipment Number

Line Items

LineItems

1 2 3

Orders

Orders

1 2 3 4

Payments

Payments

1 2 3

Promised Schedule Lines

PromisedScheduleLines

1 2 3

Related Organization

RelatedOrganization

1 2 3

Related Sales Rep

RelatedSalesRep

1 2 3 4

Related Shipment

RelatedShipment

1 2 3

200

Siebel Application Services Interface Reference Version 8.2

Siebel Communications, Media, and Energy ASIs Siebel Order

Table 71.

Siebel Order ASI Integration Components XML Tag RequestedScheduleLines User Keys

Integration Component Requested Schedule Lines

1 2 3

Id Integration Id Line Number Id Integration Id Shipment Line Number

Shipment Lines

ShipmentItem

1 2 3

Table 72 lists the fields and their attributes.

Table 72. Name Orders Account

Siebel Order ASI Fields XML Tag Data Type Length Req.

Account AccountDUNSNumber AccountId AccountIntegrationId AccountSite Active Approved ApprovedBy ApprovedByDate AvailableDate AvailableStatus AvailableStatusAsOfDate BillTo-FirstName BillTo-LastName BillToAccount

DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

100 9 NA 30 100 NA NA NA NA NA 30 NA 50 50 100

No No No No No No No No No No No No No No No

Account DUNS Number Account Id Account Integration Id Account Site Active Approved Approved By Approved By Date Available Date Available Status Available Status As Of Date Bill To - First Name Bill To - Last Name Bill To Account

Siebel Application Services Interface Reference Version 8.2

20 1

Siebel Communications, Media, and Energy ASIs Siebel Order

Table 72. Name

Siebel Order ASI Fields XML Tag BillToAccountDUNSNumber BillToAccountId BillToAccountIntegrationId BillToAccountSite BillToAddress BillToAddress2 BillToAddressId BillToAddressIntegrationId BillToCity BillToContactId BillToContactIntegrationId BillToCountry BillToState BillToZip BillableFlag BillingBlock CampaignId CampaignIntegrationId CampaignName Carrier CarrierPriority Comments ContactFirstName ContactId Data Type DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID Length 9 NA 30 50 50 50 NA 30 30 NA 30 15 30 15 NA 30 NA 30 100 30 30 250 50 NA Req. No No No No No No No No No No No No No No No No No No No No No No No No

Bill To Account DUNS Number Bill To Account Id Bill To Account Integration Id Bill To Account Site Bill To Address Bill To Address 2 Bill To Address Id Bill To Address Integration Id Bill To City Bill To Contact Id Bill To Contact Integration Id Bill To Country Bill To State Bill To Zip Billable Flag Billing Block Campaign Id Campaign Integration Id Campaign Name Carrier Carrier Priority Comments Contact First Name Contact Id

202

Siebel Application Services Interface Reference Version 8.2

Siebel Communications, Media, and Energy ASIs Siebel Order

Table 72. Name

Siebel Order ASI Fields XML Tag ContactIntegrationId ContactLastName ContractId ContractIntegrationId ContractName CreditStatus CurrencyCode DeliveryStatus Description DestinationInventoryLocationId DestinationInventoryLocation Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT Length 30 50 NA 30 50 NA 20 30 255 NA 100 Req. No No No No No No No No No No No

Contact Integration Id Contact Last Name Contract Id Contract Integration Id Contract Name Credit Status Currency Code Delivery Status Description Destination Inventory Id Destination Inventory Location Destination Inventory Location Integration Id Discount Amount Entitlement Id Entitlement Name External Order Number Hold Flag Hold Reason Id Integration Id Integration Message

DestinationInventoryLocationIntegrationId

DTYPE_TEXT

30

No

DiscountAmount EntitlementId EntitlementName ExternalOrderNumber HoldFlag HoldReason Id IntegrationId IntegrationMessage

DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT

NA NA 50 NA NA 30 30 30 2,000

No No No No No No No No No

Siebel Application Services Interface Reference Version 8.2

20 3

Siebel Communications, Media, and Energy ASIs Siebel Order

Table 72. Name

Siebel Order ASI Fields XML Tag IntegrationStatus IntegrationStatusAsOfDate Data Type DTYPE_TEXT DTYPE_TEXT Length 30 NA Req. No No

Integration Status Integration Status As Of Date Opportunity Id Opportunity Integration Id Opportunity Name Order Date Order Number Order Priority Order Type Order Type Id Organization DUNS Number Parent Order Id Partial Ship Pay To Account Pay To Account DUNS Number Pay To Account Id Pay To Account Integration Id Pay To Account Site Pay To Address Id Pay To Address Integration Id Pay To Contact First Name

OpportunityId OpportunityIntegrationId OpportunityName OrderDate OrderNumber OrderPriority OrderType OrderTypeId OrganizationDUNSNumber ParentOrderId PartialShip PayToAccount PayToAccountDUNSNumber PayToAccountId PayToAccountIntegrationId PayToAccountSite PayToAddressId PayToAddressIntegrationId PayToContactFirstName

DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT

NA 30 100 NA 30 30 30 NA 9 NA NA 100 9 NA 30 50 NA 30 50

No No No No No No No No No No No No No No No No No No No

204

Siebel Application Services Interface Reference Version 8.2

Siebel Communications, Media, and Energy ASIs Siebel Order

Table 72. Name

Siebel Order ASI Fields XML Tag PayToContactId PayToContactIntegrationId PayToContactLastName PaymentTerm PaymentTermId PaymentTermIntegrationId PriceList PriceListId PriceListIntegrationId PricingDate PrimaryOrganization PrimaryOrganizationId ProjectId ProjectIntegrationId ProjectName PromotionId PurchaseOrderNumber QuoteId QuoteIntegrationId QuoteNumber RequestedDate ReturnReason ReturnToAccount Data Type DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length NA 30 50 50 NA 30 50 NA 30 NA 100 NA NA 30 100 NA 50 NA 30 30 NA 30 100 Req. No No No No No No No No No No No No No No No No No No No No No No No

Pay To Contact Id Pay To Contact Integration Id Pay To Contact Last Name Payment Term Payment Term Id Payment Term Integration Id Price List Price List Id Price List Integration Id Pricing Date Primary Organization Primary Organization Id Project Id Project Integration Id Project Name Promotion Id Purchase Order Number Quote Id Quote Integration Id Quote Number Requested Date Return Reason Return To Account

Siebel Application Services Interface Reference Version 8.2

20 5

Siebel Communications, Media, and Energy ASIs Siebel Order

Table 72. Name

Siebel Order ASI Fields XML Tag ReturnToAccountDUNSNumber Data Type DTYPE_TEXT Length 9 Req. No

Return To Account DUNS Number Return To Account Id Return To Account Integration Id Return To Account Site Return To Address Id Return To Address Integration Id Return To Contact First Name Return To Contact Id Return To Contact Integration Id Return To Contact Last Name Revision Service Request Id Service Request Number Ship Complete Ship Instructions Ship To - First Name Ship To - Last Name

ReturnToAccountId ReturnToAccountIntegrationId

DTYPE_ID DTYPE_TEXT

NA 30

No No

ReturnToAccountSite ReturnToAddressId ReturnToAddressIntegrationId

DTYPE_TEXT DTYPE_ID DTYPE_TEXT

50 NA 30

No No No

ReturnToContactFirstName

DTYPE_TEXT

50

No

ReturnToContactId ReturnToContactIntegrationId

DTYPE_ID DTYPE_TEXT

NA 30

No No

ReturnToContactLastName

DTYPE_TEXT

50

No

Revision ServiceRequestId ServiceRequestNumber ShipComplete ShipInstructions ShipTo-FirstName ShipTo-LastName

DTYPE_NUMBER DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

NA NA NA NA 250 50 50

No No No No No No No

206

Siebel Application Services Interface Reference Version 8.2

Siebel Communications, Media, and Energy ASIs Siebel Order

Table 72. Name

Siebel Order ASI Fields XML Tag ShipToAccount ShipToAccountDUNSNumber ShipToAccountId ShipToAccountIntegrationId ShipToAccountSite ShipToAddress ShipToAddress2 ShipToAddressId ShipToAddressIntegrationId ShipToCity ShipToContactId ShipToContactIntegrationId ShipToCountry ShipToState ShipToZip ShippingCharges ShippingMethod ShippingTerms FreightTermsInfo SourceInventoryLocationId SourceInventoryLocationIntegrationId Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT Length 100 9 NA 30 50 50 50 NA 30 30 NA 30 15 30 15 NA 30 30 100 NA 30 Req. No No No No No No No No No No No No No No No No No No No No No

Ship To Account Ship To Account DUNS Number Ship To Account Id Ship To Account Integration Id Ship To Account Site Ship To Address Ship To Address 2 Ship To Address Id Ship To Address Integration Id Ship To City Ship To Contact Id Ship To Contact Integration Id Ship To Country Ship To State Ship To Zip Shipping Charges Shipping Method Shipping Terms Shipping Terms Info Source Inventory Id Source Inventory Loc Integration Id

Siebel Application Services Interface Reference Version 8.2

20 7

Siebel Communications, Media, and Energy ASIs Siebel Order

Table 72. Name Source Inventory Location Status

Siebel Order ASI Fields XML Tag SourceInventoryLocation Data Type DTYPE_TEXT Length 100 Req. No

Status StatusAsOfDate SubmitDate TaxAmount TaxExempt TaxExemptCode TaxExemptId TaxRate TotalVolume TotalVolumeUoM TotalWeight TotalWeightUoM operation

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER DTYPE_NUMBER DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT

30 NA NA NA NA 80 30 NA NA 30 NA 30 30

No No No No No No No No No No No No No

Status As Of Date Submit Date Tax Amount Tax Exempt Tax Exempt Code Tax Exempt Id Tax Rate Total Volume Total Volume UoM Total Weight Total Weight UoM operation Line Items Action Code Asset Id Asset Integration Id Asset Internal Integration Id Asset Number Available Date Available Quantity Available Status Available Status As Of Date

ActionCode AssetId AssetIntegrationId AssetInternalIntegrationId AssetNumber AvailableDate AvailableQuantity AvailableStatus AvailableStatusAsOfDate

DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT

30 NA 30 30 NA NA NA 30 NA

No No No No No No No No No

208

Siebel Application Services Interface Reference Version 8.2

Siebel Communications, Media, and Energy ASIs Siebel Order

Table 72. Name

Siebel Order ASI Fields XML Tag BasePrice BillableFlag BillingAccount BillingAccountId BillingProfileId CancelledQuantity CoveredProductUnitPrice DeliveryStatus Description DestinationInventoryLocation Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length NA NA NA NA NA NA NA 30 NA 100 Req. No No No No No No No No No No

Base Price Billable Flag Billing Account Billing Account Id Billing Profile Id Cancelled Quantity Covered Product Unit Price Delivery Status Description Destination Inventory Location Destination Inventory Location Id Destination Inventory Location Integration Id Discount Amount Freight Amount Hold Flag Hold Reason Id Integration Id Integration Status Integration Status As Of Date Invoiced Quantity

DestinationInventoryLocationId

DTYPE_ID

NA

No

DestinationInventoryLocationIntegrationId

DTYPE_TEXT

30

No

DiscountAmount FreightAmount HoldFlag HoldReason Id IntegrationId IntegrationStatus IntegrationStatusAsOfDate

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

NA NA NA 30 30 30 30 NA

No No No No No No No No

InvoicedQuantity

DTYPE_NUMBER

NA

No

Siebel Application Services Interface Reference Version 8.2

20 9

Siebel Communications, Media, and Energy ASIs Siebel Order

Table 72. Name Item Price

Siebel Order ASI Fields XML Tag ItemPrice LineIntegrationId LineNumber LoanerFlag NetPrice Note OrderHeaderId OrderNumber PackageNameInbound PackageNameOutbound ParentOrderItemId PartNumber PartialShip Product ProductGlobalIdentifier ProductId ProductIntegrationId ProductPrimaryOrganizationId RequestedDate RequestedQuantity ReturnToAccountDUNSNumber Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT Length NA 30 NA NA NA 1,500 NA 30 50 NA NA 50 NA 100 50 NA 30 NA NA NA 9 Req. No No No No No No No No No No No No No No No No No No No No No

Line Integration Id Line Number Loaner Flag Net Price Note Order Header Id Order Number Package Name (Inbound) Package Name (Outbound) Parent Order Item Id Part Number Partial Ship Product Product Global Identifier Product Id Product Integration Id Product Primary Organization Id Requested Date Requested Quantity Return To Account DUNS Number Return To Account Id

ReturnToAccountId

DTYPE_ID

NA

No

210

Siebel Application Services Interface Reference Version 8.2

Siebel Communications, Media, and Energy ASIs Siebel Order

Table 72. Name

Siebel Order ASI Fields XML Tag ReturnToAccountIntegrationId Data Type DTYPE_TEXT Length 30 Req. No

Return To Account Integration Id Return To Account Name Return To Account Site Return To Address Id Return To Address Integration Id Return To Contact Id Return To Contact Integration Id Return To First Name Return To Last Name Root Order Item Id Sales Unit of Measure Service Account Service Account Id Service Account Type Service Id Service Instance Flag Service Point Service Profile Id Service Type

ReturnToAccountName ReturnToAccountSite ReturnToAddressId ReturnToAddressIntegrationId

DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT

100 50 NA 30

No No No No

ReturnToContactId ReturnToContactIntegrationId

DTYPE_ID DTYPE_TEXT

NA 30

No No

ReturnToFirstName ReturnToLastName RootOrderItemId SalesUnitofMeasure ServiceAccount ServiceAccountId ServiceAccountType ServiceId ServiceInstanceFlag ServicePoint ServiceProfileId ServiceType

DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

50 50 NA 30 NA 30 NA NA NA NA NA 30

No No No No No No No No No No No No

Siebel Application Services Interface Reference Version 8.2

21 1

Siebel Communications, Media, and Energy ASIs Siebel Order

Table 72. Name Ship Date

Siebel Order ASI Fields XML Tag ShipDate ShipInstruction ShipQuantity ShipToAccount ShipToAccountDUNSNumber ShipToAccountId ShipToAccountIntegrationId ShipToAccountSite ShipToAddress ShipToAddress2 ShipToAddressId ShipToCity ShipToContact-FirstName ShipToContact-LastName ShipToContactId ShipToContactIntegrationId ShipToCountry ShipToState ShipToZip ShiptoAddressIntegrationId ShippingCarrier ShippingCharges Data Type DTYPE_DATETIME DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 100 9 NA 30 50 50 50 NA 30 50 50 NA 30 15 15 15 30 30 NA Length NA 250 Req. No No No No No No No No No No No No No No No No No No No No No No

Ship Instruction Ship Quantity Ship To Account Ship To Account DUNS Number Ship To Account Id Ship To Account Integration Id Ship To Account Site Ship To Address Ship To Address 2 Ship To Address Id Ship To City Ship To Contact - First Name Ship To Contact - Last Name Ship To Contact Id Ship To Contact Integration Id Ship To Country Ship To State Ship To Zip Ship to Address Integration Id Shipping Carrier Shipping Charges

212

Siebel Application Services Interface Reference Version 8.2

Siebel Communications, Media, and Energy ASIs Siebel Order

Table 72. Name Shipping Method

Siebel Order ASI Fields XML Tag ShippingMethod ShippingTerms SingleSource SmartPartNumber SourceInventoryLocationIntegrationId Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length 30 30 NA 250 30 Req. No No No No No

Shipping Terms Single Source Smart Part Number Source Inventory Loc Integration Id Source Inventory Location Source Inventory Location Id Start Price Status Status As Of Date Tax Amount Unit of Measure Volume Volume Unit of Measure Weight Weight Unit of Measure operation Attributes Action Code Attribute Id Data Type Description Hidden

SourceInventoryLocation

DTYPE_TEXT

100

No

SourceInventoryLocationId

DTYPE_ID

NA

No

StartPrice Status StatusAsOfDate TaxAmount UnitofMeasure Volume VolumeUnitofMeasure Weight WeightUnitofMeasure operation

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT

NA 30 NA NA 30 NA 30 NA 30 30

No No No No No No No No No No

ActionCode AttributeId DataType Description Hidden

DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

30 NA 30 255 NA

No No No No No

Siebel Application Services Interface Reference Version 8.2

21 3

Siebel Communications, Media, and Energy ASIs Siebel Order

Table 72. Name Id

Siebel Order ASI Fields XML Tag Id IntegrationId ListOfValueType Name ObjectId ReadOnly Required Sequence Validation Value operation Data Type DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length 30 30 30 75 NA NA NA NA 250 100 30 Req. No No No No No No No No No No No

Integration Id LOV Type Name Object Id Read Only Required Sequence Validation Value operation

Promised Schedule Lines Available Status Available Status As Of Date Id Integration Id Line Item Action Number Order Item Id Order Item Integration Id Part Number Product Id Product Integration Id Product Name Promised Date Promised Quantity Source Inventory Location AvailableStatus AvailableStatusAsOfDate Id IntegrationId LineItemActionNumber OrderItemId OrderItemIntegrationId PartNumber ProductId ProductIntegrationId ProductName PromisedDate PromisedQuantity SourceInventoryLocation DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT 30 NA 30 30 NA NA 30 50 NA 30 100 NA NA 100 No No No No No No No No No No No No No No

214

Siebel Application Services Interface Reference Version 8.2

Siebel Communications, Media, and Energy ASIs Siebel Order

Table 72. Name

Siebel Order ASI Fields XML Tag SourceInventoryLocationId Data Type DTYPE_ID Length NA Req. No

Source Inventory Location Id Source Inventory Location Integration Id operation

SourceInventoryLocationIntegrationId

DTYPE_TEXT

30

No

operation

DTYPE_TEXT

30

No

Requested Schedule Lines Id Integration Id Line Number Order Item Id Requested Date Requested Quantity Source Inventory Location Source Inventory Location Id Source Inventory Location Integration Id operation Payments Account Number Authorization Code Bill To Address Id Bill To Address Integration Id Card Holder AccountNumber AuthorizationCode BillToAddressId BillToAddressIntegrationId CardHolder DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT 50 40 NA 30 50 No No No No No Id IntegrationId LineNumber OrderItemId RequestedDate RequestedQuantity SourceInventoryLocation DTYPE_ID DTYPE_TEXT DTYPE_NUMBER DTYPE_ID DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT 30 30 NA NA NA NA 100 No No No No No No No

SourceInventoryLocationId

DTYPE_ID

NA

No

SourceInventoryLocationIntegrationId

DTYPE_TEXT

30

No

operation

DTYPE_TEXT

30

No

Siebel Application Services Interface Reference Version 8.2

21 5

Siebel Communications, Media, and Energy ASIs Siebel Order

Table 72. Name

Siebel Order ASI Fields XML Tag CreditCardExpirationMonth Data Type DTYPE_TEXT Length 30 Req. No

Credit Card Expiration Month Credit Card Expiration Year Credit Check Message Credit Check Status Credit Check Status As Of Date Encryption Key Encryption Key Reference Id Integration Id Issuing Bank Customer Id Issuing Bank Name Issuing Bank Phone Number Merchant Id Payment # Payment Account Id Payment Account Integration Id Payment Account Name Payment Account Site Payment Method

CreditCardExpirationYear CreditCheckMessage CreditCheckStatus CreditCheckStatusAsOfDate

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

30 250 30 NA

No No No No

EncryptionKey EncryptionKeyReference Id IntegrationId IssuingBankCustomerId IssuingBankName IssuingBankPhoneNumber MerchantId Payment PaymentAccountId PaymentAccountIntegrationId

DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT

30 30 30 30 30 30 40 30 30 NA 30

No No No No No No No No No No No

PaymentAccountName PaymentAccountSite PaymentMethod

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

100 50 30

No No No

216

Siebel Application Services Interface Reference Version 8.2

Siebel Communications, Media, and Energy ASIs Siebel Order

Table 72. Name

Siebel Order ASI Fields XML Tag PaymentStatus PaymentStatusAsOfDate PaymentType TransactionAmount TransactionId TransactionTime VerificationNumber operation Data Type DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length 30 NA 30 NA NA NA 10 30 Req. No No No No No No No No

Payment Status Payment Status As Of Date Payment Type Transaction Amount Transaction Id Transaction Time Verification Number operation

Related Organization Integration Id IsPrimaryMVG Organization Organization Id IntegrationId IsPrimaryMVG Organization OrganizationId DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID 30 1 50 NA No No No No

Related Sales Rep Id Integration Id IsPrimaryMVG Login Position Id IntegrationId IsPrimaryMVG Login Position DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 30 30 1 50 50 No No No No No

Related Shipment Carrier Destination Inventory Location Id Id Integration Id Shipment Number Carrier DestinationInventoryLocationId DTYPE_TEXT DTYPE_ID 30 15 No No

Id IntegrationId ShipmentNumber

DTYPE_ID DTYPE_TEXT DTYPE_TEXT

30 30 30

No No No

Siebel Application Services Interface Reference Version 8.2

21 7

Siebel Communications, Media, and Energy ASIs Customer Lifecycle Management

Table 72. Name

Siebel Order ASI Fields XML Tag SourceInventoryLocationId Data Type DTYPE_ID Length 15 Req. No

Source Inventory Location Id Waybill Number Shipment Lines Confirmed Qty Delivery Date Delivery Qty Id Integration Id Order Line Id Shipment Date Shipment Line Number Shipment Qty

WaybillNumber

DTYPE_TEXT

50

No

ConfirmedQty DeliveryDate DeliveryQty Id IntegrationId OrderLineId ShipmentDate ShipmentLineNumber ShipmentQty

DTPYE_NUMBER DTYPE_DATETIME DTPYE_NUMBER DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_DATETIME DTYPE_TEXT DTPYE_NUMBER

NA NA NA NA NA NA NA NA NA

No No No No No No No No No

Customer Lifecycle Management


The Siebel Account ASI supports the Customer Lifecycle Management process. This process enables the user to create and validate accounts and to perform other account-related tasks, such as credit approval.

Siebel Account
The Siebel Account ASI is used for business processes related to customer information management. This ASI facilitates inbound and outbound data synchronization between Siebel applications and external systems.

218

Siebel Application Services Interface Reference Version 8.2

Siebel Communications, Media, and Energy ASIs Siebel Account

Figure 34 describes the Siebel Account ASI structure.

Figure 34. Siebel Account ASI Table 73 lists the integration components and XML tags of this ASI.

Table 73.

Siebel Account ASI Integration Components XML Tag Account User Keys

Integration Component Account

1 2 3

Account Id Integration Id Location, Name, Primary Organization Address Id Address Integration Id Id Name Id, Name Name Credit Profile Id Credit Profile Integration Id Credit Area Person UId, Primary Organization Contact Id Contact Integration Id

Business Address

BusinessAddress

1 2 1 2 1 2 1 2 3

Com Financial Profile

FinancialProfile

Com Invoice Profile

BillingProfile

Credit Profile

CreditProfile

Related Contact

RelatedContact

1 2 3

Siebel Application Services Interface Reference Version 8.2

21 9

Siebel Communications, Media, and Energy ASIs Siebel Account

Table 73.

Siebel Account ASI Integration Components XML Tag RelatedIndustry User Keys

Integration Component Related Industry

1 2 3 4

Industry Id Industry Integration Id Industry SIC Code Organization Id Organization Integration Id Organization Position Id Position Integration Id Division, Position Login

Related Organization

RelatedOrganization

1 2 3

Related Sales Rep

RelatedSalesRep

1 2 3 4

Table 74 lists the Siebel Account fields and their attributes.

Table 74. Name Account

Siebel Account ASI Fields XML Tag Data Type Length Req.

Account Id Account Status Alias Assignment Area Code Assignment Country Code Competitor Flag Credit Auto Approval Limit Credit Status Date Currency Code DUNS Number Description

AccountId AccountStatus Alias AssignmentAreaCode AssignmentCountryCode CompetitorFlag CreditAutoApprovalLimit CreditStatusDate CurrencyCode DUNSNumber Description

DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

30 24 50 5 5 Not applicable Not applicable Not applicable 15 15 255

No No No No No No No No No No No

220

Siebel Application Services Interface Reference Version 8.2

Siebel Communications, Media, and Energy ASIs Siebel Account

Table 74. Name

Siebel Account ASI Fields XML Tag DomesticUltimateDUNS Expertise GlobalUltimateDUNS HomePage IntegrationId LanguageCode Location MainFaxNumber MainPhoneNumber MasterAccountId Name NumberofEmployees POApprovedFlag POAutoApprovalCurrencyCode POAutoApprovalDate POAutoApprovalLimit ParentAccountId ParentAccountIntegrationId ParentAccountLocation ParentAccountName ParentHQDUNS PartnerFlag PriceList PriceListId Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID Length 15 30 15 100 30 15 50 Not applicable Not applicable Not applicable 100 Not applicable Not applicable 20 Not applicable Not applicable Not applicable 30 50 100 15 Not applicable Not applicable Not applicable Req. No No No No No No No No No No No No No No No No No No No No No No No No

Domestic Ultimate DUNS Expertise Global Ultimate DUNS Home Page Integration Id Language Code Location Main Fax Number Main Phone Number Master Account Id Name Number of Employees PO Approved Flag PO Auto Approval Currency Code PO Auto Approval Date PO Auto Approval Limit Parent Account Id Parent Account Integration Id Parent Account Location Parent Account Name Parent HQ DUNS Partner Flag Price List Price List Id

Siebel Application Services Interface Reference Version 8.2

22 1

Siebel Communications, Media, and Energy ASIs Siebel Account

Table 74. Name

Siebel Account ASI Fields XML Tag PriceListIntegrationId PrimaryOrganization SkipCreditCheck Type VATregistrationnumber operation Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length 30 100 Not applicable 255 30 30 Req. No No No No No No

Price List Integration Id Primary Organization Skip Credit Check Type VAT registration number operation Business Address Address Id Address Integration Id City Country County Email Address IsPrimaryMVG Postal Code Province State Street Address Street Address 2 operation

AddressId AddressIntegrationId City Country County EmailAddress IsPrimaryMVG PostalCode Province State StreetAddress StreetAddress2 operation

DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

30 30 50 50 50 50 1 30 50 10 200 100 30

No No No No No No No No No No No No No

Com Financial Profile Account Id Account Type Annual Income Bank Account Name Bank Account Number Bank Branch Bank Name AccountId AccountType AnnualIncome BankAccountName BankAccountNumber BankBranch BankName DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Not applicable 30 Not applicable 100 50 100 100 No No No No No No No

222

Siebel Application Services Interface Reference Version 8.2

Siebel Communications, Media, and Energy ASIs Siebel Account

Table 74. Name

Siebel Account ASI Fields XML Tag ConflictId ContactFirstName ContactId ContactLastName CorporateNumber Created CreditAgency CreditCardExpireDate CreditCardNumber CreditCardType CreditScore2 CreditUpdateDate CreditUpdatedBy CurrencyCode2 CurrentAddressId CurrentCity CurrentCountry CurrentHireDate CurrentPostalCode CurrentState CurrentStreetAddress DBIdentifier EmployerId EmployerName ExchangeDate FormerAddressId FormerCity FormerCountry FormerPostalCode Data Type DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER DTYPE_DATETIME DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_DATETIME DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length 30 50 Not applicable 50 30 30 30 Not applicable 30 30 Not applicable Not applicable Not applicable 20 Not applicable 50 30 Not applicable 30 10 200 30 Not applicable 100 Not applicable Not applicable 50 30 30 Req. No No No No No No No No No No No No No No No No No No No No No No No No No No No No No

Conflict Id Contact First Name Contact Id Contact Last Name Corporate Number Created Credit Agency Credit Card Expire Date Credit Card Number Credit Card Type Credit Score Credit Update Date Credit Updated By Currency Code Current Address Id Current City Current Country Current Hire Date Current Postal Code Current State Current Street Address D B Identifier Employer Id Employer Name Exchange Date Former Address Id Former City Former Country Former Postal Code

Siebel Application Services Interface Reference Version 8.2

22 3

Siebel Communications, Media, and Energy ASIs Siebel Account

Table 74. Name

Siebel Account ASI Fields XML Tag FormerState FormerStreetAddress Id IdType Identifier LegalName ModId Name OwnorRent PreviousEmployerId Status TaxId2 TaxProfileCd Type Updated operation searchspec Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_TEXT Length 10 200 30 30 30 100 30 100 30 Not applicable 30 30 30 30 30 30 250 Req. No No No No No No No No No No No No No No No No No

Former State Former Street Address Id Id Type Identifier Legal Name Mod Id Name Own or Rent Previous Employer Id Status Tax Id Tax Profile Cd Type Updated operation searchspec Com Invoice Profile Account Id Address Id Bank Account Name Bank Account Number Bank Account Type Bank Authorization Flag Bank Branch Bank Language Code Bank Language Id Bank Name Bill Average

AccountId AddressId2 BankAccountName2 BankAccountNumber2 BankAccountType BankAuthorizationflag BankBranch2 BankLanguageCode BankLanguageId BankName2 BillAverage

DTYPE_ID DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

Not applicable Not applicable Not applicable Not applicable 30 Not applicable Not applicable 5 5 Not applicable Not applicable

No No No No No No No No No No No

224

Siebel Application Services Interface Reference Version 8.2

Siebel Communications, Media, and Energy ASIs Siebel Account

Table 74. Name Bill Cycle

Siebel Account ASI Fields XML Tag BillCycle BillCycleDay BillFrequency BillSequence BillSource BillType BillVendorId BudgetBillingFlag CPNIDate CPNIFlag CollectionsFlag ConflictId ContactFirstName ContactId ContactLastName Created CreditCardBlockFlag CreditCardBlockReason CreditCardCategory CreditCardExpirationDate CreditCardName CreditCardNumber2 CreditCardType2 CurrencyType DaysToCash EmailBillTo ExternalBillingAccountNumber ExtraCopies Data Type DTYPE_NUMBER DTYPE_NUMBER DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER Length Not applicable Not applicable Not applicable Not applicable 30 Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable 30 50 Not applicable 50 30 Not applicable 30 30 Not applicable Not applicable Not applicable Not applicable 20 Not applicable 100 30 Not applicable Req. No No No No No No No No No No No No No No No No No No No No No No No No No No No No

Bill Cycle Day Bill Frequency Bill Sequence Bill Source Bill Type Bill Vendor Id Budget Billing Flag CPNI Date CPNI Flag Collections Flag Conflict Id Contact First Name Contact Id Contact Last Name Created Credit Card Block Flag Credit Card Block Reason Credit Card Category Credit Card Expiration Date Credit Card Name Credit Card Number Credit Card Type Currency Type Days To Cash Email Bill To External Billing Account Number Extra Copies

Siebel Application Services Interface Reference Version 8.2

22 5

Siebel Communications, Media, and Energy ASIs Siebel Account

Table 74. Name Id

Siebel Account ASI Fields XML Tag Id InterestatInvoiceFlag LastBillAmount LastBillDate MediaType ModId Name NoPayFormFlag NumberofManualInvoices PaymentMethod ReasonforManualOutsource RepeatDebtorFlag RowId StandingOrderFlag StatementFlag Status Updated YearlyAdvancePaymentFlag operation searchspec Data Type DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length 30 Not applicable Not applicable Not applicable 30 30 100 Not applicable Not applicable 30 30 Not applicable Not applicable Not applicable Not applicable 30 30 Not applicable 30 250 Req. No No No No No No No No No No No No No No No No No No No No

Interest at Invoice Flag Last Bill Amount Last Bill Date Media Type Mod Id Name No Pay Form Flag Number of Manual Invoices Payment Method Reason for Manual Outsource Repeat Debtor Flag Row Id Standing Order Flag Statement Flag Status Updated Yearly Advance Payment Flag operation searchspec Credit Profile Credit Area Credit Available Credit Currency Code Credit Limit Credit Profile Id Credit Profile Integration Id

CreditArea CreditAvailable CreditCurrencyCode CreditLimit CreditProfileId CreditProfileIntegrationId

DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_NUMBER DTYPE_ID DTYPE_TEXT

30 Not applicable 20

No No No No

30 30

No No

226

Siebel Application Services Interface Reference Version 8.2

Siebel Communications, Media, and Energy ASIs Siebel Account

Table 74. Name

Siebel Account ASI Fields XML Tag CreditReportingGroup CreditStatusCode CreditStatusMessage CreditUsed IsPrimaryMVG RiskCategoryCode operation Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length 50 30 250 Not applicable 1 30 30 Req. No No No No No No No

Credit Reporting Group Credit Status Code Credit Status Message Credit Used IsPrimaryMVG Risk Category Code operation Related Industry Industry Industry Id Industry Integration Id IsPrimaryMVG SIC Code Related Sales Rep Division IsPrimaryMVG Login Position Position Id Position Integration Id Related Contact Assistant Phone # Cellular Phone # Contact Id Contact Integration Id Email Address Fax Phone #

Industry IndustryId IndustryIntegrationId IsPrimaryMVG SICCode

DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

50 30 30 1 30

No No No No No

Division IsPrimaryMVG Login Position PositionId PositionIntegrationId

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT

255 1 50 50 30 30

No No No No No No

AssistantPhone CellularPhone ContactId ContactIntegrationId EmailAddress FaxPhone

DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

Not applicable Not applicable 30 30 50

No No No No No No

Siebel Application Services Interface Reference Version 8.2

22 7

Siebel Communications, Media, and Energy ASIs Billing Management

Table 74. Name

Siebel Account ASI Fields XML Tag FirstName JobTitle LastName MF MM PersonUId PrimaryOrganization WorkPhone Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length 50 75 50 255 15 100 100 Req. No No No No No No No No

First Name Job Title Last Name M/F M/M Person UId Primary Organization Work Phone #

Related Organization IsPrimaryMVG Organization Organization Id Organization Integration Id IsPrimaryMVG Organization OrganizationId OrganizationIntegrationId DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT 1 50 Not applicable 30 No No No No

Billing Management
One ASI and four integration objects are associated with eight Billing Management Business Integration Processes: Siebel Invoice ASI, CUT Payment Interface Integration Object, and a request and response set for CUT Account Balance Interface Integration Object.

Siebel Invoice
The Siebel Invoice ASI is used by multiple Business Integration Processes, including Sync Invoice Header, Query Invoice Details, and Request Duplicate Invoice. The ASI has four types of fields associated with it, a different subset of which is used by each calling Business Integration Process to access information in an external billing system.

228

Siebel Application Services Interface Reference Version 8.2

Siebel Communications, Media, and Energy ASIs Siebel Invoice

Figure 35 describes the Siebel Invoice ASI structure.

Figure 35. Siebel Invoice ASI Table 75 lists the integration components and XML tags of this ASI.

Table 75.

Siebel Invoice Integration Components XML Tag CmeInvoiceDetails CmeInvoiceDuplicateRequest Invoice User Keys No user keys. No user keys.

Integration Component CME Invoice Details CME Invoice Duplicate Request Invoice

1 2

Id Document Number, Document Type Id Integration Id Line Number

Invoice Line Items

InvoiceLineItems

1 2 3

Table 76 lists the fields and their attributes.

Table 76. Name Invoice

Siebel Invoice ASI Fields XML Tag Data Type Length Req.

Account Id Account Integration Id Account Location Account Name

AccountId AccountIntegrationId AccountLocation AccountName

DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

Not applicable 30 30 50

No No No No

Siebel Application Services Interface Reference Version 8.2

22 9

Siebel Communications, Media, and Energy ASIs Siebel Invoice

Table 76. Name

Siebel Invoice ASI Fields XML Tag AccountOrganizationName ActivityId ActivityUserDefinedUniqueId AmountPaid BalanceForward BillToPersonId BillingEndDate BillingStartDate ContractId ContractIntegrationId ContractName ContractOrganizationName ContractRevisionNumber CurrencyCode DelinquentFlag DocumentDate DocumentDescription DocumentNumber DocumentPeriodId DocumentPeriodName Data Type DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT Length 100 Not applicable 30 Not applicable Not applicable 30 Not applicable Not applicable Not applicable 30 50 100 Not applicable 20 Not applicable Not applicable 250 50 Not applicable 50 Req. No No No No No No No No No No No No No No No No No No No No

Account Organization Name Activity Id Activity User Defined Unique Id Amount Paid Balance Forward Bill To Person Id Billing End Date Billing Start Date Contract Id Contract Integration Id Contract Name Contract Organization Name Contract Revision Number Currency Code Delinquent Flag Document Date Document Description Document Number Document Period Id Document Period Name

230

Siebel Application Services Interface Reference Version 8.2

Siebel Communications, Media, and Energy ASIs Siebel Invoice

Table 76. Name

Siebel Invoice ASI Fields XML Tag DocumentPeriodOrganizationName DocumentRevisionNumber DocumentStatus DocumentSubType DocumentType Id IntegrationId OrderId OrderIntegrationId OrderNumber OrderOrganizationName OrderType PaymentTerm PaymentTermDueDate PaymentTermId PaymentTermNetDays ProjectId ProjectIntegrationId ProjectNumber ProjectOrganizationName STOREDAdjustmentAmount STOREDDiscountAmount STOREDGrossAmount Data Type DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_ID DTYPE_NUMBER DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 30 30 100 50 50 Not applicable Not applicable Not applicable Not applicable 30 30 100 Not applicable Not applicable Not applicable Length 100 Not applicable 30 30 30 30 30 Req. No No No No No No No No No No No No No No No No No No No No No No No

Document Period Organization Name Document Revision Number Document Status Document Sub Type Document Type Id Integration Id Order Id Order Integration Id Order Number Order Organization Name Order Type Payment Term Payment Term Due Date Payment Term Id Payment Term Net Days Project Id Project Integration Id Project Number Project Organization Name STORED Adjustment Amount STORED Discount Amount STORED Gross Amount

Siebel Application Services Interface Reference Version 8.2

23 1

Siebel Communications, Media, and Energy ASIs Siebel Invoice

Table 76. Name

Siebel Invoice ASI Fields XML Tag STOREDSurchargeAmount STOREDTaxAmount ServiceRequestId ServiceRequestNumber ServiceRequestOrganizationName Status TotalAmount TypeCode operation Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length Not applicable Not applicable Not applicable 64 100 30 Not applicable Not applicable 30 Req. No No No No No No No No No

STORED Surcharge Amount STORED Tax Amount Service Request Id Service Request Number Service Request Organization Name Status Total Amount Type Code operation Invoice Line Items Activity Id Activity User Defined Unique Id Contract Id Contract Integration Id Contract Line Id Contract Name Contract Organization Name Contract Revision Number Currency Code Description Discount Amount

ActivityId ActivityUserDefinedUniqueId ContractId ContractIntegrationId ContractLineId ContractName ContractOrganizationName ContractRevisionNumber CurrencyCode Description DiscountAmount

DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

Not applicable 30 Not applicable 30 Not applicable 50 100 Not applicable 20 250 Not applicable

No No No No No No No No No No No

232

Siebel Application Services Interface Reference Version 8.2

Siebel Communications, Media, and Energy ASIs Siebel Invoice

Table 76. Name

Siebel Invoice ASI Fields XML Tag GrossAmount Id IntegrationId LineNumber LineQuantity LineType OrderId OrderIntegrationId OrderItemId OrderItemIntegrationId OrderLineNumber OrderNumber OrderOrganizationName OrderType PersonId ProductId ProductIntegrationId ProductName ProductOrganizationName ProductVendorOrganizationName ProjectId Data Type DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_NUMBER DTYPE_NUMBER DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID Length Not applicable 30 30 Not applicable Not applicable 30 Not applicable 30 Not applicable 30 Not applicable 30 100 50 Not applicable Not applicable 30 100 100 100 Not applicable Req. No No No No No No No No No No No No No No No No No No No No No

Gross Amount Id Integration Id Line Number Line Quantity Line Type Order Id Order Integration Id Order Item Id Order Item Integration Id Order Line Number Order Number Order Organization Name Order Type Person Id Product Id Product Integration Id Product Name Product Organization Name Product Vendor Organization Name Project Id

Siebel Application Services Interface Reference Version 8.2

23 3

Siebel Communications, Media, and Energy ASIs Siebel Invoice

Table 76. Name

Siebel Invoice ASI Fields XML Tag ProjectIntegrationId ProjectItemId ProjectItemNumber ProjectNumber ProjectOrganizationName ProjectResourceId ProjectResourceNumber ServiceRequestId ServiceRequestNumber ServiceRequestOrganizationName SurchargeAmount TaxAmount UnitofMeasure operation Data Type DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length 30 Not applicable 30 30 100 Not applicable 30 Not applicable 64 100 Not applicable Not applicable 30 30 Req. No No No No No No No No No No No No No No

Project Integration Id Project Item Id Project Item Number Project Number Project Organization Name Project Resource Id Project Resource Number Service Request Id Service Request Number Service Request Organization Name Surcharge Amount Tax Amount Unit of Measure operation CME Invoice Details Amount Call Type Currency Date/Time Duration

Amount2 CallType Currency DateTime Duration

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

Not applicable Not applicable Not applicable Not applicable Not applicable

No No No No No

234

Siebel Application Services Interface Reference Version 8.2

Siebel Communications, Media, and Energy ASIs Siebel Invoice Adjustment

Table 76. Name Id

Siebel Invoice ASI Fields XML Tag Id InvoiceHeaderId LineNumber Location NumberCalled OriginatingNumber Period Rate Segment Service Vid operation Data Type DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT Length 30 Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable 30 Req. No No No No No No No No No No No No

Invoice Header Id Line Number Location Number Called Originating Number Period Rate Segment Service Vid operation

CME Invoice Duplicate Request Copies Id operation Copies Id operation DTYPE_NUMBER DTYPE_ID DTYPE_TEXT Not applicable 30 30 No No No

Siebel Invoice Adjustment


The Siebel Invoice Adjustment ASI is used to modify invoices.

Siebel Application Services Interface Reference Version 8.2

23 5

Siebel Communications, Media, and Energy ASIs Siebel Invoice Adjustment

Figure 36 describes the structure of the Siebel Invoice Adjustment ASI.

Figure 36. Siebel Invoice Adjustment ASI Table 77 lists the integration components of this ASI.

Table 77.

Siebel Invoice Adjustment Components XML Tag Adjustment User Keys

Integration Component FS Invoice Adjustment

1 2 1 2

Adjustment ID Integration Id Item Adjustment ID Integration Id

FS Invoice Adjustment Items

AdjustmentItem

Table 78 lists the fields and their attributes.

Table 78. Name

Siebel Invoice Adjustment ASI Fields XML Tag Data Type Length Req.

FS Invoice Adjustment Account Id Account Name Adjustment ID Alert Id Approved Amt Approved Currency AccountId AccountName AdjustmentID AlertId ApprovedAmt ApprovedCurrency DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_ID DTYPE_TEXT DTYPE_TEXT Not applicable 100 Not applicable Not applicable Not applicable 20 No No No No No No

236

Siebel Application Services Interface Reference Version 8.2

Siebel Communications, Media, and Energy ASIs Siebel Invoice Adjustment

Table 78. Name

Siebel Invoice Adjustment ASI Fields XML Tag ApprovedDate ApprovedExchangeDate ConflictId Created CreatedByLogin CustomerDecision CustomerDecisionDate DecisionDescription Description FirstName Id IntegrationId InvoiceID InvoiceLineItemID InvoiceNumber InvoiceNumberNoConstrain ItemLineNumber LastName LineNumber ModId ReasonForRequest RequestAmt RequestCurrency RequestDate Data Type DTYPE_TEXT DTYPE_DATETIME DTYPE_ID DTYPE_DATETIME DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_NUMBER DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length Not applicable Not applicable 30 30 50 30 Not applicable 250 250 50 30 30 Not applicable Not applicable 50 50 Not applicable 50 Not applicable 30 30 Not applicable 20 Not applicable Req. No No No No No No No No No No No No No No No No No No No No No No No No

Approved Date Approved Exchange Date Conflict Id Created Created By Login Customer Decision Customer Decision Date Decision Description Description First Name Id Integration Id Invoice ID Invoice Line Item ID Invoice Number Invoice Number No Constrain Item Line Number Last Name Line Number Mod Id Reason For Request Request Amt Request Currency Request Date

Siebel Application Services Interface Reference Version 8.2

23 7

Siebel Communications, Media, and Energy ASIs Siebel Invoice Adjustment

Table 78. Name

Siebel Invoice Adjustment ASI Fields XML Tag RequestExchangeDate Status Type Updated operation searchspec Data Type DTYPE_DATETIME DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_TEXT Length Not applicable 30 30 30 30 250 Req. No No No No No No

Request Exchange Date Status Type Updated operation searchspec

FS Invoice Adjustment Items Approved Amt Approved Currency Code Approved Description Approved Exchange Date Conflict Id Created Description Id Integration Id Invoice Adj ID Invoice Item ID Item Adjustment ID Line Number Mod Id Original Amount Request Amt Request Currency ApprovedAmt ApprovedCurrencyCode ApprovedDescription ApprovedExchangeDate ConflictId Created Description Id IntegrationId InvoiceAdjID InvoiceItemID ItemAdjustmentID LineNumber ModId OriginalAmount RequestAmt RequestCurrency DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_ID DTYPE_DATETIME DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_ID DTYPE_ID DTYPE_NUMBER DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Not applicable 20 250 Not applicable 30 30 250 30 30 Not applicable Not applicable Not applicable Not applicable 30 Not applicable Not applicable 20 No No No No No No No No No No No No No No No No No

238

Siebel Application Services Interface Reference Version 8.2

Siebel Communications, Media, and Energy ASIs CUT Payment Interface Integration Object

Table 78. Name

Siebel Invoice Adjustment ASI Fields XML Tag RequestDate RequestExchangeDate Status Updated operation searchspec Data Type DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_TEXT Length Not applicable Not applicable 30 30 30 250 Req. No No No No No No

Request Date Request Exchange Date Status Updated operation searchspec

CUT Payment Interface Integration Object


The CUT Payment Interface integration object is used by both the CME Sync Payment and CME Update Payment Status Business Integration Processes to share information with external systems about payments made through the Siebel application. Figure 37 describes the CUT Payment Interface integration object structure.

Figure 37. CUT Payment Interface Integration Object Table 79 lists the integration components and XML tags.

Table 79.

CUT Payment Interface ASI Integration Components XML Tag ListOfCutPaymentInterface SiaPayment SiaPaymentInvoices User Keys

Integration Component Action SIA Payment SIA Payment Invoices

1 1 1

Description Id Invoice Id

Siebel Application Services Interface Reference Version 8.2

23 9

Siebel Communications, Media, and Energy ASIs CUT Payment Interface Integration Object

Table 80 lists the fields and their attributes.

Table 80. Name

CUT Payment Interface Integration Object Fields XML Tag Data Type Length Req.

SIA Payment Account Id Alert Id Bank Account Number Bank Location Bank Name Cheque Number Cheque Status Comments Credit Card Expiration Date Credit Card Holder Name Credit Card Number Currency Code Desired Payment Date Exchange Date Id Invoice Amount Invoice Num Payment Amount Payment Date Payment Method Payment Number Payment Type Received Date Reference Location Reference Number Status Updated AccountId AlertId BankAccountNumber BankLocation BankName ChequeNumber ChequeStatus Comments CreditCardExpirationDate CreditCardHolderName CreditCardNumber CurrencyCode DesiredPaymentDate ExchangeDate Id InvoiceAmount InvoiceNum PaymentAmount PaymentDate PaymentMethod PaymentNumber PaymentType ReceivedDate ReferenceLocation ReferenceNumber Status Updated DTYPE_ID DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_DATETIME DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME Not applicable Not applicable 50 100 100 30 30 255 Not applicable 50 50 20 Not applicable Not applicable 30 Not applicable Not applicable Not applicable Not applicable 30 30 30 Not applicable 100 30 30 30 No No No No No No No No No No No No No No No No No No No No No No No No No No No

240

Siebel Application Services Interface Reference Version 8.2

Siebel Communications, Media, and Energy ASIs CUT Account Balance Interface Request Integration Object

Table 80. Name

CUT Payment Interface Integration Object Fields XML Tag UpdatedBy operation Data Type DTYPE_TEXT DTYPE_TEXT Length 50 30 Req. No No

Updated By operation SIA Payment Invoices Currency Code Id Invoice Date Invoice Id Payment Amount Applied Payment Id operation Action Account Id Description Primary Owner Id Type

CurrencyCode Id InvoiceDate InvoiceId PaymentAmountApplied PaymentId operation

DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_TEXT

20 30 Not applicable Not applicable Not applicable Not applicable 30

No No No No No No No

AccountId Description PrimaryOwnerId Type

DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_TEXT

Not applicable 100 Not applicable 30

No No No No

CUT Account Balance Interface Request Integration Object


The CME Query Account Balance Business Integration Process uses the CUT Account Balance Interface - Request integration object to query the external application with an account number for balance and dunning information. Figure 38 describes the CUT Account Balance Interface - Request Integration Object structure.

Figure 38. CUT Account Balance Interface Request Integration Object

Siebel Application Services Interface Reference Version 8.2

24 1

Siebel Communications, Media, and Energy ASIs CUT Account Balance Interface Response Integration Object

Table 81 lists the integration components and XML tags.

Table 81.

CUT Account Balance Request Integration Object Integration Components XML Tag ComInvoiceProfile User Keys No user keys.

Integration Component Com Invoice Profile

Table 82 lists the fields and their attributes.

Table 82. Name

CUT Account Balance Interface - Request Integration Object Fields XML Tag Data Type Length Req.

Com Invoice Profile Account Id External Billing Account Number AccountId ExternalBillingAccountNumber DTYPE_ID DTYPE_TEXT Not applicable 30 No No

CUT Account Balance Interface Response Integration Object


The CME Query Account Balance Business Integration Process uses the CUT Account Balance Interface - Response integration object to receive balance and dunning information related to an account. Figure 39 describes the CUT Account Balance Interface - Response Integration Object structure.

Figure 39. CUT Account Balance Interface - Response Integration Object Table 83 lists the integration components and XML tags.

Table 83.

CUT Account Balance Interface - Response Integration Object Integration Components XML Tag CutAccountBalance User Keys No user keys.

Integration Component CUT Account Balance

242

Siebel Application Services Interface Reference Version 8.2

Siebel Communications, Media, and Energy ASIs Siebel Meter Reading

Table 84 lists the fields and their attributes.

Table 84. Name

CUT Account Balance Interface - Response Integration Object Fields XML Tag Data Type Length Req.

CUT Account Balance 30 Days Due 60 Days Due 90 Days Due Balance Currency Current Balance Due Date External Account # Pending Credits Pending Debits Unbilled Usage operation searchspec DaysDue30 DaysDue60 DaysDue90 Balance Currency CurrentBalance DueDate ExternalAccountNum PendingCredits PendingDebits UnbilledUsage operation searchspec DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable 30 250 No No No No No No No No No No No No No

Siebel Meter Reading


The CME Update Meter Usage Business Integration Process uses the Siebel Meter Reading ASI to update the external application with meter reading data for billing information. Figure 40 describes the Siebel Meter Reading ASI structure.

Figure 40. Siebel Meter Reading ASI Table 85 lists the integration components and XML tags of this ASI.

Table 85.

Siebel Meter Reading ASI Integration Components XML Tag FsAssetReading User Keys

Integration Component FS Asset Reading

Id

Siebel Application Services Interface Reference Version 8.2

24 3

Siebel Communications, Media, and Energy ASIs Siebel Meter Usage Data

Table 86 lists the fields and their attributes.

Table 86. Name

Siebel Meter Reading ASI Fields XML Tag Data Type Length Req.

FS Asset Reading Account Id Asset Id Asset Number Asset Serial Number Complete Flag Conflict Id Created Employee Id Measurement Method Code Mod Id Product Id Reading Service Point Number Timestamp Units Updated operation searchspec AccountId AssetId AssetNumber AssetSerialNumber CompleteFlag ConflictId Created Employee Id MeasurementMethodCode ModId ProductId Reading ServicePointNumber Timestamp Units Updated operation searchspec DTYPE_ID DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_DATETIME DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_ID DTYPE_NUMBER DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_TEXT Not applicable Not applicable 100 100 Not applicable 30 30 50 30 30 30 Not applicable Not applicable Not applicable Not applicable 30 30 30 250 No No No No No No No No No No No No No No No No No No No

Siebel Meter Usage Data


The CME Query Meter Usage Business Integration Process uses the Siebel Meter Usage Data ASI to query the external application with meter usage data for billing information.

244

Siebel Application Services Interface Reference Version 8.2

Siebel Communications, Media, and Energy ASIs Siebel Meter Usage Data

Figure 41 describes the Siebel Meter Usage Data ASI structure.

Figure 41. Siebel Meter Usage Data ASI Table 87 lists the integration components and XML tags of this ASI.

Table 87.

Siebel Meter Usage Data ASI Integration Components XML Tag Asset User Keys

Integration Component SIS OM Asset Mgmt - Asset - Complex Header Billing

1 2 1

Id Asset Number Period Id

UT Usage Detail Table 88 lists the fields and their attributes.

UtUsageDetail

Table 88. Name

Siebel Meter Usage Data ASI Fields XML Tag Data Type Length Req.

SIS OM Asset Mgmt - Asset - Complex Header Billing Billing Account Id Id Product Id Service Point Id Service Point Serial Number Status operation searchspec UT Usage Detail Asset Id Billed Demand Billing Account Billing Account Id AssetId BilledDemand BillingAccount BillingAccountId DTYPE_ID DTYPE_NUMBER DTYPE_TEXT DTYPE_ID Not applicable Not applicable 100 Not applicable No No No No BillingAccountId Id ProductId ServicePointId ServicePointSerialNumber Status operation searchspec DTYPE_ID DTYPE_ID DTYPE_ID DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Not applicable 30 Not applicable Not applicable 100 30 30 250 No No No No No No No No

Siebel Application Services Interface Reference Version 8.2

24 5

Siebel Communications, Media, and Energy ASIs Siebel Meter Usage Data

Table 88. Name

Siebel Meter Usage Data ASI Fields XML Tag BillingAccountNumber BillingDays ConflictId Created DataSource DegreeDays DemandUOM EndDate Id IntermediateUsage LoadFactor ModId OffPeakDemand OffPeakUsage OnPeakDemand OnPeakUsage Period PeriodId PowerFactor RateCode RateException ReadCode StartDate Supplier SupplierId TotalUsage Updated UsageUOM operation searchspec Data Type DTYPE_TEXT DTYPE_NUMBER DTYPE_ID DTYPE_DATETIME DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_DATETIME DTYPE_ID DTYPE_NUMBER DTYPE_NUMBER DTYPE_ID DTYPE_NUMBER DTYPE_NUMBER DTYPE_NUMBER DTYPE_NUMBER DTYPE_TEXT DTYPE_ID DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_ID DTYPE_NUMBER DTYPE_DATETIME DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length 30 Not applicable 30 30 30 Not applicable 30 Not applicable 30 Not applicable Not applicable 30 Not applicable Not applicable Not applicable Not applicable 50 Not applicable Not applicable 30 30 30 Not applicable 100 Not applicable Not applicable 30 30 30 250 Req. No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No

Billing Account Number Billing Days Conflict Id Created Data Source Degree Days Demand UOM End Date Id Intermediate Usage Load Factor Mod Id Off Peak Demand Off Peak Usage On Peak Demand On Peak Usage Period Period Id Power Factor Rate Code Rate Exception Read Code Start Date Supplier Supplier Id Total Usage Updated Usage UOM operation searchspec

246

Siebel Application Services Interface Reference Version 8.2

Siebel Communications, Media, and Energy ASIs Siebel Payment

Siebel Payment
The Siebel Payment ASI is used to query payment information from the external systems. Figure 42 describes the structure of the Siebel Payment ASI.

Figure 42. Siebel Payment ASI Table 89 lists the integration components of this ASI.

Table 89.

Siebel Payment Integration Component XML Tag Action SiaPayment User Keys

Integration Component Action SIA Payment

1 1 2 1

Description Id Integration Id Invoice Id

SIA Payment Invoices

SiaPaymentInvoices

Table 90 lists the fields and their attributes.

Table 90. Name Action

Siebel Payment ASI Fields XML Tag Data Type Length Req.

Account Id Description Primary Owner Id Type SIA Payment Account Id Alert Id

AccountId Description PrimaryOwnerId Type

DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_TEXT

Not applicable 100 Not applicable 30

N N N N

AccountId AlertId

DTYPE_ID DTYPE_ID

Not applicable Not applicable

N N

Siebel Application Services Interface Reference Version 8.2

24 7

Siebel Communications, Media, and Energy ASIs Siebel Payment

Table 90. Name

Siebel Payment ASI Fields XML Tag BankAccountNumber BankLocation BankName ChequeNumber ChequeStatus Comments CreditCardExpirationDate CreditCardHolderName CreditCardNumber CurrencyCode DesiredPaymentDate ExchangeDate Id IntegrationId InvoiceAmount InvoiceNum PaymentAmount PaymentDate PaymentMethod PaymentNumber PaymentType ReceivedDate ReferenceLocation ReferenceNumber Status Updated UpdatedBy operation Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_DATETIME DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME DTYPE_TEXT DTYPE_TEXT Length 50 100 100 30 30 255 Not applicable 50 50 20 Not applicable Not applicable 30 30 Not applicable Not applicable Not applicable Not applicable 30 30 30 Not applicable 100 30 30 30 50 30 Req. N N N N N N N N N N N N N N N N N N N N N N N N N N N N

Bank Account Number Bank Location Bank Name Cheque Number Cheque Status Comments Credit Card Expiration Date Credit Card Holder Name Credit Card Number Currency Code Desired Payment Date Exchange Date Id Integration Id Invoice Amount Invoice Num Payment Amount Payment Date Payment Method Payment Number Payment Type Received Date Reference Location Reference Number Status Updated Updated By operation SIA Payment Invoices Currency Code

CurrencyCode

DTYPE_TEXT

20

248

Siebel Application Services Interface Reference Version 8.2

Siebel Communications, Media, and Energy ASIs Siebel Simple Product

Table 90. Name Id

Siebel Payment ASI Fields XML Tag Id InvoiceDate InvoiceId PaymentAmountApplied PaymentId operation Data Type DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_TEXT Length 30 Not applicable Not applicable Not applicable Not applicable 30 Req. N N N N N N

Invoice Date Invoice Id Payment Amount Applied Payment Id operation

Siebel Simple Product


Oracles Siebel Simple Product ASI is used in the CME Create Product Business Integration Process and the CME Update Product Business Integration Process to create and synchronize Siebel simple products. Figure 43 describes the Siebel Simple Product ASI structure.

Figure 43. Siebel Simple Product ASI

Siebel Application Services Interface Reference Version 8.2

24 9

Siebel Communications, Media, and Energy ASIs Siebel Simple Product

Table 91 lists the integration components and XML tags of this ASI.

Table 91.

Siebel Simple Product Components XML Tag InternalProduct User Keys

Integration Component Internal Product

1 2 3

Id Integration Id, Product Name Integration Id, Primary Organization, Primary Vendor, Product Name, Vendor Primary Organization, Vendor Site Primary Organization, Primary Vendor, Product Name, Vendor Primary Organization, Vendor Site Id Integration Id Inventory Type, Product Name Id Integration Id Equivalent Product, Equivalent Product Primary Organization, Equivalent Product Vendor, Equivalent Product Vendor Location, Equivalent Product Vendor Organization Id Integration Id Inventory Name, Primary Organization Id Integration Id Organization Id Integration Id Organization, Product Name, Vendor, Vendor Location

FS Inventory Options

InventoryOptions

1 2 3

Internal Product_Equivalent Product

RelatedEquivalentProduct

1 2 3

FS Inventory Location

RelatedInventoryLocation

1 2 3

Internal Product_Organization

RelatedOrganization

1 2 3

Internal Product_Related Product

RelatedProduct

1 2 3

250

Siebel Application Services Interface Reference Version 8.2

Siebel Communications, Media, and Energy ASIs Siebel Simple Product

Table 91.

Siebel Simple Product Components XML Tag RelatedProductLine User Keys

Integration Component Internal Product_Admin Product Line

1 2 3

Id Integration Id Product Line Id Integration Id Name, Primary Organization Id Integration Id Warranty Name, Warranty Provider Name, Warranty Provider Primary Organization, Warranty Provider Site

Sales Tool by Product

RelatedSalesToolByProduct

1 2 3

FS Warranty

RelatedWarranty

1 2 3

Table 92 lists the fields and their attributes.

Table 92. Name

Siebel Simple Product ASI Fields XML Tag Data Type Length Req.

Internal Product Allocate Below Safety Flag Auto Allocate Flag Auto Substitute Flag Class Id Class Integration Id Class Name Class Type Compensable Description Division Code Effective End Date AllocateBelowSafetyFlag AutoAllocateFlag AutoSubstituteFlag ClassId ClassIntegrationId ClassName ClassType CompensableFlag Description DivisionCode EffectiveEndDate DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_DATETIME 30 30 30 NA 30 75 30 NA 255 30 NA No No No No No No No No No No No

Siebel Application Services Interface Reference Version 8.2

25 1

Siebel Communications, Media, and Energy ASIs Siebel Simple Product

Table 92. Name

Siebel Simple Product ASI Fields XML Tag EffectiveStartDate FieldReplacable GlobalAssemblyLevelCode GlobalProductClassificationCode Data Type DTYPE_DATETIME DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length NA NA 50 50 Req. No No No No

Effective Start Date Field Replacable Global Assembly Level Code Global Product Classification Code Global Product Identifier Global Product Lifecycle Status Code Global Supply Chain Code Id Image Name Image Primary Organization Name Image File Name Integration Id IsAdminMode Item Size Lead Time MTBF MTTR Maximum Quantity Minimum Quantity Orderable Parent Internal Product Id (Joined)

GlobalProductIdentifier GlobalProductLifecycleStatusCode

DTYPE_TEXT DTYPE_TEXT

50 50

No No

GlobalSupplyChainCode Id ImageName ImagePrimaryOrganizationName

DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT

50 30 100 100

No No No No

ImageFileName IntegrationId IsAdminMode ItemSize LeadTime MTBF MTTR MaximumQuantity MinimumQuantity Orderable ParentInternalProductId

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_NUMBER DTYPE_NUMBER DTYPE_NUMBER DTYPE_NUMBER DTYPE_TEXT DTYPE_ID

200 30 NA NA 30 NA NA NA NA NA NA

No No No No No No No No No No No

252

Siebel Application Services Interface Reference Version 8.2

Siebel Communications, Media, and Energy ASIs Siebel Simple Product

Table 92. Name

Siebel Simple Product ASI Fields XML Tag ParentInternalProductIntegrationId Data Type DTYPE_TEXT Length 30 Req. No

Parent Internal Product Integration Id Parent Internal Product Name Parent Internal Product Primary Organization Parent Internal Product Vendor Parent Internal Product Vendor Location Parent Internal Product Vendor Organization Part Number Price Type Primary Organization Primary Vendor Product Image Id Product Image Integration Id Product Level Product Name Product Type Return if Defective Revision Sales Product Serialized Service Product Service Type

ParentInternalProductName ParentInternalProductPrimaryOrganizatio n ParentInternalProductVendor ParentInternalProductVendorLocation

DTYPE_TEXT DTYPE_TEXT

100 100

No No

DTYPE_TEXT DTYPE_TEXT

100 50

No No

ParentInternalProductVendorOrganization

DTYPE_TEXT

100

No

PartNumber PriceType PrimaryOrganization PrimaryVendor ProductImageId ProductImageIntegrationId ProductLevel ProductName ProductType ReturnifDefective Version SalesProduct Serialized ServiceProduct ServiceType

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

50 NA 50 100 NA 30 NA 100 30 NA 30 NA NA 30 NA

No No No No No No No No No No No No No No No

Siebel Application Services Interface Reference Version 8.2

25 3

Siebel Communications, Media, and Energy ASIs Siebel Simple Product

Table 92. Name

Siebel Simple Product ASI Fields XML Tag Carrier ShippingVia Status TargetedCountry TargetedIndustry TargetedMaxAge TargetedMinAge TargetedPostalCode ToolFlag UnitofMeasure UnitsInInventory UnitsInInventoryAsOf VendorId VendorIntegrationId VendorPartNumber VendorPrimaryOrganization VendorSite operation searchspec Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER DTYPE_NUMBER DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_NUMBER DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length 30 30 30 250 250 NA NA 250 NA 30 NA NA NA 30 50 100 50 30 250 Req. No No No No No No No No No No No No No No No No No No No

Ship Carrier Shipping Via Status Targeted Country Targeted Industry Targeted Max Age Targeted Min Age Targeted Postal Code Tool Flag Unit of Measure Units In Inventory Units In Inventory As Of Vendor Id Vendor Integration Id Vendor Part Number Vendor Primary Organization Vendor Site operation searchspec

FS Inventory Options Allocate Below Safety Flag Auto AllocateFlag AllocateBelowSafetyFlag AutoAllocateFlag DTYPE_TEXT DTYPE_TEXT 30 30 No No

254

Siebel Application Services Interface Reference Version 8.2

Siebel Communications, Media, and Energy ASIs Siebel Simple Product

Table 92. Name

Siebel Simple Product ASI Fields XML Tag AutoSubstituteFlag ClassABC ClassXYZ Id IntegrationId InventoryType ProductName operation searchspec Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length 30 30 30 30 30 30 100 30 250 Req. No No No No No No No No No

Auto Substitute Flag Class ABC Class XYZ Id Integration Id Inventory Type Product Name operation searchspec

Internal Product_Equivalent Product Equivalent Product Equivalent Product Primary Organization Equivalent Product Vendor Equivalent Product Vendor Location Equivalent Product Vendor Organization Id Integration Id IsPrimaryMVG operation searchspec EquivalentProduct EquivalentProductPrimaryOrganization DTYPE_TEXT DTYPE_TEXT 100 50 No No

EquivalentProductVendor EquivalentProductVendorLocation

DTYPE_TEXT DTYPE_TEXT

100 50

No No

EquivalentProductVendorOrganization

DTYPE_TEXT

100

No

Id IntegrationId IsPrimaryMVG operation searchspec

DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

30 30 1 30 250

No No No No No

FS Inventory Location Id Integration Id Inventory Name Id IntegrationId InventoryName DTYPE_ID DTYPE_TEXT DTYPE_TEXT 30 30 100 No No No

Siebel Application Services Interface Reference Version 8.2

25 5

Siebel Communications, Media, and Energy ASIs Siebel Simple Product

Table 92. Name

Siebel Simple Product ASI Fields XML Tag PrimaryOrganizationName Data Type DTYPE_TEXT Length 100 Req. No

Primary Organization Name operation searchspec

operation searchspec

DTYPE_TEXT DTYPE_TEXT

30 250

No No

Internal Product_Organization Id Integration Id IsPrimaryMVG Organization operation searchspec Id IntegrationId IsPrimaryMVG Organization operation searchspec DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 30 30 1 50 30 250 No No No No No No

Internal Product_Related Product Id Integration Id IsPrimaryMVG Organization Product Name Vendor Vendor Location operation searchspec Id IntegrationId IsPrimaryMVG Organization ProductName Vendor VendorLocation operation searchspec DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 30 30 1 50 100 100 50 30 250 No No No No No No No No No

Internal Product_Admin Product Line Id Integration Id IsPrimaryMVG Product Line operation searchspec Id IntegrationId IsPrimaryMVG ProductLine operation searchspec DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 30 30 1 100 30 250 No No No No No No

Sales Tool by Product Id Id DTYPE_ID 30 No

256

Siebel Application Services Interface Reference Version 8.2

Siebel Communications, Media, and Energy ASIs Trouble Ticketing Management

Table 92. Name

Siebel Simple Product ASI Fields XML Tag IntegrationId LitFileName Name PrimaryOrganization operation searchspec Data Type DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length 30 220 50 50 30 250 Req. No No No No No No

Integration Id LitFileName Name Primary Organization operation searchspec FS Warranty Id Integration Id Warranty Name Warranty Provider Name Warranty Provider Primary Organization Warranty Provider Site operation searchspec

Id IntegrationId WarrantyName WarrantyProviderName WarrantyProviderPrimaryOrganization

DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

30 30 100 100 100

No No No No No

WarrantyProviderSite operation searchspec

DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT

50 30 250

No No No

Trouble Ticketing Management


Trouble Ticketing Management uses a single ASI, Trouble Ticket, to enable the submission and processing of trouble tickets and the update of trouble ticket line items.

Siebel Trouble Ticket


The Oracles Siebel Trouble Ticket ASI enables the use of a trouble ticket in the Siebel application to create, request, and update the external application with trouble ticket data when the external application has detected an outage or network fault.

Siebel Application Services Interface Reference Version 8.2

25 7

Siebel Communications, Media, and Energy ASIs Siebel Trouble Ticket

Figure 44 describes the Siebel Trouble Ticket ASI structure.

Figure 44. Siebel Trouble Ticket ASI Table 93 lists the integration components and XML tags of this ASI.

Table 93.

Siebel Trouble Ticket ASI Integration Components XML Tag RelatedServiceRequest_ServiceElements RelatedServiceRequest User Keys

Integration Component Related Service Request_ Service Elements Related Service Request

1 1 2 1 1 2

Service Element Id Integration Id Id Service Element Id Id Integration Id

Service Request_Service Elements Service Request

ServiceRequest_ServiceElements ServiceRequest

Table 94 lists the fields and their attributes.

Table 94. Name

Siebel Trouble Ticket ASI Fields XML Tag Data Type Length Req.

Related Service Request_Service Elements IsPrimaryMVG Service Element Id operation searchspec IsPrimaryMVG ServiceElementId operation searchspec DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT 1 30 30 250 No No No No

258

Siebel Application Services Interface Reference Version 8.2

Siebel Communications, Media, and Energy ASIs Siebel Trouble Ticket

Table 94. Name

Siebel Trouble Ticket ASI Fields XML Tag Data Type Length Req.

Related Service Request Abstract Account Id Area Closed Date Commit Time Contact Id Created Customer Ref Number Description Entitlement Id Id Integration Id Owned By Id Priority Service Point Asset Id Severity Status Sub-Area Sub-Status TT Source Ticket Type operation searchspec Service Request Abstract Account Id Area Closed Date Commit Time Contact Id Abstract AccountId Area ClosedDate CommitTime ContactId DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID 100 Not applicable 30 Not applicable Not applicable Not applicable No No No No No No Abstract AccountId Area ClosedDate CommitTime ContactId Created CustomerRefNumber Description EntitlementId Id IntegrationId OwnedById Priority ServicePointAssetId Severity Status Sub-Area Sub-Status TTSource TicketType operation searchspec DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_DATETIME DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_ID DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT 100 Not applicable 30 Not applicable Not applicable Not applicable 30 64 2000 Not applicable 30 30 Not applicable 30 15 30 30 30 30 30 30 30 250 No No No No No No No No No No No No No No No No Yes No Yes No No No No

Siebel Application Services Interface Reference Version 8.2

25 9

Siebel Communications, Media, and Energy ASIs Siebel Trouble Ticket

Table 94. Name Created

Siebel Trouble Ticket ASI Fields XML Tag Created CustomerRefNumber Description EntitlementId Id IntegrationId OpenedDate OwnedById Priority ServicePointAssetId Severity Status Sub-Area Sub-Status TTSource TicketType operation searchspec Data Type DTYPE_DATETIME DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT DTYPE_TEXT Length 30 64 2000 Not applicable 30 30 Not applicable Not applicable 30 15 30 30 30 30 30 30 30 250 Req. No No No No No No Yes No No No No Yes No No No No No No

Customer Ref Number Description Entitlement Id Id Integration Id Opened Date Owned By Id Priority Service Point Asset Id Severity Status Sub-Area Sub-Status TT Source Ticket Type operation searchspec

Service Request_Service Elements IsPrimaryMVG Service Element Id operation searchspec IsPrimaryMVG ServiceElementId operation searchspec DTYPE_TEXT DTYPE_ID DTYPE_TEXT DTYPE_TEXT 1 30 30 250 No No No No

260

Siebel Application Services Interface Reference Version 8.2

Index

A
Account Balance Request ASI 242 Account Balance Response ASI 242 Account Interface ASI 218 ANI Message Header ASI ASI fields 119 integration components 119 ANI Opportunity Message ASI ASI fields 113 integration components 110 Application Services Interfaces (ASI) authentication and security, about 26 defined and format 9 exposing, about 24 extending 31 extending, user scenario 36 External Credit Check ASI 173 External Opportunity Create/External Opportunity Query/External Opportunity Update ASI 109 External Shipment Tracking ASI 176 inbound ASI example 11 inbound ASI, about 9 outbound ASI example 12 outbound ASI, about 10 prebuilt, table of 40 Siebel Account ASI 41 Siebel Action ASI 55 Siebel Asset ASI 64 Siebel ATP Response/External ATP Check ASI 165 Siebel Business Address ASI 61 Siebel Contact ASI 68 Siebel Cost List ASI 75 Siebel CUT Address MSAG Service ASI 74 Siebel Employee ASI 78 Siebel Financial Account ASI 90 Siebel Forecast ASI 96 Siebel Invoice Adjustment ASI 235 Siebel Invoice ASI 98 Siebel Order ASI 129 Siebel Personal Address ASI 63 Siebel Position ASI 146 Siebel Price List ASI 147 Siebel Quote/External Quote ASI 150 Siebel Service Request ASI 184 Siebel SIA Service Request ASI 181

Siebel Simple Product ASI 188 Application Services Interfaces (ASI) structure Application Services Interfaces (ASI) 14 components and fields 14 components, about picking related 15 data mapping, implicit 17 defined and structure example 13 integration objects and instance diagram 14 integration objects, about and sample 13 List of Value fields, about 14 user keys, about 15 ASI Framework about 31 ASI, extending 31 customized workflow example 32 Data Map, defining 36 external interface, defining 35 inbound interface, defining 34 asynchronous processing, creating 29 authentication, for ASIs 26 automatic mapping about 19 upgrading data maps, about 19

B
batch processing, creating 29 Billing Management ASIs about 228 CUT Account Balance Interface - Request Integration Object ASI 241 CUT Account Balance Interface - Response Integration Object ASI 242 Siebel Invoice ASI 228 Siebel Meter Reading ASI 243 Siebel Meter Usage Data ASI 244 Siebel Trouble Ticket ASI 257 business service user properties, about and table of 22

C
CME ASIs, prebuilt Billing Management ASIs 228 Customer Lifecycle Management ASI 218 CUT Account Balance Interface - Request Integration Object ASI 241

Siebel Application Services Interface Reference Version 8.2

26 1

Index D

CUT Account Balance Interface - Response Integration Object ASI 242 Order Management ASI 199 Siebel Account ASI 218 Siebel Invoice ASI 228 Siebel Meter Reading ASI 243 Siebel Meter Usage Data ASI 244 Siebel Order ASI 199 Siebel Simple Product ASI 249 Siebel Trouble Ticket ASI 257 table of 198 Trouble Ticketing Management ASI 257 Communications, Media, and Energy ASIs See CME ASIs, prebuilt components deactivating 28 defined 14 picking related, about 15 configuring inbound data synchronization ASI 27 outbound ASI 28 Credit Check Request ASI about and diagram 173 ASI fields 174 integration components 173 Credit Check Response ASI 175 customer information management-related business processes 218 Customer Lifecycle Management ASI 218 Customer Order Lifecycle business process Siebel Asset ASI 64 Siebel Business Address ASI 61 Siebel Personal Address ASI 63 CUT Account Balance Interface - Request Integration Object ASI about and diagram 241 fields and attributes 242 integration components and XML tags 242 structure and field definitions 241 CUT Account Balance Interface - Response Integration Object ASI about and diagram 242 fields and attributes 243 integration components and XML tags 242 CUT Payment Interface Integration Object ASI about and diagram 239 fields and attributes 240 integration components and XML tags 239

cache, purging 32 defining the data map 36 data mapping automatic mapping, about 19 data synchronization, within 16 explicit data mapping, about 18 implicit data mapping, about 17 upgrading data maps, about 19 data synchronization services about 15 data mapping and synchronization data mapping, implicit 17 methods, arguments (table) 21 methods, table of 19 Destination Channel Partner ASI ASI fields 126 integration components 125

16

E
EAI Framework, using to expose ASIs 24 Employee Management business integration application Siebel CUT Address MSAG Service ASI 74 error messages inbound error handling 25 integration objects, about returning 22 outbound error handling 26 explicit mapping about 18 upgrading data maps, about 19 External Credit Check ASI about 173 Credit Check Request ASI 173 Credit Check Response ASI 175 External Opportunity Create/External Opportunity Query/External Opportunity Update ASI about and diagram 109 ANI Message Header (PRM ANI) ASI 119 ANI Opportunity Message (PRM ANI) ASI 110 Destination Channel Partner (PRM ANI) ASI 125 Opportunity (PRM ANI) ASI 120 Opportunity Account (PRM ANI) ASI 127 Source Organization (PRM ANI) ASI 126 External Shipment Tracking ASI about 176 Shipment Tracking Interface Request ASI 177 Shipment Tracking Interface Response ASI 178

D
Data Map

262

Siebel Application Services Interface Reference Version 8.2

Index F

F
fields about 14 deactivating 28 deactivating fields example 29 foreign key, about using to pick related components 15

configuring 28 defined and use of 10 defining, user scenario 37 error message handling 26 example 12 inbound ASI 10

I
implementation, specifying 30 inbound ASI component or field, deactivating 28 configuring 27 defined and use of 9 error message handling 25 example 11 exposing example 30 outbound ASI 11 information protocols, about using to make ASIs externally available 24 integration objects about and sample 13 instance diagram 14 interfaces Data Map, defining 36 external interfaces, defining 35 inbound interfaces, defining 34 Invoice Interface ASI 228

P
Payment Interface ASI 239 prebuilt CME ASIs Billing Management ASIs 228 Customer Lifecycle Management ASI 218 CUT Account Balance Interface - Request Integration Object ASI 241 CUT Account Balance Interface - Response Integration Object ASI 242 Order Management ASI 199 Siebel Account ASI 218 Siebel Invoice ASI 228 Siebel Meter Reading ASI 243 Siebel Meter Usage Data ASI 244 Siebel Order ASI 199 Siebel Simple Product ASI 249 Siebel Trouble Ticket ASI 257 table of 198 Trouble Ticketing Management ASI 257 predefined, Application Service Interfaces (ASI) ANI Message Header (PRM ANI) ASI 119 ANI Opportunity Message (PRM ANI) ASI 110 Credit Check ASI 173 Credit Check Response ASI 175 Destination Channel Partner (PRM ANI) ASI 125 External Credit Check ASI 173 External Opportunity Create/External Opportunity Query/External Opportunity Update ASI 109 External Shipment Tracking ASI 176 Opportunity (PRM ANI) ASI 120 Opportunity Account (PRM ANI) ASI 127 Shipment Tracking Interface Request ASI 177 Shipment Tracking Interface Response ASI 178 Siebel Account ASI 41 Siebel Action ASI 55 Siebel Asset ASI 64 Siebel ATP Response/External ATP Check ASI 165 Siebel Business Address ASI 61 Siebel Contact ASI 68

L
List of Value fields, about 14

M
methods arguments, table of 21 business service user properties, about and table of 22 data synchronization, table of 19 error messages, about returning 22 status key, about and recommended keys 21 XML method example 23

O
Opportunity Account ASI ASI fields 128 integration components 127 Opportunity ASI ASI fields 122 Order Management ASI 199 Siebel Interface ASI 199 outbound ASI component of field, deactivating 28

Siebel Application Services Interface Reference Version 8.2

26 3

Index S

Siebel Cost List ASI 75 Siebel CUT Address MSAG Service ASI 74 Siebel Employee ASI 78 Siebel Forecast ASI 90, 96 Siebel Invoice Adjustment ASI 235 Siebel Invoice ASI 98 Siebel Order ASI 129 Siebel Personal Business Address ASI 63 Siebel Position ASI 146 Siebel Price List ASI 147 Siebel QuoteExternal Quote ASI 150 Siebel Service Request ASI 184 Siebel Simple Product ASI 188 Source Organization (PRM ANI) ASI 126 table of 40 processing asynchronous processing 29 batch processing 29 Product and Pricing Administration ASIs Siebel Simple Product ASI 249 protocols, about and table of 24

S
scenarios ASI, extending 36 deactivating fields 29 implementation, specifying 30 inbound ASI, exposing 30 outbound ASI, defining 37 security, for ASIs 26 Shipment Tracking Interface Request ASI 177 about 177 ASI Fields 177 integration components 177 Shipment Tracking Interface Response ASI 178 about and diagram 178 ASI fields 179 integration components 178 Siebel Account ASI about and diagram 41 ASI fields 43 Customer Lifecycle Management 218 fields and attributes 220 integrated components 42 integration components and XML tags 219 predefined, Application Service Interfaces (ASI) 41 Siebel Action ASI about and diagram 55 ASI fields 56 integration components 56

Siebel Action Business Component 55 Siebel Asset ASI about and diagram 64 ASI fields 65 integrated components 65 Siebel ATP Response/External ATP Check ASI about and diagram 165 ASI fields 166 integration components 165 Siebel Business Address ASI about and diagram 61 ASI fields 62 integrated components 62 Siebel Contact ASI about and diagram 68 ASI fields 69 integration components 68 Siebel Cost List ASI about and diagram 75 ASI fields 76 integration components 76 Siebel CUT Address MSAG Service ASI about and diagram 74 ASI fields 74 integration components 74 Siebel Employee ASI about and diagram 78 ASI fields 81 integration components 79 Siebel Financial Account ASI about and diagram 90 ASI fields 91 integration components 91 Siebel Forecast ASI about and diagram 96 ASI fields 97 integration components 97 Siebel Invoice Adjustment ASI about and diagram 235 ASI fields 236 integration components 236 Siebel Invoice ASI about and diagram 98, 228 ASI fields 99, 236 billing management 228 fields and attributes 229 integration components 99 integration components and XML tags 229 predefined, Application Service Interfaces (ASI) 98 Siebel Meter Reading ASI about and diagram 243 fields and attributes 244

264

Siebel Application Services Interface Reference Version 8.2

Index T

integration components and XML tags 243 structure and field definitions 243 Siebel Meter Usage Data ASI about and diagram 244 fields and attributes 245 integration components and XML tags 245 structure, and field definitions 244 Siebel Order ASI about and diagram 129 ASI fields 131 CME ASIs, prebuilt 199 fields and attributes 201 integration components 129 integration components and XML tags 200 predefined, Application Service Interfaces (ASI) 129 Siebel Payment ASI about and diagram 247 ASI fields 247 integration components 247 Siebel Personal Address ASI about and diagram 63 ASI fields 63 integration components 63 Siebel Position ASI about and diagram 146 ASI fields 147 integration components 146 Siebel Price List ASI about and diagram 147 ASI fields 148 integration components 148 Siebel Quote/External Quote ASI about and diagram 150 ASI fields 152 integration components 151 Siebel Service Request ASI about and diagram 184 ASI fields 185 integration components 185 Siebel SIA Service Request ASI about and diagram 181 fields and attributes 182 integration components 182 Siebel Simple Product ASI

about and diagram 188 ASI fields 190 CME ASIs, prebuilt 249 fields and attributes 251 integration components 189 integration components and XML tags 250 predefined, Application Service Interfaces (ASI) 188 Siebel Trouble Ticket ASI about and diagram 257 fields and attributes 258 integration components and XML tags 258 structure and field definitions 257 Source Organization ASI ASI fields 127 integration components 126 status key, about and recommended keys 21

T
Trouble Ticketing Management ASI 257

U
user keys, about 15 user properties, about and table of 22 user scenarios ASI, extending 36 deactivating fields 29 implementation, specifying 30 inbound ASI, exposing 30 outbound ASI, defining 37

W
Web services ASIs, about making externally available 24 inbound error handling 25 outbound error handling 26 protocols, about and table of 24 workflow, customized example 32

X
XML method, example 23

Siebel Application Services Interface Reference Version 8.2

26 5

Index X

266

Siebel Application Services Interface Reference Version 8.2

Вам также может понравиться