Configuring the Merge Progress Notification feature - SmartPlant Foundation - IM Update 46 - Help - Hexagon

SmartPlant Foundation Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10
SmartPlant Markup Plus Version
10.0 (2019)
Smart Review Version
2020 (15.0)

You can configure the Desktop Client to display the progress statistics of a merge action by using the notification functionality to create a Merge Progress Notification item in the Notification List window. The SPFNotification class definition realizes the ISPFMergeProgressNotification interface definition, which exposes properties that display the merge progress statistics. The statistics are displayed in the Merge Progress Notification section in the Properties window, and can be refreshed as the merge progresses.

The MergeObj client API and MergeConfig client API have an argument, Run in asynchronous mode, that allows you to decide whether to use asynchronous mode or not, depending on your merge progress administration needs. Running in asynchronous mode allows you to continue working in the Desktop Client on unrelated work items, which is useful if you are merging large data sets.

  • If you are merging smaller sets of data, you can choose not to process the merge operation asynchronously, and the merge progress statistics will not appear in the Properties window.

  • If you merging large sets of data you can choose to commit in larger sets by setting the Commit Frequency argument to tune performance. The default value is set to 50, but the maximum size is limited to 500 to prevent large rollbacks and excessive memory usage.

    You can merge all the data in one single large transaction by setting the Commit Frequency value to -1. This results in either the Completed or Failed status, and avoids partial merges displayed with the Completed With Errors status.

  • The Properties window displays the progress statistics only for asynchronous merges.

To configure the Desktop Client to use asynchronous mode and display merge progress statistics, create a new method using either the MergeConfig or the MergeObj client API. This method uses asynchronous mode and creates a new merge progress notification item in the Notifications List for each merge operation. The user performing the asynchronous merge can then click the merge progress notification item and the merge progress statistics appear in the Properties window.

The name of the merge progress notification item is comprised of the following values:

  • The name of the user who started the merge action

  • The date and time that the merge action was started

  • The name of the configuration or project that is being merged

For example, superuser-24-14-2014-12:44:30-Project10.

You can use the following steps to configure the Merge Progress Notification functionality in the Desktop Client.

  1. Create two new methods, such as Merge With Progress and Merge Without Progress using the MergeObj client API or MergeConfig client API depending on your merge requirements.

  2. Set the Merge With Progress method argument Run in asynchronous mode to True.

    You can select this method when merging large data sets or projects when you want to continue to work during the merge process, and view the merge progress statistics.

  3. Set the Merge Without Progress method argument Run in asynchronous mode to False.

    You can select this method when merging small data sets or objects, but you have to wait until the merge process finishes as the merge runs synchronously.

SHARED Tip Creating two methods gives you the option to merge data synchronously or asynchronously, depending on your merge requirements.

For more information on the MergeConfig and MergeObj client APIs and methods, see MergeConfig client API and MergeObj client API. For more information on creating methods, see Create or update a method.