updateCollectionAsync()

This API considers the current state of the model in the form of the input JSON file and updates the corresponding Teamcenter objects asynchronously.

This API also updates the model properties, model composition (GRM or BVR), and associated files.

ResponseData updateCollectionAsync(String applicationName, String inputData, String contextFolder)

Configure task execution time

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

Two configuration properties in the transmodule.properties file impact task execution time.

Property	Default Value
MaximumProgress	100
MonitorInterval	0.5

Together, these define the timeout threshold, with the default set at 50 minutes. When a task exceeds this duration, the task 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 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 name that identifies the integrating tool, for example, MATLAB, ECAD, or Amesim. This value is used to identify the mapping file of the tool.
• inputData — The delta input payload in the form of a JSON string. This is the JSON file that is created after the compareContainers() API is executed.
• contextDirectory — The context folder of the model data from the staging directory.

Returns

As this is an asynchronous operation, it does not return any results. 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 receive an error.

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