enhancingignore_user_abort

SIEMENSSIEMENSSIEMENSTeamcenterIntegrationFrameworktcif13.
1ContentsWhat'snewinTeamcenterIntegrationFramework3.
11-1EfficientinstallationsusingDeploymentCenter1-1Backupandrecoverysupport1-1ImprovedJavaDatabaseConnectivity(JDBC)connectorbatchandtransactionsupport1-1TeamcenterIntegrationFrameworkoverview2-1TeamcenterIntegrationFrameworktutorialandexamples3-1InstallingandupgradingTeamcenterIntegrationFramework4-1Installationandupdateoverview4-1UsingDeploymentCentertoinstallTeamcenterIntegrationFramework4-2UsingTEMtoinstallTeamcenterIntegrationFramework4-3UsingTEMtoinstallTeamcenterIntegrationFrameworkand(optionally)Teamcenter4-4UpgradingandpatchingTeamcenterIntegrationFramework4-6UsingDeploymentCentertoupdateTeamcenterIntegrationFramework4-6UsingTEMtoupgradeTeamcenterIntegrationFramework4-8UsingTEMtopatchTeamcenterIntegrationFramework4-8ResolveTeamcenterIntegrationFrameworkdatastoremigrationconflicts4-10Retainbusinessobjectdefinitions4-14RetainJDBCsiteconfigurationsasPAX-JDBCsiteconfigurations4-15RunTeamcenterIntegrationFramework4-15RunTeamcenterIntegrationFrameworkasaservice4-16RunTeamcenterIntegrationFrameworkinstancesinacluster4-16MigratingfromGlobalServicestoTeamcenterIntegrationFramework4-20DifferencesbetweenGlobalServicesandTeamcenterIntegrationFramework4-20MigratingaGlobalServicesdatastoretoTeamcenterIntegrationFramework4-22Updatecustommappingcontrolfiles4-23GlobalServicestoTeamcenterIntegrationFrameworkpublishedclassmapping4-24MigratingaGlobalServicesconnectortoTeamcenterIntegrationFramework4-32MigratingasolutionfromGlobalServicestoTeamcenterIntegrationFramework4-32MigratingaGlobalServicesreactortoaTeamcenterIntegrationFrameworkprocess.
.
.
.
4-35MigratingacustomBPELprocesstoGroovyscripts4-37MigratingGlobalServicesemailtemplatestoTeamcenterIntegrationFramework4-37ConfiguringandmanagingTeamcenterIntegrationFrameworkoperation5-1ConfiguringTeamcenterIntegrationFramework5-1TeamcenterIntegrationFrameworkconfigurationoverview5-1Configure5-2Queueing5-8DataViews5-8Documentation5-9tcif13.
1TeamcenterIntegrationFramework3ContentsViewDefaultLogFile5-9Wizard5-9Configuringtheintegrationframeworkemailservice5-12TroubleshootingTeamcenterIntegrationFrameworktransferprocesses5-12Controllingfileuploading5-13StoppingTeamcenterIntegrationFramework5-13Managingpasswords5-14ConfiguretheApacheKarafpassword5-14EnableKarafpasswordencryption5-14ChangetheTeamcenterIntegrationFrameworksecurityrepositorypassword5-15TeamcenterIntegrationFrameworklogging5-16TeamcenterIntegrationFrameworkmessageobjects5-16ConfigureTeamcenterIntegrationFrameworkexceptionmessagelogging5-17ConfiguringTeamcenterIntegrationFrameworktracinginlogfiles5-17CustomizingTeamcenterIntegrationFramework6-1AddacustomconnectortoTeamcenterIntegrationFramework6-1ExtendingaconnectorinTeamcenterIntegrationFramework6-3UsingGroovyscripts6-4Groovyscriptingenvironment6-4CreatingaGroovyprocess6-5CreatingacustomconnectorextensionusingGroovy6-7Usingmessage-orientedmiddlewaresolutionsandscripting6-8TeamcenterIntegrationFrameworkandmessage-orientedmiddleware6-8Creatinglistenersandqueueswithscripts6-9CreateTeamcenterIntegrationFrameworkqueues6-10MonitorTeamcenterIntegrationFrameworkqueues6-11ManageTeamcenterIntegrationFrameworkjobs6-11ManageTeamcenterIntegrationFrameworkqueues6-12TeamcenterIntegrationFrameworksolutionsupport6-13UsingJAXRSscriptsinTeamcenterIntegrationFramework6-14IndexIndex-14TeamcenterIntegrationFrameworktcif13.
1ContentsChapter1:What'snewinTeamcenterIntegrationFramework3.
1EfficientinstallationsusingDeploymentCenter1-1Backupandrecoverysupport1-1ImprovedJavaDatabaseConnectivity(JDBC)connectorbatchandtransactionsupport1-1tcif13.
1TeamcenterIntegrationFrameworkChapter1:What'snewinTeamcenterIntegrationFramework3.
1EfficientinstallationsusingDeploymentCenterYoucanuseDeploymentCentertoinstallTeamcenterIntegrationFramework.
ThiscapabilitywasfirstintroducedinTeamcenterIntegrationFramework3.
0andisenhancedinTeamcenterIntegrationFramework3.
1.
DeploymentCenterisacentralizedwebapplicationfordeployingsoftwaretoTeamcenterenvironments.
DeploymentCentergivesyouaccesstomultipleenvironmentsfromasingle,centralizedlocation.
Itsimplifiestheprocessofinstallingandupdatingsoftware,automatesdeployment,andallowsyoutomanageavarietyofTeamcenterenvironmentsmoreefficiently.
TeamcenterEnvironmentManager(TEM)canstillbeusedforTeamcenterIntegrationFrameworkinstallationsandupgradesifyoursitehasestablishedproceduresusingTEM.
BackupandrecoverysupportYoucansafelyshutdownandrestartanyTeamcenterIntegrationFrameworkinstancewithoutlosinganyrequests.
ThestateofTeamcenterIntegrationFrameworkiscapturedpriortoashutdown,andtheinstanceisbroughtbacktothatstatewhenrestarted.
WhenTeamcenterIntegrationFrameworkisrunningasanodeinacluster,messagesareprocessedbyotherinstancesintheclusteruntiltherestartednoderejoinsthecluster.
SeeStoppingTeamcenterIntegrationFrameworkforrecommendedshutdownprocedures.
ImprovedJavaDatabaseConnectivity(JDBC)connectorbatchandtransactionsupportTeamcenterIntegrationFrameworkprovidesyouwiththeabilitytowritedirectlytoadatabasethroughJDBCconnectors.
Youcannowcreateandstoredifferenttypesofobjectstogetherinasingletransaction.
Saveoperationscannowalsobecommittedorrolledbacktogetherforallobjectsinabatch.
tcif13.
1TeamcenterIntegrationFramework1-1Chapter2:TeamcenterIntegrationFrameworkoverviewtcif13.
1TeamcenterIntegrationFrameworkChapter2:TeamcenterIntegrationFrameworkoverviewTeamcenterIntegrationFramework(TcIF)integratesTeamcenterwithothersystems,helpingtoautomateprocesseswhichcrosssystemboundaries.
TeamcenterIntegrationFrameworkletsyouleverageyourexistingapplicationsandintegratenewapplicationswithTeamcenterusingahighperformanceandscalableframeworkthatdecouplestheintegrationsfromtheapplicationstoreducemaintenancecomplexity.
InstallTeamcenterIntegrationFrameworkInstall(orupdate)TeamcenterIntegrationFrameworkusingDeploymentCenterorTeamcenterEnvironmentManager(TEM)asdescribedinInstallationandupdateprocess.
TheTeamcenterintegrationserverrequiresaJavadevelopmentkit(JDK)duringinstallation.
Forinformationaboutversionsofoperatingsystems,third-partysoftware,Teamcentersoftware,andsystemhardwarecertifiedforyourplatform,seetheTeamcenterCompatibilityMatrix.
ConfigureTeamcenterIntegrationFrameworkTeamcenterIntegrationFrameworkisconfiguredandadministeredusingtheTeamcenterIntegrationFrameworkconfigurationinterfaceasdescribedinConfiguringTeamcenterIntegrationFramework.
StartTeamcenterIntegrationFrameworkStarttheTeamcenterintegrationserverfromthecommandlineasdescribedinRunTeamcenterIntegrationFramework.
YoucanalsoconfigureTeamcenterIntegrationFrameworktorunasaserviceonWindowsasdescribedinRunTeamcenterIntegrationFrameworkasaservice.
tcif13.
1TeamcenterIntegrationFramework2-1Chapter3:TeamcenterIntegrationFrameworktutorialandexamplestcif13.
1TeamcenterIntegrationFrameworkChapter3:TeamcenterIntegrationFrameworktutorialandexamplesATeamcenterIntegrationFrameworktutorialandsetofexamplesisavailablefromtheTeamcenterIntegrations&SolutionssectionoftheGTACwebsite(http://www.
siemens.
com/gtac).
Thedownloadablearchivecontains:ExampleswithsamplecodetoaddressdifferentusesofTeamcenterIntegrationFramework.
SamplecodetoimplementtoolsthatsimplifyTeamcenterIntegrationFrameworkdevelopment.
InstructionsforinstallingandusingtheTeamcenterIntegrationFrameworktutorial,tools,andexamples.
tcif13.
1TeamcenterIntegrationFramework3-1Chapter4:InstallingandupgradingTeamcenterIntegrationFrameworkInstallationandupdateoverview4-1UsingDeploymentCentertoinstallTeamcenterIntegrationFramework4-2UsingTEMtoinstallTeamcenterIntegrationFramework4-3UsingTEMtoinstallTeamcenterIntegrationFrameworkand(optionally)Teamcenter4-4UpgradingandpatchingTeamcenterIntegrationFramework4-6UsingDeploymentCentertoupdateTeamcenterIntegrationFramework4-6UsingTEMtoupgradeTeamcenterIntegrationFramework4-8UsingTEMtopatchTeamcenterIntegrationFramework4-8ResolveTeamcenterIntegrationFrameworkdatastoremigrationconflicts4-10Retainbusinessobjectdefinitions4-14RetainJDBCsiteconfigurationsasPAX-JDBCsiteconfigurations4-15RunTeamcenterIntegrationFramework4-15RunTeamcenterIntegrationFrameworkasaservice4-16RunTeamcenterIntegrationFrameworkinstancesinacluster4-16MigratingfromGlobalServicestoTeamcenterIntegrationFramework4-20DifferencesbetweenGlobalServicesandTeamcenterIntegrationFramework4-20MigratingaGlobalServicesdatastoretoTeamcenterIntegrationFramework4-22Updatecustommappingcontrolfiles4-23GlobalServicestoTeamcenterIntegrationFrameworkpublishedclassmapping4-24MigratingaGlobalServicesconnectortoTeamcenterIntegrationFramework4-32MigratingasolutionfromGlobalServicestoTeamcenterIntegrationFramework4-32MigratingaGlobalServicesreactortoaTeamcenterIntegrationFrameworkprocess.
.
.
.
4-35MigratingacustomBPELprocesstoGroovyscripts4-37MigratingGlobalServicesemailtemplatestoTeamcenterIntegrationFramework4-37tcif13.
1TeamcenterIntegrationFrameworkChapter4:InstallingandupgradingTeamcenterIntegrationFrameworkInstallationandupdateoverviewYoucancreateastand-aloneTeamcenterIntegrationFrameworkoraTeamcenterIntegrationFrameworkinanexistingTeamcenterenvironment.
Astand-aloneTeamcenterIntegrationFrameworkcanrunonaseparatehostfromtheTeamcenterserver.
BeawarethatTeamcenterIntegrationFrameworkrequiresthesamenumberoflicensesasthenumberofthesite'sTeamcenterauthorlicensesoraminimumof20,whicheverisgreater.
DeploymentCenterandTeamcenterEnvironmentManager(TEM)canbeusedtoinstallandupdateTeamcenterIntegrationFramework.
Thebesttoolsandstepsvarydependingonyoursite'sconfigurationandrequirements.
Usethefollowinginformationtodeterminethebestapproachforyoursite.
InstallationutilityTeamcenterIntegrationFrameworkinstallationorupgradetypeTEMDeploymentCenterNotesInstallasstandalone(noTeamcenter)XInstallTeamcenterwithTeamcenterIntegrationFrameworkXInstallonanexistingTeamcentersinglemachineenvironmentXXDeploymentCenterrequiresascannedTeamcenterenvironment.
InstallonanexistingTeamcenterdistributedenvironmentXDeploymentCenterrequiresascannedTeamcenterenvironment.
Patchorupgradefromaversionbefore3.
0XUpdateorpatchversion3.
0(configuredasstandalone)XXDeploymentCenterrequiresTeamcenterIntegrationFrameworkmusthavebeenpreviouslyinstalledusingDeploymentCenter.
Patch3.
0(configuredaspartofacluster)XInstallusingDeploymentCenterSeeUsingDeploymentCentertoinstallTeamcenterIntegrationFramework.
tcif13.
1TeamcenterIntegrationFramework4-1Chapter4:InstallingandupgradingTeamcenterIntegrationFrameworkInstallusingTEMStandalone(oratthesametimeasTeamcenter):seeUsingTEMtoinstallTeamcenterIntegrationFrameworkand(optionally)Teamcenter.
OnamachinewithanexistingTeamcenterinstallation:seeUsingTEMtoinstallTeamcenterIntegrationFramework.
UpdateusingDeploymentCenterSeeUsingDeploymentCentertoupdateTeamcenterIntegrationFramework.
PatchorupgradeusingTEMSeeUsingTEMtoupgradeTeamcenterIntegrationFramework.
CreatingclustersandupdatingexistingclustersForinstructionsoncreatingandupdatingTeamcenterIntegrationFrameworkclusters,seeRunTeamcenterIntegrationFrameworkinstancesinacluster.
UsingDeploymentCentertoinstallTeamcenterIntegrationFrameworkYoucanuseDeploymentCenterforaquickerandsimplifiedTeamcenterIntegrationFrameworkinstallation:WhenyouareinstallingTeamcenterIntegrationFrameworkonamachinewithTeamcenteralreadyinstalled.
WheninstallinginaTeamcenterinstallationinadistributedenvironmentthatcanbescannedbyDeploymentCenter.
SiteswithestablishedTEMprocessesmaychoosetouseTEM.
ForinstructionsonusingDeploymentCenter,seetheDeploymentCenterhelpcollectionavailableontheSiemensPLMSoftwareDocCenter.
UsethefollowingstepstoinstallTeamcenterIntegrationFramework:1.
DownloadboththeTeamcenterFoundationandTeamcenterIntegrationFrameworksoftwarekitsfromtheGlobalTechnicalAccessCenter(GTAC)andplacethemintheDeploymentCentersoftwarerepository.
SoftwarekitssupportingseveralconfigurationsareavailablefromGTAC.
EnsureyouhavethecorrectsoftwarekitsfortheoperatingsystemandversionofTeamcenterandTeamcenterIntegrationFrameworkyouareinstalling.
2.
LogontoDeploymentCenterandclicktheSoftwareRepositoriestiletoviewtheTeamcenterFoundationandTeamcenterIntegrationFrameworksoftwarekits,verifyingtheiravailabilityinthesoftwarerepository.
3.
ClicktheEnvironmentstiletodisplaytheavailableenvironments.
SelectanexistingscannedTeamcenterenvironmenttousetoinstallTeamcenterIntegrationFrameworkoranotherexistingTeamcenterenvironmenttouse.
4-2TeamcenterIntegrationFrameworktcif13.
1Chapter4:InstallingandupgradingTeamcenterIntegrationFrameworkInstallingandupgradingTeamcenterIntegrationFramework4.
ClicktheDeploySoftwaretab.
IntheSoftwaretask,addtheTeamcenterIntegrationFrameworksoftwaretotheSelectedSoftwarelist.
5.
IntheOptionstask,selecttheoptionsforyourenvironment.
6.
IntheApplicationstask,updateyourselectedapplicationswiththefollowingavailableapplications:IntegrationFrameworkCoreThefundamentalTeamcenterIntegrationFrameworkcomponents.
IntegrationFrameworkforApplicationsTheintegrationwithyourselectedTeamcenterenvironment.
7.
IntheComponentstask,bringeachcomponenttoa100%completestatusbysupplyingtherequiredsettingsforeach.
Whilesupplyingsettings,recordvaluessuchasusernamesandpasswordsforlaterreference.
8.
IntheDeploytask,generatetheinstallationscripts.
9.
FollowthestepsinRunthedeploymentscriptsintheDeploymentCenterhelpcollectiontorunthedeploymentscriptsforyourTeamcenterIntegrationFrameworkenvironment.
10.
AfteryoureceivetheDeploymentactionsuccessfullycompletedmessagefromtheconsolefromwhichyouranthedeploymentscript,TeamcenterIntegrationFrameworkisinstalled.
StartTeamcenterIntegrationFrameworkasdescribedinRunTeamcenterIntegrationFramework.
UsingTEMtoinstallTeamcenterIntegrationFrameworkUseTeamcenterEnvironmentManager(TEM)withthefollowingproceduretoinstallTeamcenterIntegrationFrameworkonamachinewithTeamcenteralreadyinstalled.
1.
OpenaTeamcentercommandpromptandstartTEMfromthe\installdirectoryofanexistingTeamcenterenvironment.
Alternatively,youcanstartTEMfromtheTeamcentersoftwaredistributionimagewiththeJavaruntimeenvironment(JRE)youwanttouse,forexampleTC_ROOT\install\tem-jre"C:\ProgramFiles\Java\jdk1.
7.
0_17\jre"2.
OntheMaintenancepanel,chooseUpdatesManager.
3.
OntheApplyUpdatespanel,specifythelocationoftheTeamcenterIntegrationFrameworkkitinUpdatekitlocation.
4.
OntheDiagnosticspanel,enteralogdirectoryandclickRun.
5.
OntheConfirmationpanel,clickStart.
Whenthecopyingcompletes,restartTEM.
6.
OntheMaintenancepanel,chooseConfigurationManager.
tcif13.
1TeamcenterIntegrationFramework4-3InstallingandupgradingTeamcenterIntegrationFrameworkChapter4:InstallingandupgradingTeamcenterIntegrationFramework7.
OntheConfigurationMaintenancepanel,choosePerformmaintenanceonanexistingconfiguration.
8.
OntheFeatureMaintenancepanel,underTeamcenter,chooseAdd/RemoveFeatures.
9.
OntheFeaturepanel,expandPlatformExtensibility>IntegrationFrameworkandchooseIntegrationFrameworkCore.
10.
Continuethroughtheremainingpanelsbyacceptingthedefaultvalues.
YoucanclickAdvancedtochoosedifferentports.
Thedefaultvaluesare:WebServerPort:8080SecurityPort:9001WebUIPort:8040ActiveMQPort:61616RestServicesPort:8090Ifyouchangethedefaultvalues,makenoteofthem.
YouneedtheWebServerPortnumberwhendefiningyoursitesinTeamcenter,andyouneedtheWebUIPortnumbertoaccesstheTeamcenterIntegrationFrameworkconfigurationinterfacewhenyouentertheaddressdirectlyinawebbrowser.
TEMdisplaystheConfirmationpanel.
ClickStarttoconfirmthesettingsandstarttheTeamcenterIntegrationFrameworkinstallation.
Itmaytakeseveralminutestocompletetheinstallation.
TEMdisplaysasuccessmessagewhentheinstallationcompletes.
OnWindowssystems,ashortcuticonforstartingTeamcenterIntegrationFrameworkisplacedonyourdesktop.
Alternatively,youcanstartTeamcenterIntegrationFrameworkinacommandpromptwindowbyrunningthetrunscriptinthetcif\container\bindirectory.
OnLinuxandUNIXsystems,youcanstartTeamcenterIntegrationFrameworkininteractivemodebyrunningthetrunscriptinthetcif/container/bindirectory.
Alternatively,youcanstarttheapplicationasabackgroundprocessbyrunningthestartscriptinthesamedirectory.
UsingTEMtoinstallTeamcenterIntegrationFrameworkand(optionally)TeamcenterUsethefollowingstepstocreateastand-aloneTeamcenterIntegrationFramework.
BeawarethatTeamcenterIntegrationFrameworkrequiresthesamenumberoflicensesasthenumberofthesite'sTeamcenterauthorlicensesoraminimumof20,whicheverisgreater.
1.
Ifyouareinstallingastand-aloneTeamcenterIntegrationFramework,orareinstallingTeamcenterIntegrationFrameworkatthesametimeasinstallingTeamcenter,beginyourinstallationwiththefollowingsteps:a.
StartTeamcenterEnvironmentManager(TEM)fromtheTeamcentersoftwaredistributionimage.
Alternatively,youcanstartTEMfromthecommandlineoftheTeamcentersoftwaredistributionimagewiththeJavaruntimeenvironment(JRE)thatyouwanttouse,forexample:C:\apps\tc111_win\tem-jre"D:\ProgramFiles\Java\jdk1.
7.
0_17\jre"4-4TeamcenterIntegrationFrameworktcif13.
1Chapter4:InstallingandupgradingTeamcenterIntegrationFrameworkInstallingandupgradingTeamcenterIntegrationFrameworkb.
SelectthelanguageintheInstallerLanguagedialogbox.
c.
ChooseTeamcenterintheWelcometoTeamcenterpanel.
d.
ClickInstallintheInstall/UpgradeOptionspanel.
e.
OntheMediaLocationspanel,specifythelocationofthemediausedforthecurrentTeamcenterinstallationforOriginalMediaLocation.
Then,browsetoandselecttheTeamcenterIntegrationFrameworkmedialocation,addingittotheUpdateLocationlist.
f.
TypeanewidentificationanddescriptionintheConfigurationpanelifyoudonotwanttousethedefaultvalues.
2.
IntheFeaturespanel,expandExtensions→PlatformExtensibility.
IfyouareconnectingtoTeamcenterEnterprise,selectEnterpriseIntegration.
IfyouareconnectingtoProductMasterManager,selectPMMIntegration.
IfyouareconnectingtoSupplierRelationshipManagement,selectSRMIntegration.
(SRMIntegrationrequiresaseparatekit.
)IfyouareconnectingtoSubstanceCompliance,selectSubstanceComplianceIntegration.
.
NoteTousetheEnterpriseIntegration,TEMmustbeabletoaccesstheTeamcenterEnterpriseconnectorfiles(mti.
jarandmtiems.
jar)forthesite.
Youmustsupplytheirlocationinalaterstep.
IfyouareinstallinginanexistingTeamcenterenvironment,youcannotchangetheinstallationdirectory.
TeamcenterIntegrationFrameworkisinstalledinthetcifdirectoryunderyourexistingTC_ROOTdirectory.
Otherwise,youcanenterthepathtothedesireddirectoryandTeamcenterIntegrationFrameworkisinstalledinthetcifdirectoryunderthepathyouenter.
3.
Ifyouareinstallingastand-aloneTeamcenterIntegrationFramework,enterthepathtotheJavaDevelopmentKit(JDK)inthePathboxoftheJavaDevelopmentKitpanel.
4.
YoucanacceptthedefaultportnumbersorclickAdvancedtochoosedifferentports.
Thedefaultvaluesare:WebServerPort:8080SecurityPort:9001WebUIPort:8040ActiveMQPort:61616RestServicesPort:8090Ifyouchangethedefaultvalues,makenoteofthem.
YouneedtheWebServerPortnumberwhendefiningyoursitesinTeamcenter,andyouneedtheWebUIPortnumbertoaccesstheTeamcenterIntegrationFrameworkconfigurationinterfacewhenyouentertheaddressdirectlyinawebbrowser.
tcif13.
1TeamcenterIntegrationFramework4-5InstallingandupgradingTeamcenterIntegrationFrameworkChapter4:InstallingandupgradingTeamcenterIntegrationFramework5.
IfyouareconnectingtoTeamcenterEnterprise,enterthepathtotheTeamcenterEnterpriseconnectorfiles(mti.
jarandmtiems.
jar)intheEnterpriseIntegrationSettingpanel.
TEMdisplaystheConfirmationpanel.
ClickStarttoconfirmthesettingsandstarttheTeamcenterIntegrationFrameworkinstallation.
Itmaytakeseveralminutestocompletetheinstallation.
TEMdisplaysasuccessmessagewhentheinstallationcompletes.
OnWindowssystems,ashortcuticonforstartingTeamcenterIntegrationFrameworkisplacedonyourdesktop.
Alternatively,youcanstartTeamcenterIntegrationFrameworkinacommandpromptwindowbyrunningthetrunscriptinthetcif\container\bindirectory.
OnLinuxandUNIXsystems,youcanstartTeamcenterIntegrationFrameworkininteractivemodebyrunningthetrunscriptinthetcif/container/bindirectory.
Alternatively,youcanstarttheapplicationasabackgroundprocessbyrunningthestartscriptinthesamedirectory.
UpgradingandpatchingTeamcenterIntegrationFrameworkUsingDeploymentCentertoupdateTeamcenterIntegrationFrameworkTeamcenterIntegrationFramework3.
0accompaniedTeamcenter11.
4.
SiemensPLMSoftwarerecommendsusingDeploymentCentertoupdateTeamcenterIntegrationFramework3.
0tolaterversions.
However,siteswithestablishedTEMprocessesmaychoosetouseTEM.
WhenupgradingTeamcenterIntegrationFramework,yourlocaldatastoreismigratedtobecompatiblewiththecurrentTeamcenterIntegrationFrameworkrelease.
UsethefollowingstepstoupdateTeamcenterIntegrationFramework3.
0orlaterusingDeploymentCenter.
ForinstructionsonusingDeploymentCenter,seetheDeploymentCenterhelpcollectionavailableontheSiemensPLMSoftwareDocCenter.
1.
FromtheGlobalTechnicalAccessCenter(GTAC),downloadthefollowingsoftwarekitsandplacethemintheDeploymentCentersoftwarerepository:TheversionofTeamcenterIntegrationFrameworktowhichyouareupdating.
TheTeamcenterFoundationkitrequiredtosupporttheupdatedversionofTeamcenterIntegrationFramework.
SoftwarekitssupportingseveralconfigurationsareavailablefromGTAC.
EnsureyouhavethecorrectsoftwarekitsfortheyouroperatingsystemandversionofTeamcenteranTeamcenterIntegrationFramework.
2.
LogontoDeploymentCenterandclicktheSoftwareRepositoriestiletoviewtheTeamcenterFoundationandTeamcenterIntegrationFrameworksoftwarekits,verifyingtheiravailabilityinthesoftwarerepository.
3.
ClicktheEnvironmentstiletodisplaytheenvironmentsinDeploymentCenter.
SelecttheenvironmentforwhichyouwanttoupdateTeamcenterIntegrationFramework.
4.
ClicktheDeploySoftwaretab.
IntheSoftwaretask,addtheTeamcenterFoundationsoftwaretotheSelectedSoftwarelistifitisnotalreadylisted.
Then,addtheTeamcenterIntegrationFrameworksoftwaretotheSelectedSoftwarelist.
4-6TeamcenterIntegrationFrameworktcif13.
1Chapter4:InstallingandupgradingTeamcenterIntegrationFrameworkInstallingandupgradingTeamcenterIntegrationFramework5.
IntheOptionstask,reviewtheexistingoptionsasneeded.
6.
IntheApplicationstask,verifytheTeamcenterIntegrationFrameworkapplicationsaremarkedforupdating.
7.
IntheComponentstask,bringeachcomponenttoa100%completestatusbysupplyingtherequiredsettingsforeach.
Whilesupplyingsettings,recordvaluessuchasusernamesandpasswordsforlaterreference.
8.
IntheDeploytask,generatetheinstallationscripts.
9.
FollowthestepsinRunthedeploymentscriptsintheDeploymentCenterhelpcollectiontorunthedeploymentscriptsforyourTeamcenterIntegrationFrameworkenvironment.
OnceyoureceivetheDeploymentactionsuccessfullycompletedmessagefromtheconsolefromwhichyouranthedeploymentscript,TeamcenterIntegrationFrameworkisupdated.
ThepreviousTeamcenterIntegrationFrameworkisarchived,remainsfunctional,andcanbestartedifnecessary.
ThepreviousTeamcenterIntegrationFrameworkisarchivedatthefollowinglocation:TcIF_ROOT\tcif_10.
EvaluatethefilesinTcIF_ROOT/container/etctoensureallcustomfileshavebeenmigratedfromtheoldTeamcenterIntegrationFramework.
ManuallycopyanyfilesthathavenotbeenmigratedfromthearchivedTeamcenterIntegrationFrameworkinstallation.
11.
EvaluatethefilesinTcIF_ROOT/container/deploytoensureallcustomfileshavebeenmigratedfromtheoldTeamcenterIntegrationFramework.
ManuallycopyanyfilesthathavenotbeenmigratedfromthearchivedTeamcenterIntegrationFrameworkinstallation.
12.
CustomfeaturefilesintheTcIF_ROOT/container/deploydirectorythatrefertotheoldTeamcenterIntegrationFrameworkversionwillnotdeploycorrectly.
UpdatethefilestorefertothelatestTeamcenterIntegrationFrameworkversion.
13.
IfcustombundlesspecificallyusetheoldTeamcenterIntegrationFrameworkversion,updatethesebundlestousethelatestTeamcenterIntegrationFrameworkversion.
14.
StartTeamcenterIntegrationFramework.
(OnUNIX,startTeamcenterIntegrationFrameworkfromaconsoleandnotasabackgroundprocess.
)ThedatastoremigrationoccursthefirsttimetheupgradedTeamcenterIntegrationFrameworkisstarted.
Oncethemigrationiscomplete,TeamcenterIntegrationFrameworkrestartsautomatically.
Theconsolewindowshowsthemigrationstatus,andmigrationinformationiscapturedintheTeamcenterIntegrationFrameworklogfileTcIF_ROOT/container/log/tesb.
log.
Afterthemigration,youmayneedtomanuallyresolvemigrationconflictsiffilesinthenewdatastorehavethesamenamesasfilesintheolddatastore,yettheircontentsdiffer.
SeeResolveTeamcenterIntegrationFrameworkdatastoremigrationconflictsforguidance.
Onceconflictsareresolved,TeamcenterIntegrationFrameworkisreadyforuse.
tcif13.
1TeamcenterIntegrationFramework4-7InstallingandupgradingTeamcenterIntegrationFrameworkChapter4:InstallingandupgradingTeamcenterIntegrationFrameworkUsingTEMtoupgradeTeamcenterIntegrationFrameworkWhenupgradingTeamcenterIntegrationFramework,yourlocaldatastoreismigratedtobecompatiblewiththecurrentTeamcenterIntegrationFrameworkrelease.
UpgradinginstallsTeamcenterIntegrationFrameworkinanewdirectory,leavingthepreviousTeamcenterIntegrationFrameworkinstallationfunctional.
Usethefollowingprocessforupgradingyourinstance.
1.
UseTeamcenterEnvironmentManager(TEM)toupgradeTeamcenterIntegrationFramework.
2.
EvaluatethefilesinTcIF_ROOT/container/etctoensureallcustomfileshavebeenmigratedfromtheoldTeamcenterIntegrationFramework.
Manuallycopyanyfilesthathavenotbeenmigrated.
3.
EvaluatethefilesinTcIF_ROOT/container/deploytoensureallcustomfileshavebeenmigratedfromtheoldTeamcenterIntegrationFramework.
Manuallycopyanyfilesthathavenotbeenmigrated.
4.
CustomfeaturefilesintheTcIF_ROOT/container/deploydirectorythatrefertotheoldTeamcenterIntegrationFrameworkversionwillnotdeploycorrectly.
UpdatethefilestorefertothelatestTeamcenterIntegrationFrameworkversion.
5.
IfcustombundlesspecificallyusetheoldTeamcenterIntegrationFrameworkversion,updatethesebundlestousethelatestTeamcenterIntegrationFrameworkversion.
6.
StartTeamcenterIntegrationFramework.
ThedatastoremigrationoccursthefirsttimetheupgradedTeamcenterIntegrationFrameworkisstarted.
Oncethemigrationiscomplete,TeamcenterIntegrationFrameworkrestartsautomatically.
Theconsolewindowshowsthemigrationstatus,andmigrationinformationiscapturedintheTeamcenterIntegrationFrameworklogfileTcIF_ROOT/container/log/tesb.
log.
Afterthemigration,youmayneedtomanuallyresolvemigrationconflictsiffilesinthenewdatastorehavethesamenamesasfilesintheolddatastore,yettheircontentsdiffer.
SeeResolveTeamcenterIntegrationFrameworkdatastoremigrationconflictsforguidance.
Onceconflictsareresolved,TeamcenterIntegrationFrameworkisreadyforuse.
UsingTEMtopatchTeamcenterIntegrationFrameworkWhenpatchingTeamcenterIntegrationFramework,yourlocaldatastoreismigratedtobecompatiblewiththecurrentTeamcenterIntegrationFrameworkrelease.
IfyoursiteispartofaTeamcenterIntegrationFrameworkcluster,theclusterdatastoreisalsomigrated.
Inadditiontodatastores,custombundles,featurefiles,andasetofTeamcenterIntegrationFrameworkconfigurationfilesaremigrated.
WhenanexistingTeamcenterIntegrationFrameworkinstallationispatched,thepreviousTeamcenterIntegrationFrameworkinstallationismovedtoabackupdirectoryprovidedbytheadministratorduringtheTeamcenterEnvironmentManager(TEM)patchprocess.
ThepreviousTeamcenterIntegrationFrameworkinstallationremainsfunctionalifitisastandaloneinstallation.
Ifitispartofacluster,itcontinuestobefunctionaluntilthesharedclusterdatastoreismigratedtothelatestversion.
Atthatpoint,thepreviousTeamcenterIntegrationFrameworkinstallationmaynolongerworkwiththelatestfilesinthedatastore.
4-8TeamcenterIntegrationFrameworktcif13.
1Chapter4:InstallingandupgradingTeamcenterIntegrationFrameworkInstallingandupgradingTeamcenterIntegrationFrameworkAfterthepreviousTeamcenterIntegrationFrameworkinstallationismovedtothebackupdirectory,thenewTeamcenterIntegrationFrameworkversionisinstalledintheoriginalinstallationdirectory.
ThestepsforpatchingastandaloneTeamcenterIntegrationFrameworkinstancedifferfromthoseforpatchingaTeamcenterIntegrationFrameworkinstancethatispartofacluster.
Eachprocessincludesmanuallyverifyingthatanysite-specificcustomizationshaveproperlymigrated.
Usethefollowinggeneralprocessesforpatchingyourinstance.
PatchingastandaloneTeamcenterIntegrationFrameworkinstance1.
UseTEMtopatchTeamcenterIntegrationFramework.
2.
EvaluatethefilesinTcIF_ROOT/container/etctoensureallcustomfileshavebeenmigratedfromtheoldTeamcenterIntegrationFramework.
Manuallycopyanyfilesthathavenotbeenmigrated.
3.
EvaluatethefilesinTcIF_ROOT/container/deploytoensureallcustomfileshavebeenmigratedfromtheoldTeamcenterIntegrationFramework.
Manuallycopyanyfilesthathavenotbeenmigrated.
4.
CustomfeaturefilesintheTcIF_ROOT/container/deploydirectorythatrefertotheoldTeamcenterIntegrationFrameworkversionwillnotdeploycorrectly.
UpdatethefilestorefertothelatestTeamcenterIntegrationFrameworkversion.
5.
IfcustombundlesspecificallyusetheoldTeamcenterIntegrationFrameworkversion,updatethesebundlestousethelatestTeamcenterIntegrationFrameworkversion.
6.
StartTeamcenterIntegrationFramework.
ThedatastoremigrationoccursthefirsttimethepatchedTeamcenterIntegrationFrameworkisstarted.
Oncethemigrationiscomplete,TeamcenterIntegrationFrameworkrestartsautomatically.
Theconsolewindowshowsthemigrationstatus,andmigrationinformationiscapturedintheTeamcenterIntegrationFrameworklogfileTcIF_ROOT/container/log/tesb.
log.
Afterthemigration,youmayneedtomanuallyresolvemigrationconflictsiffilesinthenewdatastorehavethesamenamesasfilesintheolddatastore,yettheircontentsdiffer.
SeeResolveTeamcenterIntegrationFrameworkdatastoremigrationconflictsforguidance.
Onceconflictsareresolved,TeamcenterIntegrationFrameworkisreadyforuse.
WhenpatchingfromareleaseearlierthanTeamcenterIntegrationFramework3.
0(deliveredwithTeamcenter11.
4),beawarethatSSOisdisabledbydefaultinthenewTeamcenterIntegrationFrameworkinstallationandmustbemanuallyenabledifdesired.
PatchingaTeamcenterIntegrationFrameworkinstancethatispartofacluster1.
ShutdownallTeamcenterIntegrationFrameworkinstancesthatarepartofthecluster.
2.
Backupthedatabaseusedbythecluster.
3.
Oneinstanceatatime,performthefollowingstepsoneachinstanceinthecluster.
a.
UseTEMtopatchTeamcenterIntegrationFrameworkontheinstance.
tcif13.
1TeamcenterIntegrationFramework4-9InstallingandupgradingTeamcenterIntegrationFrameworkChapter4:InstallingandupgradingTeamcenterIntegrationFrameworkb.
EvaluatethefilesinTcIF_ROOT/container/etctoensureallcustomfileshavebeenmigratedfromtheoldTeamcenterIntegrationFramework.
Manuallycopyanyfilesthathavenotbeenmigrated.
c.
EvaluatethefilesinTcIF_ROOT/container/deploytoensureallcustomfileshavebeenmigratedfromtheoldTeamcenterIntegrationFramework.
Manuallycopyanyfilesthathavenotbeenmigrated.
d.
CustomfeaturefilesintheTcIF_ROOT/container/deploydirectorythatrefertotheoldTeamcenterIntegrationFrameworkversionwillnotdeploycorrectly.
UpdatethefilestorefertothelatestTeamcenterIntegrationFrameworkversion.
e.
IfcustombundlesspecificallyusetheoldTeamcenterIntegrationFrameworkversion,updatethesebundlestousethelatestTeamcenterIntegrationFrameworkversion.
4.
Oncealloftheinstancesintheclusterhavebeenpatched,startTeamcenterIntegrationFrameworkoneinstanceatatime.
Ensurethataninstancehasstartedandhassuccessfullycompleteditsdatastoremigrationbeforestartingthenextinstance.
Whenthefirstinstanceisstarted,thelocaldatastoremigrationoccursandisfollowedbytheclusterdatastoremigration.
Forthesubsequentinstances,onlytheirlocaldatastoresaremigrated,astheclusterdatastorehasalreadybeenmigrated.
Oncethedatastoremigrationiscompleteoneachinstance,TeamcenterIntegrationFrameworkrestartsautomatically.
Afteramigration,youmayneedtomanuallyresolvemigrationconflictsiffilesinthenewdatastorehavethesamenamesasfilesintheolddatastore,yettheircontentsdiffer.
SeeResolveTeamcenterIntegrationFrameworkdatastoremigrationconflictsforguidance.
ResolveTeamcenterIntegrationFrameworkdatastoremigrationconflictsMigrationartifactsYoumustmanuallyresolvemigrationconflictswhenfilesinthenewdatastorehavethesamenamesasfilesintheolddatastore,yettheircontentsdiffer.
Toaidinresolvingtheseconflicts,severalfilesrelatedtothemigrationareplacedintheTcIF_ROOT/container/migratedirectoryduringthemigrationprocess.
Thedirectorycontainsa/rundirectorywithsubdirectoriesuniquelynamedforeachmigrationrun.
Duringthemigration,theresultsofthemigrationaredisplayedinaconsolewindowandloggedtothefollowingfile:TcIF_ROOT/container/log/tesb.
log.
StandaloneTeamcenterIntegrationFrameworkinstallation:ThefollowingfilesarebackedupintheTcIF_ROOT/container/migrate/run/unique_iddirectory:LocalOldDS.
zipAfullbackupofthepreviousTeamcenterIntegrationFrameworkdatastore.
LocalNewDS_initial.
zipAsnapshotofthenewTeamcenterIntegrationFrameworkdatastorewithinitialfiles.
LocalNewDS_updated.
zip4-10TeamcenterIntegrationFrameworktcif13.
1Chapter4:InstallingandupgradingTeamcenterIntegrationFrameworkInstallingandupgradingTeamcenterIntegrationFrameworkAsnapshotofthenewTeamcenterIntegrationFrameworkdatastorewithinitialfilesandmigratedfilesfromthepreviousdatastore.
LocalNewDS_final.
zipAfullbackupofthecompletelymigrateddatastore.
Thefollowingmigration-relatedfilesarestoredintheTcIF_ROOT/container/migrate/run/unique_iddirectory:LocalFilesToDrop.
txtAlistoffilesthatwerenotmigratedfromthepreviousTeamcenterIntegrationFrameworkdatastorebecausetheyarenotrequiredbytheupdatedTeamcenterIntegrationFrameworkversion.
LocalFilesToOverlay.
zipThefilesthatweremigratedfromthepreviousTeamcenterIntegrationFrameworkdatastore,regardlessofwhetherthesamefilesalsoexistedintheupdatedTeamcenterIntegrationFrameworkdatastorebydefault.
Preservingthesefilesensuresthatseveralfilesthattypicallyholdcustomizedvaluesarecarriedoverintheupdateddatastore.
LocalFilesToUpload.
zipThefilesthatweremigratedfromthepreviousTeamcenterIntegrationFrameworkdatastorebecausetheydidnotexistintheupdatedTeamcenterIntegrationFrameworkdatastorebydefault.
LocalFilesWithConflict.
zipThefilesthatwerenotmigratedfromthepreviousTeamcenterIntegrationFrameworkdatastorebecausethesame-namedfilesexistedintheupdatedTeamcenterIntegrationFrameworkdatastorebydefault.
LocalFilesWithConflictList.
txtThelistoffilesinLocalFilesWithConflict.
zipforeasyreviewingoftheconflictlist.
ClusterTeamcenterIntegrationFrameworkinstallation:ATeamcenterIntegrationFrameworkinstancethatispartofaclusteralsohasalocaldatastoretouseiftheinstanceleavestheclusterinthefuture.
Therefore,themigrationinvolvesboththelocaldatastoreandtheclusterdatastore.
ThefollowingfilesarebackedupintheTcIF_ROOT/container/migrate/run/unique_iddirectory:LocalOldDS.
zipAfullbackupofthepreviousTeamcenterIntegrationFrameworklocaldatastore.
LocalNewDS_initial.
zipAsnapshotofthenewTeamcenterIntegrationFrameworklocaldatastorewithinitialfiles.
LocalNewDS_updated.
ziptcif13.
1TeamcenterIntegrationFramework4-11InstallingandupgradingTeamcenterIntegrationFrameworkChapter4:InstallingandupgradingTeamcenterIntegrationFrameworkAsnapshotofthenewTeamcenterIntegrationFrameworklocaldatastorewithinitialfilesandmigratedfilesfromthepreviouslocaldatastore.
LocalNewDS_final.
zipAfullbackupofthecompletelymigratedlocaldatastore.
ClusterOldDS.
zipAfullbackupofthepreviousTeamcenterIntegrationFrameworkclusterdatastore.
ClusterNewDS_initial.
zipAsnapshotofthenewTeamcenterIntegrationFrameworkclusterdatastorewithinitialfiles.
ClusterNewDS_updated.
zipAsnapshotofthenewTeamcenterIntegrationFrameworkclusterdatastorewithinitialfilesandmigratedfilesfromthepreviousclusterdatastore.
ClusterNewDS_final.
zipAfullbackupofthecompletelymigratedclusterdatastore.
Thefollowingmigration-relatedfilesarestoredintheTcIF_ROOT/container/migrate/run/unique_iddirectory:LocalFilesToDrop.
txtAlistoffilesthatwerenotmigratedfromthepreviousTeamcenterIntegrationFrameworklocaldatastorebecausetheyarenotrequiredbytheupdatedTeamcenterIntegrationFrameworkversion.
LocalFilesToOverlay.
zipThefilesthatweremigratedfromthepreviousTeamcenterIntegrationFrameworklocaldatastoreregardlessofwhetherthesamefilesalsoexistedintheupdatedTeamcenterIntegrationFrameworklocaldatastorebydefault.
Preservingthesefilesensuresthatseveralfilesthattypicallyholdcustomizedvaluesarecarriedoverintheupdatedlocaldatastore.
LocalFilesToUpload.
zipThefilesthatweremigratedfromthepreviousTeamcenterIntegrationFrameworklocaldatastorebecausetheydidnotexistintheupdatedTeamcenterIntegrationFrameworklocaldatastorebydefault.
LocalFilesWithConflict.
zipThefilesthatwerenotmigratedfromthepreviousTeamcenterIntegrationFrameworklocaldatastorebecausethesame-namedfilesexistedintheupdatedTeamcenterIntegrationFrameworklocaldatastorebydefault.
LocalFilesWithConflictList.
txtThelistoffilesinLocalFilesWithConflict.
zipforeasyreviewingoftheconflictlist.
ClusterFilesToDrop.
txt4-12TeamcenterIntegrationFrameworktcif13.
1Chapter4:InstallingandupgradingTeamcenterIntegrationFrameworkInstallingandupgradingTeamcenterIntegrationFrameworkAlistoffilesthatwerenotmigratedfromthepreviousTeamcenterIntegrationFrameworkclusterdatastorebecausetheyarenotrequiredbytheupdatedTeamcenterIntegrationFrameworkversion.
ClusterFilesToOverlay.
zipThefilesthatweremigratedfromthepreviousTeamcenterIntegrationFrameworkclusterdatastoreregardlessofwhetherthesamefilesalsoexistedintheupdatedTeamcenterIntegrationFrameworkclusterdatastorebydefault.
Preservingthesefilesensuresthatseveralfilesthattypicallyholdcustomizedvaluesarecarriedoverintheupdatedclusterdatastore.
ClusterFilesToUpload.
zipThefilesthatweremigratedfromthepreviousTeamcenterIntegrationFrameworkclusterdatastorebecausetheydidnotexistintheupdatedTeamcenterIntegrationFrameworkclusterdatastorebydefault.
ClusterFilesWithConflict.
zipThefilesthatwerenotmigratedfromthepreviousTeamcenterIntegrationFrameworkclusterdatastorebecausethesame-namedfilesexistedintheupdatedTeamcenterIntegrationFrameworkclusterdatastorebydefault.
ClusterFilesWithConflictList.
txtThelistoffilesinClusterFilesWithConflict.
zipforeasyreviewingoftheconflictlist.
ManagemigrationconflictsNomanualresolutionisrequiredforfilesdeliveredwithTeamcenterIntegrationFramework(unlessyouhavemodifiedthesefiles).
Thatis,filessuchaslocalizationfilesfromthepreviousversionmayhavefewerentriescomparedtothesamelocalizationfilesintheupdatedversionduetonewchanges,andscriptAPIsmayhavechangedbetweenversions.
Filesofthesetypesareidentifiedasconflictsduringthemigration,butyoucanignorethemunlessyouhavepreviouslycustomizedthem.
ArunningTeamcenterIntegrationFrameworkhasonlyonedatastoreactive.
TheactivedatastoreisthelocaldatastoreifTeamcenterIntegrationFrameworkisrunningasastandaloneinstance.
TheactivedatastoreistheclusterdatastoreifTeamcenterIntegrationFrameworkisrunningaspartofacluster.
Resolveconflictsfortheactivedatastoreatyoursite.
Usethefollowinggeneralprocesstoresolveconflicts:1.
EvaluatethescopeofconflictsbyreviewingtheLocalFilesWithConflictList.
txtorClusterFilesWithConflictList.
txtsummaries.
2.
ReviewthefilescontainedinLocalFilesWithConflict.
ziporClusterFilesWithConflict.
ziptodeterminewhichfilesfromtheolddatastoreshouldbemigratedtothenewdatastore.
3.
BackupLocalFilesWithConflict.
ziporClusterFilesWithConflict.
zip.
Editthecontentsofthe.
zipfilessuchthatitcontainsonlythosefilesthatshouldbemigratedtothenewdatastore.
4.
PlacetheeditedversionofLocalFilesWithConflict.
ziporClusterFilesWithConflict.
zipinthe/autoinstalldirectorytoautomaticallyuploadthosefilestothenewdatastore.
tcif13.
1TeamcenterIntegrationFramework4-13InstallingandupgradingTeamcenterIntegrationFrameworkChapter4:InstallingandupgradingTeamcenterIntegrationFrameworkResolvingunrecoverablemigrationissuesIfanunrecoverableerroroccursduringthemigration,themigrationstopsandamessagesimilartoTcIFlocaldatastoremigration-abortorTcIFclusterdatastoremigration-abortappearsintheconsolewindow.
Detailsoftheerrorarealsoenteredinthelogfile.
StopTeamcenterIntegrationFramework,reviewthedetailsintheerrorlog,addresstheissuecausingtheerror,andrestartTeamcenterIntegrationFramework.
Afteradatastoremigrationsuccessfullycompletes,itcannotbererun.
RetainbusinessobjectdefinitionsThedatabaseschemabusinessobjectdefinition(BOD)haschangedforTeamcenterIntegrationFramework10.
1.
5laterversions.
ThisrequiressomemanualstepsbothbeforeandafterusingTeamcenterEnvironmentManager(TEM)toapplythepatch.
1.
StartTeamcenterIntegrationFrameworkandopentheDatastoreConfigurationwebpage.
2.
Downloadthefollowingfilestoadisklocationretainingthedatastoredirectorystructure:/config/BOSBox.
jaxb/config/SSOPseudoAppIDMap.
jaxbAlljaxbfilesdirectlyunderthe/boslocationAllconnector-config_site-ID.
jaxbfilesdirectlyunderthe/configlocationAllsite-type_site-ID.
jaxbfilesdirectlyunderthe/siteslocation3.
Createanarchive(ZIP)filecontainingallthedownloadedfiles,maintainingthedirectorystructure.
4.
StopTeamcenterIntegrationFramework.
5.
Renamethedatastore.
h2.
dbfileunderTcIF_ROOT/tcif/container/h2/todatastore-current-release-version-h2.
db.
6.
StartTEMandapplythepatchupdate.
7.
DeleteallfeatureXMLfilesthathaveapreviousversionintheirnamesundertheTcIF_ROOT/tcif/container/deploydirectory.
8.
UploadtheupdatedfilestotheTeamcenterIntegrationFrameworkdatastore.
YoucandothisthroughtheDatastoreConfigurationwebpageasfollows,oryoucancopytheZIPfilecontainingthebacked-updatastorecontentintotheTcIF_ROOT/tcif/container/autoinstalldirectory.
a.
StartTeamcenterIntegrationFrameworkandopentheDatastoreConfigurationwebpage.
b.
ClickBrowseandchoosetheZIPfilecontainingthebacked-updatastorecontentc.
Selecttheforwardslash(/)fromtheSelectaLocationlistandclickUpload.
4-14TeamcenterIntegrationFrameworktcif13.
1Chapter4:InstallingandupgradingTeamcenterIntegrationFrameworkInstallingandupgradingTeamcenterIntegrationFrameworkRetainJDBCsiteconfigurationsasPAX-JDBCsiteconfigurationsTheJDBCconnectorchangedtousePAX-JDBCatTeamcenterIntegrationFramework10.
1.
6.
YoumustretainthepreviousversionJDBCconnectorconfigurationsasPAX-JDBCconfigurations.
1.
StartTeamcenterIntegrationFrameworkandopenthesiteconfigurationwizard.
ObtainthefollowinginformationaboutyourJDBCsites:SiteIDJDBCDriverNameDatabaseURL2.
StopTeamcenterIntegrationFramework.
3.
Inawebbrowser,searchforthefollowingPAX-JDBCpropertiesforyourJDBCdatabase:PAX-JDBCdriver-namePAX-JDBCdatabase-name4.
StartTEMandapplythepatchupdate.
5.
CreateadatasourcefileasfollowsandcopyittotheTcIF_ROOT/tcif/container/etc/directory.
Namethefileusingthefollowingconvention:org.
ops4j.
datasource-data-source-name.
cfg.
Thefilemustcontain:osgi.
jdbc.
driver.
name=url=dataSourceName=user=password=NoteThedatabaseusernameandpasswordcannotbeobtainedfromtheTeamcenterIntegrationFrameworksiteconfigurationwizard.
Youmustgetthisinformationfromthedatabaseadministrator.
ThismakesthedatasourceavailabletoTeamcenterIntegrationFrameworkasadatasourceservice.
6.
StartTeamcenterIntegrationFrameworkandusethesiteconfigurationwizardtocreateasiteusingtheinformationobtainedinsteponeandthenewPAX-JDBCdatasourceyoucreated.
RunTeamcenterIntegrationFrameworkStarttheTeamcenterIntegrationFrameworkserverbyenteringthefollowingcommandatacommandpromptintheTeamcenterIntegrationFrameworkinstalldirectory:trunWaittoaccessTeamcenterIntegrationFrameworkuntilthe"TcIFsuccessfullystarted"messageappears.
tcif13.
1TeamcenterIntegrationFramework4-15InstallingandupgradingTeamcenterIntegrationFrameworkChapter4:InstallingandupgradingTeamcenterIntegrationFrameworkRunTeamcenterIntegrationFrameworkasaserviceYoucanrunTeamcenterIntegrationFrameworkasaserviceonWindowssystems.
Dependingonyourinstallation,youmayneedtocreatethe\data\logdirectorystructureunderyourTcIF_ROOT\tcif\containerdirectorysothelogfileiscreatedinthecorrectlocation.
1.
StartTeamcenterIntegrationFrameworkinacommandshellusingthetrun.
batscriptintheTcIF_ROOT\tcif\container\bin\directory.
2.
TypethefollowingcommandsintheTeamcenterIntegrationFrameworkcommandwindow:karaf@TcIB>feature:installwrapperkaraf@TcIB>wrapper:install3.
Openthekaraf-wrapper.
conffileintheTcIF_ROOT\tcif\container\etc\directoryandaddthefollowingnewparameters:Updatethefollowingexistingparameters:wrapper.
java.
initmemory=512wrapper.
java.
maxmemory=1024YoucanalsorenametheWindowsserviceinthisfile.
4.
StoptherunninginstanceofTeamcenterIntegrationFrameworkbyclosingthecommandwindow.
5.
Openanewcommandwindowandtypethefollowingcommandtoinstalltheservice:%TC_ROOT%\tcif\container\bin\karaf-service.
batinstall6.
Checkthewrapper.
logfileintheTcIF_ROOT\tcif\container\data\logdirectoryforanyerrors.
7.
ConfirmthattheserviceisrunningbytypingthefollowingURLinabrowser:http://localhost:/tcif/controller/webclientis"8040"bydefault.
RunTeamcenterIntegrationFrameworkinstancesinaclusterMultipleTeamcenterIntegrationFrameworkinstancescanruninaclusteredmode.
AclusterofTeamcenterIntegrationFrameworkinstances(nodes)worktogethertoprocessrequestsinparallel,enhancingthesystem'soverallefficiencyandstability.
RequestsarepostedtosharedqueuestoallowrequeststobeprocessedbyanyoftheTeamcenterIntegrationFrameworknodesinthecluster.
AclusterdiffersfromastandaloneTeamcenterIntegrationFrameworkinstanceinthattheclusterusesasharedexternaldatabasetostoreconfigurationinformationandasharedexternaldatabaseformessagingpersistence.
ThesamedatabasessupportedbyTeamcenteraresupportedbyTeamcenterIntegrationFramework.
ClusteringconsiderationsBeawareofthefollowingconsiderationswhenconfiguringTeamcenterIntegrationFrameworkclusters:4-16TeamcenterIntegrationFrameworktcif13.
1Chapter4:InstallingandupgradingTeamcenterIntegrationFrameworkInstallingandupgradingTeamcenterIntegrationFrameworkAllnodesintheclustermustberunningthesamereleaseversionofTeamcenterIntegrationFramework.
EachTeamcenterIntegrationFrameworknodeinaclustermustberunningonaseparatemachine.
Themachinesinaclustermustbeonthesamenetworkandmusthaveuniquehostnames.
Themachinesmustbevisibletoeachothersohostscanresolveotherhostsbynamewheninteracting.
AnexternalproxyorloadbalancercanactasasinglepointofentrytotheTeamcenterIntegrationFrameworkcluster.
ConfiguresupportingdatabasesIntheexternaldatabaseusedtostoreconfigurationinformation,createauserthatcanconnectandcreateinteractivesessions,hasprivilegesforcreatingthetablesusedbyTeamcenterIntegrationFramework,andhasaquotaforcreatingtables.
TeamcenterIntegrationFrameworkcreatesthetablesitneedsuponjoiningthecluster.
Aftertheclusteriscreated,theprivilegescanberevoked.
Anotherdatabaseortablespaceanduserisrequiredformessagingpersistence.
ApacheActiveMQisusedasthemessagebroker.
ActiveMQcreatesthetablesitneedsinthedatabaseforpersistingmessagesandclustering.
ThedatabaseusedfortheActiveMQmessagingmustbeofthesametype(andusethesamedriver)astheoneusedfortheTeamcenterIntegrationFrameworktables.
NoteWhenusingTeamcenterIntegrationFrameworkwithMicrosoftSQLServer,thefirsttimeApacheActiveMQconnectswiththeSQLServerdatabase,tablemodificationwarningmessagesarelogged.
Thesemessagescanbesafelyignored.
Themessagesbeginasfollows:WARN|CouldnotcreateJDBCtables;theycouldalreadyexist.
Failurewas:ALTERTABLEACTIVEMQ_ACKSDROPPRIMARYKEYMessage:Incorrectsyntaxnearthekeyword'PRIMARY'.
ThesewarningsareduetoaknownissuewithActiveMQandSQLServer.
Thetablesarecreatedproperly,andthewarningswillnotbereportedinfuturesessions.
CreateorjoinaTeamcenterIntegrationFrameworkclusterTocreateaTeamcenterIntegrationFrameworkclusterortoaddTeamcenterIntegrationFrameworknodestoacluster,firstinstallTeamcenterIntegrationFrameworkasastandaloneinstanceusingthestepsinUsingTEMtoinstallTeamcenterIntegrationFrameworkand(optionally)Teamcenter.
OnceTeamcenterIntegrationFrameworkisinstalled,usethefollowingstepstocreateorjoinacluster:1.
OnthemachinehostingthestandaloneTeamcenterIntegrationFrameworkinstallation,openaTeamcenterIntegrationFrameworkconsolewindowandstartTeamcenterIntegrationFrameworkusingthetrun.
batbatchfileintheTcIF_ROOT\tcif\container\bin\directory.
WaituntiltheconsolewindowmessagestatingthatTeamcenterIntegrationFrameworkhasstartedisdisplayedbeforecontinuing.
2.
EnsureallmessagingsystemprocessingjobsarecompletedintheTeamcenterIntegrationFrameworkinstance.
WhenswitchingfromastandaloneTeamcenterIntegrationFrameworktcif13.
1TeamcenterIntegrationFramework4-17InstallingandupgradingTeamcenterIntegrationFrameworkChapter4:InstallingandupgradingTeamcenterIntegrationFrameworkinstancetoaclusternode,messagesintheinstance'smessagingsystemarenotmigratedtotheclustermessagingsystem.
3.
FromtheopenTeamcenterIntegrationFrameworkconsolewindow,usethecluster:joincommandtoaddtheTeamcenterIntegrationFrameworkinstancetoanexistingclusterortocreateanewcluster.
Thecluster:joincommandtakesargumentsidentifyingthetypeofdatabasetobeusedandconnectioninformationforthedatabase.
Thecommandhasthefollowingform:cluster:join–activemqDBUrlmq_url–activemqDBUsermq_username–activemqDBPwdmq_passwddb_typejdbc_urldb_usernamedb_passwdwhere:-activemqDBUrlmq_urlistheURLofthemessagingpersistencedatabase.
TheURLisrequiredonlyforthefirstinstancewhencreatingacluster.
-activemqDBUsermq_usernameisthemessagedatabaseusername.
Theusernameisrequiredonlyforthefirstinstancewhencreatingacluster.
-activemqDBPwdmq_passwdisthemessagedatabaseuserpassword.
Thepasswordisrequiredonlyforthefirstinstancewhencreatingacluster.
db_typeisthetypeofexternaldatabaseusedtostoreconfigurationinformation(oracleormssql).
jdbc_urlistheJDBCURLfortheexternaldatabase.
db_usernameistheexternaldatabaseusername.
db_passwdistheexternaldatabaseuserpassword.
Followingisanexamplecommandforcreatingacluster:cluster:join–activemqDBUrljdbc:oracle:thin:@machinename:1521:amq–activemqDBUserscott–activemqDBPwd12tiger3oraclejdbc:oracle:thin:@machinename:1521:tcifdsscott12tiger3Followingisanexamplecommandforaddinganodetoaexistingcluster:cluster:joinoraclejdbc:oracle:thin:@machinename:1521:tcifdsscott12tiger3Theconfigurationfromtheinstanceusedtocreatetheclusteriscopiedontothecluster.
Anyconfigurationinformationfromnodessubsequentlyjoiningaclusterisignored.
Therefore,ensureyoucreatetheclusterusingtheinstancewithyourdesiredconfiguration.
Enterhelpcluster:joinforafulldescriptionofthecommand'ssyntax.
4.
FromtheTeamcenterIntegrationFrameworkconsolewindow,usethecluster:refreshcommandtoupdate(refresh)eachpreviouslyexistingnodeintheclusterafterjoininganewnodetothecluster.
(Ifyouhaveaddedseveralnodestoacluster,performarefreshoneachnodeintheclusterexceptforthelastoneadded.
)Therefreshesarenecessarytosynchronizetheconfigurationofpreviouslyaddednodestoincludethelatestnodes.
4-18TeamcenterIntegrationFrameworktcif13.
1Chapter4:InstallingandupgradingTeamcenterIntegrationFrameworkInstallingandupgradingTeamcenterIntegrationFrameworkThecluster:refreshcommandhasnoparameters.
WorkwithTeamcenterIntegrationFrameworkclustersYoucanperformthefollowingmonitoringtaskswithTeamcenterIntegrationFrameworkclusters:ListnodesinaclusterYoucanviewthecurrentnodesinaclusterusingthecluster:listcommandfromtheTeamcenterIntegrationFrameworkconsolewindow.
Thecommandliststhehostnamesofeachnodeconfiguredaspartofthecluster.
Thecluster:listcommandhasnoparameters.
MonitornodestatusTodeterminetheoperationalstatusofaparticularnodeinacluster,browsetothefollowingURL:http://host:port/tcif/rest/isALivewhere:ohostisthenameoftheserverhostingthenode.
oportistheTeamcenterIntegrationFrameworkRESTserviceportnumber.
Forexample:http://tcifboston:8090/tcif/rest/isALiveThenoderespondswithitscurrentstatus.
RemoveaTeamcenterIntegrationFrameworknodefromaclusterRemovinganodefromaclusterreturnsittobeingastandaloneinstanceusingitsembeddedH2SQLdatabase.
ThemessagingserverassociatedwiththeremovedTeamcenterIntegrationFrameworknodeisnolongerpartoftheclusteranddoesnotsharemessageswiththecluster.
Anymessagesinthemessagingsystemarenotmigratedtothestandaloneinstance'smessagingsystem.
Othernodesintheclusterarestillabletoprocessthosemessages.
Performthefollowingstepstoremoveanodefromacluster.
1.
FromtheopenTeamcenterIntegrationFrameworkconsolewindowonthemachinehostingtheTeamcenterIntegrationFrameworkinstancetoberemoved,usethecluster:leavecommandtoremovetheinstancefromthecluster.
Thecluster:leavecommandhasnoparameters.
2.
ShutdowntheActiveMQserverrunningonthesamemachineastheremovednodebyclosingthecommandwindow.
3.
Whenanodeisremovedfromacluster,itisshutdown.
RestartthestandaloneTeamcenterIntegrationFrameworkinstanceusingthetrun.
batbatchfileintheTcIF_ROOT\tcif\container\bin\directoryofthemachinehostingtheinstance.
4.
Theremainingnodesintheclustermustbeupdatedtooperatewithouttheremovednodeaspartoftheclusterconfiguration.
Runthecluster:refreshcommandonceforeachremainingnodeinthecluster.
tcif13.
1TeamcenterIntegrationFramework4-19InstallingandupgradingTeamcenterIntegrationFrameworkChapter4:InstallingandupgradingTeamcenterIntegrationFrameworkThecluster:refreshcommandhasnoparameters.
MigratingfromGlobalServicestoTeamcenterIntegrationFrameworkDifferencesbetweenGlobalServicesandTeamcenterIntegrationFrameworkTeamcenterIntegrationFrameworkisbasedonanOSGiplatformandnotanapplicationserver.
TeamcenterIntegrationFrameworkdiffersfromGlobalServicesasfollows:TeamcenterIntegrationFrameworkusesOSGibundlesandservicesinsteadofenterpriseJavabeans(EJBs).
Insteadofanapplication(EARfile),therearefeaturefilesandacollectionofservices.
ThescriptingplatformchangedfromBSHtoGroovy.
GroovyisalmostasupersetofJava;however,somethingsdonotmapdirectlyfromJavatoGroovy.
Forexample,certainoperationswithJavagenericscausecompilererrors.
TherearesomearrayinitializationsthatmustbewrittendifferentlyinGroovy.
ThescriptsdistributedwithTeamcenterIntegrationFrameworkprovidegoodexamples.
ThedatastoreisbuiltintotheTeamcenterIntegrationFrameworkplatforminanH2database.
Thedatastorestartsandstopsautomaticallywiththeplatform.
Youcanchangethedatabaseused;however,SiemensPLMSoftwarehasnottestedanddoesnotsupportTeamcenterIntegrationFrameworkusingotherdatabases.
AnActiveMQJMSsystemalsorunswithintheTeamcenterIntegrationFrameworkplatformandisusedautomaticallywiththeSOAPservices.
TheJavaMessageService(JMS)systemissetuptoautomaticallyretrymessagesaftersomesmalldelaysandtoputthemessagesintoadeadletterqueueforpotentialmanualretries.
ManualretriesrepeattheentireprocessunlessyoucircumventpartsoftheprocessbyaddinglogictoGroovyscripts.
TheTeamcenterIntegrationFrameworksecuritysystemissimplerthanGlobalServicessecurityandsupportsonlyLDAPandsinglesign-on(SSO).
AnLDAPserverisbundledwiththeTeamcenterIntegrationFrameworkframeworkandisthestandardsecuritysystem.
Thebusinessprocesslanguage(BPEL)engineusedbyGlobalServicesisreplacedwithGroovyscriptinginTeamcenterIntegrationFramework.
BecauseGroovyissimilartoJava,itismucheasiertowriteandmodifyGlobalMulti-Site(GMS)processes.
TheGlobalServicesmessageserverbasedonbusinessobjectdefinitions(BODs)andreactorsisimplementedusingtheJavapersistentAPI(JPA)andaSpringserviceinTeamcenterIntegrationFramework.
TheTeamcenterIntegrationFrameworkuserinterfaceisextendedtoimproveinteractionwiththemessagingsystem.
Adashboardshowsthemostrecentchanges.
TheGlobalServicesreactorframeworkisreplacedwithaGroovyscriptingframeworkinTeamcenterIntegrationFramework.
4-20TeamcenterIntegrationFrameworktcif13.
1Chapter4:InstallingandupgradingTeamcenterIntegrationFrameworkInstallingandupgradingTeamcenterIntegrationFrameworkTheGlobalServicesPublishservletisreplacedinTeamcenterIntegrationFrameworkwitheitherRESTservicesoranewPublishservicethatsupportsthesametypeofURLastheoldPublishservlet,butforwardsthemessagetotheGroovyscriptingframework.
GlobalServiceswebservicesaresupportedwithminorchangessuchastheSOAPendpoints.
TheGlobalServicesschemasaremostlyunchanged.
However,theauditingschemahasmanyrevisionsandanewnamespace.
Theconnectionschemaremainsunchangedwiththeexceptionthatthejndi-nameattributeisrenamedtobean-name.
ThisimpactsBODsyoumovefromGlobalServicestoTeamcenterIntegrationFramework.
Themonitoringschemaisnolongerusedalongwiththequeryauditprocess.
TheTeamcenterIntegrationFrameworkemailservicereplacespartsoftheGlobalServicesnotifierreactorandemailingcapabilities.
ItisCamelandvelocitybased.
Thereisaconfigurationpointandthevelocitytemplatescanbeeditedforcustomization.
TeamcenterIntegrationFrameworkconnectorextensionsareGroovyscripts.
Connectorcustomizationcanbedonethroughtheconnectorextensions.
Ratherthanlistingalloftheconnectorextensionsintheconnectorconfigurationfile,youspecifyoneormorepackagesandallconnectorextensionsfoundinthepackagesareloadedintotheconnector.
MigrationofpackagesThemainpackagemigrationsare:The/com/teamcenter/globalservices/packagesaremovedto/com/teamcenter/esb.
The/com/teamcenter/_globalservicespackagesaremovedto/com/teamcenter/esb/internal.
Packagesunder/com/teamcenter/esb/internalareforinternaluseandnotincludedintheJavadocumentation.
SomepackagesarerenamedtofitintotheOSGiparadigmtoalignwiththebundlesandtoavoidsplittingpackagesacrossbundles.
MostofthisoccurredwiththebindbundleandtheJavaarchitectureforXMLbinding(JAXB)classes.
BusinessobjectdefinitiontemplatesAsolutionmayhaveaBODthatituseswithaparticularconnector.
TeamcenterIntegrationFrameworkprocessesinteractwiththatconnectorthroughasiteandcreatetheconnectorconfigurationforthesiteautomaticallyintheconfigurationuserinterface(UI)atthetimethesiteiscreated.
TheconfigurationuserinterfacefillsinthecorrectconnectorconfigurationnameintoBODtemplatesfoundinthedatastore.
TheuserinterfacelooksforBODtemplatesinthesite-type/*.
jaxblocationand,foreachofthefiles,itcreatesabusinessobjectdefinitioninthe/boslocationandfillsinthecorrectconnectorconfigurationreference.
ConnectorconfigurationtemplatesWhenyoucreateasiteintheTeamcenterIntegrationFrameworkconfigurationuserinterface(UI),theUIsearchesforatemplatematchingthesitetypeofthesite.
Thetemplatesforconnectorconfigurationfilesarestoredinthedatastoreinthe/config/templatelocation.
Aserverrestartmaybenecessaryforchangestotemplatestotakeeffect.
tcif13.
1TeamcenterIntegrationFramework4-21InstallingandupgradingTeamcenterIntegrationFrameworkChapter4:InstallingandupgradingTeamcenterIntegrationFrameworkIftheblueprintsoftheconnectorspecifythesite-typeattributeasDevSite,thetemplatewiththatsitetypeisusedforthesite,forexample:Ifatemplatewiththatsitetypedoesnotexist,bydefault,theCustomConfigtemplateisusedforthesite.
Theconnectorconfigurationiscreatedinthe/configlocationofthedatastorewithanameformattedasconnector-config-name_site-id.
jaxb.
Ifthedevelopment.
jaxbtemplatehastheDevSitesite-typeattributeandthesiteIDinthewizardisspecifiedasDevSite,thewizardcreatesadevelopment_DevSite.
jaxbconnectorconfigurationfile.
InBODdatasourcespecifications,theconfig-nameattributemustbesettodevelopment_DevSitetousetheconnectorwiththatsite.
Ifatemplatefortheconnectorconfigurationfiledoesnotexist,thewizardcreatesaCustomConfig_mySite.
jaxbconnectorconfigurationfileandtheconfig-nameattributevaluemustbeCustomConfig_mySite.
WebservicesURLsTheBOSServicewebservicesURLforTeamcenterIntegrationFrameworkishttp://localhost:8080/tcif/BOSService.
Thisisforlogon,logout,query,andotherBOSrelatedwebservices.
ThisreplacestheGlobalServicesURL.
TheprocessserviceforhandlingvariousSOAPserviceshastwoendpoints:http://localhost:8080/tcif/processandhttp://localhost:8080/tcif/processAsync.
Thesereplacethehttp://localhost:8080/tcgs-wsandhttp://localhost:8080/tcgs-odeinTcGSURLsinGlobalServices.
MigratingaGlobalServicesdatastoretoTeamcenterIntegrationFrameworkTheauditingbusinessobjectdefinitions(BODs)arenotsupportedinTeamcenterIntegrationFramework.
TheTeamcenterIntegrationFrameworkconfigurationuserinterfaceprovidestheinteractionswiththemessageserviceinformation.
TomigrateotherBODs,theconn:data-source-specelements:Replaceitwithelementssimilartothefollowing:Allpostmappingcontrolfileroutines(forexample,ElemIdAssigner,DuplicateRemover,PrefixRemover,andReferenceResolver)mustbelistedinthepostProcessorChainvariables.
tcif13.
1TeamcenterIntegrationFramework4-23InstallingandupgradingTeamcenterIntegrationFrameworkChapter4:InstallingandupgradingTeamcenterIntegrationFrameworkSomeroutines(forexample,SetAttrsXFactorandRemoveAndDedangler)arelistedtwice.
Thisisrequiredbecausetheroutineexecutesperfactorandalsoexecutesafterallthedataisgatheredinthefirstpass.
TheRemoveAndDedanglerroutinereplacestheRemoveFlaggedObj.
xslandRemoveFlaggedRel.
xslstylesheetsthatwereprocessedoutsidethemappingengine.
Thesefilesarenolongernecessary.
5.
Addanyrequiredadditionalpostprocessorroutinesasfollows:a.
AddJavaclassestothemapperengine2.
jarfileortoaseparateJARfile.
b.
AddtheJARfiletotheCLASSPATHvariableandadditsfullyqualifiednametooneofthepostProcessorChainvariablesinthemappingconfig.
xmlfile.
c.
ExtendtheSnippetPostProcessorclassand,ataminimum,overridetheprocess()method.
TheothermethodsintheSnippetPostProcessorclass,initialize(),initParams(),andfinish(),areavailableforcustomizationbutarenotrequired.
Thefollowingisanexampleofthesyntaxyouusetospecifycustompostprocessorconfigurationvariables:com.
teamcenter.
datamapper.
mapperengine.
postprocessors.
SortByIsland{maxIslandFileHandles=250000,islandDivFactor=100}YoumustalsowritecodeintheinitParams()methodtoprocesstheparamStrargument.
6.
Updateanyreferencespostprocessorroutinestothenewnameasfollows:OriginalnameNewnameGMSCrossFactorSetAttrsSetAttrsXFactorHeaderHandlerHeaderCreatorPSAlternateListHandlerPSAListProcessorAssmStrcQtyFixRequiredPSOccurrenceQtyProcessorSharedMultiOccurrenceHandlerEffectivityIdProcessorGlobalServicestoTeamcenterIntegrationFrameworkpublishedclassmappingSomeofthepublishedGlobalServicescomponentsaremappedintoTeamcenterIntegrationFrameworkbundles.
Onlybundledpublicexportedresourcesareidentified.
com.
teamcenter.
datamapperThisbundlecontainsthemappingengine.
Itprovidescontrolfilemappingandpostprocessing.
Italsocontainsmappingdesignerprojects.
Itdoesnotpublishtoblueprint.
Exportedpackagescom.
teamcenter.
datamapper.
configcom.
teamcenter.
datamapper.
mapperengineConvertedpackagesmapperengine.
jar4-24TeamcenterIntegrationFrameworktcif13.
1Chapter4:InstallingandupgradingTeamcenterIntegrationFrameworkInstallingandupgradingTeamcenterIntegrationFrameworkcom.
teamcenter.
datamapper.
*NoteTheexistingpackagespaceremainsthesamebecausetheseclassesarenotinthecom.
teamcenter.
globalservicespackagespace.
Forexample,thecom.
teamcenter.
datamapperpackagespaceisthesameinboththeGlobalServicescomponentandtheTeamcenterIntegrationFrameworkbundle.
com.
teamcenter.
esb.
activemqThisbundlewrapsanddeploystheJavaMessageService(JMS)intheframework.
Therearenoexportedorconvertedpackagesinthisbundle.
com.
teamcenter.
esb.
bindProvidesbindingservicesfortheframeworkExportedpackagescom.
teamcenter.
esb.
model.
bodcom.
teamcenter.
esb.
model.
configcom.
teamcenter.
esb.
model.
connectioncom.
teamcenter.
esb.
model.
datacom.
teamcenter.
esb.
model.
exceptioncom.
teamcenter.
esb.
model.
formcom.
teamcenter.
esb.
model.
securitycom.
teamcenter.
esb.
model.
tablecom.
teamcenter.
esb.
model.
utilcom.
teamcenter.
esb.
model.
valuemapcom.
teamcenter.
esb.
model.
whereNoteThegeneratedpackagenamesretainglobalservicesinthepackagename.
ChangingtheserequiresexistingsystemstoalsochangethewaytheycallTeamcenterIntegrationFramework.
Theendsystemdoesnotseeanydifferenceinaccess.
com.
teamcenter.
globalservices.
audit.
_2006_12com.
teamcenter.
globalservices.
bod.
_2006_12com.
teamcenter.
globalservices.
config.
_2006_12com.
teamcenter.
globalservices.
config.
site.
_2010_06com.
teamcenter.
globalservices.
connection.
_2006_12com.
teamcenter.
globalservices.
data.
_2006_12com.
teamcenter.
globalservices.
datastore.
_2007_06com.
teamcenter.
globalservices.
failure.
_2011_06com.
teamcenter.
globalservices.
form.
_2006_12com.
teamcenter.
globalservices.
mapper.
_2007_06com.
teamcenter.
globalservices.
menu.
_2010_06com.
teamcenter.
globalservices.
monitoring.
_2007_06tcif13.
1TeamcenterIntegrationFramework4-25InstallingandupgradingTeamcenterIntegrationFrameworkChapter4:InstallingandupgradingTeamcenterIntegrationFrameworkcom.
teamcenter.
globalservices.
namespace.
_2006_12com.
teamcenter.
globalservices.
process.
_2007_06com.
teamcenter.
globalservices.
rule.
_2006_12com.
teamcenter.
globalservices.
security.
_2006_12com.
teamcenter.
globalservices.
sitemap.
_2007_06com.
teamcenter.
globalservices.
table.
_2006_12com.
teamcenter.
globalservices.
transfer.
_2007_06com.
teamcenter.
globalservices.
util.
_2006_12com.
teamcenter.
globalservices.
valuemap.
_2006_12com.
teamcenter.
globalservices.
webservice.
_2006_12com.
teamcenter.
globalservices.
wsutil.
_2006_12Convertedpackagescom.
teamcenter.
globalservices.
bodcom.
teamcenter.
globalservices.
configcom.
teamcenter.
globalservices.
connectioncom.
teamcenter.
globalservices.
datacom.
teamcenter.
globalservices.
exceptioncom.
teamcenter.
globalservices.
formcom.
teamcenter.
globalservices.
securitycom.
teamcenter.
globalservices.
tablecom.
teamcenter.
globalservices.
utilcom.
teamcenter.
globalservices.
valuemapcom.
teamcenter.
globalservices.
wherecom.
teamcenter.
esb.
bosProvidesbusinessobjectserver(BOS)servicestotheframework.
Therearenoexportedorconvertedpackages.
com.
teamcenter.
esb.
cacheProvidescachefunctionstotheframework.
Therearenoexportedpackages.
Convertedpackagescom.
teamcenter.
_globalservices.
cachecom.
teamcenter.
esb.
camelProvidesCamelprocessesandservices.
Itistheinfrastructureformessagerouting.
Therearenoexportedorconvertedpackages.
com.
teamcenter.
esb.
clientProvidesGlobalServicesclientfunctionstotheframework.
Exportedpackagescom.
teamcenter.
esb.
client4-26TeamcenterIntegrationFrameworktcif13.
1Chapter4:InstallingandupgradingTeamcenterIntegrationFrameworkInstallingandupgradingTeamcenterIntegrationFrameworkConvertedpackagescom.
teamcenter.
globalservices.
clientcom.
teamcenter.
esb.
commonsProvidescommonutilitiestotheframework.
Exportedpackagescom.
teamcenter.
esb.
commons.
datacom.
teamcenter.
esb.
commons.
exceptionConvertedpackagescom.
teamcenter.
globalservices.
utilcom.
teamcenter.
esb.
configProvidesconnectionconfigurationservicestotheframework.
Exportedpackagescom.
teamcenter.
esb.
config.
connectionConvertedpackagescom.
teamcenter.
globalservices.
config.
connectioncom.
teamcenter.
esb.
connectorProvidesthebaseconnectorclassestotheframework.
Exportedpackagescom.
teamcenter.
esb.
connectionConvertedpackagescom.
teamcenter.
globalservices.
connectioncom.
teamcenter.
esb.
connector.
jdbcProvidestheJDBCconnector.
Therearenoexportedorconvertedpackages.
com.
teamcenter.
esb.
connector.
tcsoaProvidestheSOAconnector.
Exportedpackagescom.
teamcenter.
esb.
connection.
tc.
soaConvertedpackagescom.
teamcenter.
globalservices.
connection.
tc.
soacom.
teamcenter.
esb.
connector.
tcentProvidestheTeamcenterEnterpriseconnector.
tcif13.
1TeamcenterIntegrationFramework4-27InstallingandupgradingTeamcenterIntegrationFrameworkChapter4:InstallingandupgradingTeamcenterIntegrationFrameworkExportedpackagescom.
teamcenter.
esb.
connection.
tcentConvertedpackagescom.
teamcenter.
globalservices.
connection.
tcentcom.
teamcenter.
esb.
coreContainscoreTeamcenterIntegrationFrameworkfunctions,suchasexceptionhandling,messaging,settings,andXMLfunctions.
Exportedpackagescom.
teamcenter.
esb.
exceptioncom.
teamcenter.
esb.
msgConvertedpackagescom.
teamcenter.
globalservices.
exceptioncom.
teamcenter.
globalservices.
msgcom.
teamcenter.
esb.
datastoreContainstheTeamcenterIntegrationFrameworkdatastore.
Therearenoexportedorconvertedpackages.
com.
teamcenter.
esb.
datastoreContainstheTeamcenterIntegrationFrameworkdatastore.
Therearenoexportedorconvertedpackages.
com.
teamcenter.
esb.
loggerContainstheTeamcenterIntegrationFrameworkloggingfunction.
Therearenotexportedpackages.
Convertedpackagescom.
teamcenter.
globalservices.
loggercom.
teamcenter.
esb.
parserContainstheTeamcenterIntegrationFrameworkparsingfunctions.
Therearenoexportedorconvertedpackages.
com.
teamcenter.
esb.
securityContainstheTeamcenterIntegrationFrameworksecurityfunctions.
Exportedpackagescom.
teamcenter.
esb.
securityConvertedpackagescom.
teamcenter.
globalservices.
security4-28TeamcenterIntegrationFrameworktcif13.
1Chapter4:InstallingandupgradingTeamcenterIntegrationFrameworkInstallingandupgradingTeamcenterIntegrationFrameworkcom.
teamcenter.
esb.
tcsoaProvidesdependentJARfilesfortheSOAconnector.
Exportedpackagescom.
fnd0.
schemas.
wproxy.
_2014_10.
proxylinkcom.
fnd0.
services.
strong.
wproxycom.
fnd0.
services.
strong.
wproxy.
_2014_10com.
teamcenter.
net.
tcserverproxy.
admincom.
teamcenter.
net.
tcserverproxy.
clientcom.
teamcenter.
schemas.
core.
_2006_03.
datamanagementcom.
teamcenter.
schemas.
core.
_2006_03.
filemanagementcom.
teamcenter.
schemas.
core.
_2006_03.
reservationcom.
teamcenter.
schemas.
core.
_2006_03.
sessioncom.
teamcenter.
schemas.
core.
_2007_01.
datamanagementcom.
teamcenter.
schemas.
core.
_2007_01.
filemanagementcom.
teamcenter.
schemas.
core.
_2007_01.
managedrelationscom.
teamcenter.
schemas.
core.
_2007_01.
sessioncom.
teamcenter.
schemas.
core.
_2007_06.
datamanagementcom.
teamcenter.
schemas.
core.
_2007_06.
lovcom.
teamcenter.
schemas.
core.
_2007_06.
propdescriptorcom.
teamcenter.
schemas.
core.
_2007_06.
sessioncom.
teamcenter.
schemas.
core.
_2007_09.
datamanagementcom.
teamcenter.
schemas.
core.
_2007_09.
projectlevelsecuritycom.
teamcenter.
schemas.
core.
_2007_12.
datamanagementcom.
teamcenter.
schemas.
core.
_2007_12.
sessioncom.
teamcenter.
schemas.
core.
_2008_03.
sessioncom.
teamcenter.
schemas.
core.
_2008_05.
datamanagementcom.
teamcenter.
schemas.
core.
_2008_06.
datamanagementcom.
teamcenter.
schemas.
core.
_2008_06.
dispatchermanagementcom.
teamcenter.
schemas.
core.
_2008_06.
managedrelationscom.
teamcenter.
schemas.
core.
_2008_06.
propdescriptorcom.
teamcenter.
schemas.
core.
_2008_06.
reservationcom.
teamcenter.
schemas.
core.
_2008_06.
sessioncom.
teamcenter.
schemas.
core.
_2008_06.
structuremanagementcom.
teamcenter.
schemas.
core.
_2009_04.
projectlevelsecuritycom.
teamcenter.
schemas.
core.
_2009_04.
sessioncom.
teamcenter.
schemas.
core.
_2009_10.
datamanagementcom.
teamcenter.
schemas.
core.
_2009_10.
projectlevelsecuritycom.
teamcenter.
schemas.
core.
_2010_04.
datamanagementcom.
teamcenter.
schemas.
core.
_2010_04.
languageinformationcom.
teamcenter.
schemas.
core.
_2010_04.
sessioncom.
teamcenter.
schemas.
core.
_2010_09.
datamanagementcom.
teamcenter.
schemas.
core.
_2011_06.
datamanagementcom.
teamcenter.
schemas.
core.
_2011_06.
envelopecom.
teamcenter.
schemas.
core.
_2011_06.
lovcom.
teamcenter.
schemas.
core.
_2011_06.
operationdescriptorcom.
teamcenter.
schemas.
core.
_2011_06.
propdescriptorcom.
teamcenter.
schemas.
core.
_2011_06.
reservationcom.
teamcenter.
schemas.
core.
_2011_06.
sessiontcif13.
1TeamcenterIntegrationFramework4-29InstallingandupgradingTeamcenterIntegrationFrameworkChapter4:InstallingandupgradingTeamcenterIntegrationFrameworkcom.
teamcenter.
schemas.
core.
_2012_02.
datamanagementcom.
teamcenter.
schemas.
core.
_2012_02.
operationdescriptorcom.
teamcenter.
schemas.
core.
_2012_02.
sessioncom.
teamcenter.
schemas.
core.
_2012_09.
datamanagementcom.
teamcenter.
schemas.
core.
_2012_09.
projectlevelsecuritycom.
teamcenter.
schemas.
core.
_2012_10.
datamanagementcom.
teamcenter.
schemas.
core.
_2013_05.
datamanagementcom.
teamcenter.
schemas.
core.
_2013_05.
lovcom.
teamcenter.
schemas.
core.
_2014_10.
datamanagementcom.
teamcenter.
schemas.
globalmultisite.
_2007_06.
importexportcom.
teamcenter.
schemas.
globalmultisite.
_2007_06.
sitereservationcom.
teamcenter.
schemas.
globalmultisite.
_2007_12.
importexportcom.
teamcenter.
schemas.
globalmultisite.
_2008_06.
importexportcom.
teamcenter.
schemas.
globalmultisite.
_2010_04.
importexportcom.
teamcenter.
schemas.
globalmultisite.
_2011_06.
importexportcom.
teamcenter.
schemas.
multisite.
_2014_10.
importexporttcxmlcom.
teamcenter.
schemas.
query.
_2006_03.
savedquerycom.
teamcenter.
schemas.
query.
_2007_01.
savedquerycom.
teamcenter.
schemas.
query.
_2007_06.
findercom.
teamcenter.
schemas.
query.
_2007_06.
savedquerycom.
teamcenter.
schemas.
query.
_2007_09.
savedquerycom.
teamcenter.
schemas.
query.
_2008_06.
savedquerycom.
teamcenter.
schemas.
query.
_2010_04.
savedquerycom.
teamcenter.
schemas.
query.
_2010_09.
savedquerycom.
teamcenter.
schemas.
query.
_2013_05.
savedquerycom.
teamcenter.
schemas.
soa.
_2006_03.
basecom.
teamcenter.
schemas.
soa.
_2006_03.
exceptionscom.
teamcenter.
schemas.
soa.
_2006_09.
clientcontextcom.
teamcenter.
schemas.
soa.
_2011_06.
metamodelcom.
teamcenter.
schemas.
soa.
objectpropertypolicycom.
teamcenter.
schemas.
workflow.
_2007_06.
workflowcom.
teamcenter.
schemas.
workflow.
_2008_06.
workflowcom.
teamcenter.
schemas.
workflow.
_2010_09.
workflowcom.
teamcenter.
schemas.
workflow.
_2013_05.
workflowcom.
teamcenter.
schemas.
workflow.
_2014_10.
workflowcom.
teamcenter.
services.
loose.
corecom.
teamcenter.
services.
loose.
core.
_2006_03com.
teamcenter.
services.
loose.
core.
_2007_01com.
teamcenter.
services.
loose.
core.
_2007_06com.
teamcenter.
services.
loose.
core.
_2007_12com.
teamcenter.
services.
loose.
core.
_2008_03com.
teamcenter.
services.
loose.
core.
_2008_06com.
teamcenter.
services.
loose.
core.
_2009_04com.
teamcenter.
services.
loose.
core.
_2010_04com.
teamcenter.
services.
loose.
core.
_2011_06com.
teamcenter.
services.
loose.
core.
_2012_02com.
teamcenter.
services.
strong.
corecom.
teamcenter.
services.
strong.
core.
_2006_03com.
teamcenter.
services.
strong.
core.
_2007_014-30TeamcenterIntegrationFrameworktcif13.
1Chapter4:InstallingandupgradingTeamcenterIntegrationFrameworkInstallingandupgradingTeamcenterIntegrationFrameworkcom.
teamcenter.
services.
strong.
core.
_2007_06com.
teamcenter.
services.
strong.
core.
_2007_09com.
teamcenter.
services.
strong.
core.
_2007_12com.
teamcenter.
services.
strong.
core.
_2008_03com.
teamcenter.
services.
strong.
core.
_2008_05com.
teamcenter.
services.
strong.
core.
_2008_06com.
teamcenter.
services.
strong.
core.
_2009_04com.
teamcenter.
services.
strong.
core.
_2009_10com.
teamcenter.
services.
strong.
core.
_2010_04com.
teamcenter.
services.
strong.
core.
_2010_09com.
teamcenter.
services.
strong.
core.
_2011_06com.
teamcenter.
services.
strong.
core.
_2012_02com.
teamcenter.
services.
strong.
core.
_2012_09com.
teamcenter.
services.
strong.
core.
_2013_05com.
teamcenter.
services.
strong.
core.
_2014_10com.
teamcenter.
services.
strong.
globalmultisitecom.
teamcenter.
services.
strong.
globalmultisite.
_2007_06com.
teamcenter.
services.
strong.
globalmultisite.
_2007_12com.
teamcenter.
services.
strong.
globalmultisite.
_2008_06com.
teamcenter.
services.
strong.
globalmultisite.
_2010_04com.
teamcenter.
services.
strong.
globalmultisite.
_2011_06com.
teamcenter.
services.
strong.
multisitecom.
teamcenter.
services.
strong.
multisite.
_2014_10com.
teamcenter.
services.
strong.
querycom.
teamcenter.
services.
strong.
query.
_2006_03com.
teamcenter.
services.
strong.
query.
_2007_01com.
teamcenter.
services.
strong.
query.
_2007_06com.
teamcenter.
services.
strong.
query.
_2007_09com.
teamcenter.
services.
strong.
query.
_2008_06com.
teamcenter.
services.
strong.
query.
_2010_04com.
teamcenter.
services.
strong.
query.
_2010_09com.
teamcenter.
services.
strong.
query.
_2013_05com.
teamcenter.
services.
strong.
workflowcom.
teamcenter.
services.
strong.
workflow.
_2007_06com.
teamcenter.
services.
strong.
workflow.
_2008_06com.
teamcenter.
services.
strong.
workflow.
_2010_09com.
teamcenter.
services.
strong.
workflow.
_2013_05com.
teamcenter.
services.
strong.
workflow.
_2014_10com.
teamcenter.
soacom.
teamcenter.
soa.
clientcom.
teamcenter.
soa.
client.
modelcom.
teamcenter.
soa.
client.
model.
strongcom.
teamcenter.
soa.
commoncom.
teamcenter.
soa.
common.
utilscom.
teamcenter.
soa.
exceptionsorg.
apache.
xml.
serializeorg.
apache.
xml.
serializerorg.
w3.
_2001.
xmlschematcif13.
1TeamcenterIntegrationFramework4-31InstallingandupgradingTeamcenterIntegrationFrameworkChapter4:InstallingandupgradingTeamcenterIntegrationFrameworkcom.
teamcenter.
esb.
servicesProvidesTeamcenterIntegrationFrameworkservices.
Exportedpackagescom.
teamcenter.
esb.
mappercom.
teamcenter.
esb.
publishcom.
teamcenter.
esb.
servicecom.
teamcenter.
esb.
service.
utilConvertedpackagescom.
teamcenter.
globalservices.
servicecom.
teamcenter.
fmsProvidesTeamcenterFileServicesdependencies.
Exportedpackagescom.
teamcenter.
fms.
servercachecom.
teamcenter.
fms.
servercache.
proxyTherearenoconvertedpackages.
MigratingaGlobalServicesconnectortoTeamcenterIntegrationFrameworkFollowtheprocessforhowtoaddacustomconnectortoTeamcenterIntegrationFramework.
TheonlypartoftheGlobalServicesconnectorrequiredistheConnectionBoxBeanimplementationclass.
1.
RemovealloftheEJBmethodsfromtheclass(ejbCreate,ejbPassivate,andsoforth).
AlsoremovethrowsRemoteExceptionfromtheclass.
2.
MovetheejbCreatemethodintotheconstructoroftheconnectionboxbeanimplementation.
3.
ReplacetheGlobalServicespackageswiththeTeamcenterIntegrationFrameworkpackagesintheimportstatementsandanywhereelsetheyappear.
MigratingasolutionfromGlobalServicestoTeamcenterIntegrationFrameworkThisexampleshowshowtheGlobalServicesSubstanceCompliancesolutionwasmigratedtoTeamcenterIntegrationFramework.
SubstanceCompliancecontainedareactorandsupportingclasses.
Thecom.
tccpmreactor.
TCCPMReactorBeanclassmapstocom.
teamcenter.
subscmpl.
internal.
service.
CPMEventProcessorclass.
TheCPMEventProcessorclassimplementsthecom.
teamcenter.
esb.
publish.
PublishEventHandlerclass.
PublishEventHandlerisaTeamcenterIntegrationFrameworkcomponentthatsupportslegacyPublish/Reactorsolutions.
TheSOAconnectorextensions(ExtractTcXMLandImportTcXML)aremappeddirectlytothefollowingGroovyscripts:4-32TeamcenterIntegrationFrameworktcif13.
1Chapter4:InstallingandupgradingTeamcenterIntegrationFrameworkInstallingandupgradingTeamcenterIntegrationFramework\script\com\teamcenter\esb\connector\tc\soa\ExtractTcXML.
groovy\script\com\teamcenter\esb\connector\tc\soa\ImportTcXML.
groovyTheCPMconnectorisunchangedexceptasdescribedinMigratingaGlobalServicesconnectortoTeamcenterIntegrationFramework.
CreateacustomsolutionbundleCreateanantmoduletobuildthesolutionbundlethatisusedinTeamcenterIntegrationFrameworkstructure.
YoudonotneedtopublishthisJARfiletoout/jarsandthereforeyoucanpublishittoasolutionspecificconfiguration.
AnyadditionalbundlesrequiredtorunyoursolutionthatarenotpartofthestandardTeamcenterIntegrationFrameworkinstallationmustbeinthefollowingformat.
JARnamecom.
teamcenter.
solution.
solution-11.
1.
0.
jarContents(locationinJAR)resources/solutionName.
propertiesMETA-INF/MANIFEST.
MFOSGI-INF\blueprint\bundle-context-osgi.
xmlOSGI-INF\blueprint\bundle-context.
xmlcom\teamcenter\.
.
\*.
classI18NContentsresources/solutionName.
propertiesyour-teamcenter-package-prefix/internal/msg/optional/TextBundleIDs.
classInstalledLocationTcIFInstallDir/tcif/container/bundlesDatastorecomponentsIfyoursolutionrequiresdatastorefiles,createanAntmoduletobuildaZIPfilecontainingthesolution'sdatastorefiles.
Youcanpublishtheresultingfiletoasolutionspecificconfiguration,thatis,thereisnoneedfortcjarsfiles.
Usethefollowingformat.
IPfilenameSolutionDataStore.
zipContents/solution/solution-name/script/com/.
.
.
/*.
groovy/solution/solution-name/bosBOSName.
xml/solution/solution-name/config/ConfigName.
xmlFeaturefileYourfeaturemustcontainisonefeatureXMLfilenamedtcesb-solution-11.
1.
0-feature.
xml.
TheinstalledlocationmustbetcifInstallDir/tcif/container/deploy.
BundlethesolutionkitThebundledkitfilemustbeaZIPfilecontainingthedatastorecontents,thesolutionOSGIbundles,andthefeaturefile.
TheAntbuilddependsontheOSGIbundlemoduleandthedatastoremodule.
NameTcIFSolutionNameBundle.
zipContentstcif/container/autoinstall/SolutionDataStore.
ziptcif/container/bundles/com.
teamcenter.
solution.
solution-version.
jartcif/container/deploy/tcesb-solution-11.
1.
0-feature.
xmlBuildoutputdirectoryout/jarstcif13.
1TeamcenterIntegrationFramework4-33InstallingandupgradingTeamcenterIntegrationFrameworkChapter4:InstallingandupgradingTeamcenterIntegrationFrameworkIncludethebundledsolutioninthekitThebundledsolutionmustbeavailabletothekittingprocess.
KittingFilesrc/build/kits/kit_kitTcIntegrationFramework.
xmlContenttoAddFollowotherexamplesinthefiletoaddtheTcIFSolutionBundle.
zipreferencetothekit.
CreatethefeaturefileNamefeature_tcifsolutionintg.
xmlAdduserdisplayedtesttothelanguagefileforlocalizationNameIntegrationFrameworkBundle_en_US.
xmlSourcelocationsrc/ESB/install/langRequiredchangesAddanymessagesortextthatdisplaytotheusertothefile.
Donotchangeanyotherlanguagefiles.
Thelocalizationteamdoesalltranslationsnecessary.
KitthefeaturefileSourcelocationbuild/kits/kit_tc_cdrom.
xmlRequiredchangesLocatetheothertcifentriesinbuild/kits/kit_tc_cdrom.
xmlfileandaddthefeature_tcifsolutionintg.
xmltothekit.
BundletheZIPfileforTeamcenterEnvironmentManagerThebuildaddstheTcIFSubsCmplBundle.
zipfiletotheoutput.
Thisfilecontainsthe\tcif\container\autoinstall\subsCmplDataStore.
zipZIPfilesintheautoinstalldirectoryareuploadedtothedatastore.
Forexample,thesolutionfilesuploadedforSubstanceComplianceare:\solutions\subsCmpl\tcif\container\autoinstall\subsCmplDataStore.
zip\solutions\subsCmp\bos\TeamcenterSoaCommercialPart.
jaxb\solutions\subsCmp\config\TCCPM_solutionConfig.
jaxb\solutions\subsCmp\config\TCCPM_mapping.
xsl\solutions\subsCmp\script\com\teamcenter\esb\connector\tc\soa\solutions\subsCmp\script\com\teamcenter\esb\connector\tc\soa\ExtractTcXML.
groovy\solutions\subsCmp\script\com\teamcenter\esb\connector\tc\soa\ImportTcXML.
groovy\solutions\subsCmp\tcif\container\bundles\com.
teamcenter.
subscmpl.
solution-10.
1.
4.
jarContainsserviceandsolutionclassesforsubstancecompliance.
Thisreplacesthereactor.
\solutions\subsCmp\tcif\container\bundles\tcsoa-subscmpl-fragment-10.
1.
4.
jarThisfragmentaddstherequiredsupporttotheOOTBSOAconnectortoallowittocallanextension.
\solutions\subsCmp\tcif\container\deploy\tcesb-subscmpl-10.
1.
4-features.
xmlThisisadeploymentfileprovisioningthedeploymentintothecontainer.
4-34TeamcenterIntegrationFrameworktcif13.
1Chapter4:InstallingandupgradingTeamcenterIntegrationFrameworkInstallingandupgradingTeamcenterIntegrationFrameworkMigratingaGlobalServicesreactortoaTeamcenterIntegrationFrameworkprocessTounderstandhowtoconvertreactorstoprocesses,refertohowreactorsareactivatedinGlobalServicesandhowtoactivateaprocessinTeamcenterIntegrationFramework.
ActivateaGlobalServicesreactorAGlobalServicesreactorrespondstoaGlobalServicesmessagethatissenttotheGlobalServicesmessageserver.
TheGlobalServicesmessageservermustbeconfiguredthroughrulestorecognizethecontentsoftheGlobalServicesmessagetodeterminewhichGlobalServicesreactorisrequiredtorespond.
AninitiatorisusedtogenerateaGlobalServicesmessagetosendtotheGlobalServicesmessageserver.
AninitiatorcansendamessagebycallingtheGlobalServicesservletwithanHTTPrequestorbysendingaJMSmessagecontainingaGlobalServicesmessagetothequeuethattheGlobalServicesmessageserverisprocessing.
InTeamcenterIntegrationFramework,thereisnoGlobalServicesmessage.
ThatmessagehadaveryspecificformatwhichtheGlobalServicesrulesengineunderstood.
InTeamcenterIntegrationFramework,thesolutionproviderdeterminesthebestformatforthemessage.
IndustrystandardmethodsofhandlingthemessagesinTeamcenterIntegrationFrameworkYoucancreatesimpleJAXBannotatedclassesanddropthemintothedatastoretofacilitatesendingSOAPMessages.
Somesimpleexamplesofthisareshippedinthedatastorealongwithasampleprocessor.
YoucanaddRESTendpointsthatacceptHTTPrequestscontainingthecontentofthemessagesasqueryorpathparameters.
Alternatively,JSONandotherformatscanbeusedwiththeRESTendpoints.
ReplacementforinitiatorsForinitiatorsthatusedtheGlobalServicespublishservlet,aRESTendpoint(PublishService)wasaddedtoTeamcenterIntegrationFrameworkthatmimicsthebehavioroftheGlobalServicespublishservlet.
Theserviceatthatendpoint(http://localhost:8090/tcif/publish)buildsaPublishEventJAXBobjectandsendsittotheTeamcenterIntegrationFrameworkmessageprocessor,whichhandlesitlikeanormalrequestcallingaPublishEventProcessorinterface.
ThatGroovyscripteitherstartsanotherGroovyscriptregisteredwithinitorlooksforanOSGiserviceimplementingthePublishEventHandlerinterfacewiththematchingtypeserviceproperty.
AllofthecodeinthePublishEventProcessorinterfacecanbereplacedwithcodetoprocessarbitrarypublishevents.
However,somesolutionsdependonitcallinganOSGiservice.
AninitiatorthatsentaGlobalServicesmessagetoaqueueforthemessageservertoprocessmustbemodifiedtosendaPublishEventobjectoraJAXBGroovyscriptedtype.
YoucanalsodefineaGlobalServicesmessageJAXBGroovyscriptinTeamcenterIntegrationFrameworkanddevelopaprocessorforit.
However,thisisamorecomplexsolution.
IfthepublishservicedoesnotsupporttheHTTPrequestaninitiatorsends,thatinitiatorcanbedirectedto(http://localhost:8090/tcif/rest/publish)orasimilarendpoint.
YoumustwriteaRESTfulGroovyscripttohandletheHTTPrequest.
OptionsforinitiatingprocesseswithinTeamcenterIntegrationFrameworkModifytheinitiatortosendandindustrystandardrequest(REST/SOAP)andprocessitinTeamcenterIntegrationFrameworkwithgroovyscripts.
tcif13.
1TeamcenterIntegrationFramework4-35InstallingandupgradingTeamcenterIntegrationFrameworkChapter4:InstallingandupgradingTeamcenterIntegrationFrameworkUsethepublishservicetoacceptaGlobalServices-likeURL:[http://localhost:8090/tcif/publishtype=t&publisher=p&class=c&source_attr_names=one%5E%5Etwo&sourceattrvalues=bar1%5E%5Ebar2]WriteaRESTGroovyservicetohandleaGlobalServices-likeURL.
SendaJMSmessagetotheActiveMQserverembeddedinTeamcenterIntegrationFrameworkwithaPublishEventobjectoraGroovyscriptedtype.
MigratingreactorcodetoTeamcenterIntegrationFrameworkReactorsinGlobalServicesextendtheReactorBeanabstractclassandimplementtheonMessagemethod.
TheonMessagemethodreceivesaGlobalServicesmessage.
InTeamcenterIntegrationFramework,thereisaProcessServiceinterfacethatcontainsthegetMethod()methodthatyoumustimplementtoreturnajava.
reflect.
Methodobjectreferringtothemethodthattheserviceusestoprocessmessages.
Theprocessingmethodmusttakeamessageobjectandacredentialsobject.
Youcanlookatthecom.
teacenter.
esb.
publish.
BasePublishEventProcessor.
groovypackageinthedatastoreforanexample.
Reactorsaremeanttorespondtoaneventoccurringonasystem.
Typically,anidentifierforthesystemisinthemessage.
InTeamcenterIntegrationFramework,theidentifiermapstoasiteID,allowingtheprocessortouseaconnectortoretrieveinformationfromthesitethatinitiatedthemessage.
Ifthereisonlyonesitewheretheeventcanoccur,itcanbehardcoded,butthisisnotabestpractice.
TheProxyServiceinterfaceisthebestwaytointeractwithothersystemsfromwithintheprocessors.
ItlooksupcredentialsforthesiteandcreatesaBOSClientinstancetointeractwiththeconnector.
TheProxyServiceinterfacecanalsobeusedtoinitiateactionsonothersystemsbasedontheeventthatoccurredonthefirstsystem.
Connectorextensionsarethebestwaytoimplementcustomlogictointeractwiththebackendconnections.
Forinstance,ifaJDBCdatabasemustbeupdatedbasedonthemessage,theProxyServiceinterfacecanbeusedtointeractwiththeJDBCconnector.
ThisallowsaccesstotheJDBCconnectorextensionexecutedwithinthecontextoftheJDBCconnector.
Aprocessorcancallaconnectorextensionforoneconnectortogetdatafromthefirstsystem,callanotherconnectorextensiononasecondconnector,andpassthedatafromthefirstsystemtoupdatethesecondsystem.
ThescopeoftheProcessServiceinterfacecodeislimitedtotheclassloadingcontextoftheTeamcenterIntegrationFrameworkservicesbundle.
Therefore,itmaybenecessarytousePlatformExtensionbundlestocallGroovyscriptsthatexecutewithinthebundleclassloadingcontextwithaccesstoJavaclassesfromothersoftwarevendors.
Forexample,theservicesbundledoesnothaveaccesstotheHTMLclientclasses.
Youmustcreateaplatformextendingbundletoprovideaccesstothoseclasses.
NotifierreactorfunctionalityinGlobalServicesThenotifierreactorinGlobalServicesreceivesaGlobalServicesmessageandusesarulesenginetosendanemailwiththeinformationtoarecipientbasedonthecontentsofthemessage.
InTeamcenterIntegrationFramework,thereisanemailservicethatyoucancallwithanEmailRequestobjectbasedontheclassfromtheGlobalServicesschemas.
YouconfiguretheGlobalServicesnotifierreactorbyeditingtheconfig/Notifier.
xmlandtheconfig/EmailTemplate.
xmlfilesinthedatastore.
InTeamcenterIntegrationFrameworkyouconfiguretheemailservicebyeditingtheemailtemplatesinthe/templates/*.
vmdatastorelocation.
4-36TeamcenterIntegrationFrameworktcif13.
1Chapter4:InstallingandupgradingTeamcenterIntegrationFrameworkInstallingandupgradingTeamcenterIntegrationFrameworkYoumustalsosetemailpropertiesintheTeamcenterIntegrationFrameworkwebconsole.
TheemailtemplatesinTeamcenterIntegrationFrameworkareindustrystandardApacheVelocitytemplatesinsteadofGlobalServices-specifictemplates.
TheemailpropertiesintheTeamcenterIntegrationFrameworkuserinterfacearedefinedbyApacheCamelandcontainpropertiesliketheSMTPserverURL.
MigratingacustomBPELprocesstoGroovyscriptsTheGMSprocessesinTeamcenterIntegrationFrameworkarelocatedinthedatastoreat:/solution/gms/script/com/teamcenter/globalservices/process/_2007_06IfyouhavecustomizedGMSBPELprocessestocalladditionalconnectorextensionmethods,youcanconverttheConnectorExtensionmethodtoaGroovyscriptwithminorchanges.
UsetheConnectorExtensionmethodoftheImportObjectsscriptasanexample.
TheGroovyscriptsaresuccinctcomparedtoBPEL.
ABPELassignmentXML:yxConvertstoasimpleassignmentinGroovy:x=y;Callingaservice:Convertstoasimplemethodcall:EmailResponseemailResponse=EmailService.
email(emailRequest);JAXBobjectsandsettersreplacetheXMLliteralinBPEL.
Tocallaconnectorextension,makeacalltotheProxyServiceinterfacewithaProxyServiceRequestobject.
MigratingGlobalServicesemailtemplatestoTeamcenterIntegrationFrameworkThesubstitutablepartsinGlobalServicesareformattedas%gs_transaction_id%.
InTeamcenterIntegrationFramework,theyareformattedas$body.
transaction_id.
Theattributesvaluefromtheparamelementswithintheemail-requestelementaresubstitutedintothetemplatewherethenameattributeoftheparamelementmatchesthesubstitutionvariablename.
Forexample,$body.
transaction_idgetsthevalue12345fromthefollowingemail-request.
xmlfile:email-requestxmlns="http://teamcenter.
com/globalservices/webservice/2006-12"xmlns:util="http://teamcenter.
com/globalservices/util/2006-12">data-transfer-successsomeuser@xxx.
comtransferwassuccessfultcif13.
1TeamcenterIntegrationFramework4-37InstallingandupgradingTeamcenterIntegrationFrameworkChapter4:InstallingandupgradingTeamcenterIntegrationFrameworkNoteThegs_transaction_idparameterinthetemplatesisrenamedtotransaction_idtoshowitisnolongerspecifictoGlobalServices.
4-38TeamcenterIntegrationFrameworktcif13.
1Chapter4:InstallingandupgradingTeamcenterIntegrationFrameworkChapter5:ConfiguringandmanagingTeamcenterIntegrationFrameworkoperationConfiguringTeamcenterIntegrationFramework5-1TeamcenterIntegrationFrameworkconfigurationoverview5-1Configure5-2DataStore5-2Manuallyconfiguringthedatastorecontents5-2Downloadpane5-2Uploadpane5-3Removepane5-3Properties5-3Security5-4Principals5-4SSO5-5SSL5-5JDBCDataSources5-6Sites&Monitoring5-7Queueing5-8AdministeringTeamcenterIntegrationFrameworkqueues5-8DataViews5-8Activitystatus5-8Retryfailedmessages5-8Businessobjectdefinitions(BODs)5-9Documentation5-9ViewDefaultLogFile5-9Wizard5-9Wizardprocessoverview5-9ConfigurationHome5-10SiteConfigurationwizard5-10SiteMappingwizard5-11Configuringtheintegrationframeworkemailservice5-12TroubleshootingTeamcenterIntegrationFrameworktransferprocesses5-12Controllingfileuploading5-13StoppingTeamcenterIntegrationFramework5-13Managingpasswords5-14ConfiguretheApacheKarafpassword5-14EnableKarafpasswordencryption5-14ChangetheTeamcenterIntegrationFrameworksecurityrepositorypassword5-15TeamcenterIntegrationFrameworklogging5-16TeamcenterIntegrationFrameworkmessageobjects5-16ConfigureTeamcenterIntegrationFrameworkexceptionmessagelogging5-17ConfiguringTeamcenterIntegrationFrameworktracinginlogfiles5-17tcif13.
1TeamcenterIntegrationFrameworkChapter5:ConfiguringandmanagingTeamcenterIntegrationFrameworkoperationConfiguringTeamcenterIntegrationFrameworkTeamcenterIntegrationFrameworkconfigurationoverviewTheTeamcenterIntegrationFrameworkconfigurationinterfaceisaweb-basedapplicationforconfiguringTeamcenterIntegrationFrameworkcomponents.
Theapplicationisaweb-basedtoolthatadministratorscanaccessthroughawebbrowser.
ItallowsyoutosetvaluesinTeamcenterIntegrationFrameworkconfigurationfilesinthedatastoreandprovidesexistingvaluesfromfilesinthedatastorethatyoucanviewormodify.
RunningtheconfigurationinterfaceAccesstheconfigurationinterfacewithabrowserusingaURLwiththefollowingformat:http://tcif-server-host:port/tcif/controller/indexwheretcif-server-hostisyourTeamcenterIntegrationFrameworkservername,andport-numberisyourWebUIport(8040bydefault).
TheTeamcenterIntegrationFrameworkconfigurationinterfaceoffersthefollowingconfigurationoptions.
ConfigureDataStoreletsyoumanuallyupdatethecontentsoftheTeamcenterIntegrationFrameworkdatastore.
PropertiesletsyouconfiguregeneralpropertiesofTeamcenterIntegrationFramework.
Securityletsyouconfigureuser,SSO,andSSLsettings.
JDBCDataSourcesletsyouviewandconfigureJDBCdatasources.
Sites&MonitoringopenstheIntegrationFrameworkWebConsole.
QueueingPerformadministrationtasksrelatedtoTeamcenterIntegrationFrameworkqueues.
SeeAdministeringTeamcenterIntegrationFrameworkqueues.
DataViewsViewactivitystatus,failedmessageinformation,andbusinessobjectdefinitions(BODs).
DocumentationAccessTeamcenterIntegrationFrameworkAPI,Java,andotherdocumentation.
tcif13.
1TeamcenterIntegrationFramework5-1Chapter5:ConfiguringandmanagingTeamcenterIntegrationFrameworkoperationViewDefaultLogFileRetrievethecurrentTeamcenterIntegrationFrameworklogfile.
TeamcenterIntegrationFrameworkpropertiesTeamcenterIntegrationFrameworkisbasedonanOSGicontainerwithOSGibundles.
ThebundlesusetheBlueprintdependencyinjectionframeworktoprovideconfigurationpropertiesfortheOSGibeans.
Thesepropertiescanbesetintheetcdirectoryofthecontainer(tcif/container/etcdirectory)Thebundlesmustregisterlistenersorberestartedforchangestopropertyvaluestooccuratruntime.
Mostofthepropertiesrequirerestartforupdatestotakeeffect.
Youcanexposethepropertiesofanyfilewiththenameformattedascom.
tc.
esb.
property-name.
cfginthePropertiespaneoftheuserinterface.
TeamcenterIntegrationFrameworkdisplaysthepropertiesinthefileifyousetthedisplay.
in.
uipropertytotrue(display.
in.
ui=trueinthecfgfile).
SomeofthestandardpropertiesarepurposelynotsettodisplayinthePropertiespanebecausetheyarenotnormallychangedfromthevaluessetduringinstallation.
ConfigureDataStoreManuallyconfiguringthedatastorecontentsChooseConfigure→DatastoretodisplaytheDatastoretabthatcontainstheConfigurationObjectspane.
ThispaneallowsyoutomanuallyupdatethecontentsoftheTeamcenterIntegrationFrameworkdatastorebydownloadingfilestoeditanduploadingnewormodifiedfiles.
Youcanalsoremovefilesthatarenolongerused.
Thedatastorecontainstemplatefilesthatyoucandownloadandmodifyforyourconfiguration.
PlatformExtensibilityConfigurationintheTeamcenterHelpcollectioncontainsinformationaboutthecontentsofthedatastorefilesandtheirformatrequirements.
Thebusinessobjectdefinitionandmostconfigurationfilesusethe.
jaxbextension.
Theyareserializedanddeserializedwhenyouuploadthemtoordownloadthemfromthedatastore.
Fileswithotherextensions,forexample.
xmland.
propertiesfiles,arestoredinthedatastoreinwithoutbeingserialized.
DownloadpaneThedatastoreispopulatedwiththeinitialcontentwhenTeamcenterIntegrationFrameworkisinstalled.
YouusetheDownloadpanetoviewthecurrentdirectorystructure,andyoucanclickthefoldericonsinthispanetoshowthecontentsofthedirectory,orclickafiletodownloaditandsaveittoalocaldirectoryoropenitinthedefaulteditorforthefiletype.
Fileswiththe.
jaxbextensionareautomaticallydeserializedwhenyouaccess.
TheJAXBfilesareJavaArchitectureforXMLBinding(JAXB)files.
TheseallowyoutomapJavaclassestoXMLrepresentationstostoreandretrievedatainmemoryinXMLformatandarethemaincontentofthedatastore.
Therearetemplatefilesfortheservice-orientedarchitecture(SOA)connector,thebusinessobjectserver(BOS)configuration,standardsiteconnectors(JDBC,TeamcenterEnterprise,Teamcenterproductmastermanagement,Teamcenter),andotherstandardconfigurationsfiles.
Forinformationaboutthecontentandformatofthedatastoreconfigurationfiles,seePlatformExtensibilityConfigurationintheTeamcenterHelpcollection.
5-2TeamcenterIntegrationFrameworktcif13.
1Chapter5:ConfiguringandmanagingTeamcenterIntegrationFrameworkoperationConfiguringandmanagingTeamcenterIntegrationFrameworkoperationUploadpaneYouusethispanetonavigatetoanduploadaTeamcenterIntegrationFrameworkfileafteryoucreateormodifyit.
Youcanpackageadirectorystructurecontainingfilecontentsinacompressedarchiveformat(JARorZIPfiles)anduploadtheentirecontentstotheappropriatelocationinthedatastorebycheckingChecktounpackcontentsofjar/zipfilebeforeyouuploadthefile.
Anydirectoriesthatdonotexistarecreatedwhenyouuploadthefile.
YoucanalsocreatenewdirectoriesbymanuallytypingthemintheDatastorelocationforobjectbox.
ThisfeatureisusefulforTeamcenterIntegrationFrameworkcustomizations.
YoucandisableaccesstothispaneasdescribedinControllingfileuploading.
RemovepaneYouusethispanetonavigatetofilesthatarenolongerneededbyTeamcenterIntegrationFramework.
Thishelpscontrolthesizeofthedatastoredatabaseasitevolves.
PropertiesThePropertiestabliststheexposedpropertybundles(areas)usedtoconfiguregeneralpropertiesofTeamcenterIntegrationFramework.
Onlyareasthathavethedisplayattributesettoshowitspropertiesinthearea'sconfigurationfilearelisted.
Clickonanareatoseeindividualpropertynamesandvaluesforthearea.
Youcanperformthefollowingadministrativefunctionsonthistab:CreateanewpropertyareaWiththelistofexistingpropertyareasdisplayed,clickabovethelistofareas.
EnteranameforthenewareaandclickOK.
Thenewareaisaddedtothelist.
Propertyareasmaptoconfigurationfilesinthetcif/container/etcdirectory.
Thefilenameshavetheformcom.
tc.
esb.
area_name.
cfg.
Thepropertiesareaccessibleprogrammaticallyusing:service.
ui.
config.
ConfigurationProperties.
getProperties(StringareaName)Editanarea'sproperties1.
Inthelistofpropertyareas,locatetheareatoeditandclick.
2.
Nexttothepropertyareaname,click.
EnteranameforthenewpropertyandclickOK.
3.
ClickSavechangestosavethechangestothedatastore.
RefreshthelistofpropertyareasAsyouworkwithproperties,clicktoupdatethelistofdisplayedareaswiththecurrentcontentsofthedatastore.
tcif13.
1TeamcenterIntegrationFramework5-3ConfiguringandmanagingTeamcenterIntegrationFrameworkoperationChapter5:ConfiguringandmanagingTeamcenterIntegrationFrameworkoperationSecurityPrincipalsDefinetheattributesthatTeamcenterIntegrationFrameworkusestovalidateusercredentialsonthePrincipalstab.
ThePrincipalstablistscurrentlyvalidTeamcenterIntegrationFrameworkusersandletsyouperformthefollowingtasks:FilterthelistofTeamcenterIntegrationFrameworkusersTorefinethelistofusers,beginenteringastringofcharactersin.
Asyoutype,thelistupdatestoshowonlytheuserswiththatstringofcharactersintheirnames.
AddanewTeamcenterIntegrationFrameworkuser1.
Click.
2.
Fillinthefieldsdefiningthecharacteristicsofthenewuser.
FieldsmarkedwithmustbecompletedtocreateanewTeamcenterIntegrationFrameworkuser.
NameSpecifiesausernameassociatedwithTeamcenterIntegrationFramework.
PasswordSpecifiesthepasswordassociatedwiththeuser.
ConfirmPasswordConfirmsthepasswordassociatedwiththeuser.
AdministratorWhensettoTrue,specifiestheuserhasTeamcenterIntegrationFrameworkadministratorprivileges.
DirectorySpecifiesthedirectorycontainingbusinessobjectdefinitions(BODs)forobjectstheusercanaccess.
WhennovalueisenteredforDirectory,theBODsinthe\bosdirectoryofthedatastorearedisplayed.
Topresentadifferentviewofthedata,specifythenameofadirectorythatisasubdirectoryofthe\bosdirectory.
3.
ClickCreatetoaddtheusertotheTeamcenterIntegrationFrameworkdatastore.
RemoveaTeamcenterIntegrationFrameworkuser1.
LocatetheuseryouwishtoremoveinthelistofTeamcenterIntegrationFrameworkusers.
2.
Onthesamelineasthatuser'sname,clickandconfirmtheremoval.
Theuserisremovedfromthedatastore.
EditthecredentialsofaTeamcenterIntegrationFrameworkuser1.
LocatetheuseryouwishtoeditinthelistofTeamcenterIntegrationFrameworkusers.
2.
Onthesamelineasthatuser'sname,click.
Theuser'scharacteristicsaredisplayed.
3.
Edittheuser'scharacteristics.
ClickSavewhencompletetosavethechangestothedatastore.
5-4TeamcenterIntegrationFrameworktcif13.
1Chapter5:ConfiguringandmanagingTeamcenterIntegrationFrameworkoperationConfiguringandmanagingTeamcenterIntegrationFrameworkoperationRefreshthelistofTeamcenterIntegrationFrameworkusersAsyouworkwithusers,clicktoupdatethelistofTeamcenterIntegrationFrameworkusers.
SSOTheSSOtabletsyouconfigureTeamcenterIntegrationFrameworkforSecurityServicessinglesign-on(SSO).
DoingsoallowsaTeamcenterusertologontoanySSO-enabledTeamcenterproductandaccessanyotherSSO-enabledTeamcenterproductusingalreadysuppliedandvalidatedcredentials.
SpecifythefollowingsettingsontheSSOtab.
Whenyourchangesarecomplete,clickSavetocommitthemtotheTeamcenterIntegrationFrameworkdatastore.
RestarttheTeamcenterIntegrationFrameworkserverforthechangestotakeeffect.
EnabledWhenchecked,specifiesthatTeamcenterIntegrationFrameworkusesSecurityServicessinglesign-on.
AdminAttributeSpecifiesthatthisinstanceofTeamcenterIntegrationFrameworkhasadministratorprivilegesassociatedwithitsuser'ssecuritycredentials.
ApplicationIDSpecifiestheuniqueidentifierthatSecurityServicesusestoidentifythisTeamcenterIntegrationFrameworkinstance.
ThisvaluemustcorrelatewiththeIDsenteredintheTeamcenterSecurityServicescomponent'sapplicationregistries.
ForinformationaboutconfiguringTeamcenterproductsinSecurityServices,seeSecurityServicesInstallation/CustomizationintheTeamcenterHelpcollection.
IdentityURLSpecifiestheURLoftheSecurityServicesIdentityService,forexample:http:///cvgtsso1:8080/ssoSERVICELoginRedirectURLSpecifiestheURLtowhichtheclientredirectsthelogonbysettingthecompleteURLfortheSecurityServiceslogonwindow,forexample:http://cvgtsso1:8080/ssoLOGINSERVICE/weblogin/login_redirectRedirectURLSuffixSpecifiestheURLpagethatSecurityServicesredirectstoafterasuccessfullogon.
ThisvalueisappendedtheTeamcenterIntegrationFrameworkredirectURLinSecurityServices.
Typically,youcanacceptthedefault/webclientvalue.
SecurityContextDecryptionKeySpecifiesthevalueusedtodecryptadouble-encryptedSSOtokenincaseswhencontext-sensitivesecurityisused.
ThisvaluemustmatchthevalueassignedtomediatorpasswordparameterwhenconfiguringtheSSOLoginService.
ForinformationabouttheSecurityServicesmediatorpasswordparameterandapplicationtokens,seeSecurityServicesInstallation/CustomizationintheTeamcenterHelpcollection.
SSLTheSSLtabletsyouconfigureTeamcenterIntegrationFrameworkforHTTPScommunications.
DoingsoprovidessecureencryptedcommunicationsfromTeamcenterIntegrationFramework.
tcif13.
1TeamcenterIntegrationFramework5-5ConfiguringandmanagingTeamcenterIntegrationFrameworkoperationChapter5:ConfiguringandmanagingTeamcenterIntegrationFrameworkoperationSpecifythefollowingsettingsontheSSLtab.
Whenyourchangesarecomplete,clickSavetocommitthemtotheTeamcenterIntegrationFrameworkdatastore.
RestarttheTeamcenterIntegrationFrameworkserverforthechangestotakeeffect.
EnabledWhenchecked,specifiesthatTeamcenterIntegrationFrameworkusesanHTTPSencryptedconnection.
KeyPasswordSpecifiesthepasswordusedtoprotecttheprivatecryptographickeyofapublic/privatekeypair.
KeystoreSpecifiesthelocationoftherepositoryforthesecuritycertificatesusedforSSLencryption.
KeystorePasswordSpecifiesthepasswordusedtoaccesstherepositoryforthesecuritycertificates.
TheTeamcenterIntegrationFrameworksecurityrepositoryhasanadministrationaccountinitsLDAPstructureusedformaintenanceoftherepository.
SiemensPLMSoftwarerecommendsthatyouchangethedefaultpasswordvalue(secret)whenyoufirststartTeamcenterIntegrationFramework.
KeystoreTypeSpecifiesthetypeofkeystoreyouareusing.
BecauseTeamcenterIntegrationFrameworkisJava-based,thedefaultisJKS.
AnothercommonlyusedkeystoretypeisPKCS#12,whichisnotJava-specific.
Forinformationaboutthetypesofkeystores,seetheJavaCryptographyArchitectureOracleProvidersDocumentationontheOraclewebsite.
JDBCDataSourcesTheJDBCDataSourcestablistscurrentlyconfigureddatasourceconnectionsandletsyouperformthefollowingtasks:FilterthelistofdatasourceconnectionsTorefinethelistofconnections,beginenteringastringofcharactersin.
Asyoutype,thelistupdatestoshowonlythedatasourceconnectionswiththatstringofcharactersintheirnames.
Createadatasourceconnection1.
Click.
2.
Fillinthefieldsdefiningthecharacteristicsofthenewconnection.
Fieldsmarkedwithmustbecompletedtocreateanewdatasourceconnection.
DataSourceNameSpecifiesanameforthisconnection.
DatabaseTypeSpecifiesthetypeofdatabasetoconnectto.
JDBCURLSpecifiestheURLusedtoconnecttothedatabase.
UserSpecifiesthenameusedtologontothedatabase.
PasswordSpecifiesthedatabaselogonpassword.
Confirmthepasswordwhenprompted.
PoolingWhensettoOn,connectionpoolingisenabledforthisdatasource.
5-6TeamcenterIntegrationFrameworktcif13.
1Chapter5:ConfiguringandmanagingTeamcenterIntegrationFrameworkoperationConfiguringandmanagingTeamcenterIntegrationFrameworkoperationPoolSizeSpecifiesthenumberofconnectionstocachewhenpoolingisenabledforthisdatasource.
Thedefaultvalueis64.
3.
ClickCreatetoaddtheconnection.
Testadatasourceconnection1.
Locatethedatasourceconnectionyouwishtotestinthelistofconnections.
2.
Onthesamelineasthatconnection,click.
TeamcenterIntegrationFrameworkteststheconnectionandreportsitsstatusalongwithrelateddetails.
Removeadatasourceconnection1.
Locatetheconnectionyouwishtoremoveinthelistofdatasourceconnections.
2.
Onthesamelineasthatconnection,clickandconfirmtheremoval.
Thedatasourceconnectionisremoved.
Viewandmodifyexistingconnectiondetails1.
Locatethedatasourceconnectionyouwishtoeditinthelistofconnections.
2.
Onthesamelineasthatconnection,click.
Theconnection'sdetailsaredisplayed.
3.
Edittheconnectiondetails.
ClickSavewhencompletetosavethechanges.
RefreshthelistofdatasourceconnectionsAsyouworkwithdatasourceconnections,clicktoupdatethelistofconnections.
Sites&MonitoringSites&MonitoringopenstheIntegrationFrameworkWebConsoleinanewbrowsertab.
WiththeIntegrationFrameworkWebConsole,youcanviewbusinessobjectdefinitionviewsofbackenddataandthestatusofauditingservicesandmessagingframeworkdata.
WiththeIntegrationFrameworkWebConsole,youcanconfigurethefollowingitems:SecurityUserandroledefinitions.
FMSFilemanagement.
DatastoreConfigurationfiles,scripts,andsoon.
PropertiesConfigurationpropertiesforsetupandtuning.
SitesSitesanddatamappingbetweenthem.
RefertothecontextsensitiveonlinehelpintheIntegrationFrameworkWebConsoleforadditionalinformationonitsfeatures.
tcif13.
1TeamcenterIntegrationFramework5-7ConfiguringandmanagingTeamcenterIntegrationFrameworkoperationChapter5:ConfiguringandmanagingTeamcenterIntegrationFrameworkoperationQueueingAdministeringTeamcenterIntegrationFrameworkqueuesPerformthefollowingadministrationtasksrelatedtoTeamcenterIntegrationFrameworkqueuesbyclickingQueueing.
CreateTeamcenterIntegrationFrameworkqueuesMonitorTeamcenterIntegrationFrameworkqueuesManageTeamcenterIntegrationFrameworkjobsManageTeamcenterIntegrationFrameworkqueuesDataViewsActivitystatusTeamcenterIntegrationFrameworkgeneratesmessagesfortheactivitiesthatitperforms.
AnActivityStatusmessageobjectisgeneratedforeachprocessorsubprocess(ProcessStatusobject)andeachstep(StepStatusobject).
ThemessagestateandresultsarestoredintheTeamcenterIntegrationFrameworkactivitystatustableinthedatabase.
TheActivityStatustaballowsyoutoseeallcurrentlyactiveactivitiesintheCurrentActivitypane.
Thisisthedefaultview.
YoucanchangethesortorderofanyofthecolumnsinthisCurrentActivitypanebyclickingthecolumnheading.
Youcancleanupthemessagetablebydeletingfinishedorotherunneededmessagesinthispane.
Youcanselectspecificmessagestodeleteordeleteallmessagesinthedisplayedinthepane.
ClicktheDeletecolumnheadingtoaccessthelistofcolumnsandremoveundesiredcolumnsfromthepaneoraddpreviouslyremovedcolumns.
YouopentheSearchFilterspanebyclickingtheexpandbuttonbeneaththeActivityStatustab.
Thispaneallowsyoutosearchthedatabaseforactivitiesusinganyofthefollowingmessagecriteria:MessageIDMessageTypeUserNameStartTimeFinishTimeStepNameThestandardwildcardcharacters(*and)areacceptedinthesearchboxes.
YoucanexcludesuccessfulactivitiesandcompletedactivitiesfromthesearchresultsbycheckingSuppressSuccessfulorSuppressCompleted,respectively.
RetryfailedmessagesTeamcenterIntegrationFrameworkdisplaysfailedmessagesfortheactivitiesthatitattempts.
Fromthisview,youcanidentifythefailedmessagebythemessageID,timeitwassent,andthetypeof5-8TeamcenterIntegrationFrameworktcif13.
1Chapter5:ConfiguringandmanagingTeamcenterIntegrationFrameworkoperationConfiguringandmanagingTeamcenterIntegrationFrameworkoperationmessage.
Youcanretrymessagesandremovemessagesfromthisview.
Youalsohavetheoptiontoretryallfailedmessages.
Businessobjectdefinitions(BODs)TheBODspaneprovidesalistofthebusinessobjectsdefinedinthedatastore.
Thisallowsyoutosearchforeachtypeofobject.
YoucanusethistodetermineifaparticularsiteconfigurationiscorrectandifthebusinessobjectisdefinedcorrectlyintheTeamcenterIntegrationFrameworkdatastorewithoutreturningtotheTeamcenterIntegrationFrameworkportal.
DocumentationAccessadditionalTeamcenterIntegrationFrameworkdocumentationbyclickingonDocumentationinTeamcenterIntegrationFrameworkconfiguration.
Thefollowingdocumentationisavailable:TcIFAPIDisplaysdocumentationfortheTeamcenterIntegrationFrameworkAPIsupportedinthisrelease.
Java8DocLinkstothecurrentJavadocumentation.
PlatformDescribestheTeamcenterIntegrationFrameworkplatform.
Notices&TrademarksDisplayslicensingandotherinformationrelatedtoTeamcenterIntegrationFramework.
AboutDisplayscurrentreleaseinformation.
ViewDefaultLogFileInTeamcenterIntegrationFrameworkconfiguration,clickViewDefaultLogFiletodownloada.
zipfilecontainingthecurrentTeamcenterIntegrationFrameworkoperationslog.
WizardWizardprocessoverviewThewizardguidesyouthroughthestepsrequiredtoconfigureDataExchangebetweendifferenttypesofPLMsites,forexample,betweenTeamcenterEnterpriseandTeamcentersites.
Thecurrentstepandremainingwizardstepsareshownintherightpane.
AnexampleconfigurationofTeamcenterEnterprisetoTeamcenterDataExchangecontainsthefollowingwizardstepsintheordershown:1.
StarttheConfigureasitewizard.
2.
CreateaTeamcenterEnterprisesite.
a.
SettheTeamcenterEnterprisesiteID.
b.
SettheTeamcenterEnterpriseFMSIDandURL.
c.
SettheTeamcenterEnterpriseMUXhostandport.
tcif13.
1TeamcenterIntegrationFramework5-9ConfiguringandmanagingTeamcenterIntegrationFrameworkoperationChapter5:ConfiguringandmanagingTeamcenterIntegrationFrameworkoperationd.
SettheTeamcenterEnterprisesitelogoncredentials(usernameandpassword)fortheTeamcenterIntegrationFrameworkuser.
e.
SelecttheTeamcenterEnterpriseconnector.
f.
SavetheTeamcenterEnterpriseconfiguration.
3.
CreateaTeamcentersite.
a.
SettheTeamcentersiteID.
b.
SettheTeamcenterFMSIDandURL.
c.
SettheTeamcenter4-tierURL.
d.
SettheTeamcenterservermanagerURL.
e.
SettheTeamcentersitelogoncredentials(usernameandpassword)fortheTeamcenterIntegrationFrameworkuser.
f.
SelecttheTeamcenterconnector.
g.
SavetheTeamcenterconfiguration.
4.
Configurethemappingrelationbetweenthetwosites.
a.
Createanewsitemapping.
b.
SelecttheTeamcenterEnterprisesiteasthesourcesite.
c.
SelecttheTeamcentersiteasthetargetsite.
d.
Selectthemapcontrolfilesthatdefinethemappingbetweenthetwosites.
e.
Savethesitemapping.
ConfigurationHomeUsetheConfigurationHomepanetostartthewizardforconfiguringaneworexistingsiteortostartthewizardtoconfigureoreditthemappingbetweensites.
Youcanclosethewizardandreturntotheconfigurationinterfaceatanypointintheprocessbyclickingtheclosebuttonintheupperrightcornerofthewindow.
NochangesarecommittedtothedatastorebythewizarduntilyouclickSaveattheendofthewizardsteps.
ThefinalstepalsoprovidesaCancelbuttonthatreturnsyoutotheconfigurationinterface.
SiteConfigurationwizardUsetheSiteConfigurationwizardtocreateoreditexistingsitesthatparticipateinDataExchangeandtoremovesiteconfigurationsthatarenolongerparticipating.
Thefollowingvaluesarerequiredtoconfigureanytypeofsiteandarecollectedduringthewizardsteps:SiteType5-10TeamcenterIntegrationFrameworktcif13.
1Chapter5:ConfiguringandmanagingTeamcenterIntegrationFrameworkoperationConfiguringandmanagingTeamcenterIntegrationFrameworkoperationSitetypesaredefinedbytheintegrationsselectedinTeamcenterEnvironmentManager(TEM)whenyouinstalledTeamcenterIntegrationFramework.
SiteIDDefinesthesiteID.
ForTeamcentersites,thesiteIDisgeneratedduringtheinstallationprocessandisdisplayedwhenyouopenthesiteintheOrganizationapplication.
ForTeamcenterEnterprise,thesiteIDisdefinedwhenyoucreatethelocalsiteobject.
ThisvalueissuppliedbyGTAC.
ForJDBCconnections,anystringisacceptable;abestpracticeistoprovideastringthatidentifiesthetargetdatabase.
SiteSecurityDefinestheTeamcenterIntegrationFrameworkusersusedtoaccesstheTeamcenterorTeamcenterEnterprisesite.
Theusernameandpasswordmustbeavaliduseratthetargetsite.
SiteConnectorDefinestheTeamcenterIntegrationFrameworkconnectorusedtocommunicatewiththesite.
TeamcenterPMMspecificconfigurationEndpointDefinestheendpointforthePMMsite.
Import/ExportLibraryDefinesthelibrarythatTeamcenterIntegrationFrameworkusestoexportandimportdatatothePMMsite.
JDBCspecificconfigurationDriverDefinesthedatabasedriverTeamcenterIntegrationFrameworkusestoconnecttothesite.
URLDefinesthedatabaseURLassociatedwiththesite.
SiteMappingwizardUsetheSiteMappingwizardtoconfigureoreditexistingdatamodelmappingbetweenthesitesinyourDataExchangeenvironment.
Youselectthesourceandtargetsitesandsetthetransformservicesandmapcontrolfilesusedtoperformthemappingonthepanesinthistab.
TheMapControlFilespanesprovidestheAvailableTransformslistthatdisplaysallthetransformsintheTeamcenterIntegrationFrameworkdatastore.
Selectthedesiredtransforminthelist,andusetherightarrowbuttontomoveittotheSelectedTransformslist.
UsetheleftarrowbuttontomoveatransformoutoftheSelectedTransformslist.
UsetheupanddownarrowstoreorderthesequenceofthetransformsintheSelectedTransformslist.
Thischangeprocessingorder.
tcif13.
1TeamcenterIntegrationFramework5-11ConfiguringandmanagingTeamcenterIntegrationFrameworkoperationChapter5:ConfiguringandmanagingTeamcenterIntegrationFrameworkoperationUseaddallarrowbuttontomovealltransformstotheSelectedTransformslistortheremoveallarrowbuttontoremovealltransformsfromthelist.
ConfiguringtheintegrationframeworkemailserviceTheTeamcenterIntegrationFrameworkemailserviceusedbyDataExchangeandotherprocessesisconfiguredbytheemailservice.
smtp-uripropertyinthecom.
tc.
esb.
camel.
cfgconfigurationfile.
YoucanconfiguretheemailserviceinthePropertiespaneoftheconfigurationuserinterfaceordirectlyintheconfigurationfile.
ThepropertymustbeformattedasaCamel/SpringURI,forexample:#Needtosupplythesmtpserverandappropriatefromandto.
emailservice.
smtp-uri=smtp://tbd.
comfrom=no-reply@tbd.
com&to=tcifadmin@tbd.
comTheemailserviceconfigurationrequiresthatyoudefineanSMTPserveranddefaultsforthemessage,suchasasendingemailaccountandpossiblyanemailaccounttocopyonallmessages.
Forfurtherinformationonsupportedemailprotocolsandparameters,seetheCamelwebsiteat:http://camel.
apache.
org/mail.
htmlTroubleshootingTeamcenterIntegrationFrameworktransferprocessesThefollowingfigureshowsthetransferflowfrombetweenaTeamcentersiteandathird-partyproductforaremoteimportaction.
YoucanusethisdiagramandtheTeamcenterIntegrationFrameworkActivityStatususerinterfacetotroubleshootatransferprocess.
5-12TeamcenterIntegrationFrameworktcif13.
1Chapter5:ConfiguringandmanagingTeamcenterIntegrationFrameworkoperationConfiguringandmanagingTeamcenterIntegrationFrameworkoperationAdiagramshowingthetransferofdatafromTeamcentertoTeamcenterEnterprisewouldcloselymirrorthesequenceofeventsinthisdiagram.
ForTeamcenterIntegrationFramework,themaindifferenceistheclientthatcallsTeamcenterIntegrationFramework.
TheTeamcenterIntegrationFrameworkisneutral;itexecutesascriptprocessfordatatransferthatcontainsasetofstepsoractivities.
Thefigureprovidesthesequenceofeachstepintheprocessshown.
YoucanviewTeamcenterIntegrationFrameworkactivitystatusintheconfigurationinterfacebychoosingView→ActivitystatusorintheTeamcenterIntegrationFrameworklogfile.
ATeamcenterIntegrationFrameworkactivitycanhavethefollowingstatuses:NullActivityisnotyetstartedorinactive.
InProgressActivityhasstarted.
DetailsindicatesActive.
WaitingAnerroroccurredduringtheactivity.
Theprocessiswaitingforamanualretry.
Afterresolvingtheerrorcondition,theusermustusetheResumebuttonontheDetailedTransferStatusdialogboxtostarttheretry.
CompleteActivityhasfinished.
DetailsindicatesSucceededorFailed.
AbortedThetransferwasabortedbyauserpriortoorduringtheactivity.
CommonactivityIDsare:SchedulingDataExportDataImportDataMappingNotificationControllingfileuploadingToguardagainstpossibleuploadingofmaliciousdatatotheTeamcenterIntegrationFrameworkdatastore,youcandisableaccesstotheTeamcenterIntegrationFrameworkconfigurationDataStoreUploadpane.
Bydefault,thepaneisdisplayed.
Hidethepanebysettingtheui.
datastore.
upload.
disabledparameterintcif/container/etc/system.
propertiestotrue.
StoppingTeamcenterIntegrationFrameworkYoucansafelyshutdownandrestartanyTeamcenterIntegrationFrameworkinstancewithoutlosinganyrequests.
ThestateofTeamcenterIntegrationFrameworkiscapturedpriortoashutdown,andtheinstanceisbroughtbacktothatstatewhenrestarted.
WhenTeamcenterIntegrationFrameworkisrunningasanodeinacluster,messagesareprocessedbyotherinstancesintheclusteruntiltherestartednoderejoinsthecluster.
UsethefollowingprocesstostopTeamcenterIntegrationFramework1.
Navigatetothecommandwindow(Windows)orKarafconsole(UNIX)inwhichTeamcenterIntegrationFrameworkisrunning.
2.
Typectrl-dortheKarafcommandsystem:shutdown.
IfTeamcenterIntegrationFrameworkisrunningasaserviceonWindows,stoptheserviceusingtheWindowsTaskManagerorMicrosoftManagementConsole.
tcif13.
1TeamcenterIntegrationFramework5-13ConfiguringandmanagingTeamcenterIntegrationFrameworkoperationChapter5:ConfiguringandmanagingTeamcenterIntegrationFrameworkoperationManagingpasswordsConfiguretheApacheKarafpasswordTheTeamcenterIntegrationFrameworkintegrationserverusesApacheKaraftomanageOpenServiceGatewayinitiative(OSGi)bundles.
Thereisabundlemanagementuserinterface(UI)componentthatisexposedthroughaURLendpoint.
Thedefaultlocationforthisendpointishttp://[host-name]:8040/system/console.
Bydefault,theKarafwebconsoleisdisabled.
Toenablethewebconsole,typethefollowingcommandintheKarafshell:features:installwebconsoleYoucanalsoaddwebconsoletofollowingentryincontainer/etc/or.
apache.
karaf.
features.
cfgfiletostartthewebconsolewhenKarafstarts:featuresBoot=webconsoleYoucanconfigureKarafpasswordsusingtheusers.
propertiesfilelocatedinthetcif\container\etcdirectoryofyourintegrationserverinstallationlocation.
Thisfilecontainstheauthorizedusersandtheassociatedpasswordsfortheminthefollowingformat:user-name=password-value[,role][,role].
.
.
KarafpasswordsareusedtoaccesstheSSHconsole,JMXmanagementlayer,andthewebconsole,allusingJAAS-basedsecurityauthentication.
TheinitialconfigurationprovidestheIFAdminuserwithadmin(bothcase-sensitive)asthepasswordandadminastherole.
Forsecurityreasons,youmustchangetheuserandpasswordvaluesandenablepasswordencryption,beforeyouusetheTeamcenterIntegrationFrameworkinaproductionenvironment.
FormoreaboutKarafrolesandrealmsandhowtomanagethem,seetheKarafdocumentationprovidedatwww.
apache.
org.
EnableKarafpasswordencryptionBydefault,Karafpasswordsarestoredinplaintextintheusers.
propertiesfile.
Forsecurity,youmustenablepasswordencryptionwhichreplacestheplaintextpasswordwithanencryptedversionintheusers.
propertiesfilethefirsttimeauserlogsontoKaraf.
Encryptedpasswordsareeasilyidentifiedinthefilebythe{CRYPT}stringinfrontofthem.
Toenablepasswordencryption,enterthefollowingcommandsintheKarafconsolewindow:#editconfigconfig:editorg.
apache.
karaf.
jaasconfig:propsetencryption.
enabledtrueconfig:update#forcearestartdev:restartYoumustrestarttheKarafconsolefortheencryptionfeaturetotakeeffect.
5-14TeamcenterIntegrationFrameworktcif13.
1Chapter5:ConfiguringandmanagingTeamcenterIntegrationFrameworkoperationConfiguringandmanagingTeamcenterIntegrationFrameworkoperationChangetheTeamcenterIntegrationFrameworksecurityrepositorypasswordInadditiontoasingleTeamcenterIntegrationFrameworkadministrativeaccount,theTeamcenterIntegrationFrameworksecurityrepositoryhasanadministrativeaccountdefinedasuid=admin,ou=system.
Thisaccountprovidesaccessemergencymaintenancepurposesonly.
SiemensPLMSoftwarerecommendsyouchangetheaccount'sdefaultpasswordvalue(secret)afteryoustartTeamcenterIntegrationFrameworkthefirsttime.
YoucanuseanyexistingLDAPclienttomakethischange.
Ifyoudonothaveaclient,youcandownloadtheApacheDirectoryStudioforthispurpose.
ForWindowssystems,downloadtheclientfrom:https://directory.
apache.
org/studio/download/download-windows.
htmlForUNIX/Linuxsystems,downloadtheclientfrom:https://directory.
apache.
org/studio/download/download-linux.
htmlThefollowingstepsareanexampleofhowyouchangethepasswordusingtheApacheDirectoryStudio.
1.
InApacheDirectoryStudio,clickNewConnection.
2.
Intheindicatedbox:ConnectionnameTypeadescriptivenamefortheLDAPconnection.
HostnameTypethenameofyourTeamcenterIntegrationFrameworkhost.
PortTypetheTeamcenterIntegrationFrameworkLDAPportnumber(14389bydefault).
EncryptionmethodLeavethedefaultNoencryptionvalue.
ProviderLeavethedefaultApacheDirectoryLDAPClientAPIvalue.
3.
ClickCheckNetworkParametertoverifyconnectivity.
Iftheconnectionissuccessful,clickNext.
4.
Intheindicatedbox:AuthenticationMethodLeavethedefaultSimpleAuthenticationvalue.
BindDNoruserTypeuid=admin,ou=system.
Bindpasswordtcif13.
1TeamcenterIntegrationFramework5-15ConfiguringandmanagingTeamcenterIntegrationFrameworkoperationChapter5:ConfiguringandmanagingTeamcenterIntegrationFrameworkoperationTypesecret.
5.
ClickCheckAuthenticationtoverifyyouenteredthepropercredentials.
Ifauthenticationissuccessful,clickFinish.
6.
Intheleftnavigationpane,expandou=systemandselectui=admin.
Intherightpane,double-clickuserPassword.
7.
SelecttheNewPasswordtabandtypeyourdesiredpasswordintheEnterNewPasswordbox.
LeavetheothervaluesastheyareandclickOK.
TeamcenterIntegrationFrameworkloggingTeamcenterIntegrationFrameworkmessageobjectsTheTeamcenterIntegrationFrameworkmessagingsystemcontainsthefollowingobjects:LogMessageOneLogMessageobjectiscreatedforeachuniquemessagereceivedbythesystem.
UniquelyidentifiedbytheMessageIDvalue.
ActivityStatusTheActivityStatusprovideseitheraProcessStatus(processorsubprocess)oraStepStatus(atomicstep).
AnactivitymaybeperformedmorethanonceinaprocesssoeachactivityisgivenauniqueactivityIDvaluebythemessagingsystem.
ProcessStatusOneProcessStatusobjectiscreatedforattempttoprocessamessage.
ItisuniquelyidentifiedbytheProcessIDvalue.
Amessageisnormallyonlyprocessedonce;however,ifthereareretriesattempted,therecanbemultipleProcessStatusobjectsassociatedwithaLogMessageobject.
Aprocessiscomposedofstepsandpossiblysubprocesses.
Forinstanceexport,mapping,andimportarestepsandreplicatostubnotificationisasubprocessthatmayhaveoneormoresteps.
ArequestforasubprocessusesthesamemessageIDvalueastheparentprocesssoitcanbetrackedaspartoftheparentprocess.
StepStatusOneStepStatusobjectiscreatedforeachstepintheprocess.
Astepisanatomicunitandhasnosubsteps.
Anactivitythathasmultiplestepsistrackedbyaprocessstatusandnotastepstatus.
Eachofthemessagingobjectscanstoreadditionalpropertiessuchasclientinformation,logginginformation,andprocessstate.
Forexample,ifaprocessfailedatastep,itispossibleforthatprocesstotrackthefailureinthemessagingsystemalongwiththeauditinginformation.
Ifthemessageisresent,theprocesscanusethatinformationtoresumefromwherethepreviousprocessingfailed.
5-16TeamcenterIntegrationFrameworktcif13.
1Chapter5:ConfiguringandmanagingTeamcenterIntegrationFrameworkoperationConfiguringandmanagingTeamcenterIntegrationFrameworkoperationConfigureTeamcenterIntegrationFrameworkexceptionmessageloggingTeamcenterIntegrationFrameworkusestheTeamcenterLogManagerandastandardmessageconfigurationfileforexceptionmessagelogging.
Youcancustomizethelogfilecontentsbyprovidingacustomconfigurationfile.
InstandardTeamcenterIntegrationFramework,the/etc/org.
ops4j.
pax.
logging.
cfgXML-basedconfigurationfilecontrolstheloggingbehavioroflog4j.
Bymodifyingtheconfigurationfile,youcanreconfigureseveralaspectsoftheloggingprocess.
Forexample,youcan:Controlhowmanylogfilesexist,whatthelogfilesarenamed,andwherethelogfilesarelocatedSetthemaximumsizeofthelogfileChangetheformatoftheentriesinthelogfileSetthelevelofexceptionsloggedThepropertiesofthelogconfigurationfiledefinetheloggingconfiguration.
Forinformationabouttheloggingproperties,seethePaxloggingdocumentationat:https://ops4j1.
jira.
com/wiki/display/paxlogging/ConfigurationStandardoutputstreamThefirstappenderelementintheTeamcenterIntegrationFrameworklogconfigurationfilecreatesalog4jappenderobjectthatlogs(appends)exceptionmessagestothestandardoutputstream(theSystem.
outvalueontheparamelement).
Youcandeletethisappenderifyoudonotwanttologtothestandardoutputstream,oryoumaywanttochangetheformatofthelogentriesusingthelayoutelement.
LeveldefinitionTherootelementdefinesalog4jcategorythatincludesallTeamcenterIntegrationFrameworkexceptionmessages.
Youcaneasilychangethetypeofmessagesloggedbychangingthevalueofthelevelelement.
Forexample,ifyouchangethevaluefromerrortofatal,onlymessageswithafatallevelarelogged.
ConfiguringTeamcenterIntegrationFrameworktracinginlogfilesEnableTeamcenterIntegrationFrameworkmessagetracinginthelogfilestoaidyouwhenyouaretroubleshootingaproblem.
Toenablemessagetracing:1.
Openthetcif/container/etc/org.
ops4j.
pax.
logging.
cfgfileinatexteditor.
2.
LocatetheLogginglevelforalltheTciFclassesandLogginglevelforTcGSJAXBclassesentriesandreplaceDEBUGwithTRACE.
#LogginglevelforalloftheTcIFclasseslog4j.
category.
com.
teamcenter.
esb=TRACE#LogginglevelfortheTcGSJAXBclasseslog4j.
category.
com.
teamcenter.
globalservices=TRACEtcif13.
1TeamcenterIntegrationFramework5-17ConfiguringandmanagingTeamcenterIntegrationFrameworkoperationChapter5:ConfiguringandmanagingTeamcenterIntegrationFrameworkoperation3.
StoptheTeamcenterIntegrationFrameworkserver,removethelogfiles,andrestarttheserver.
YougetfullmessagetracinginthenewlogfilesuntilyouchangetheconfigurationfileandrestarttheTeamcenterIntegrationFrameworkserver.
5-18TeamcenterIntegrationFrameworktcif13.
1Chapter5:ConfiguringandmanagingTeamcenterIntegrationFrameworkoperationChapter6:CustomizingTeamcenterIntegrationFrameworkAddacustomconnectortoTeamcenterIntegrationFramework6-1ExtendingaconnectorinTeamcenterIntegrationFramework6-3UsingGroovyscripts6-4Groovyscriptingenvironment6-4CreatingaGroovyprocess6-5CreatingacustomconnectorextensionusingGroovy6-7Usingmessage-orientedmiddlewaresolutionsandscripting6-8TeamcenterIntegrationFrameworkandmessage-orientedmiddleware6-8Creatinglistenersandqueueswithscripts6-9CreateTeamcenterIntegrationFrameworkqueues6-10MonitorTeamcenterIntegrationFrameworkqueues6-11ManageTeamcenterIntegrationFrameworkjobs6-11ManageTeamcenterIntegrationFrameworkqueues6-12TeamcenterIntegrationFrameworksolutionsupport6-13UsingJAXRSscriptsinTeamcenterIntegrationFramework6-14tcif13.
1TeamcenterIntegrationFrameworkChapter6:CustomizingTeamcenterIntegrationFrameworkAddacustomconnectortoTeamcenterIntegrationFrameworkTeamcenterIntegrationFrameworkisbasedonanOSGIcontainerwithOSGIbundlesusingtheBlueprintdependencyinjectionframework.
ToaddacustomconnectoryoumustcreateanewOSGIbundle.
Thereisamavenarchetypeintheexamplesdirectorythathelpsyoucreatecustomconnectors.
Itdoesmanyofthefollowingstepsforyou.
1.
CreateanOSGImanifestfilethatliststheTeamcenterIntegrationFrameworkConnectorbundleasadependency.
Thisconnectorbundlecontainstheinterfacesthatyourcustomconnectormustimplement.
Thisistheminimumrequirement.
Includeotherbundlesasnecessary(forexample,CoreandBindingbundles).
2.
Implementthecom.
teamcenter.
esb.
connection.
ConnectorFactoryinterfaceforyourconnector.
tcif13.
1TeamcenterIntegrationFramework6-1Chapter6:CustomizingTeamcenterIntegrationFramework3.
UsetheBlueprintfiletocreateanOSGIservicethatimplementstheconnectorfactoryinterfacetocreateinstancesoftheconnector.
Theconnectorfactoryinterfaceisasingletoncreatedwhenthebundleisdeployed.
Clientsuseittogetinstancesofthecustomconnector.
4.
IfyourcustomconnectormustsupportGroovyconnectorextensions,embedtheconnectorExtension.
jarfileinthecustomconnectorbundleandincludetheOSGI-INF/blueprint/datastore-classloader-context.
xmlfile.
AddtheconnectorExtension.
jarfiletothemanifestclasspathoftheconnectorbundle.
Refertotheout-of-the-boxTeamcenterIntegrationFrameworkconnectorsasexamples.
5.
UsetheBlueprintfilesofthecustomconnectorbundletoexportthefactoryservice.
Thefollowingexampleshowstheservicepropertiesthatenabletoconfigurationuserinterfacetocreatesitesbasedonacustomconnector.
6.
DeploytheOSGIbundle(JARfile)foryourcustomconnectorbycopyingthefileintothetcif/container/deploydirectory.
Afteritissuccessfullydeployed,thecustomconnectorsitetype(my-connector-type)appearsinthelistofconnectorsthatthesiteconfigurationwizarddisplays.
Tosetconfigurationparametersontheconnector,youcandownloadthefilefromthedatastore,editit,anduploadit.
7.
Usethefollowcommandtocheckiftheconnectorsuccessfullydeployed:list|grepbundle-nameThebundlenameisasubstringofthebundle-SymbolicNamevaluespecifiedintheOSGIcustomconnectorbundle.
Thecommandreturnsavalueinthefollowingformatshowingtheconnectorisdeployed:[279][Active][][80]bundle-name(bundle-version)Thefirstnumberinsquarebracketsisthebundlenumber.
Activeindicatesthebundlesstate.
CreatedappearsinthethirdsetofsquarebracketswhentheSpringservicesarecreated.
Totroubleshootanissue(forexample,ifActiveandCreatedaremissingwhenyoucheckthedeployment),runthefollowingcommandsbundles:headersbundle-numberUsethebundle-numberonthesystem.
Ifthebundlestateisinstalled,usethefollowingcommandtostartitordeterminewhyitdidnotstart:bundles:startbundle-number6-2TeamcenterIntegrationFrameworktcif13.
1Chapter6:CustomizingTeamcenterIntegrationFrameworkCustomizingTeamcenterIntegrationFrameworkExtendingaconnectorinTeamcenterIntegrationFrameworkInTeamcenterIntegrationFramework,avoidcreatingsubclassesfromtheconnectorimplementationclasses.
SiemensPLMSoftwarerecommendsthatyouwriteConnectorExtensionGroovyscriptsanduploadthemtothedatastore.
Theconnectorextensionscriptsaretheninvokedthroughtheexecutemethodoftheconnector.
Wheninvoked,thescriptispassedtheinstanceofConnectionBoxImplthatisassociatedwiththeConnectoruponwhichtheexecutemethodhasbeeninvoked.
ThroughtheConnectionBoxImplinstance,thebackendconnectionisaccessedandoperationsareperformedagainstit.
IfaConnectorExtensionscriptisuploadedtothedatastoreintothesamepackageastheConnectionBoxImplclassforwhichitisdesignedtobeused,theconnectordiscoversitandmakesitaccessiblebytheConnectorExtensionname.
TheConnectorExtensionnameisdefinedintheConnectorExtensionconstructorasinthefollowingexample:packagecom.
teamcenter.
esb.
connection.
tc.
soa;classMyExtensionScriptextendsConnectorExtension{publicMyExtensionScript(){//Thefirstparameteristhenameofthisconnectorextension//operation.
Thesecondparameterdenotesthenumberofarguments//passedtothisconnectorextension.
super("MyExtensionScript",1);}TheConnectorExtensionnameis"MyExtensionScript".
Becausethescriptisinthepackagecom.
teamcenter.
esb.
connection.
tc.
soa,TeamcenterSOABoxImplwillbeawareoftheConnectorExtensionifitisuploadedintotheappropriatedirectoryinthedatastore.
Forexample,/solution/mySolution/script/com/teamcenter/esb/connection/tc/soa.
Ifexecute("MyExtensionScript")iscalledagainsttheTeamcenterSOAconnector,itwillinvoketheexecute(String,ConnectionBoxImplementor,Object…)methodoftheConnectorExtension.
UsingspecificpackagesYoucanconfigureeachofthestandardconnectorstouseadifferentpackagefortheconnectorextensionsthattheconnectorbindsbynamebyaddingaparametersuchasintheconnectorconfigurationfileforthesite.
ThiscausestheConnectortoloadtheConnectorExtensionscriptsfromthespecifiedpackageratherthanfromthedefaultpackage.
Usingfully-qualifiedclassnamesYoucanspecifythefully-qualifiedclassnameofthescriptratherthantheConnectorExtensionnamewhencallingtheexecutemethodoftheconnectorwiththeformconnector.
execute("my.
package.
MyExtension",…).
Inthisexample,theConnectorsearchesforaConnectorExtensionscriptinthedatastorein/solution/*/script/my/package/MyExtension.
groovy,compilesit,andinvokestheexecutemethoddefinedintheGroovyscript.
tcif13.
1TeamcenterIntegrationFramework6-3CustomizingTeamcenterIntegrationFrameworkChapter6:CustomizingTeamcenterIntegrationFrameworkUsingGroovyscriptsGroovyscriptingenvironmentTeamcenterIntegrationFrameworksupportstheuseofJava-likeclassesresidinginthedatastore.
GroovyisadynamiclanguagefortheJavaVirtualMachine(JVM)thathasadditionalfeatures,suchasclosures,builders,anddynamictyping.
AlthoughGroovyintegrateswithallexistingJavaclassesandlibraries,certainoperationswithJavagenericscausecompilererrors.
TherearealsosomearrayinitializationsthatmustbewrittendifferentlyinGroovy.
Groovyprovidestheabilitytostaticallytypecheckandstaticallycompileyourcode.
Groovysupportsdomain-specificlanguagesandothercompactsyntax.
ThescriptsdistributedwithTeamcenterIntegrationFrameworkprovideexamples.
Unittestingandmockingaresupportedout-of-the-boxandyourscriptscompilestraighttoJavabytecode,soyoucanuseitanywhereyoucanuseJava.
Whenthefunctionalityintheclassesinthedatastoreisaccessed,themostrecentversionoftheclassuploadedtothedatastoreisused.
NocompilationisrequiredoutsideoftheTeamcenterIntegrationFrameworkenvironment.
Theclasscanbedownloadedfromthedatastore,modified,uploadedbackintothedatastore,andthechangestakeeffectimmediately(seethecaveatlaterinthissection).
ThedifferenttypesofGroovyscriptsthatcanexistinTeamcenterIntegrationFrameworkare:Scriptsthatfulfillwebservicerequests.
ScriptsthatfulfillRESTservicerequests.
ScriptsthatrespondtoeventspostedbythePublishServiceservice.
Scriptsthatextendconnectors.
Scriptsthatextendtheplatform.
Mostscriptsexecutewithintheclassloadingcontextofthecom.
teamcenter.
esb.
servicesbundle.
TheyhaveaccesstotheclassesthatarevisiblewithintheservicesOSGibundle.
ViewingtheheadersofthatbundleprovidesthecompletelistofpackagesthatGroovyscriptscanaccess.
AllbuttheConnectorExtensionandPlatformExtensionscriptsfallinthiscategory.
Similarly,thescriptsthatextendtheconnectorscanexecutewithintheclassloadingcontextoftheconnectorwheretheyareused.
Thesescriptsimplementthecom.
teamcenter.
esb.
connection.
ConnectorExtensioninterfaceandarestartedusingtheexecute()methodoftheBOSClientclass.
ThesescriptsareintendedtointeractwiththeAPIsofthesystemthattheconnectorisinteractingwithtoprovideadditionalcapabilitiestotheconnector.
TheConnectorExtensionscriptsareanalogoustothePlatformExtensionscripts.
Theseimplementthecom.
teamcenter.
esb.
platform.
extension.
PlatformExtensioninterface.
YoucancreateanOSGibundlewithacopyofthePlatformExtensionjarembeddedinitandanAriesBlueprintdeclarationofanExtensionServicespringbean.
Thisstructureprovidesanewclassloadingcontextinwhichgroovyscriptscanexecute.
ThisnewOSGibundlecanimportpackagesnotaccessiblebytheothercontextswherescriptscanrun.
UsingthePlatformExtensionManagerthescriptsrunningintheservicesbundlecanstarttheplatformextensionscriptsprovidingaccesstootherpackagesandversionsofsoftware.
6-4TeamcenterIntegrationFrameworktcif13.
1Chapter6:CustomizingTeamcenterIntegrationFrameworkCustomizingTeamcenterIntegrationFrameworkScriptscanstartclassesthataredeclaredinotherscripts.
ThereisalimitationwiththeGroovyclassloaderwhereaGroovyclassthatiscalledfromanotherGroovyclassisnotnecessarilythelatestversionuploadedtothedatastore.
IfaGroovyclassisloadedintotheGroovyclassloaderand:Itissubsequentlymodified.
TheclassisnotloadedexplicitlybytheGroovyclassloader(asmostGroovyProcessesandRESTfulscriptsare).
ItisdirectlyreferencedfromaGroovyclass.
ThentheGroovyclassloaderdoesnotchecktoseeiftheversioninthedatastoreismorerecent.
Itisnotfeasibletocompileallscriptsastheyareuploadedastheymayrequireotherscriptsthathavenotbeenuploaded.
CreatingaGroovyprocessTeamcenterIntegrationFrameworkprocessescanbecontrolledusingGroovyscripts.
YouuploadtheGroovyscripttotheTeamcenterIntegrationFrameworkdatastore.
CalltheprocessbysendingaSOAPrequesttotheTeamcenterIntegrationFrameworkprocessorprocessAsyncendpoints.
tcif13.
1TeamcenterIntegrationFramework6-5CustomizingTeamcenterIntegrationFrameworkChapter6:CustomizingTeamcenterIntegrationFrameworkYoucanpassawebservicerequesttoaGroovyrequestobjectscripttoaccessaGroovyJAXBobjectinthedatastore.
Forexample,ifarequestobjectscriptcontainsthehttp://teamcenter.
com/esb/examplenamespaceattributevalueandanexample-requestlocalnameattributevalueintherootelement,TeamcenterIntegrationFrameworkattemptstounmarshaltheelementintoaGroovyJAXBobjectthatisinthe/script/com/teamcenter/esb/example/ExampleRequest.
groovydatastorelocation.
ThenamespacesareconvertedintopackagenamesfollowingstandardJAXBconventionsandthepackagenamesaremappedtodatastorelocationnames.
SiemensPLMSoftwarerecommendsthatyouputthe/scriptlocationunderthe/solution/solution-namelocationinthedatastore.
Thefollowingisanexampleofarequestobjectscript:packagecom.
teamcenter.
esb.
example;importjavax.
xml.
bind.
annotation.
*;@XmlRootElement(name="example-request",namespace="http://teamcenter.
com/esb/example")@XmlAccessorType(XmlAccessType.
NONE)publicclassExampleRequestextendscom.
teamcenter.
esb.
internal.
bind.
JAXBBaseObject{@XmlAttributeprivateStringid_;@XmlElement(name="value",namespace="http://teamcenter.
com/esb/example")privateStringvalue_;publicStringgetID(){returnid_;}publicvoidsetID(Stringid){id_=id;}publicStringgetValue(){returnvalue_;}publicvoidsetValue(Stringvalue){value_=value;}}ThisscriptincludesJAXBannotationsthatallowTeamcenterIntegrationFrameworktounmarshalitfromXMLintoaJavaobject.
YoucanconvertaschemafileintoJAXBclassesusingCXForAxis2toolsandthenchangetheextensionfrom.
javato.
groovytouseitasaGroovyscript.
TeamcenterIntegrationFrameworkappendsProcessortoaninputreceivedinaformatsimilartocom.
teamcenter.
esb.
example.
ExampleRequestthroughaSOAPrequest.
ItthenlooksforaGroovyscriptwiththatname(com.
teamcenter.
esb.
example.
ExampleRequestProcessor)toprocesstherequest.
TheprocessorscriptmustimplementtheProcessServiceinterfaceandtheprocessingmethodmustacceptanargumentwhosetypematchestherequestclass.
Youuploadtheprocessorscriptintothedatastorewithinthesamesolutionastherequestscriptandinthesamedirectory(package)withinthe/scriptlocation.
Thefollowingisanexampleofaprocessorscript:packagecom.
teamcenter.
esb.
example;importcom.
teamcenter.
esb.
client.
BOSClient;importcom.
teamcenter.
esb.
client.
BOSClientFactory;importcom.
teamcenter.
esb.
commons.
data.
SerializableArrayList;importcom.
teamcenter.
esb.
commons.
data.
SerializableList;importcom.
teamcenter.
esb.
exception.
ESBException;importcom.
teamcenter.
esb.
model.
security.
Credentials;importcom.
teamcenter.
esb.
service.
ProcessService;importjava.
lang.
reflect.
Method;publicclassExampleRequestProcessorimplementsProcessService{publicExampleResponseprocess(ExampleRequestrequest,Credentialscredentials)throwsESBException{ProxyServiceRequestserviceRequest=newProxyServiceRequest();serviceRequest.
setSiteId("111");//shouldmatchsomesiteinTcIFserviceRequest.
setMethodName("com.
tcesb.
test.
connector.
extension.
ComputeExtension");6-6TeamcenterIntegrationFrameworktcif13.
1Chapter6:CustomizingTeamcenterIntegrationFrameworkCustomizingTeamcenterIntegrationFrameworkserviceRequest.
getArguments().
addAll(Arrays.
asList("AVG",9,6,3));Objectresult=ProxyService.
callService(serviceRequest,credentials);ExampleResponseresponse=newExampleResponse();response.
setValue("response:"+result);returnresponse;}@OverridepublicMethodgetMethod()throwsNoSuchMethodException{returngetClass().
getMethod("process",ExampleRequest.
class,Credentials.
class);}}Thecom.
teamcenter.
esb.
service.
ProcessServiceinterfacecontainsonegetMethod()methodthatreturnsajava.
lang.
reflect.
Methodobject.
ThemethodtakesthegiveninputandcallsaCredentialsobject.
ProcessorscriptsmustusetheProxyServicerequesttosendexecuterequeststotheconnectors,whereconnectorspecificlogicisexecuted,usingtheclasspathoftheconnector.
CreatingacustomconnectorextensionusingGroovyAconnectorextensionisaJavaorGroovyclassthatimplementsthecom.
teamcenter.
esb.
connection.
ConnectorExtensioninterface.
TeamcenterIntegrationtcif13.
1TeamcenterIntegrationFramework6-7CustomizingTeamcenterIntegrationFrameworkChapter6:CustomizingTeamcenterIntegrationFrameworkFrameworkprovidessomeJavaconnectorextensionclassesout-of-the-box.
TheframeworklooksforcustomConnectorExtensionclassesthataregroovyscriptsuploadedtotheTeamcenterIntegrationFrameworkdatastoreinthe/scriptlocation.
Theconnectorsprovidequery,update,insert,anddeleteAPIsalongwithanexecutemethod.
Theexecutemethodisgiventhenameofamethodtoexecuteandanarrayofarguments.
ThemethodnameisthenameofaconnectorextensionprovidedwiththeconnectororthenameofagroovyscriptimplementingtheConnectorExtensionmethodinthedatastore.
YouusethefullclassnameincludingthepathfortheGroovyscripttocalltheConnectorExtensionmethod.
ThefollowingisanexampleofaconnectorextensionGroovyscript:tcesb.
test.
connector.
extensionimportcom.
teamcenter.
esb.
commons.
data.
SerializableList;importcom.
teamcenter.
esb.
connection.
ConnectionBoxImplementor;importcom.
teamcenter.
esb.
exception.
ESBException;importjava.
io.
Serializable;classEqualExtensionextendscom.
teamcenter.
esb.
connection.
ConnectorExtension{publicEqualExtension(){//ConnectorExtensionconstructortakesthename(willnotbeusedforagroovyscript),//andthenumberofargumentsexpected.
Theargumentspassedinarecheckedbythebase//connectorimplementationsothattheextensiondoesnothavetocheck.
super("equal",[1]asInteger[]);}@OverridepublicSerializableexecute(StringobjectName,ConnectionBoxImplementorboxImpl,SerializableListargumentList)throwsESBException{Objectargument=argumentList.
get(0);if(argumentinstanceofjava.
lang.
String&&objectName.
equals(argument)){return"equal";}return"unequal";}}Usingmessage-orientedmiddlewaresolutionsandscriptingTeamcenterIntegrationFrameworkandmessage-orientedmiddlewareTeamcenterIntegrationFrameworksupportsmessage-orientedmiddlewaresolutionsandscripting.
Leveragingmessage-orientedmiddlewarecanprovideseveralbenefits:Improvedloadlevelingbylettingproducersanddestinations(queues)sendandreceivemessagesatdifferentrates.
Easierintegrationandscalingofsystemresources.
Decoupledcommunicationletsserversconnectasneededandperformtheiroperationsinanasynchronousfashion.
Byaddingthecom.
teamcenter.
esb.
service.
messaging.
JMSListenerannotationtomethodsinGroovyscripts,TeamcenterIntegrationFrameworkwillusethemethodstocreatequeueswiththespecifiednamesorwillmakethelistenersavailableforlaterqueuecreation.
Whenthelistenerisassociatedwithaqueue,andcodeinthemessage'sbodyisassociatedwithamethod'sObjectparameter,TeamcenterIntegrationFrameworkcancreateprocessinglogicthatpullsthemessageoffthequeueandcallsthemethodwiththemessageobject.
SeeUsingGroovyscriptsfordetailsoncreatingandworkingwithGroovyscripts.
6-8TeamcenterIntegrationFrameworktcif13.
1Chapter6:CustomizingTeamcenterIntegrationFrameworkCustomizingTeamcenterIntegrationFrameworkCreatinglistenersandqueueswithscriptsUsethefollowingprocessestocreateanddeployTeamcenterIntegrationFrameworkqueuesandlistenerswithscripts.
CreatealisteneronthemethodAddthecom.
teamcenter.
esb.
service.
messaging.
JMSListenerannotationtomethodsinGroovyscriptstoletTeamcenterIntegrationFrameworkusethemethodstocreatedestinations(queues)withthespecifiednamesortomakethelistenersavailableforlaterqueuecreation.
Whenthelistenerisassociatedwithaqueue,andcode(JSONorXML)inthemessage'sbodyisassociatedwithamethod'sObjectparameter,TeamcenterIntegrationFrameworkcancreateprocessinglogicthatpullsthemessageoffthequeueandcallsthemethodwiththemessageobject.
Anannotatedmethodmustmeetoneofthefollowingrequirements:Theannotatedmethodmustacceptoneparameterwhichimplementscom.
teamcenter.
esb.
internal.
bind.
JSONInterface.
Theannotatedmethodmustextendeithercom.
teamcenter.
esb.
internal.
bind.
JSONObjectorcom.
teamcenter.
esb.
internal.
bind.
JAXBBaseObject.
Themethodcanoptionallyacceptasecondparameter,com.
teamcenter.
esb.
model.
security.
Credentials.
Thefollowingexamplecreatesaqueuenamed"queue-test":packageservice.
ui.
test;publicclassFailingProcessor{@com.
teamcenter.
esb.
service.
messaging.
JMSListener(destinationName="queue-test")publicstaticui.
test.
ProcRequestprocess(ui.
test.
ProcRequestrequest){thrownewException("Failed");}}ThemethodreturnsaninstanceofanyGroovyclassthatextendscom.
teamcenter.
esb.
internal.
bind.
JAXBBaseObjectorcom.
teamcenter.
esb.
internal.
bind.
JSONObject,orthatusestheJavaArchitectureforXMLBinding(JAXB)orJacksonData-bind(JSON)annotations.
Thecom.
teamcenter.
esb.
service.
messaging.
JMSListenerannotationhasoptionsforcontrollingtheprocessingofmessagessuchasspecifyingthenumberofretriesandtimeouts.
SeetheTeamcenterIntegrationFrameworkAPIdocumentationfordetailsonthecom.
teamcenter.
esb.
service.
messaging.
JMSListenerannotation'soptions.
(APIdocumentationsupportingTeamcenterIntegrationFrameworkisavailablefromtheTeamcenterIntegrationFrameworkwebinterface.
Browseto:/tcif/controller/indexandclickDocumentation.
)CodedoptionscanalsobeoverriddenfromtheTeamcenterIntegrationFrameworkwebinterfaceasdescribedinManageTeamcenterIntegrationFrameworkqueues.
DeploythescriptDeployGroovyscriptsbyplacingtheminthe/solution/solution-name/scriptdirectoryinthedatastore.
ForallscriptsinthatdirectorythathavemethodswiththeJMSListenerannotation,TeamcenterIntegrationFrameworkcreatesaqueuewiththenamespecifiedontheannotation.
Ifnonameistcif13.
1TeamcenterIntegrationFramework6-9CustomizingTeamcenterIntegrationFrameworkChapter6:CustomizingTeamcenterIntegrationFrameworkspecifiedontheannotation,thennoqueuewillbecreated,butthelistenerwillbeavailableforlatercreationofqueuesasdescribedinManageTeamcenterIntegrationFrameworkqueues.
CreateTeamcenterIntegrationFrameworkqueuesAdministratorscancreateTeamcenterIntegrationFrameworkdestinations(queuesandtopics)usingtheTeamcenterIntegrationFrameworkwebinterface.
CreateaqueuefromanyTeamcenterIntegrationFrameworksiteinacluster.
Oncecreatedandstarted,thequeueisavailabletoallsitesinthecluster.
1.
OpentheTeamcenterIntegrationFrameworkwebinterfacebybrowsingto:/tcif/controller/index.
2.
IntheTeamcenterIntegrationFrameworkwebinterface,clickQueueingtodisplaythecurrentqueues.
3.
Click.
Thedefaultsettingsforthequeuearedisplayed.
4.
Enteranameforthequeue.
ThequeuenamemustbeuniqueintheTeamcenterIntegrationFrameworkcluster.
5.
OntheGeneralSettingstab,updatethequeuesettingsasnecessaryforthequeue.
StuckTimeOutSpecifiesthelengthoftime,inmilliseconds,beforeanunprocessedjobismovedtothestuckstate.
HungTimeOutSpecifiesthelengthoftime,inmilliseconds,ajobremainsinthestuckstatebeforebeingmovedtothefailedstate.
AutomaticRetriesSpecifiesthenumberofattemptstomaketoretryafailedjob.
Ifthejobdoesnotsucceedafterthisnumberofretries,itissenttothedeadletterqueue(ifavailable).
InitialRetryDelaySpecifiesthelengthoftime,inmilliseconds,topausebeforeretryingafailedjob.
DeadLetterQueueWhensettoOn,adeadletterqueueisavailableforthisqueue.
ParallelismSpecifiesthenumberofmessagesthatcanbeprocessedsimultaneously.
SettingParallelismto1specifiesthatmessagesareprocessedsequentially.
ProcessorSpecifiestheGroovyscriptthatprocessesmessagesinthequeue.
6.
ClickCreate.
Thequeueiscreated.
7.
Locatethenewqueueinthelistofqueues.
Clicknexttothequeuenameandthenclicktostartthequeue.
6-10TeamcenterIntegrationFrameworktcif13.
1Chapter6:CustomizingTeamcenterIntegrationFrameworkCustomizingTeamcenterIntegrationFrameworkMonitorTeamcenterIntegrationFrameworkqueuesAsaTeamcenterIntegrationFrameworkuseroradministrator,youcanmonitorTeamcenterIntegrationFrameworkqueues.
Toperformthefollowingtasks,firstopentheTeamcenterIntegrationFrameworkwebinterfacebybrowsingto:/tcif/controller/index.
ListthecurrentqueuesIntheTeamcenterIntegrationFrameworkwebinterface,clickQueueingintheleftpane.
Thecurrentlyconfiguredqueuesaredisplayed.
FilterthelistofqueuesTofilterthelistofqueuesbyname,enterallorpartofaqueuenameinFiltertheDestinations.
RefreshthelistofqueuesClicktoupdatethelistofcurrentqueues.
Viewaqueue'ssettingsClickforthequeueforwhichyouwanttoviewproperties.
Alistofsettingssuchasitsstatus,numberofautomaticretries,processor,andtimeoutisdisplayed.
Clicktocollapsethesettinglisting.
ManageTeamcenterIntegrationFrameworkjobsAdministratorscanmanageTeamcenterIntegrationFrameworkqueuesandmessagesusingtheTeamcenterIntegrationFrameworkwebinterface.
Toperformthefollowingqueuemanagementtasks,firstopentheTeamcenterIntegrationFrameworkwebinterfacebybrowsingto:/tcif/controller/index.
Listthejobsinaqueue1.
IntheTeamcenterIntegrationFrameworkwebinterface,clickQueueingintheleftpane.
Thecurrentlyconfiguredqueuesaredisplayed.
2.
Clickforthequeuecontainingthejobsyouwishtoview.
Thecurrentlyqueuedjobsarelistedalongwiththeircurrentstatuses.
Changejobstates1.
IntheTeamcenterIntegrationFrameworkwebinterface,locatethejobyouwanttomanage.
2.
Changethejobstateasfollows:tcif13.
1TeamcenterIntegrationFramework6-11CustomizingTeamcenterIntegrationFrameworkChapter6:CustomizingTeamcenterIntegrationFrameworkPausejobsClicknexttothejobnameandchoosePause.
StopjobsClicknexttothejobnameandchooseStop.
AdvancejobstothenextstateClicktomovethejobtothenextstate.
RestorejobsinthedeadletterqueueJobsinthedeadletterqueueareidentifiedwithasymbol.
Clicktorestoreajobinthedeadletterqueue.
Delete(purge)jobsClicktoremoveajobfromthequeue.
Onlyjobsinpausedorfailedstatescanbepurgedfromaqueue.
ManagejobpropertiesAdministratorscanmodifycertainpropertiesofqueuedjobs,suchasajob'spriorityrelativetootherjobsinthequeue,ajob'spublisher,andajob'stimeoutsettings.
1.
IntheTeamcenterIntegrationFrameworkwebinterface,locatethejobyouwanttomanage.
2.
Clickforthejobyouwishtoview.
Detailedinformationaboutthejobisdisplayed.
3.
ClickthePropertiestab.
Alistingoftheavailablejobpropertiesisdisplayed.
4.
Modifythepropertiesasnecessary.
5.
ClickSaveChanges.
Thejobisupdatedwiththechanges.
ManageTeamcenterIntegrationFrameworkqueuesAdministratorscanmanageTeamcenterIntegrationFrameworkqueuesandmessagesusingtheTeamcenterIntegrationFrameworkwebinterface.
Toperformthefollowingqueuemanagementtasks,firstopentheTeamcenterIntegrationFrameworkwebinterfacebybrowsingto:/tcif/controller/index.
Pauseandrestartaqueue1.
Locatethenewqueueinthelistofqueues.
2.
Reviewthejobscurrentlyinthequeue.
Pauseanyjobswithapendingstatus.
3.
Clicknexttothequeuenameandthenclicktopausethequeue.
Allpendingjobsinthequeuearepauseduntilthequeueisrestarted.
4.
Clicknexttothequeuenameandthenclicktorestartthequeue.
Pendingjobswillbeprocessedinpriorityorder.
6-12TeamcenterIntegrationFrameworktcif13.
1Chapter6:CustomizingTeamcenterIntegrationFrameworkCustomizingTeamcenterIntegrationFrameworkManagequeuepropertiesandsettingsAdministratorscanmodifycertainsettingsandpropertiesofqueues,suchasqueuepriority,thenumberofjobretries,retryintervals,andsoon.
1.
IntheTeamcenterIntegrationFrameworkwebinterface,locatethequeueyouwanttomanageandpausethequeue.
2.
Clickforthequeueyouwishtomanage.
Detailedinformationaboutthequeueisdisplayed.
3.
ReviewandupdatethesettingsontheGeneralSettingsandPropertiestabsasnecessary.
4.
ClickSaveChanges.
Thequeueisupdatedwiththechanges.
5.
Restartthequeue.
ManagethedeadletterqueueSomejobsmaynotbeprocessedduetothetargetsystembeingunavailable,networkerrors,orotherenvironmentalissues.
Afteraspecifiednumberoffailedretryattempts,ajobismovedtoastoragequeue(adeadletterqueue)ifitstargetqueuehastheDeadLetterSettingsettingenabled.
Onceissuescausingthefailureareaddressed,thejobcanberestarted.
IntheTeamcenterIntegrationFrameworkwebinterface,locatethejobyouwanttorestart.
Jobsinthedeadletterqueuewillbelistedintheirtargetqueue,identifiedwithasymbol.
Clicktorestoreajobinthedeadletterqueue.
Deleteaqueue1.
Inthelistofqueues,locatethequeuetobedeleted.
2.
Letalljobsinthequeuecomplete,orcancelanyjobsinthequeue.
3.
Oncethequeueisemptyofjobs,pausethequeue.
4.
Clickforthequeuetodeletethequeue.
TeamcenterIntegrationFrameworksolutionsupportTeamcenterIntegrationFrameworksupportssolutions.
AsolutiontypicallycontainssomeconfigurationdataandpossiblysomeGroovyscripts.
Insteadofhavingthosefilesspreadthroughoutthedatastoreinthevariouslocationsthatfilesaretraditionallyfound,theTeamcenterIntegrationFrameworkdatastorehandlesfilesinsolutiondirectoriesasiftheyareinthetraditionaldatastorelocations.
Asolutiondirectorystructurestartswiththesolutiondirectorythatcontainsadirectorywiththesolutionname.
Thesolutionnamedirectorycontainstraditionaldatastoredirectories.
Thefollowingisanexampleofthestructureforasolutionnamedsample.
tcif13.
1TeamcenterIntegrationFramework6-13CustomizingTeamcenterIntegrationFrameworkChapter6:CustomizingTeamcenterIntegrationFrameworkThesamplesolutioncontainstraditionaldatastoredirectoriesincludingbos,config,andscript.
Thecontentsofsolutiondirectoriesarehandledasiftheywereinthestandarddirectorieswiththosenames,exceptforprecedencerules.
Forexample,thebusinessobjectdefinitions(BODs)intheBOSdirectoryappearinthedataviews,theconfigurationfilesintheconfigdirectoryareusedtoconfigureconnectors,andthescriptsinthescriptdirectoryareexecuted.
Thescriptsrespondtowebservicerequests,RESTfulservicerequests,connectorextensions,andsoforth.
Scriptsinonesolutioncandependonscriptsinothersolutions.
Topreventpotentialproblems,useuniquenamesforpackagesandothercontentinsolutions.
Thereisadefinedsearchorderforlookingupfilesacrosssolutions.
FilesinthestandarddirectorytakeprecedenceandthenthesolutionsaresearchedinalphabeticalorderingfromAtoZ.
Therefore,ifsolutionjoecontainsa/bos/XXXBOD,thatisusedinsteadofthesameBODfromsolutionsam,ifoneexists.
Anentiresolutioncanberemovedeasilybyselectingthesolutionnameinthefileremovalforminthedatastoreconfigurationpageoftheconfigurationuserinterface.
AutomatedsolutiondeploymentTheautoinstalldirectoryexistsinthecontainerdirectory.
IfyoucreateaZIPfileandmoveittotheautoinstalldirectory,thecontentsoftheZIPfileareextractedanduploadedtothedatastore.
Youcandothesamethingthroughtheuserinterfaceinthedatastoreconfigurationpage.
UsingJAXRSscriptsinTeamcenterIntegrationFrameworkTeamcenterIntegrationFrameworksupportsJAXRSscriptingusinggroovy.
YoucanuploadgroovyclassescontainingmethodswithJAXRSannotations,suchas@PATHand@GETintotheTeamcenterIntegrationFrameworkdatastore.
Youloadtheminthe/script/servicedirectoryanditssubdirectories.
Theseclassesarecompiledwiththegroovydatastoreclassloaderastheyareuploadedtothedatastore.
ThemethodsoftheloadedclassareinspectedtoseeiftheycontaintheJAXRSPATHannotation.
AllmethodscontainingthepathannotationareexposedasRESTfulservicesontheTeamcenterIntegrationFrameworkRepresentationalstatetransfer(REST)port.
TheRESTportisdisplayedontheTeamcenterIntegrationFrameworkconsolewhenyoustarttheframework.
TheRESTportisidentifiedinthesystem.
propertiesfileinthetcif/container/etcdirectory.
6-14TeamcenterIntegrationFrameworktcif13.
1Chapter6:CustomizingTeamcenterIntegrationFrameworkCustomizingTeamcenterIntegrationFrameworkAbestpracticeistonamethepackageoftheclasstomatchitsdirectorystructureunderthescriptdirectory.
Forexample,Ifyouuploadaclasstothescript/service/test/Hello.
groovydirectoryinthedatastore,thepackagenameshouldbeservice.
test.
Ifyouspecifythe@javax.
ws.
rs.
Path("helloworld/you")annotationonthemethod,theURLtoaccessthatendpointishttps://tcif-host:rest-port/tcif/rest/helloworld/you.
Youaccessobjects,suchasHttpRequest,HttpResponse,andsoforth,usingthe@javax.
ws.
rs.
core.
Contextannotation.
The@javax.
ws.
rs.
Producesannotationcanbeusedtospecifywhatthescriptproduces.
Class-levelJAXRSannotationsarenotsupported.
YoucanpasscredentialstotheRESTfulserviceswiththej_usernameandj_passwordorTCSSO_APP_USER_IDandTCSSO_SESSION_KEYqueryparameters.
tcif13.
1TeamcenterIntegrationFramework6-15CustomizingTeamcenterIntegrationFrameworkIndexAappenderelement5-17CConfigurationfileslog4j.
xml5-17EElementsappender5-17root5-17ExceptionlogReconfiguration5-17XMLelementsappender5-17root5-17ExceptionlogconfigurationfileModification5-17rootelement5-17Exceptionmessages5-17Llog4j.
xmlfile5-17LogsExceptionmessages5-17MMessagesExceptionmessages5-17Rrootelement5-17SStandardoutputstream5-17XXMLExceptionlog5-17XMLelementsappender5-17root5-17tcif13.
1TeamcenterIntegrationFrameworkIndex-1SiemensIndustrySoftwareHeadquartersGraniteParkOne5800GraniteParkwaySuite600Plano,TX75024USA+19729873000AmericasGraniteParkOne5800GraniteParkwaySuite600Plano,TX75024USA+13142648499EuropeStephensonHouseSirWilliamSiemensSquareFrimley,CamberleySurrey,GU168QD+44(0)1276413200Asia-PacificSuites4301-4302,43/FAIAKowloonTower,LandmarkEast100HowMingStreetKwunTong,KowloonHongKong+85222303308AboutSiemensPLMSoftwareSiemensPLMSoftware,abusinessunitoftheSiemensIndustryAutomationDivision,isaleadingglobalproviderofproductlifecyclemanagement(PLM)softwareandserviceswith7millionlicensedseatsand71,000customersworldwide.
HeadquarteredinPlano,Texas,SiemensPLMSoftwareworkscollaborativelywithcompaniestodeliveropensolutionsthathelpthemturnmoreideasintosuccessfulproducts.
FormoreinformationonSiemensPLMSoftwareproductsandservices,visitwww.
siemens.
com/plm.
2018SiemensProductLifecycleManagementSoftwareInc.
SiemensandtheSiemenslogoareregisteredtrademarksofSiemensAG.
D-Cubed,Femap,Geolus,GOPLM,I-deas,Insight,JT,NX,Parasolid,SolidEdge,Teamcenter,TecnomatixandVelocitySeriesaretrademarksorregisteredtrademarksofSiemensProductLifecycleManagementSoftwareInc.
oritssubsidiariesintheUnitedStatesandinothercountries.
Allothertrademarks,registeredtrademarksorservicemarksbelongtotheirrespectiveholders.