Shortcut toolbar - 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)

By default, the Shortcut toolbar displays the Details and History buttons; however, any existing shortcut menu method can be added to the toolbar by updating the method and providing the shortcut icon, display text, or both. When a user logs on to the Desktop Client, the software retrieves all the methods for which the Shortcuticon or Shortcutdisplaytext properties are populated and makes the methods accessible to users through their roles. The Shortcut toolbar is context-sensitive in that it only displays shortcuts that are configured on the selected objects.

To maximize performance, the software does not test any conditions on the methods until the method is selected from the toolbar. For example, if the Signoff and Revise commands are added to the shortcut menu, then the commands would both appear on the menu when the user selects a current document. The conditions are tested when the user selects the method. The user is informed of process status and is given the option to continue processing the valid objects. After the shortcut properties, Shortcuticon or Shortcutdisplaytext, are populated, administrators must log out of the Desktop Client and log back in to see the updates to the existing methods on the Shortcut toolbar.

details on shortcut toolbar

Shortcut toolbar icons

The following table shows Details and History icons that display by default in the list view window.

Icon

Icon name

Actions

Details

Displays the Details dialog box.

History

Displays the History dialog box.

Revise_16

Revise

A change state command; allows the status of a document to be changed.

Update_16

Update

Change the properties of an object.

SignOff_16

Signoff

A change of state command; allows the user to sign off on the documents.

CheckOut_16

Check Out

A change state command; icon indicates that document is checked out.

See Check out a document for details on checking out a document.

CheckIn_16

Check In

A change of state command; icon indicates that the document is checked in.

See Check in a document for details on checking in a document.

Add an existing method to the Shortcut toolbar

Update the required method and enter the following information in the Shortcut Toolbar details section. For more information, see Create a new method.

shortcut method interface details - for details

  • If you run a method on a document object from the shortcut toolbar, the method runs on the object based on the SPFInterfaceDefMethod relationship definition. However, for shortcut menus, you can have multiple objects to which you can assign the methods. For example, you can assign a method to class definitions, interface definitions, and other objects. In these scenarios, the information retrieved by using the same method from the shortcut toolbar and the shortcut menu differs depending on the configuration of the method.

  • When you configure a shortcut for a method, it will disappear from the text section of the actions menu in the Web Client. It will appear only as a shortcut.

Update shortcut methods with load files

You can add methods to the Shortcut toolbar using load files, which allow you to update methods without running a query and also allow multiple methods to be updated at once. Use the following load file to add shortcut toolbar details to a method, in this case, the view and markup method.

- <Container CompSchema="" Scope="" SoftwareVersion="04.03.03.04" ContainerID="DW.General_Admin">

- <!-- Adding an OOTB method to the Shortcut Toolbar -->

- <SPFMethod>

<IObject UID="MTH_ViewNavigateFiles" Name="ViewNavigateFiles" Description="View and Markup" />

<ISPFAdminItem />

<ISPFGUIDisplay SPFGUIDisplayAs="View and Markup" />

<ISPFShortcutMethod SPFShortcutIcon="ViewandNavigateIcon" SPFShortcutDisplayText="View and Markup"
SPFShortcutSeq="25" SPFShortcutTooltip="View and Markup" />

<ISPFSubscribableItem />

<ISPFMethod SPFAvailableinDesktop="True" />

</SPFMethod>

</Container>