Create a user-defined method for exchanging data - 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)
  1. Click File > New > Administration > Method.

  2. Type a Name and Description for the new method.

  3. In the Display as box, type the text that will appear on the shortcut menu of objects if this method is associated with an interface.

  4. In the Client API box, select SPFExchangeData.

  5. If necessary, define a condition that must be met by an object for this method to be available on the shortcut menu. For more information, see Create conditions.

  6. In the Report Configuration name box, type the name of the report configuration with which you want to associate the method.

  7. Select the Create load job and attach CSV files option to create a load job automatically to process your data and attach CSV files to the job.

    The load job is related to the Exchange Data Loader classification delivered with Data Validator.

    SHARED Tip If your SmartPlant Foundation and Data Validator staging systems are different, you can export the CSVs to a shared location, and the CSVs can be processed later using the Data Validator Job Management module. Select this option only if you are sure that both the SmartPlant Foundation and the Data Validator staging systems are configured on the same site.

  8. In the Workflow name to attach load job box, type the name of the workflow you want to use for the load job.

    Ensure that the workflow specified contains a process step that converts the load job into a Data Validator job to process the generated CSV files. We recommend using the delivered Exchange Load Job Import Validate Export workflow, which contains the SDVExchangeLoadJob process step that converts the load job to a Data Validator job. For more information, see Exchange Load Job Import Validate Export workflow.

  9. Select Available in Desktop client to make this option available to objects when viewed in the Desktop Client application.

  10. If the method will not be available for use in the Web Client, select Suppress in Web Client.

  11. If the command should appear on a submenu available from the shortcut menu, type the name of the submenu in the Cascade name box.

    SHARED Tip Use any of the remaining steps in this procedure if you want to add this new method to the shortcut menu of objects of an associated type. All these properties are optional.

  12. In the Shortcut Icon box, provide the name of the icon image that will be displayed for this command on the shortcut toolbar.

  13. In the Shortcut Display Text box, provide the text that will be displayed on the shortcut toolbar button for this command.

  14. In the Shortcut Sequence box, provide a sequence number that will be used to determine the placement of this command on the shortcut toolbar.

  15. In the Shortcut Tooltip box, type the text that will appear when a user rests the cursor on the shortcut toolbar button for this command.

  • Configure access to this method by relating it to one or more access groups.

  • To make this new method available on a shortcut menu for items of a specific type, relate the method to an interface definition for that type of object.