Oracle相關(guān)文檔-Siebel詳細(xì)說明書-ASIRef

SiebelApplicationServicesInterfaceReference

InnovationPack2016April2016

Copyright?2005,2016Oracleand/oritsaffiliates.Allrightsreserved.

Thissoftwareandrelateddocumentationareprovidedunderalicenseagreementcontainingrestrictionsonuseanddisclosureandareprotectedbyintellectualpropertylaws.Exceptasexpresslypermittedinyourlicenseagreementorallowedbylaw,youmaynotuse,copy,reproduce,translate,broadcast,modify,license,transmit,distribute,exhibit,perform,publish,ordisplayanypart,inanyform,orbyanymeans.Reverseengineering,disassembly,ordecompilationofthissoftware,unlessrequiredbylawforinteroperability,isprohibited.

Theinformationcontainedhereinissubjecttochangewithoutnoticeandisnotwarrantedtobeerror-free.Ifyoufindanyerrors,pleasereportthemtousinwriting.

IfthisissoftwareorrelateddocumentationthatisdeliveredtotheU.S.GovernmentoranyonelicensingitonbehalfoftheU.S.Government,thefollowingnoticeisapplicable:

U.S.GOVERNMENTENDUSERS:Oracleprograms,includinganyoperatingsystem,integratedsoftware,anyprogramsinstalledonthehardware,and/ordocumentation,deliveredtoU.S.Governmentendusersare“commercialcomputersoftware”pursuanttotheapplicableFederalAcquisitionRegulationandagency-specificsupplementalregulations.Assuch,use,duplication,disclosure,modification,andadaptationoftheprograms,includinganyoperatingsystem,integratedsoftware,anyprogramsinstalledonthehardware,and/ordocumentation,shallbesubjecttolicensetermsandlicenserestrictionsapplicabletotheprograms.NootherrightsaregrantedtotheU.S.Government.

Thissoftwareorhardwareisdevelopedforgeneraluseinavarietyofinformationmanagementapplications.Itisnotdevelopedorintendedforuseinanyinherentlydangerousapplications,includingapplicationsthatmaycreateariskofpersonalinjury.Ifyouusethissoftwareorhardwareindangerousapplications,thenyoushallberesponsibletotakeallappropriatefail-safe,backup,redundancy,andothermeasurestoensureitssafeuse.OracleCorporationanditsaffiliatesdisclaimanyliabilityforanydamagescausedbyuseofthissoftwareorhardwareindangerousapplications.

OracleandJavaareregisteredtrademarksofOracleand/oritsaffiliates.Othernamesmaybetrademarksoftheirrespectiveowners.

IntelandIntelXeonaretrademarksorregisteredtrademarksofIntelCorporation.AllSPARCtrademarksareusedunderlicenseandaretrademarksorregisteredtrademarksofSPARCInternational,Inc.AMD,Opteron,theAMDlogo,andtheAMDOpteronlogoaretrademarksorregisteredtrademarksofAdvancedMicroDevices.UNIXisaregisteredtrademarkofTheOpenGroup.

Thissoftwareorhardwareanddocumentationmayprovideaccesstoorinformationoncontent,products,andservicesfromthirdparties.OracleCorporationanditsaffiliatesarenotresponsibleforandexpresslydisclaimallwarrantiesofanykindwithrespecttothird-partycontent,products,andservicesunlessotherwisesetforthinanapplicableagreementbetweenyouandOracle.OracleCorporationanditsaffiliateswillnotberesponsibleforanyloss,costs,ordamagesincurredduetoyouraccesstooruseofthird-partycontent,products,orservices,exceptassetforthinanapplicableagreementbetweenyouandOracle.

DocumentationAccessibility

ForinformationaboutOracle'scommitmenttoaccessibility,visittheOracleAccessibilityProgramwebsiteat/pls/topic/lookup?ctx=acc&id=docacc.

AccesstoOracleSupport

OraclecustomersthathavepurchasedsupporthaveaccesstoelectronicsupportthroughMyOracleSupport.Forinformation,

visit/pls/topic/lookup?ctx=acc&id=infoorvisit

/pls/topic/lookup?ctx=acc&id=trs

ifyouarehearingimpaired.

Contents

SiebelApplicationServicesInterfaceReference1

Chapter1:What’sNewinThisRelease

Chapter2:SiebelApplicationServicesInterfaces

Overview

DefiningASIs11

AbouttheTwoTypesofASIs11

ASIUsageExamples13

Chapter3:ApplicationServicesInterfaces

AboutASIStructure15

AboutIntegrationObjectStructure15

ComponentsandFieldsinIntegrationObjects16

ListofValueFieldsinIntegrationObjects16

RelatedBusinessComponentSelectioninDatabaseUpdates17

UniqueKeysinIntegrationObjects17

ASIDataSynchronizationServices17

DataMappingforASIReleaseIndependence18

DataSynchronizationMethodsforASIs21

ExposingASIswithInterfaceTechnologies26

AboutASIsandWebServices26

ProtocolsUsedwithASIs26

HandlingErrorsforASIs27

AuthenticationandSecurityforASIs28

Chapter4:AdministeringApplicationServicesInterfaces

UsingASIs29

ConfiguringASIs29

DeactivatingASIComponentsandFields30

RealTimeandAsynchronousProcessingwithASIs31

UserScenariosforASIAdministration31

5

SiebelApplicationServicesInterfaceReferenceInnovationPack2016

Contents■

Chapter5:CustomizinganApplicationServicesInterface

AboutASIFramework33

ExtendinganASI33

CustomizingWorkflowstoUseASIs34

BuildingCustomizedInterfacesUsingtheASIFramework36

UserScenariosforASIs39

AppendixA:PredefinedApplicationServiceInterfaces

AboutPrebuiltASIs42

SiebelAccount43

SiebelAction57

SiebelBusinessAddress63

SiebelPersonalAddress65

SiebelAssets66

SiebelContact70

SiebelCUTAddressMSAGService76

SiebelCostList77

SiebelEmployee80

SiebelFinancialAccount93

SiebelForecast98

SiebelInvoice101

ExternalOpportunityCreate/ExternalOpportunityQuery/ExternalOpportunity

Update

111

ANIOpportunityMessage(PRMANI)112

ANIMessageHeader(PRMANI)122

Opportunity(PRMANI)123

DestinationChannelPartner(PRMANI)128

SourceOrganization(PRMANI)129

OpportunityAccount(PRMANI)130

SiebelOrder132

SiebelPosition149

SiebelPriceList150

SiebelQuote/ExternalQuote153

SiebelATPResponse/ExternalATPCheck168

6SiebelApplicationServicesInterfaceReferenceInnovationPack2016

Contents■

ExternalCreditCheck176

CreditCheckRequest176

CreditCheckResponse179

ExternalShipmentTracking179

ShipmentTrackingInterfaceRequest180

ShipmentTrackingInterfaceResponse181

SiebelSIAServiceRequest184

SiebelServiceRequest187

SiebelSimpleProduct191

AppendixB:SiebelCommunications,Media,andEnergy

ASIs

AboutPrebuiltCommunications,Media,andEnergyASIs202

OrderManagement203

SiebelOrder203

CustomerLifecycleManagement222

SiebelAccount222

BillingManagement232

SiebelInvoice232

SiebelInvoiceAdjustment239

CUTPaymentInterfaceIntegrationObject243

CUTAccountBalanceInterface-RequestIntegrationObject245

CUTAccountBalanceInterface-ResponseIntegrationObject246

SiebelMeterReading247

SiebelMeterUsageData248

SiebelPayment251

SiebelSimpleProduct253

TroubleTicketingManagement261

SiebelTroubleTicket261

Index

7

SiebelApplicationServicesInterfaceReferenceInnovationPack2016

Contents■

8

SiebelApplicationServicesInterfaceReferenceInnovationPack2016

1

What’sNewinThisRelease

What’sNewinSiebelApplicationServicesInterfaceReference,Siebel

InnovationPack2016

Nonewfeatureshavebeenaddedtothisguideforthisrelease.Thisguidehasbeenupdatedtoreflectonlyproductnamechanges.

NOTE:SiebelInnovationPack2016isacontinuationoftheSiebel8.1/8.2release.

9

SiebelApplicationServicesInterfaceReferenceInnovationPack2016

What’sNewinThisRelease■

10

SiebelApplicationServicesInterfaceReferenceInnovationPack2016

2

SiebelApplicationServices

InterfacesOverview

ThischapterprovidesgeneralinformationaboutOracle’sSiebelApplicationServicesInterfaces(ASIs),thedefinition,benefits,andtypesofASIs,andgeneralexamplesofASIstogiveyouanoverviewofthiscomponent.Topicsinclude:

■

DefiningASIs

■

AbouttheTwoTypesofASIs

■

ASIUsageExamples

DefiningASIs

AnApplicationServicesInterface(ASI)isarelease-independentinterfacepublishedbyOraclethatallowsyoutointegrateSiebelapplicationswithexternalapplications.AnASIisacollectionofrelatedmethods;eachmethodcontainsinputandoutputparameters.Themethodsandparametersarelistedonthebusinessservicedefinition.Simplemethodparameters(suchasastringornumber)aredefineddirectlyintheservicedefinition.Hierarchicalmethodparametersaredefinedusingintegrationobjects.

NOTE:WebServicesareusedinASIdevelopment,buttheymaynotbeapparentinthe implementationonspecificintegrationservers.ASIsarepublishedinastandardmetadataformat—suchasExtensibleMarkupLanguageDocumentTypeDefinitions(XMLDTD)andWebServicesDescriptiveLanguage/XMLSchemas(WSDL/XSD)—andarebuiltusingtheASIFramework.See

“AboutASIFramework”onpage33

formoreinformation.

SiebelASIsareprebuiltandcanbeusedimmediately.ASIsprovidearelease-independentintegrationinterfacetotheSiebelapplication,whichremainsunchangedwitheachupgradetoanewrelease.ASIsusethestandardmetadataformat,whichmakesASIslanguage-independent,sotheyreturnthesamevaluetyperegardlessoflanguagesetting.

AbouttheTwoTypesofASIs

TherearetwotypesofASIs—inboundandoutbound.

InboundASI

AninboundASIdefinesaninterfaceforservicesprovidedbyOracle.ExternalapplicationsusethistypeofASItoinvokeSiebel-providedservices.

11

SiebelApplicationServicesInterfaceReferenceInnovationPack2016

SiebelApplicationServicesInterfaceReferenceInnovationPack2016

SiebelApplicationServicesInterfacesOverview■AbouttheTwoTypesofASIs

Anexternalapplicationmakesaninboundrequestthattheinbounddispatcherreceives.BasedontheinformationintheASI,thedispatcherinvokesoneofseveralservicestopassitsdatatotheSiebelapplication—eitheradatasynchronizationservice,otherbusinessservices,oraworkflowprocess.Forfurtherdetailsaboutdatasynchronizationservices,see

“ASIDataSynchronization

Services”onpage17

.Formoreinformationaboutbusinessservicesandworkflows,seeBusinessProcessesandRules:SiebelEnterpriseApplicationIntegration.

Thedispatcherdetermineswhichservicetoinvoke,accordingtotheASIconfigurationandtransportprotocols.TheASIdetermineswhethertheservicerequestisarequest-responseoperation(aresponsecontainingthestatusoftheoperationorthedataretrieved)oraone-wayrequest(wherenoresponseisrequired).ASIsareconfiguredtohavethesameinputandoutputargument(SiebelMessage),andalwaysreturnaresponseunlessyouchangetheASIargument.ExternalapplicationscanuseinboundASIs,whichcanbeexposedasaWebservice,XML,orJava.

Figure1onpage12

showstheseprocesses.

Figure1.InboundASI

OutboundASI

AnoutboundASIdefinesaninterfacefromaSiebelapplicationtoanexternalapplicationandprovidesaproxytotheexternalapplicationthatcanbecalledfromwithintheSiebelapplication.TheSiebelapplicationinvokesthisproxytomakeaservicerequesttotheexternalapplication,solicitinginformationfromtheexternalservice,whichtheSiebeldatabaseupdatesordisplaystotheuser.

12

SiebelApplicationServicesInterfacesOverview■ASIUsageExamples

Aworkfloworauserinterfaceeventcallsanoutbounddispatcher.BasedontheASIconfiguration,thedispatcherinvokesoneofseveralservicesatruntime—SiebelServices,PartnerAdapters,XML,orWebServices.Theoutbounddispatcherlinksaservicename,interface,andtransportorprotocolbindingtotheASI,whichisalsosenttotheexternalapplication,asshownin

Figure2onpage13

.

Figure2.OutboundASIs

ASIUsageExamples

Thefollowingexamplein

Figure3onpage13

demonstrateshowtouseinboundandoutboundASIsintheworkflow.

InboundASIExample

AcustomerusinganexternalapplicationneedstoupdateanaccountwithintheSiebeldatabase.Asshownin

Figure3

,anexternalapplicationinvokesaninboundASI,SiebelAccount,toretrievethecorrectcustomerinformationfromtheSiebeldatabaseusingthemethod,QueryById.

IntheExternalAccountproxystep,anoutboundASIiscalled,andtheaccountinformationissenttotheexternalsystemsforprocessing.

Aftertheupdateiscompletedintheexternalsystem,theresponseispassedtoaninboundASI,SiebelAccount,toupdatetheinformationintheSiebeldatabase,usingtheSynchronizemethod.

Figure3.UpdateAccount

13

SiebelApplicationServicesInterfaceReferenceInnovationPack2016

SiebelApplicationServicesInterfacesOverview■ASIUsageExamples

Foramoredetaileddescriptionofthisexample,see

“CustomizingWorkflowstoUseASIs”onpage34

.

OutboundASIExample

ThefollowingexampleusesanoutboundASItoretrieveinformationanddisplayittotheuser.

AcustomerusingaSiebelapplicationmightneedtochecktheinventoryofaproduct,RequestATPCheck,tofulfillanorder.TheSiebelapplicationsendsanoutboundrequesttotheexternalsystem,retrievestheinformation,anddisplaysittotheuser.

14

SiebelApplicationServicesInterfaceReferenceInnovationPack2016

SiebelApplicationServicesInterfaceReferenceInnovationPack2016

3

Application

Services

Interfaces

ThischapterdescribestheunderlyingstructureofanApplicationServicesInterface(ASI)andthespecializedtypesofASIsusedbybusinessservices.ItalsoexplainstherelationshipbetweenASIs,EAI,andWebservices,aswellasauthenticationandsecurityissues.Topicsincludethefollowing:

■

AboutASIStructure

■

AboutIntegrationObjectStructure

■

ASIDataSynchronizationServices

■

ExposingASIswithInterfaceTechnologies

■

AboutASIsandWebServices

■

AuthenticationandSecurityforASIs

AboutASIStructure

Asdefinedearlier,anASIisaninterfacewhoseimplementationisdefinedbyabusinessserviceorworkflow.Aspecializedclassofbusinessservicesisimplementedasdatasynchronizationservices.

Figure4onpage15

showsanexampleofthestructureoftheAccountASI.ForinformationregardingspecificASIs,see

AppendixA,“PredefinedApplicationServiceInterfaces”

and

AppendixB,“Siebel

Communications,Media,andEnergyASIs.”

Figure4.AccountASI

AboutIntegrationObjectStructure

Integrationobjectsaremetadatastructuresthatrepresenthierarchicalobjectsusingcomponentsandfields.Forexample,theContactintegrationobjectmighthavethefollowingcomponents—PersonalAddress,Account,andOpportunity.

Figure5onpage16

showsasampleoftheContactintegrationobject,andtheintegrationobjectinstancecontainingthedataforContact.Thestructureofintegrationobjectsincludes:

■

“ComponentsandFieldsinIntegrationObjects”onpage16

15

SiebelApplicationServicesInterfaceReferenceInnovationPack2016

ApplicationServicesInterfaces■AboutIntegrationObjectStructure

■

“ListofValueFieldsinIntegrationObjects”onpage16

■

“RelatedBusinessComponentSelectioninDatabaseUpdates”onpage17

■

“UniqueKeysinIntegrationObjects”onpage17

Fordatasynchronizationservices,therearetwotypesofintegrationobjects.Formoreinformation

aboutdatasynchronizationservices,see

“ASIDataSynchronizationServices”onpage17

.

Formoreinformationaboutintegrationobjects,seeIntegrationPlatformTechnologies:SiebelEnterpriseApplicationIntegration.

Figure5.IntegrationObjectandIntegrationObjectInstance

ComponentsandFieldsinIntegrationObjects

Componentsdefinethehierarchyofanintegrationobject,andacomponentcontainsoneormorefieldsandchildcomponents.In

Figure5

,theContactintegrationobjecthasthesecomponents:Contact_PersonalAddress,Contact_Account,andContact_Opportunity;PersonalAddresshastheadditionalfields,PersonalAddressStateandPersonalAddressZip.

Bydefault,allfieldsareactive.However,youcandeactivatethesefieldstosatisfythedifferentrequirementsforeachASIandtoincreaseperformanceoftheASI.Formoreinformationaboutdeactivatingfieldcomponents,see

“DeactivatingASIComponentsandFields”onpage30

.

ListofValueFieldsinIntegrationObjects

FieldscanmaptoaSiebelpredefinedListofValues(LOV).Thefieldsintheintegrationcomponentsthatarebasedonsuchfieldscantakevaluesonlyfromthatlist—thefieldsareboundtothevaluesofthatLOV.Forexample,in

Figure5onpage16

,PersonalAddressStatecanmaptoanLOVofthedifferentstatesintheU.S.(suchasAZ,CA,FL,andsoon).

16

ApplicationServicesInterfaces■ASIDataSynchronizationServices

TheseLOVfieldsshouldusealanguage-independentrepresentation.ForeachLOVfield,theinternalintegrationobjectreturnsaLanguageIndependentCode(LIC)iftheuserproperty,AllLangIndependentVals,issettoYattheobjectlevel.

TheintegrationobjectcanexposetheSiebelLICormapthefieldtoanindustrystandardcode.

RelatedBusinessComponentSelectioninDatabase

Updates

WhenarowisinsertedorupdatedintheSiebeldatabase,itisoftennecessarytocreaterelationshipswithotherbusinesscomponentsthroughaforeignkey.Forexample,anaccounthasamany-to-onerelationshipwithPriceList—anaccountisassociatedwithonepricelist;thesamepricelistcanbeusedwithdifferentaccounts.ThecorrectpricelistisidentifiedbytheforeignkeyPriceListId,whichexistsintheAccountcomponent.Thisrelationshipisimplementedthroughthepicklist.

Forthistypeofintegration,apointertotheappropriatepricelistrowisstoredintheaccountrow,whereitisidentifiedbyaforeignkey.

UniqueKeysinIntegrationObjects

InternalintegrationobjectsimplementuserkeysthattheSiebelapplicationcreatesforeachcomponent,basedontheuserprimarykeydefinedfortheunderlyingtable.UserkeysareagroupoffieldswhosevaluesuniquelyidentifyonlyoneSiebelrecord.WhenanASIexecutes,itsearchesthelistofuserkeystofindthefirstkeypresentinthecomponentinstanceandusesittodeterminewhethertherecordhasamatchintheSiebeldatabase.

Youcandeactivate,modify,orcreateadditionalkeysforanASIdependingonyourbusinessandapplicationneeds.However,itisrecommendedthateachcomponentcontainasetofthreeuniquekeys:

■RowID.TheSiebelRowID.

■IntegrationID.Across-referencethatlinkstheSiebelapplicationtothecorrespondingrecordintheexternalapplication.

■UserKey.CorrespondstotheU1indexoftheunderlyingtable.

ASIDataSynchronizationServices

AdatasynchronizationserviceisaspecializedtypeofbusinessserviceusedbyaclassofASIs.DatasynchronizationservicesimportandexportdatafromSiebelapplicationsandarebasedontheframeworkprovidedbytheEAISiebeladapter.FormoreinformationabouttheEAISiebeladapter,seeIntegrationPlatformTechnologies:SiebelEnterpriseApplicationIntegration.Thecomponentsofadatasynchronizationserviceinclude:

■

“DataMappingforASIReleaseIndependence”onpage18

■

“DataSynchronizationMethodsforASIs”onpage21

SiebelApplicationServicesInterfaceReferenceInnovationPack201617

SiebelApplicationServicesInterfaceReferenceInnovationPack2016

ApplicationServicesInterfaces■ASIDataSynchronizationServices

ManyinboundASIsarebuiltusingdatasynchronizationservices,andcanalsobeusedtopopulatetheparametersofanoutboundASI.TheinboundASIisolatestheinterfaceoftheoutboundASIandprovidesaninterfacethatisindependentfromthedatamodelbyisolatingtheunderlyingdatamodelthroughtheuseofadatamap.

NOTE:DatamappingcannotbespecifiedforoutboundASIsusingtheinternalintegrationobjectanddatamapbusinessserviceuserproperties.Theseuserpropertiesareonlyforusebythedatasynchronizationbusinessservice.

Datasynchronizationservicesuseapairofintegrationobjects—theinternalintegrationobjectandtheinterfaceintegrationobject—thatdefinetheschemaoftherelease-independentinterface.Bothobjectsmustbeprovided,eveniftheyareexactlythesame,fortheASItobeupgradedatalaterdate.AninternalintegrationobjectmirrorstheschemaoftheSiebelbusinessobject,whileaninterfaceintegrationobjectdefinestheexternalrepresentationofthedata.

Figure6onpage18

illustratestheseconcepts.

Figure6.DataSynchronizationServices

ComponentandfieldnamesoftheinternalintegrationobjectmustmatchthenamesoftheunderlyingSiebelbusinessobject’scomponentsandfields.Theinterfaceintegrationobject’scomponentsandfieldsdonotneedtomatch;youdeterminethembasedonyourbusinessrequirements.

DataMappingforASIReleaseIndependence

Withindatasynchronization,adatamaptranslatesthedataintheformofintegrationobjectsbetweenaninternalintegrationobjectandaninterfaceintegrationobject,makingASIsrelease-independent.

18

SiebelApplicationServicesInterfaceReferenceInnovationPack2016

ApplicationServicesInterfaces■ASIDataSynchronizationServices

DatasynchronizationservicesusedatamappingtotranslatedatabetweenintegrationobjectsandsupportasubsetofmethodsthatareusedbytheEAISiebeladapter,suchasInsert,Update,andDelete.See

“DataSynchronizationMethodsforASIs”onpage21

formoreinformation.AnASIusuallyrequirestwotypesofdatamaps—oneforeachdirection,asshownin

Figure7onpage19

.Formoreinformationaboutdatamapping,seeBusinessProcessesandRules:SiebelEnterpriseApplicationIntegration.

Figure7.MappingBetweenIntegrationObjects

ForASIsusingdatasynchronizationservices,therearetwotypesofdatamapping—implicitdatamappingandexplicitdatamapping.

ImplicitDataMappingforIntegrationObjects

Datasynchronizationservicessupportimplicitdatamappingwhentheinternalintegrationobjectisasubsetorexactlythesameastheinterfaceintegrationobject;thereversealsoholdstrue.Implicitmappingoccurswhen:

■Asourcecomponentmapstoatargetcomponentwiththesamename.

■Asourcecomponentmapstoatargetcomponentandbothcomponentshavefieldswiththesamename.

■Datasynchronizationservicedoesnotspecificadatamap.

Everycomponent,field,andchildcomponentismappedbetweenintegrationobjects.

F