Application Services Interface Reference > Predefined Application Service Interfaces >

Siebel Product Catalog


A catalog is a collection of items arranged in a logical hierarchy of categories. The Siebel catalog provides core functions used by other applications to organize master data for administrative and display purposes. Different types of content items can be grouped into catalogs in the Siebel application.

The Siebel catalog uses products and auction items. This ASI allows access to products and prices based on access rules and price lists.

Figure 29 describes the outbound Siebel Product Catalog ASI structure and Table 59 lists the field definitions.

Figure 29.  Siebel Product Catalog ASI

Click for full size image

Table 58 lists the integration components and user keys of the Siebel Product Catalog ASI.

Table 58.  Siebel Product Catalog Integration Components
Integration Component
XML Tag
User Keys
Product Catalog
ProductCatalog
  1. Id
  2. Catalog Type, Name, Primary Group Id, Version
Internal Product by Price List
InternalProductbyPriceList
  1. Id
  2. Name, Primary Organization Id, Vendor Id
Catalog Category
CatalogCategory
  1. Id
  2. Catalog Id, Effective end Date, Name

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

Table 59.  Siebel Product Catalog ASI Field Definitions
Name
XML Tag
Data Type
Length
Required
Note
Product Catalog
Active
Active
DTYPE_TEXT
 
 
 
Catalog
Catalog
DTYPE_TEXT
20
 
 
Catalog Type
CatalogType
DTYPE_TEXT
30
 
 
Conflict Id
ConflictId
DTYPE_ID
 
 
 
Correct Effective Dates
CorrectEffectiveDates
DTYPE_TEXT
 
 
 
Created
Created
 
 
 
 
Created By Login
CreatedByLogin
DTYPE_TEXT
50
 
 
Description
Description
DTYPE_TEXT
250
 
 
Effective End Date
EffectiveEndDate
DTYPE_TEXT
 
 
 
Effective Start Date
EffectiveStartDate
DTYPE_TEXT
 
 
 
ISSCDA Project Id
ISSCDAProjectId
DTYPE_ID
 
 
 
ISSCDA Project Location
ISSCDAProjectLocation
DTYPE_TEXT
250
 
 
ISSCDA Project Name
ISSCDAProjectName
DTYPE_TEXT
100
 
 
Id
Id
 
 
 
 
Master Siebel Server
MasterSiebelServer
DTYPE_TEXT
75
 
 
Mod Id
ModId
 
 
 
 
Name
Name
DTYPE_TEXT
75
 
 
Primary Group Id
PrimaryGroupId
DTYPE_ID
 
 
 
Primary Group Name
PrimaryGroupName
DTYPE_TEXT
 
 
 
Private Flag
PrivateFlag
DTYPE_TEXT
 
 
 
Sequence Number
SequenceNumber
DTYPE_NUMBER
 
 
 
Type
Type
DTYPE_TEXT
30
 
 
Updated
Updated
 
 
 
 
Version
CatalogVersion
DTYPE_NUMBER
 
 
 
Operation
Operation
 
 
 
 
Searchspec
Searchspec
 
 
 
 
Internal Product by Price List Optional 2
Accrual Rate
AccrualRate
DTYPE_NUMBER
 
 
 
Allocate Below Safety Flag
AllocateBelowSafetyFlag
DTYPE_TEXT
 
 
 
Auto Allocate Flag
AutoAllocateFlag
DTYPE_TEXT
 
 
 
Auto Substitute Flag
AutoSubstituteFlag
DTYPE_TEXT
 
 
 
CDA Pageset Id
CDAPagesetId
DTYPE_ID
 
 
 
Carrier
Carrier
DTYPE_TEXT
30
 
 
Case Conversion Factor
CaseConversionFactor
DTYPE_NUMBER
 
 
 
Case Pack
CasePack
DTYPE_NUMBER
 
 
 
Catalog Price
CatalogPrice
DTYPE_TEXT
 
 
 
Cfg Complex Product Id
CfgComplexProductId
DTYPE_ID
 
 
 
Cfg Latest Released Flag
CfgLatestReleasedFlag
DTYPE_TEXT
 
 
 
Cfg Released Flag
CfgReleasedFlag
DTYPE_TEXT
 
 
 
Cfg Version
CfgVersion
DTYPE_NUMBER
 
 
 
Compensatable
Compensatable
DTYPE_TEXT
 
 
 
Conflict Id
ConflictId
 
 
 
 
Course Status
CourseStatus
DTYPE_TEXT
30
 
 
Created
Created
 
 
 
 
Currency Code
CurrencyCode
DTYPE_TEXT
20
 
 
Description
Description
DTYPE_TEXT
255
 
 
Display Component
DisplayComponent
DTYPE_TEXT
 
 
 
Display Component Price
DisplayComponentPrice
DTYPE_TEXT
 
 
 
End Date
EndDate
DTYPE_DATETIME
 
 
 
Expiration
Expiration
DTYPE_TEXT
 
 
 
Field Replacable Unit
FieldReplacableUnit
DTYPE_TEXT
 
 
 
Format
Format
DTYPE_TEXT
30
 
 
Global Product Identifier
GlobalProductIdentifier
DTYPE_TEXT
50
 
 
Id
Id
 
 
 
 
Item Size
ItemSize
DTYPE_NUMBER
 
 
 
Lead Time
LeadTime
DTYPE_TEXT
30
 
 
List Price
ListPrice
DTYPE_TEXT
 
 
 
List Price Calculated
ListPriceCalculated
DTYPE_TEXT
 
 
 
List Price Type Code
ListPriceTypeCode
DTYPE_TEXT
30
 
 
MTBF
MTBF
DTYPE_NUMBER
 
 
 
MTTR
MTTR
DTYPE_NUMBER
 
 
 
Maximum Quantity
MaximumQuantity
DTYPE_NUMBER
 
 
 
Minimum Quantity
MinimumQuantity
DTYPE_NUMBER
 
 
 
Mod Id
ModId
 
 
 
 
Name
Name
DTYPE_TEXT
100
 
 
Orderable
Orderable
DTYPE_TEXT
 
 
 
Pack Size
PackSize
DTYPE_NUMBER
 
 
 
Parent Internal Product Id
ParentInternalProductId
DTYPE_ID
 
 
 
Part #
Part
DTYPE_TEXT
50
 
 
Position Bill Product Flag
PositionBillProductFlag
DTYPE_TEXT
 
 
 
Primary Equivalent Product Id
PrimaryEquivalentProductId
DTYPE_ID
 
 
 
Primary Organization Id
PrimaryOrganizationId
DTYPE_ID
 
 
 
Primary Product Line Id
PrimaryProductLineId
DTYPE_ID
 
 
 
Product Def Type Code
ProductDefTypeCode
DTYPE_TEXT
30
 
 
Product Level
ProductLevel
DTYPE_NUMBER
 
 
 
Product Type Code
ProductTypeCode
DTYPE_TEXT
30
 
 
Promotional Price
PromotionalPrice
DTYPE_TEXT
 
 
 
Quantity
Quantity
DTYPE_NUMBER
 
 
 
Return if Defective
ReturnifDefective
DTYPE_TEXT
 
 
 
Sales Product Flag
SalesProductFlag
DTYPE_TEXT
 
 
 
Sales Service Flag
SalesServiceFlag
DTYPE_TEXT
 
 
 
Sequence Number
ProductSequenceNumber
DTYPE_NUMBER
 
 
 
Serialized
Serialized
DTYPE_TEXT
 
 
 
Shipping Method
ShippingMethod
DTYPE_TEXT
30
 
 
Start Date
StartDate
DTYPE_DATETIME
 
 
 
Tool Flag
ToolFlag
DTYPE_TEXT
 
 
 
Unit Conversion Factor
UnitConversionFactor
DTYPE_NUMBER
 
 
 
Unit of Measure
UnitofMeasure
DTYPE_TEXT
30
 
 
Updated
Updated
 
 
 
 
Vendor
Vendor
DTYPE_TEXT
100
 
 
Vendor Id
VendorId
DTYPE_ID
 
 
 
Vendor Location
VendorLocation
DTYPE_TEXT
50
 
 
Vendor Part Number
VendorPartNumber
DTYPE_TEXT
50
 
 
Version
Version
DTYPE_TEXT
30
 
 
Version Status
VersionStatus
DTYPE_TEXT
30
 
 
Volume Discount
VolumeDiscount
DTYPE_TEXT
50
 
 
Volume Discount Method
VolumeDiscountMethod
DTYPE_TEXT
30
 
 
XA Class Id
XAClassId
DTYPE_ID
 
 
 
XA Class Name
XAClassName
DTYPE_TEXT
75
 
 
Your Price
YourPrice
DTYPE_TEXT
 
 
 
Operation
Operation
 
 
 
 
Catalog Category
Active Flag
ActiveFlag
DTYPE_TEXT
 
 
 
Audit Percentage
AuditPercentage
DTYPE_NUMBER
 
 
 
Bitmap Name
BitmapName
DTYPE_TEXT
30
 
 
Catalog Active Flag
CatalogActiveFlag
DTYPE_TEXT
 
 
 
Catalog Effective End Date
CatalogEffectiveEndDate
DTYPE_TEXT
 
 
 
Catalog Effective Start Date
CatalogEffectiveStartDate
DTYPE_TEXT
 
 
 
Catalog Id
CatalogId
DTYPE_ID
 
 
 
Catalog Name
CatalogName
DTYPE_TEXT
75
 
 
Catalog Name 2
CatalogName2
DTYPE_TEXT
75
 
 
Catalog Private Flag
CatalogPrivateFlag
DTYPE_TEXT
 
 
 
Catalog Type
CatalogType
DTYPE_TEXT
30
 
 
Catalog Type Code
CatalogTypeCode
DTYPE_TEXT
30
 
 
Catalog Version
CatalogVersion
DTYPE_NUMBER
 
 
 
Conflict Id
ConflictId
 
 
 
 
Count
Count
DTYPE_NUMBER
 
 
 
Created
Created
 
 
 
 
Created By Login
CreatedByLogin
DTYPE_TEXT
50
 
 
Description
CategoryDescription
DTYPE_TEXT
250
 
 
Display Name
DisplayName
DTYPE_TEXT
100
 
 
Display Template
DisplayTemplate
DTYPE_TEXT
30
 
 
Display Template Lang Indep Name
DisplayTemplateLangIndepName
DTYPE_TEXT
50
 
 
Effective End Date
EffectiveEndDate
DTYPE_TEXT
 
 
 
Effective Start Date
EffectiveStartDate
DTYPE_TEXT
 
 
 
Extended Description
ExtendedDescription
DTYPE_TEXT
2000
 
 
Followup Flag
FollowupFlag
DTYPE_TEXT
 
 
 
ISSCDA Project Id
ISSCDAProjectId
DTYPE_ID
 
 
 
ISSCDA Project Name
ISSCDAProjectName
DTYPE_TEXT
100
 
 
Id
Id
 
 
 
 
Mod Id
ModId
 
 
 
 
Name
CategoryName
DTYPE_TEXT
75
 
 
No Auto Response Flag
NoAutoResponseFlag
DTYPE_TEXT
 
 
 
No Training Flag
NoTrainingFlag
DTYPE_TEXT
 
 
 
Parent Category Id
ParentCategoryId
DTYPE_ID
 
 
 
Parent Category Name
ParentCategoryName
DTYPE_TEXT
100
 
 
Parent Category Name 2
ParentCategoryName2
DTYPE_TEXT
100
 
 
Parent Category Private Flag
ParentCategoryPrivateFlag
DTYPE_TEXT
 
 
 
Primary Auction Item Id
PrimaryAuctionItemId
DTYPE_ID
 
 
 
Primary Competitor Id
PrimaryCompetitorId
DTYPE_ID
 
 
 
Primary Decision Issue Id
PrimaryDecisionIssueId
DTYPE_ID
 
 
 
Primary Event Id
PrimaryEventId
DTYPE_ID
 
 
 
Primary Literature Id
PrimaryLiteratureId
DTYPE_ID
 
 
 
Primary Product Id
PrimaryProductId
DTYPE_ID
 
 
 
Primary Resolution Item Id
PrimaryResolutionItemId
DTYPE_ID
 
 
 
Primary Solution Id
PrimarySolutionId
DTYPE_ID
 
 
 
Primary Training Id
PrimaryTrainingId
DTYPE_ID
 
 
 
Private Flag
PrivateFlag
DTYPE_TEXT
 
 
 
Response Threshold
ResponseThreshold
DTYPE_NUMBER
 
 
 
Root Category Flag
RootCategoryFlag
DTYPE_TEXT
 
 
 
Root Category Id
RootCategoryId
DTYPE_ID
 
 
 
Sequence Number
CategorySequenceNumber
DTYPE_NUMBER
 
 
 
Updated
Updated
 
 
 
 
Usage
Usage
DTYPE_TEXT
30
 
 
View Validate Primary Auction Item
ViewValidatePrimaryAuctionItem
DTYPE_ID
 
 
 
View Validate Primary Competitor
ViewValidatePrimaryCompetitor
DTYPE_ID
 
 
 
View Validate Primary Decision Issue
ViewValidatePrimaryDecisionIssue
DTYPE_ID
 
 
 
View Validate Primary Event
ViewValidatePrimaryEvent
DTYPE_ID
 
 
 
View Validate Primary Literature
ViewValidatePrimaryLiterature
DTYPE_ID
 
 
 
View Validate Primary Product
ViewValidatePrimaryProduct
DTYPE_ID
 
 
 
View Validate Primary Resolution Item
ViewValidatePrimaryResolutionItem
DTYPE_ID
 
 
 
View Validate Primary Solution
ViewValidatePrimarySolution
DTYPE_ID
 
 
 
View Validate Primary Training
ViewValidatePrimaryTraining
DTYPE_ID
 
 
 
Operation
Operation
 
 
 
 


 Application Services Interface Reference 
 Published: 15 May 2003