isenIntegrationApril2016Copyright?2005,2016Oracleand/oritsaffiliates.Allrightsreserved.ectualpropertylawsExceptasexpresslypermittedinwedbylawyoumaynotusecopyreproducetranslatebroadcastnsmitdistributeexhibitperformpublishordisplayanypartinanyformorbyrinteroperabilityisprohibitedTheinformationcontainedhereinissubjecttochangewithoutnoticeandisnotwarrantedtobeerrorfree.Ifyoufindanyerrors,pleasereportthemtousinwriting.heUSGovernmentthefollowingnoticeisapplicablersoftwarepursuanttotheapplicableFederalAcquisitionRegulationandcyspecificsupplementalregulationsAssuchuseduplicationdisclosuremodificationandhardwareandordocumentationshallbesubjecttolicensetermsandlicenserestrictionsapplicabletotheprogramsNootherrightsaregrantedtotheU.S.Government.reorhardwareisdevelopedforgeneraluseinavarietyofinformationmanagementnherentlydangerousapplicationsincludinglberesponsibletotakeallappropriatefailsafebackupredundancyandditsaffiliatesdisclaimanyliabilityforanydamagescausedbyuseofthissoftwareorhardwareindangerousapplications.egisteredtrademarksofOracleandoritsaffiliatesOthernamesmaybetrademarksoftheirrespectiveowners.ionalIncAMDMicroDevices.UNIXisaregisteredtrademarkofTheOpenGroup.ThissoftwareorhardwareanddocumentationmayprovideaccesstoorinformationoncontentrtycontentproductsandservicesntbetweenyouandOracleOracleCorporationandandOracle.bilityilityvisittheOracleAccessibilityProgramwebsiteathttp//pls/topic/lookup?ctx=acc&id=docacc.sstoOracleSupportOraclecustomersthathavepurchasedsupporthaveaccesstoelectronicsupportthroughMyOracleSupport.Forinformation,visit/pls/topic/lookup?ctx=acc&id=infoorvisit/pls/topic/lookup?ctx=acc&id=trsifyouarehearingimpaired.BusinessProcessesandRules:SiebelEnterpriseApplicationIntegrationSiebelInnovationPack2016■3ContentsChapter1:What’sNewinThisReleaseChapter2:DefiningWorkflowsforSiebelEAISampleIntegrationWorkflows11ImportAccount(File)11ExportAccount(File)13ImportEmployee(MQSeries)14ExportEmployee(MQSeries)17TestingtheWorkflowIntegrationProcess19ExportingtheWorkflowProcesstoanXMLFile19ImportingtheXMLFileIntoSiebelTools20RunningtheWorkflowProcessSimulator20Chapter3:CreatingandUsingDispatchRulesOverviewofEAIDispatchService23EAIDispatchServiceRuleHierarchy24EAIDispatchServiceMethods25SearchExpressionGrammar26OutputTransformation26EAIDispatchService28InboundRequests28OutboundRequests30ImplementingEAIDispatchService30CreatingaWorkflow31DefiningRuleSets32DefiningRules32DefiningTransforms32InvokingaWorkflowProcessFromanEAIDispatchService33TestingYourEAIDispatchServiceUsingArgumentTracing34DifferencesBetweenEAIDispatchServiceandWorkflow34ProcessAggregateRequestMethod35EAIDispatchServiceScenarios365BusinessProcessesandRules:SiebelEnterpriseApplicationIntegration5SiebelInnovationPack2016Contents■OutboundScenario36InboundScenario37OutboundScenariosUsingProcessAggregateRequest38ExamplesofSearchExpressionGrammar40ExamplesofDispatchOutputPropertySets42Chapter4:DataMappingUsingtheSiebelDataMapperSiebelDataMapperOverview46EAIDataMappingEngine46EAIDataMappingEngineMethods47UsingtheEAIDataMappingEngine48TheSiebelDataMapper48IntegrationObjectMaps49IntegrationComponentMaps49IntegrationFieldMaps50CreatingDataMaps50DefineIntegrationObjects50DeterminingRequiredMaps51CreatingNewDataMaps51CreatingIntegrationComponentMaps52CreatingIntegrationFieldMaps53ValidatingtheDataMap53ExamplesofWorkflowProcesses53OutboundWorkflowProcess53InboundWorkflowProcess56AboutExecutingWorkflows57EAIDataMappingEngineExpressions58AddressingFieldsinComponents60DataMappingScenario60Chapter5:DataMappingUsingScriptsOverview63EAIDataTransformation64DTEBusinessServiceMethodArguments66MapFunctions67DataTransformationFunctions696BusinessProcessesandRules:SiebelEnterpriseApplicationIntegration6SiebelInnovationPack2016Contents■SiebelMessageObjectsandMethods70IntegrationMessageObjects70CSSEAIIntMsgIn70CSSEAIIntMsgOut73IntegrationObjectObjects75CSSEAIIntObjIn75CSSEAIIntObjOut77PrimaryIntegrationComponentObjects78CSSEAIPrimaryIntCompIn78CSSEAIPrimaryIntCompOut81IntegrationComponentObjects84CSSEAIIntCompIn84CSSEAIIntCompOut87MIMEMessageObjectsandMethods90CSSEAIMimeMsgIn90CSSEAIMimeMsgOut93AttachmentsandContentIdentifiersinMIMEMessages95XMLPropertySetFunctions96Top-LevelPropertySetFunctions96XMLElementAccessors98Examples103EAIValueMaps104EAIGetValueMapFunction105EAILookupSiebelSearchFunction105EAILookupExternalSearchFunction105CSSEAIValueMapTranslateMethod106EAIGetValueMapunmappedKeyHandlerArgument106EAIGetValueMap()Method107ExceptionHandlingConsiderations108ErrorCodesandErrorSymbols109DataTransformationErrorProcessing109ExceptionHandlingFunctions110SampleSiebeleScript111Index7BusinessProcessesandRules:SiebelEnterpriseApplicationIntegration7SiebelInnovationPack2016Contents■8BusinessProcessesandRules:SiebelEnterpriseApplicationIntegration8SiebelInnovationPack20161What’sNewinThisReleaseWhat’sNewinBusinessProcessesandRules:SiebelEnterpriseApplicationIntegration,SiebelInnovationPack2016Nonewfeatureshavebeenaddedtothisguideforthisrelease.Thisguidehasbeenupdatedtoreflectonlyproductnamechanges.NOTE:SiebelInnovationPack2016isacontinuationoftheSiebel8.1/8.2release.9BusinessProcessesandRules:SiebelEnterpriseApplicationIntegration9SiebelInnovationPack2016What’sNewinThisRelease■10BusinessProcessesandRules:SiebelEnterpriseApplication10SiebelInnovationPack2016BusinessBusinessProcessesandRules:SiebelEnterpriseApplicationIntegrationSiebelInnovationPack20162DefiningWorkflowsforSiebelEAIThischapterexplainsworkflowintegrationprocessesandhowtousethemtodevelopyourintegrationprojects.ThechapterdependsonseveralsampleworkflowsthatareincludedintheSiebelBusinessApplications.Itcontainsthefollowingtopics:■“SampleIntegrationWorkflows”onpage11■“TestingtheWorkflowIntegrationProcess”onpage19NOTE:Inversion8.0andhigherofSiebelBusinessApplications,workflowprocessesarecreatedinSiebelTools.However,thesampleworkflowsinthischapterarefoundintheAdministration-BusinessProcessscreen,thentheWorkflowProcessesviewintheSiebelclient.Forinformationoncreatingworkflowprocesses,seeSiebelBusinessProcessFramework:WorkflowSampleIntegrationWorkflowsSiebelEAIincludesseveralsampleworkflowsthatillustratehowyoucanreceive,process,andsendintegrationmessages.Thischapterincludesfourofthosesamples,alongwithbriefdescriptionsthatareintendedtohelpyouunderstandtheworkflowelementsspecifictoSiebelEAI.NOTE:Oneofthemethodsofinvokingaworkflowprocessisthroughaworkflowpolicy.ToinvokeaworkflowprocessthatincludesstepsthatcallEAIadaptersfromaworkflowpolicy,youmustcreateaworkflowpolicyactionusingtheRunWorkflowProcessworkflowpolicyprogram.TheworkflowpolicyactionwillinvoketheWorkflowProcessManagercomponent.Forinformationoncreatingworkflowpolicies,seeSiebelBusinessProcessFramework:WorkflowGuide.Thesampleworkflowsexplainedinthischapterinclude:■“ImportAccount(File)”onpage11■“ExportAccount(File)”onpage13■“ImportEmployee(MQSeries)”onpage14■“ExportEmployee(MQSeries)”onpage17ThisisasampleworkflowprocessthatreadsanXMLfile(c:\account.xml)andimportstheaccountinformationintotheSiebelenvironmentusingtheEAIXMLReadfromFilebusinessservice.TheEAIXMLReadfromFilebusinessserviceconvertsthedataandtheEAISiebelAdapterupdatestheSiebel11DefiningWorkflowsforSiebelEAI■SampleIntegrationWorkflowsToreviewtheImportAccount(File)sampleworkflowprocess1NavigatetoAdministration-BusinessProcess,thenWorkflowProcesses.2QueryforImportAccount(File).3WiththeImportAccount(File)workflowprocessselected,clicktheProcessPropertiestabinthebottomapplettoreviewtheprocesspropertiesforthisworkflowprocess.Workflowprocesspropertiesareglobaltotheentireworkflow.Forexample,asshowninthefollowingtable,theImportAccount(File)workflowhasseveralproperties.TheAccountMessageisdefinedtoidentifytheoutputoftheReadFilestep(aparsedversionoftheXMLAccountMessage)asahierarchicalstructure.TheErrorMessage,ErrorCode,ObjectId,andSiebelOperationObjectIdpropertiesareincludedintheworkflowbydefault.DataDataTypeIn/OutAccountMessageHierarchyIn/OutErrorCodeStringIn/OutErrorMessageStringIn/OutObjectIdStringIn/OutSiebelOperationObjectIdStringIn/Out4ClicktheProcessDesignertabinthebottomapplettoreviewtheprocessdesignforthisworkflow5Double-clicktheReadFilesteptoreviewitsmethodandarguments.ThisstepusestheReadSiebelMessagemethodoftheEAIXMLReadfromFilebusinessservicetoconvertXMLfromafileintoanintegrationobjecthierarchy,withthefollowinginputargument.InputInputArgumentsTypeValueLiterallFileNamesNotehowthepathandfilenamearespecifiedasastringintheValuefieldoftheInputArgumentsapplet.Alsonotethefollowingoutputpropertyforthisstep.PropertyPropertyNameTypeOutputArgumentSiebelMessageOutputArgumentAccountMessage12BusinessProcessesandRules:SiebelEnterpriseApplication12SiebelInnovationPack2016DefiningWorkflowsforSiebelEAI■SampleIntegrationWorkflows6Double-clicktheUpdateAccountsteptoreviewitsmethodandarguments.ThisstepusestheEAISiebelAdapterbusinessservicewiththeInsertorUpdatemethodtoreadtheSiebelMessageandupdateorinserttheAccountobjectintheSiebelDatabase.TheEAISiebelAdapterusestheinformationintheXMLfileandthefollowinginputargumenttoaccomplishthistask.ArgumentsArgumentsTypePropertyNamePropertyDataTypeHierarchySiebelMessagePropertyAccountMessageProcessBecausetheInsertorUpdatemethodisspecifiedontheEAISiebelAdapterbusinessservice,thisstepcheckstheSiebelDatabasetoseeiftheAccountobjectdefinedintheXMLfilealreadyexistsinthedatabase.Iftheaccountexists,thenitupdatestheaccountinthedatabasewiththeaccountinstancefromtheXMLfile;otherwise,itinsertstheaccountintothedatabase.ThissampleworkflowprocessexportsanaccounttoafileinanXMLformat.ThisworkflowusestheEAISiebelAdapterandtheEAIXMLWritetoFilebusinessservicetoquerythedataandthenconvertthedatafromtheSiebelbusinessobjecttoanXMLdocument.ToreviewtheExportAccount(File)sampleworkflowprocess1NavigatetoAdministration-BusinessProcess,thenWorkflowProcesses.2QueryforExportAccount(File).3WiththeExportAccount(File)workflowprocessselected,clicktheProcessPropertiestabtoreviewtheprocesspropertiesforthisworkflowprocess.Workflowprocesspropertiesareglobaltotheentireworkflow.Forexample,asshowninthefollowingtable,theExportAccount(File)workflowhasseveralproperties.TheOutputMessagepropertyisdefinedtoidentifytheoutboundaccountasahierarchicalstructure.TheObjectIdpropertyisincludedineachworkflowbydefault.DataDataTypeIn/OutObjectIdStringIn/OutOutputMessageHierarchyIn/Out4ClicktheProcessDesignertabinthebottomapplettoreviewtheprocessdesignforthisworkflow13BusinessProcessesandRules:SiebelEnterpriseApplication13SiebelInnovationPack2016InputArgumentsInputArguments6BusinessProcessesandRules:SiebelEnterpriseApplicationIntegrationSiebelInnovationPack2016DefiningWorkflowsforSiebelEAI■SampleIntegrationWorkflows5Double-clicktheGetAccountsteptoreviewitsmethodandarguments.ThisstepusestheEAISiebelAdapterbusinessservicetoqueryanaccountfromyourSiebelDatabase.TheEAISiebelAdapterusesthefollowinginputarguments.TyTypeValuePropertyPropertyDataTypeOutputIntegrationObjectNameLiteralSampleAccount--ObjectIdProcessProperty-ObjectIdStringNotethatOutputIntegrationObjectNameofSampleAccountispartofthequerycriteria.TheSampleAccountintegrationobjectdescribesthestructureoftheAccountbusinessobjectandwascreatedusingtheIntegrationObjectBuilder.TheotherpartofthequerycriteriaistheObjectId,whichisaprocesspropertythatincludestheaccountnumber1-6definedasaprocesspropertybefore.Alsonotethefollowingoutputpropertyforthisstep.PropertyPropertyNameTypeOutputArgumentSiebelMessageOutputArgumentOutputMessageTheoutputfromthisstepisOutputMessage.OutputMessageisaprocesspropertythatwillincludetheSiebelMessage,whichcontainsdatafortheaccount.TheformatisspecifiedbytheSampleAccountintegrationobject.Double-clicktheWritetoFilesteptoreviewitsmethodandarguments.ThisstepinvokestheEAIXMLWritetoFilebusinessservicewiththeWriteSiebelMessagemethod.TheEAIXMLWritetoFileusesthefollowinginputarguments.InputArgumentsTypeValuePropertyNamePropertyDataTypeFileNameLiteral--SiebelMessageProcessProperty-OutputMessageHierarchyTheEAIXMLWritetoFilebusinessserviceconvertsthehierarchicalmessagetoXMLandwritestheresultingdocumenttothefilenamedintheFileNameargument.iesThisisasampleworkflowprocessthatreceivesanXMLstringfromanIBMMQSeriesqueueandupdatestheEmployeeinstanceintheSiebelDatabase.14DefiningWorkflowsforSiebelEAI■SampleIntegrationWorkflowsToreviewtheImportEmployee(MQSeries)sampleworkflowprocess1NavigatetoAdministration-BusinessProcess,thenWorkflowProcesses.2QueryforImportEmployee(MQSeries).3WiththeImportEmployee(MQSeries)processselected,clicktheProcessPropertiestabtoreviewitsprocessproperties.Workflowprocesspropertiesareglobaltotheentireworkflow.Forexample,asshowninthefollowingtable,theImportEmployee(MQSeries)workflowhasseveralproperties.TheEmployeeMessagecontainstheobjectasanintegrationobjecthierarchy,whenconverted.TheobjectmustbeinthatformatbeforeitcanbeinsertedorupdatedintheSiebelenvironment.TheEmployeeXMLpropertydefinestheMQSeriesmessageasXMLrecognizablebySiebelapplications.TheErrorCode,ErrorMessage,ObjectId,andSiebelOperationObjectIdpropertiesareincludedintheworkflowbydefault.DataDataTypeEmployeeMessageHierarchyIn/OutEmployeeXMLBinaryIn/OutErrorCodeStringIn/OutErrorMessageStringIn/OutObjectIdStringIn/OutSiebelOperationObjectIdStringIn/Out4ClicktheProcessDesignertabinthebottomapplettoreviewtheprocessdesignforthisworkflowNOTE:WhenusingtheMQSeriesReceiver,rememberthattheMQReceivertaskwillreadthemessagefromthequeueandpassitintoyourworkflowprocessinthe<Value>field.ThismeansyourworkflowprocessdoesnotneedtoreadthemessagefromtheMQSeriesQueue.TogettheXMLstringthathasbeenread,youneedtocreateaprocesspropertyandsetitsdefaultvalueasfollows:Name=MyXMLStringPropertyandDefault=<Value>.YoushouldusethisprocesspropertyastheinputtotheEAIXMLConverterbusinessservice.15BusinessProcessesandRules:SiebelEnterpriseApplication15SiebelInnovationPack2016DefiningWorkflowsforSiebelEAI■SampleIntegrationWorkflows5Double-clicktheReceivesteptoreviewitsmethodandarguments.ThisstepusestheReceivemethodoftheEAIMQSeriesServerTransporttogettheinboundmessagefromtheEmployeephysicalqueuenamedinthePhysicalQueueNameargument.Thisstepusesthefollowinginputarguments.InputInputArgumentsTypeValuePhysicalQueueNameLiteralEmployeeQueueManagerNameLiteralSiebelAsshowninthefollowingtable,theoutputfromthisstepisputintotheEmployeeXMLprocesspropertywiththeassumptionthattheinboundmessageisalreadyinXMLformat.PropertPropertyTypeOutputArgumentEmployeeEmployeeXMLMessageTextOutputArgument6Double-clicktheConverttoInternalsteptoreviewitsmethodandarguments.ThisstepusestheXMLtoPropertySetmethodoftheEAIXMLConvertertoconverttheinboundmessagetotheSiebelbusinessobjectformat.Thestepusesthefollowinginputargument.InputInputArgumentsTypePropertyNamePropertyDataTypeEmployeeXMLDocumentPropertyBinaryProcessXMLTheoutputfromthisstepispassedintheEmployeeMessageoutputargumentasdescribedinthefollowingtable.PropertyPropertyNameTypeOutputArgumentSiebelMessageEmployeeMessageOutputArgument7Double-clicktheUpdateEmployeesteptoreviewitsmethodandarguments.ThisstepusestheEAISiebelAdapterbusinessservicewiththeInsertorUpdatemethodandthefollowinginputargumenttoupdatethedatabase.InputInputArgumentsTypePropertyNamePropertyDataTypeHierarchySiebelMessageEmployeePropertyMessageProcessTheEAISiebelAdaptercheckstheSiebelDatabaseforanEmployeerecordthatmatchesthecurrentinstanceofEmployeeintheEmployeeMessageproperty.IfanEmployeerecordmatchingthecurrentinstancedoesnotexistinthedatabase,theEAISiebelAdapterinsertstherecordintothedatabase;otherwise,itupdatestheexistingrecordwiththeinstance.16BusinessProcessesandRules:SiebelEnterpriseApplication16SiebelInnovationPack2016DefiningWorkflowsforSiebelEAI■SampleIntegrationWorkflowsThisisasampleworkflowprocessthatsendsanXMLstringforanemployeetoanIBMMQSeriesToreviewtheExportEmployee(MQSeries)sampleworkflowprocess1NavigatetoAdministration-BusinessProcess,thenWorkflowProcesses.2QueryforExportEmployee(MQSeries).3WiththeExportEmployee(MQSeries)workflowprocessselected,clicktheProcessPropertiestabtoreviewtheprocesspropertiesdefinedforthisworkflowprocess.Workflowprocesspropertiesareglobaltotheentireworkflow.Forexample,asshowninthefollowingtable,theExportEmployee(MQSeries)workflowhasmultipleproperties.TheEmployeeMessagecontainstheobjectasanintegrationobjecthierarchy,beforeconversion.TheEmployeeXMLpropertyspecifiestheSiebelobjectthathasbeenconvertedtoXML.TheErrorCode,ErrorMessage,ObjectId,andSiebelOperationObjectIdpropertiesareincludedineachworkflowbyDefaultDefaultStringEmployeeMessageHierarchyIn/Out-EmployeeXMLinaryIn/Out-ErrorCodeStringIn/Out-ErrorMessageStringIn/Out-ObjectIdStringIn/OutSiebelOperationObjectIdStringIn/Out-DataTypeIn/OutNotethattheObjectIdprocesspropertyissetto1-548intheDefaultStringcolumn.ThisstringidentifiesanactualemployeerecordintheSiebelDatabasebyitsRowId.Youcansetthisworkflowtousetheactiveemployeerecordinsteadofspecifyingahard-codedemployeenumber.YoucanaccomplishthisbycreatingabuttonthatinvokesthisworkflowfromtheAdministration-User,thentheEmployeesview,oryoucanpassthevalueoftheObjectIdintotheworkflowprocessasaninputargument.4ClicktheProcessDesignertabinthebottomapplettoreviewtheprocessdesignforthisworkflow17BusinessProcessesandRules:SiebelEnterpriseApplication17SiebelInnovationPack2016DefiningWorkflowsforSiebelEAI■SampleIntegrationWorkflows5Double-clicktheGetEmployeesteptoreviewitsmethodandarguments.ThisstepusestheQuerymethodoftheEAISiebelAdapterbusinessservice,withthefollowinginputargumentstogetaninstanceofanEmployeerecordfromtheSiebelDatabase.TheSampleEmployeeintegrationobjectdescribesthestructureoftheEmployeebusinessobjectandwascreatedusingtheIntegrationObjectBuilderwizard.TheotherpartofthequerycriteriaistheObjectId,whichisaprocesspropertycontainingvalue1-548.PropertyPropertyDataTypeOutputIntegrationObjectNameLiteralSampleEmployee--ObjectIdProcessProperty-ObjectIdStringInputArgumentsPropertyTypeValueTheoutputfromthisstepispassedintheEmployeeMessageoutputargumentasdescribedinthefollowingtable.PropertyPropertyNameTypeOutputArgumentSiebelEmployeeMessageOutputArgumentMessage6Double-clicktheConverttoXMLsteptoreviewitsmethodandarguments.ThisstepusesthePropertySettoXMLmethodoftheEAIXMLConverterbusinessservicetoconverttheoutboundSiebelMessagetoXML.TheconverterstorestheoutboundSiebelMessageintheEmployeeXMLoutputargumentwiththefollowinginputargument.InputInputArgumentsTypePropertyNamePropertyDataTypeHierarchySiebelMessageEmployeeMessagePropertyProcessTheoutputfromthisstepispassedintotheEmployeeXMLoutputargumentasshowninthefollowingtable.PropertyPropertyNameTypeValueOutputArgumentXMLDocumentOutputArgumentEmployeeXML-18BusinessProcessesandRules:SiebelEnterpriseApplication18SiebelInnovationPack2016DefiningWorkflowsforSiebelEAI■TestingtheWorkflowIntegrationProcess7Double-clicktheSendsteptoreviewitsmethodandarguments.ThisstepinvokestheEAIMQSeriesServerTransportbusinessservicewiththeSendmethodtoputtheXMLmessageontotheMQSeriesqueue,Employee.ThemessageisrepresentedbytheMessageTextargument,asshowninthefollowingtable.InputInputArgumentsMessageTextProcessProperty-EmployeeXMLStringPhysicalQueueNameiteralEmployee--QueueManagerNameiteralSiebel--PropertyDataTypePropertyValueTypeTheQueueManagerthathandlestherequestiscalledSiebel.TheXMLmessageisputontotheEmployeequeue,whereitremainsuntilanotherapplicationretrievesitfromthequeue.TestingtheWorkflowIntegrationProcessWhenyouhavefinisheddefiningyourintegrationworkflowprocess,youcanusetheWorkflowProcessSimulatortotestitsbehavior.TheWorkflowProcessSimulator,includedintheWorkflowProcessManager,allowsyoutovalidateyourprocessesbeforedeployingtheminproductionenvironments.Whenyousimulateanintegrationprocessthatperformssomeexternalaction—forexample,theExportAccount(File)workflowwritesanXMLfiletoadisklocation—youcanverifytheendresultbycheckingiftheoutputobjectexists,orifapredeterminedeventhasoccurred.NOTE:Youcanalsoenabledetailedclientloggingandusethe/soptionforcreatingSQLspoolscripts.ThisoptionprovidesmoredetailedinformationwhenrunningtheintegrationworkflowprocessintheWorkflowProcessSimulator.Fordetails,seeSiebelRemoteandReplicationManagerAdministrationGuide.TotesttheworkflowprocessesdescribedinthischapterusingtheWorkflowProcess