Set up lists

This topic provides insturctions for working with pre-defined and user-defined lists.

Overview

ALM Octane provides default lists of values for system fields.

Space admins, and admins for workspaces, can modify values for many system lists, and create lists.

Admins without Administration > List > Manage permissions can view the Lists area in Settings, but cannot make any updates.

All lists and list values have the following types of names: 

  • Names, which are displayed in the ALM Octane UI.

  • Logical names, for use with the REST API, such as when filtering.

    When creating user-defined lists and list values, logical names are automatically generated, but can be modified. You cannot modify a logical name after it is created.

    For details on working with lists in the REST API, see Working with lists.

Back to top

Sharing lists between spaces

Lists can be defined for shared spaces and workspaces. This overview describes how to work with shared and non-shared lists.

Isolated spaces

Lists cannot be defined at the space level when the space is isolated.

Instead, admins for workspaces can define lists in individual workspaces.

The lists are available in that individual workspace only.

Shared spaces (Enterprise Edition)

This table summarizes the actions admins can perform when defining lists in shared spaces and associated workspaces.

Shared space Associated workspaces

The space admin can add and modify lists defined in the shared space.

The lists are available to all associated workspaces.

  • For lists defined by the space admin in the shared space:

    ALM Octane users working in a specific workspace can access the lists defined for the corresponding shared space. Shared lists are displayed with the icon.

    The admin for a workspace cannot modify shared lists.

  • Lists cannot be defined by the admin in a workspace.

Back to top

Create a user-defined list

After an admin creates a user-defined list, the list can be added in your forms and rules can be created that access the lists.

To create a user-defined list: 

  1. In Settings , select Spaces and select a shared space or a workspace.

  2. Click Lists, and then + to add a list.

  3. Name the list. The list is automatically assigned a logical name.

    Each list is automatically assigned a logical name for REST API purposes, which you can modify when initially creating the list. Logical names must be lowercase English letters, dots, and numbers. You may also enter one underscore character between letters. The suffix _ln (with a lowercase "l" for "logical name") is automatically added to the list's logical name. Do not delete this suffix. After creating the value, you can no longer change the logical name.

  4. You can perform the following operations on your lists: 

    Click... To...
    Name text box

    Rename the list.

    List item's text box Rename a list item.

    Add a value to the list.

    Logical names: Each value is automatically assigned a logical name for REST API purposes, which you can modify when initially adding the value to the list. Logical names must be lowercase English letters and numbers. You may also enter one underscore character between letters. The suffix _In (with a lowercase "l" for "logical name") is automatically added to the value. Do not delete this suffix. After creating the value, you can no longer change the logical name.

    Toggle sorting the items in the list in ascending and descending order.

    Deactivate an the item in the list.

    Deactivated items are no longer displayed in the list. However, they are not removed from existing lists.

    You cannot reactivate an item in the list once the list is saved. Alternatively, you can create a new list item with the same name.

    Restore While editing a list, you can restore the values until you Save. Values are reset to their original values when you started editing the list.
  5. Click Add.

Back to top

Modify a system list

The admin can modify some of the default system lists that are provided with ALM Octane.

To modify a system list: 

  1. In Settings , select Spaces and select a shared space or a workspace.

  2. Click Lists.

    All lists are displayed. However, you can modify only user-defined lists and certain system lists. To determine if, and to what extent, lists are editable, see the IS MODIFIABLE and IS RENAME ONLY columns.

  3. Click the link to the list you want to modify.

  4. Modify the list. 

    Not all lists support full editing. For example, Severity and Priority fields only support renaming of list items.

    Click... To...
    Name text box

    Rename the list.

    List item's text box Rename a list item.

    Add a value to the list.

    Logical names: Each value is automatically assigned a logical name for REST API purposes, which you can modify when initially adding the value to the list. Logical names must be lowercase English letters and numbers. You may also enter one underscore character between letters. The suffix _In (with a lowercase "l" for "logical name") is automatically added to the value. Do not delete this suffix. After creating the value, you can no longer change the logical name.

    Toggle sorting the items in the list in ascending and descending order.

    Deactivate an the item in the list.

    Deactivated items are no longer displayed in the list. However, they are not removed from existing lists.

    You cannot reactivate an item in the list once the list is saved. Alternatively, you can create a new list item with the same name.

    Restore While editing a list, you can restore the values until you Save. Values are reset to their original values when you started editing the list.
  5. Click Save.

Delete a user-defined list

If a list is no longer in use by any user-defined fields (UDFs) or rules, the admin can delete the list.

To delete a user-defined

  1. In Settings , select Spaces and select a shared space or a workspace.

  2. Click Lists.

  3. Select the list you want to delete.

  4. Click .

Back to top

See also: