bhmOpenBlockLibrary API

Opens behavior library models from Teamcenter.

List<BHMOperationOutput> bhmOpenBlockLibrary(List<String> dataOpenInputXML, String toolType)

Inputs

• dataOpenInputXML — Specifies a list of input strings that are based on the BHMOperationsSchema.xsd file. You can generate the xml string using the JAXB utility available with the BHMOperationData and BHMDesign classes in the com.teamcenter.behaviormodeling.common.xml package.
• toolType — Specifies the behavior modeling tool, for example, MATLAB.

In your Java code, you must specify the following:

• In the BHMOperations element, specify the values for rootModelName and rootModelIdentifier.
• In the Model element, specify the values for modelName, modelIdentifier, and tcuid.
• In the openOperationOptions element, specify the values of the following variables:
  • checkout — To check out the root model, set the value to true.
  • checkOutAll — To check out all submodels of the root model, set the value to true.
  • addAdditionalData — To download additional data, set the value to true.

Outputs

The output is a list of BHMOperationOutput objects (com.teamcenter.behaviormodeling.common package). Each object corresponds to one of the input XML strings sent through dataOpenInputXML.

BHMOperationOutput variable	Description
OperationStatus	Returns one of: OPERATION_FAILED, OPERATION_WARNING, OPERATION_SUCCESSFUL, OPERATION_SUCCESSFUL_WITH_INFO
message	Specifies the cause of the API failure.
inputXML	Specifies the input XML string based on BHMOperationsSchema.xsd.
outputXML	Specifies an XML string based on BHMDesignSchema.xsd.
rootModelName	Specifies the root model to open.
rootModelIdentifier	Specifies the identifier of the root model.
rootModelFullFilePath	Specifies the full path of the root model.

Example

Pass the following string to the dataOpenInputXML argument of the bhmOpenOperation API to load and check out a library model. To load multiple library models, you must pass separate input XMLs to dataOpenInputXML.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<BHMOperations rootModelName="test" rootModelIdentifier="test"
xmlns="http://www.plmxml.org/Schemas/bhm">
  <modelInfo>
    <Model modelName="test" modelIdentifier="test" tcuid="Q2TJlnST4BflXC" />
  </modelInfo>
  <options>
    <openOperationOptions checkOut="true" checkOutAll="false"
     addAdditionalData="false" />
    </options></BHMOperations>