exportCollectionAsync()

Note: Contact your Siemens representative before using this API to check for compatibility with future enhancements.

This API exports data to Teamcenter asynchronously from the modeling tool.

The API takes a JSON file payload as input and then creates all the defined objects, GRM and BVR associations, and related files as datasets in Teamcenter.

ResponseData exportCollectionAsync(String applicationName, String rootContainerIdentifier, String userSpecifiedSourceContextFolder, String userSpecifiedTargetContextFolder, String inputData)

Configure task run time

This API performs background task processing using Dispatcher and the Async service.

Two configuration properties in the transmodule.properties file impact the task run time:

Property	Default Value
MaximumProgress	100
MonitorInterval	0.5

Together, these define the timeout threshold — the default is 50 minutes. When a task exceeds this duration, the task's status in Dispatcher is set to TERMINAL and the Async service marks the Operation Status with Error.

Therefore, ensure that you adjust the configuration values based on the task complexity and duration. Increase MaximumProgress for long-running tasks to avoid premature termination.

If you set extreme property values, you may face the following issues:

Setting	Impact
Too Low	Risk of premature task termination
Too High	Potential system blockage from hung tasks

You can update the properties in the transmodule.properties file located at DISPATCHER_ROOT/Module/conf/.

Input Parameters

• applicationName — The application name that identifies the integrating tool, for example, MATLAB, ECAD, or Amesim. This value is used to identify the mapping file of the tool.
• rootContainerIdentifier — Not yet implemented.
• userSpecifiedSourceContextFolder — Not yet implemented.
• userSpecifiedTargetContextFolder — Not yet implemented.
• inputData — The input payload in the form of a JSON string. The JSON payload is categorized in two types: Container and Component. The format and the construct used are the same as those of the exportCollection API.
  • Container — All objects that must be created in Teamcenter must have their input information set as Container. This requirement applies to Teamcenter business objects with the following types: Item and Dataset.
  • Component — All objects that are associated with the newly created container in Teamcenter with a certain GRM relation or as an instance to the product structure of the container.

Returns

As this is an asynchronous operation, it does not return anything. However, the system returns errors when it detects them before calling the Async SOA.

Example: If an existing operation for a project is in progress, and you start another operation for the same project, you get an error.

You can use the MBSE Integration Services Toolkit to try out this API.