Configure a publish method - SmartPlant Foundation - IM Update 48 - 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)

To publish a spreadsheet, a method has to be exposed as a menu option. There is a default method provided called ExcelPublish that is available under the SmartPlant menu. This presents a GUI to select the Excel file to load and the Template document to use with it. It also automatically registers the Excel Publish tool with the data warehouse against the active configuration.

This method, or similar methods, can be configured for each template by specifying the template document name on the method instead of using the option to select it in the GUI. Refer to the to Create a new method for more details on setting up the method.

One of the differences between the Excel Publish and Excel Load is the need to first register the tool with the data warehouse before publishing. This is the same as registering the authoring environment before publishing. To make it easier, there is an option on the ExcelPublish API to auto register at the same time if not already registered.

With auto register selected the registration is made as follows:

  • Using the current server URL.

  • Using the current logged in user.

  • Registering to the current configuration (plant).

  • Registering to the domain in which the target class definition will be stored.

  • The Tool Adapter Prog ID needs to be specified on the method as you would do in the register method. This should be set to SPFAdapter.TEF.Adapters.ExcelAdapter.

The alternative is to unselect the option to not automatically register the tool and create a separate registration method as described in Configuring publish for authored data. The Tool Adapter Prog ID should be set to SPFAdapter.TEF.Adapters.ExcelAdapter.