Create or update a 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 make a new command available to users, you must create the new method first. For more information about adding a new method to a menu for users to access it, see Add a new command to a menu.

  1. Click File > New > Administration > Method.

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

    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.

  3. In the Client API box, select the API that will provide the functionality behind the method. The New Method dialog box changes dynamically to present the applicable API arguments.

    SHARED Tip Hover the cursor over an argument to see a long description of the API argument.

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

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

  6. 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.

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

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

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

  10. 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.

  • You can use the Suppress Open in New Tab in Web Client option in a method to avoid launching actions that open into separate browser tabs.

If you create a new method that uses CreateObj, CopyObj, CreateObjAndRel, or any client API that displays the File attachment configuration option, you must clear this box if your object does not instantiate the ISPFFileComposition interface.