Create a list in advanced mode - SmartPlant Foundation - IM Update 48 - Help - Hexagon

Creating a list in the List Management Console's advanced mode allows you to configure list management for the list so that you can save the list of items as a list management document. For more information about configuring list management documents, see Saving lists as documents and ISPFListEditControl interface.

Configure a new list

1. Enter a class definition to search for in the Realized Interfaces window.

   

2. Click Go. The list of realized interfaces for that class definition appears.

3. Select an interface.

   You can also select an interface from the Interface Definitions section of the console.

4. Click Create in the Lists window to create a new list for the selected interface. The create wizard appears. The create wizard guides you through the steps to configure the list.

   Using the List Management Console in advanced mode is the only way to enable list management functionality on your list. The New List page of the create wizard allows you to enter the list management information that will enable the extended functionality.

5. Enter information about the new list on the New List page of the wizard. The list will be controlled by a method that uses the client API ListEditContextMenu. The values you enter for the parameters determine the appearance and behavior for the List Edit control for the selected interface.

   What are the parameters in the Method details section?

   Client API - The client API ListEditContextMenu controls list editing. This value is not editable.

   List title - The title that should be displayed on the List Edit window for this list.

   Class definitions for new rows - When new rows are created in the List Edit control, this class definition is used to create a new object in the database. If this value is not specified, create functionality is not available.

   Delete action - When a row is deleted from the List Edit control, it is either deleted or terminated. The default value is Terminate. If this box is left blank, the user will not be able to delete or terminate items from the List Edit control.

   Column set name - The column set to use in the List Edit control. When you create a new list or copy a list, a new column set is created with the same name as the list. You can only change the column set to use for the list when you edit the list from the List Management Console.

   When a user saves a list as a list document, the current state of the list column set is saved with the list document. When the user edits the list from the list document, the columns displayed in the List Edit control are determined by the saved version of the column set, even if the column set has been changed since the list document was created.

   List Management relationship definition - The relationship definition (preceded by - or +) which will be used in the List Edit control to relate the list items to the list management object. This value is needed to enable list management (or "Save As") functionality.

   List Management query method - The UID of the method to use to query for a list management object in the List Edit control. This value is needed to enable list management functionality.

   List Management create method - The UID of the method to use to create a new list management object in the List Edit control. This value is needed to enable list management functionality.

   The object that is created to manage this list must be configured as a list document. The document revision object related to this class definition must realize the interface ISPFListEditControl. This relationship is not created for you in the List Management Console; you must model this yourself. For more information, see ISPFListEditControl interface.

   List Management button caption - The text to append to the list management buttons in the List Edit control. For example, if you enter "Equipment List Document" here, the two buttons display the text "Save As New Equipment List Document" and "Save as existing Equipment List Document." This value is needed to enable list management (or "Save As") functionality.

   Cascade name - The name of the cascade menu for the new list. The cascade menu will be a submenu of the object's shortcut menu. If the name of an existing cascade menu is specified, the new list is added as a menu item to the existing cascade menu. If a new name is specified, the cascade menu will be created with the name specified. If no cascade name is specified, the list appears as a menu item directly on the object's shortcut menu.

   The default value for Cascade name is "List Editing."

   See Configure cascading shortcut menus for more information about cascading menus.

6. Click Next to proceed to the Manage Column Items for Edit page.

7. Modify the column set or column items you want to see in the List Edit control, as necessary. See Manage column items for edit for more information.

   You can also configure column items for your list in the Column Items section of the List Management Console. See Configure column items for a list.

8. Click Next to proceed to the Manage Access Groups page.

   You can also configure the access groups for the list by clicking Edit Access Groups on the List Management Console. See Edit access groups for a list.

9. Modify the list of access groups that should have permission to create or edit this list, as necessary.

10. Click Apply or Finish to save your changes.