Temcenter SOA : Sample SOA Code Setup

In this blog I will provide detail step for setting up sample SOA code provided in install image file under SOA zip file. Below steps is for Java SOA sample code.

1.       Unzip soa_client.zip from install image to TC_ROOT directory. It will create soa_client folder under TC_ROOT.

2.       Install Eclipse 3.6 and launch

3.       Add ClassPath variable for the root location of the soa_client folder.  

Open the Preferences dialog of eclipes (Window --> Preferences ... ).

Select the ClassPath Variable tab ( Java --> Build Path --> ClassPath Variables).  

Add the variable 'TEAMCENTER_SERVICES_HOME', set it to the root path of the 'soa_client' folder

4.       Import the project

Open the Import dialog ( File --> Import... )

Select Existing Project into Workspace (General --> Existing Projects into Workspace )

Click Next, then browse to .../soa_client/java/sample, select Finish

Note:- While importing FileManagement sample, FMS_HOME need to be added just like TEAMCENTER_SERVICES_HOME

5.       Compile the project 

If the IDE is not configured to Build Automatically, force a build of the project

6.       Execute the client application

Open the Debug/Run dialog ( Run --> Debug ...)

Select the HelloTeamcenter Java Application

The launch is configured to connect to the server on http://localhost:7001/tc to change this URI on the Args tab.

If the connection is http, ensure its pointing out to the right URI and this can be checked through Run->Debug Configurations-> Arguments

If it the connection is through iiop, it should be set as follows

-Dhost=iiop:localhost:1572/TcServer1

Note:- Only Java and C++ bindings work in 2-tier mode.

7.       Go through the files to understand how the services are being called and can be used in the custom solution. Refer my OOTB SOA Service Blog for basic understanding of sample code.

 See Also :

Teamcenter SOA : Introduction
Teamcenter SOA : Using OOTB SOA Service
Teamcenter SOA : Create your Own SOA

Teamcenter SOA : Detail Step for Creating SOA

Teamcenter SOA : Using OOTB SOA Services

In last blog I have given introduction to Teamcenter SOA service. In this blog I will provide detail of using OOTB SOA services provided by Teamcenter. Teamcenter provide set of core SOA Framework class for login , Error Logging, Object Model Change framework etc. Apart from core Framework API teamcenter also provide set of SOA service for all modules like Workflow, Change Management, Query, Structure Manager etc. The detail of all API and SOA service can be found in BMIDE in Extension view under Code Generation - > Services.

Process of using SOA Client:

Teamcenter provide SOA framework for creating SOA session and using publish SOA services. For implementing SOA client required following steps.

1)      Implementing Login Credential and session Class encapsulation connection.

2)      Using published SOA service.

3)      Optionally using other Framework services like Object Model Changes, Exception handling etc.

I suggest going through the sample program provided in SAO_client.zip.  I provided the detail of setup step for sample code in this blog.

For using SOA service first thing is to connect to Teamcenter Server with two tier (iiop connection) or four tier  (web URL). Teamcenter SOA framework encapsulates most of connection implementation through com.teamcenter.soa.client.connection class and only required credential management through implementing the CredentialManager interface.

The SOA client can implement either in .NET,C++ or Java. First step is to get the connection instance for SOA which is done by creating connection instance

url is connection string for two tier or four tier server connection. credentialManagerInstance is a instance of class which implemented CredentialManager interface.

public class AppCredentialManager implements CredentialManager

Calling SAO services:

Teamcenter provide set of OOTB SOA service for different modules like work flow etc. Each of this service has its own static service class which provide handle to those specific services. For example Query service handle can be get by

SavedQueryService queryService = SavedQueryService.getService(connectionObj);

Or workflow service instance can be obtain through

WorkflowService wfser = WorkflowService.getService(connectionObj);

connectionObj is the connection instance which we created above. Similarly there are other several services for different functionality. Detail of all services and its operation detail can be seen in BMIDE as shown in below images.

The above image show the SavedQuery and available operation for it. Once we get instance on query service we can invoke all available SOA operation on it. The detail of all operations functionality and its argument Data Type is describe in BMIDE.

Quick Example of using SOA service:

Let look small code snippet of using OTTB SOA service in Java. These below code release the object using operation from TcWorkflow SOA service.

The above code release given object by calling Teamcenter SOA service. This are basic step for doing any SOA service call.

1)      Get Instance of required SOA service by providing connection object.

2)      Prepare input argument Data for requesting for specific services.

3)      Call the specific Operation for achieving the  required results.

In above example we get first WorkFlow service instance. Then we prepare input argument by creating release options object, release input object and populating them with appropriate value.

Note the most of Argument for SOA API takes as array value and return are also in array. The reason for this is that Teamcenter SOA is design is such a way that it takes bulk request (in an array) in single operation for avoiding multiple calls to server from client.  Hence in SOA implementation we have to first create instance of object and then encapsulate them in Array.

I hope the above blog will help you to understand basic aspect of using OOTB SOA services. 

 Also See :
Teamcenter SOA Introduction
Temcenter SOA : Sample SOA Code Setup

Teamcenter SOA : Create your Own SOA
Teamcenter SOA : Detail Step for Creating SOA