bhmExportOperation API

Downloads behavior models, related datasets, additional data, and referenced models from Teamcenter to the specified folder. This API also restores the original folder structure and unzips the additional data that was zipped during the save operation.

List<BHMOperationOutput> bhmExportOperation(List<String> dataExportInputXMLs)

Input

• dataExportInputXMLs — Specifies a list of xml 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.

In your Java code, you must specify the following:

• In the BHMOperations element, specify the path of the folder where the model is to be exported in the rootModelFolder variable.
• In the modelInfo element, specify values for the following variables:
  • applicationName — Specifies the name of the behavior modeling application, for example, MATLAB.
  • tcuid — Specifies the Teamcenter ID of the model.
• In the exportOperationOptions element, specify the value of the following variable:
  • getAdditionalData — To download additional data, set the value to true.

Output

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 export.
rootModelIdentifier	Specifies the identifier of the root model to be exported.

Example

Pass the following string to the dataExportInputXML argument of the bhmExportOperation API to export a model. To load multiple models, you must pass separate input XMLs to dataOpenInputXML.

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