Aras Innovator Platform

Understanding the Editor Interface

The TOC Editor is comprised of three main sections: the toolbar, the contents pane, and the details pane.

Figure 8. Viewing the TOC Editor

Editor Toolbar

The TOC Editor toolbar contains the following controls.

  • Save: Saves the current changes in the editor. If the editor tab is closed before the user clicks Save, all changes made since the last save will be lost. This button will be disabled if there are no changes in the editor.
  • Discard Changes: Discards the current changes in the editor. This button will be disabled if there are no changes in the editor.
  • Add Category: Adds a new Category to the TOC. If another Category is selected when this button is clicked, the new Category will be created as a child of the selected Category. If no Category is selected, the new Category will be created at the bottom of the TOC.
  • Add ItemType: Adds a new ItemType button to the TOC. If a Category is selected when this button is clicked, the new ItemType button will be created as a child of the selected Category. If no Category is selected, the new ItemType button will be created at the bottom of the TOC.
  • Add Form: Adds a new Form button to the TOC. A Form button displays an Aras Innovator form in a new tab when a user clicks it.
  • Add Page: Adds a new Page button to the TOC. A Page button displays an HTML page in a new tab when a user clicks it.
  • Delete: Deletes the currently selected Category or ItemType button.
  • Move Up: Moves the selected Category or ItemType button within its parent Category. This button will be disabled if the selected Category or ItemType button cannot be moved higher.
  • Move Down: Moves the selected Category or ItemType button within its parent Category. This button will be disabled if the selected Category or ItemType button cannot be moved lower.

Contents Pane

The pane on the left side of the TOC Editor displays all Categories and ItemType buttons that are configured in the Aras Innovator database. It also includes several options for filtering the content.

View As: Identity

Using the Identity “View As” filter at the bottom of the Contents Pane, admins can choose to view only the TOC configuration for a specified user or group. The TOC Editor will enter a read-only mode when the View As filter is active.

Figure 9. Viewing the TOC as a member of Change Specialist I

View As: Language

Using the Language “View As” filter at the bottom of the Contents Pane, admins can choose to view a user’s or group’s TOC configuration in a specific language. The TOC Editor will enter a read-only mode when the View As filter is active.

Figure 10. Viewing the TOC as a Change Specialist I with Japanese client settings

Note
The Language filter will be enabled only when an Identity is specified and there are two or more languages configured in the Aras Innovator database. For more details on configuring Aras Innovator for multiple languages, please refer to the Configuring Internationalization documentation.

Details Pane

The pane on the right side of the TOC Editor displays a form for viewing and editing the properties of the selected row in the Contents Pane.

No Item Selected

When no items are selected in the Contents Pane, the Details Pane shows general properties for the TOC. This is the default view when the TOC Editor opens.

Figure 11. Properties for the TOC are shown when no items are selected

  • Sort: Determines the order that the Aras Innovator web client renders the TOC elements.
    • Alphabetical: The default setting is Alphabetical, which sorts TOC Categories and their child items in alphabetical order. This setting is consistent with the behavior of Aras Innovator 12 and earlier releases.
Note
The order of items in the Contents Pane and the actual TOC may appear different when the sort properties is set to Alphabetical.

  • Custom: This setting sorts the TOC Categories and ItemType buttons according to the order defined in the TOC Editor.

To deselect an item in the Contents Pane and show the TOC properties, click the Contents header in the Contents Pane.

Category Selected

When a Category is selected in the Contents Pane, the Details Pane shows a form for viewing and editing the properties of that Category.

Figure 12. Properties for the selected Category

  • Label: This multilingual property defines the text that is shown for the Category in the TOC.

ItemType Button Selected

When an ItemType button is selected in the Contents Pane, the Details Pane shows a form for viewing and editing the properties of that ItemType button.

Figure 13. Properties for the selected ItemType button

  • ItemType: Sets the ItemType associated with the button. When the button is clicked in the TOC, the Navigation Pane will display the user’s favorite searches, favorite items, and common actions for that ItemType.
  • Icon: Defines the icon that appears on the button in the TOC.
  • Label: This multilingual property defines the text that is shown on the button in the TOC.
  • Access: Defines which Identity members will see this button in the TOC.
Note
Each button can only be configured for a single Identity. To display an ItemType in the TOC for multiple Identities, either create a separate button for each Identity or use a group Identity that encompasses all individuals or groups who should see that ItemType in the TOC.

Item Button Selected

When an Item button is selected in the Contents Pane, the Details Pane shows a form for viewing and editing the properties of that Item button.

  • ItemType: Defines the type of item that can be selected as the context item for the Item button.
  • Item: Defines the specific item that will be displayed in a new tab when a user clicks the Item button.
  • Icon: Defines the icon that appears on the button in the TOC.
  • Label: This multilingual property defines the text that is shown on the button in the TOC.
  • Access: Defines which Identity members will see this button in the TOC.
Note
Each button can only be configured for a single Identity. To display an Item in the TOC for multiple Identities, either create a separate button for each Identity or use a group Identity that encompasses all individuals or groups who should see that Item in the TOC.

Form Button Selected

When a Form button is selected in the Contents Pane, the Details Pane shows a form for viewing and editing the properties of that Form button.

Figure 14. Properties for the selected ItemType button

  • Form: Sets the Form associated with the button. When the button is clicked in the TOC, the Form will display in a new Aras Innovator tab.
  • Icon: Defines the icon that appears on the button in the TOC.
  • Label: This multilingual property defines the text that is shown on the button in the TOC.
  • Access: Defines which Identity members will see this button in the TOC.

Page Button Selected

When a Page button is selected in the Contents Pane, the Details Pane shows a form for viewing and editing the properties of that Page button.

Figure 15. Properties for the selected ItemType button

  • Start Page: Specifies the path of an HTML page to display when the button is clicked. This should be an HTML file in the code tree, and the path should be relative to the Innovator/Client/scripts directory.
  • Parameters: Optional. Passes parameters for the HTML page to use.
  • Icon: Defines the icon that appears on the button in the TOC.
  • Label: This multilingual property defines the text that is shown on the button in the TOC.
  • Access: Defines which Identity members will see this button in the TOC.