Sign in
Aras Innovator Platform
Aras Innovator Platform   Configurable User Interface Administrator Guide   Examples

Table of Contents

March 6, 2026 02:01 AM
8 min read

Add a new ItemType Button to the TOC

“I want the All Employees identity to see a TOC button for Purchase Orders.”

Figure 24. Configuring a new button for the custom ItemType “Purchase Orders”

  1. Navigate to Administration > Configuration > TOC Editor in the TOC.
  2. Click the Add ItemType button in the toolbar.
  3. In the search dialog, choose the ItemType you want to add and click OK.
Note
A new entry for your ItemType will appear in the Contents pane of the editor. If no categories were selected when you added the button, the new entry will appear at the bottom of the list. If a category was selected, the new entry will appear in that category.

  1. In the righthand pane, you may customize any of the following properties:

    1. ItemType: This ItemType will appear in the navigation pane when a user clicks the button.
    2. Icon: This image is displayed as an icon on the button.
    3. Label: This multilingual property determines the button text.
    4. Access: This property determines which identity will see this button in the TOC. If you want multiple identities to see a button for this ItemType, pick a group identity that includes all the identities that should have access, or add a button for each identity.
  2. If you want to change where the button appears in the TOC, you can drag and drop it to your preferred location. Alternatively, you can select the button and use the Move Up/Move Down buttons in the toolbar.
  3. When you’re finished making your changes, click Save and close the tab for the TOC Editor.

Add a new category to the TOC

“I want to add a ‘Finance’ category for my Invoices and Purchase Orders.”

Figure 25. Adding a Finance category to group two custom ItemType buttons

  1. Navigate to Administration > Configuration > TOC Editor in the TOC.
  2. Click the Add Category button in the toolbar.
Note
A new category will appear in the Contents pane of the editor. If no existing categories were selected when you added the new category, the new entry will appear at the bottom of the list. If a category was selected, the new entry will appear in that category.

  1. In the righthand pane, you can customize the multilingual Label property to set the category text.
  2. If you want to change where the category appears in the TOC, you can drag and drop it to your preferred location in the Contents pane. Alternatively, you can select the category and use the Move Up/Move Down buttons in the toolbar.
  3. When you’re finished making your changes, click Save and close the tab for the TOC Editor.

Set a custom button label and icon for a specific identity

“I want the All Suppliers identity to see a different label and icon for Purchase Orders.”

Figure 26. Configuring a custom label and icon for All Suppliers’ “Purchase Orders”

Note
The steps in this section are largely the same as section 2.4.1 “Add a new ItemType button to the TOC”. Here, we are adding two buttons with the same ItemType but different labels, icons, and access identities.

  1. Navigate to Administration > Configuration > TOC Editor in the TOC.
  2. Click the Add ItemType button in the toolbar.
  3. In the search dialog, choose the ItemType you want to add and click OK.
  4. In the righthand pane, you may customize the following properties or leave them set to their default values:
    1. Icon: This image is displayed as an icon on the button.
    2. Label: This multilingual property determines the button text.
    3. Access: This property determines which identity will see this button in the TOC. If you want multiple identities to see a button for this ItemType, pick a group identity that includes all the identities that should have access, or add a button for each identity.
  5. If you want to change where the button appears in the TOC, you can drag and drop it to your preferred location. Alternatively, you can select the button and use the Move Up/Move Down buttons in the toolbar.
  6. Repeat steps 2-5, choosing a different Access identity, Icon, and Label in step 4.
  7. When you’re finished making your changes, click Save and close the tab for the TOC Editor.

Sort the TOC Buttons Alphabetically

“I want all TOC categories and buttons to display in alphabetical order.”

Figure 27. Configuring the TOC for alphabetical sort order

  1. Navigate to Administration > Configuration > TOC Editor in the TOC.
  2. In the righthand pane, set the Sort property to Alphabetical.
Note
The TOC sort order is set to Alphabetical by default.

  1. When you’re finished making your changes, click Save and close the tab for the TOC Editor.

Arrange the TOC Buttons in a Custom Order

“I want the ‘My Innovator’ category to appear at the top of the TOC.”

Figure 28. Configuring the TOC for a custom sort order

  1. Navigate to Administration > Configuration > TOC Editor in the TOC.
  2. In the righthand pane, set the Sort property to Custom.
Note
The TOC sort order is set to Alphabetical by default.

  1. When you’re finished making your changes, click Save and close the tab for the TOC Editor.

View the TOC for a Specific Identity

“I want to see what the TOC looks like for user Mike Miller.”

Figure 29. Viewing the content for Mike Miller’s TOC

  1. Navigate to Administration > Configuration > TOC Editor in the TOC.
  2. Click View As at the bottom of the contents pane.
  3. Enter or search for an identity in the Identity field. This can be a group identity like “All Employees” or an alias identity for a user like “Innovator Admin”.
  4. The contents pane will now display the TOC for your chosen identity. When you are done viewing the content, click Clear to exit viewing mode.
Note
Viewing mode is read-only. To make edits to the TOC, you must clear the View As field.

Display a Form with a TOC Button

“I want the user to see a special form when they click a button in the TOC.”

Figure 30. The user clicks “My Identity Map” to see an interactive graph in a custom form

  1. Navigate to Administration > Configuration > TOC Editor in the TOC.
  2. Click the Add Form button in the toolbar.
  3. In the search dialog, choose the Form to display and click OK.
  4. In the righthand pane, you may customize the following properties or leave them set to their default values:
    1. Icon: This image is displayed as an icon on the button.
    2. Label: This multilingual property determines the button text.
    3. Access: This property determines which identity will see this button in the TOC. If you want multiple identities to see a button for this ItemType, pick a group identity that includes all the identities that should have access, or add a button for each identity.
  5. If you want to change where the button appears in the TOC, you can drag and drop it to your preferred location. Alternatively, you can select the button and use the Move Up/Move Down buttons in the toolbar.

Display an HTML Page with a TOC Button

“I want the user to see an HTML page when they click a button in the TOC.”

Figure 31. The user clicks “My Dashboard” to see a graph in a custom HTML page

  1. Navigate to Administration > Configuration > TOC Editor in the TOC.
  2. Click the Add Page button in the toolbar.
  3. In the righthand pane, you may customize the following properties or leave them set to their default values:
    1. 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.
    2. Parameters: Optional. Passes parameters for the HTML page to use.
    3. Icon: This image is displayed as an icon on the button.
    4. Label: This multilingual property determines the button text.
    5. Access: This property determines which identity will see this button in the TOC. If you want multiple identities to see a button for this ItemType, pick a group identity that includes all the identities that should have access, or add a button for each identity.
  4. If you want to change where the button appears in the TOC, you can drag and drop it to your preferred location. Alternatively, you can select the button and use the Move Up/Move Down buttons in the toolbar.

View the TOC in a Specific Language

“I want to see what the TOC looks like for a Change Specialist I member in Japan.”

Figure 32. Viewing the content for Mike Miller’s TOC

  1. Navigate to Administration > Configuration > TOC Editor in the TOC.
  2. Click View As at the bottom of the contents pane.
  3. Enter or search for an identity in the Identity field. This can be a group identity like “All Employees” or an alias identity for a user like “Innovator Admin”.
  4. The contents pane will now display the TOC for your chosen identity.
  5. Enter or search for a language in the Language field.
  6. The contents pane will now display the identity’s TOC content in the specified language. When you are done viewing the content, click Clear to exit viewing mode.
Note
Viewing mode is read-only. To make edits to the TOC, you must clear the View As field.
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.

Add a Button to the TOC from an ItemType

“I want to quickly add a new TOC button while defining my ItemType.”

Figure 33. Quickly create a new TOC button with the “Add to TOC” action

  1. If the ItemType isn’t already open:
    1. Navigate to Administration > ItemTypes in the TOC.
    2. Search for the ItemType you want to work with.
    3. Double click the ItemType in the grid to view it.
  1. Select the ‘…’ button from the ItemType toolbar and click Add to TOC. This action will create a new ItemType button in the TOC with the following settings:
    1. ItemType: Current ItemType
    2. Icon: Small Icon of the ItemType
    3. Label: Plural Label of the ItemType (or ItemType name if no plural label is defined)
    4. Access: Administrators
  2. To see the new TOC button, navigate to the TOC and scroll to the bottom. This is the default location for new buttons added via the Add to TOC action.
  3. To change the default settings for the new TOC button, navigate to Administration > Configuration > TOC Editor in the TOC.

  4. Scroll to the bottom of the contents pane and select the new ItemType button.

    Figure 34. Default settings for a button created from the xTestIT ItemType

  5. Change any default settings as needed.
Note
Changing the settings of an ItemType button on the TOC will not affect the settings of the associated ItemType. For example, changing the button icon will not change the icons defined on the ItemType.

  1. If you want to change where the button appears in the TOC, you can drag and drop it to your preferred location. Alternatively, you can select the button and use the Move Up/Move Down buttons in the toolbar.
  2. When you’re finished making your changes, click Save and close the tab for the TOC Editor.

Add a new Item Button to the TOC

“I want the All Employees identity to be able to open the Engineering Dashboard from the TOC.”


  1. Navigate to Administration > Configuration > TOC Editor in the TOC.
  2. Click the Add Item button in the toolbar.
  3. In the search dialog, choose the type of item you want to add and click OK.
  4. In the next search dialog, choose the specific item you want to add and click OK.
  5. In the righthand pane, you may customize any of the following properties:
    1. ItemType: This is the type of item that the button will open.
    2. Item: This is the specific item that will open in a new tab when a user clicks the button.
    3. Icon: This image is displayed as an icon on the button.
    4. Label: This multilingual property determines the button text.
    5. Access: This property determines which identity will see this button in the TOC. If you want multiple identities to see a button for this ItemType, pick a group identity that includes all the identities that should have access, or add a button for each identity.
  6. If you want to change where the button appears in the TOC, you can drag and drop it to your preferred location. Alternatively, you can select the button and use the Move Up/Move Down buttons in the toolbar.

  7. When you’re finished making your changes, click Save and close the tab for the TOC Editor.

Previous Topic
Shortcuts
Next Topic
Item Views