Overview of using behavior modeling APIs

Teamcenter provides Java APIs for the following behavior modeling operations:

• Open
• Pre-save
• Save
• Export
• Login
• Logout
• Derby cache status
• FCC status

You can invoke these APIs from any Java program or from the behavior modeling tool-specific script.

To use the APIs:

1. Implement an external Java program or tool-specific script using the published APIs.
2. Add all the .jar files in the Teamcenter_ROOT\bhm directory to the Java build path libraries.
3. If you are using MATLAB, ensure that you add the following entries to the PATH variable:
   • MATLAB_ROOT\bin\win64
   • MATLAB_ROOT\sys\jxbrowser\win64\lib
4. Add xercesImpl.jar to the Java build path libraries.

The class OperationsAPIs in the com.teamcenter.behaviormodeling.commonclient.operations.api package contains the behavior modeling integration APIs.

Before using the APIs, you must establish a Teamcenter session using the login API.

Use the utility functions to generate the xml input strings for the Save and the Open APIs. This utility is available in the BHMOperationData and the BHMDesign classes located in the com.teamcenter.behaviormodeling.common.xml package.

You can use the Pre-save API to generate input files for the Save API. The xml file that the Pre-save API generates does not contain information about additional data. To save additional data, you must explicitly update the xml file.

Example

The Save API requires an XML string as input. This string contains information about the models to be saved. This XML string can be based on the BHMOperationsSchema.xsd file as follows:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<BHMOperations xmlns="http://www.plmxml.org/Schemas/bhm">
 <operationData modelPath="D:\HSNModels">
  <modelInfo>
   <Model createdDate="Mon Sep 02 12:35:30 2013"
    tcType="Bhm0BehaviorModlRevision"
    instanceType="ModelReference" tcItemName="SingleModel"
    tcrevId="H"
    tcitemId="000205" tcuid="" modelIdentifier="SingleModel"
    modelName="SingleModel">
    <Attributes>
     <Key name="object_desc">
      <Value>My Desc</Value>
     </Key>
     <RevisionAttributes />
    </Attributes>
   </Model>
  </modelInfo>
  <options>
   <saveOperationOptions folderUID="g9UJCdVLopK8AC"
	checkIn="false" addAdditionalData="false" />
  </options>
 </operationData>
</BHMOperations>