Design forms

Workspace admin permissions are required.

You can design forms for entities in each workspace. Forms specify the fields that end users need to view and edit information for entities. You can create and maintain various data input forms for different users in the organization and for the various circumstances users encounter during the life cycle of application design, development, and testing. In addition, you can structure the layout of the entity form to suit your organization's needs.

For each entity type, ALM Octane provides predefined default system forms. These forms initially display all the fields for the entity, and can be modified.

System defined default
form
Description
Default form for Edit

The system-defined default form for editing an entity.

This form cannot be renamed, but other forms can be made the default for editing instead of this one.

Default form for New

The system-defined default form for creating a new entity.

This form cannot be renamed, but other forms can be made the default form for new instead of this one.

The following entities do not have a Default form for New

  • Gherkin tests

  • Automated tests

  • Manual runs

  • Automated runs

Forms are defined per module within a workspace. For example, you can define different forms for user stories and the defects in the same workspace. Which form is used is controlled by the business rules you create. For details, see Use rules to customize how you work.

The form designer

Using the form designer, you can:

  • View existing forms, add forms, delete forms, and set default forms in the Form management area.

  • Add fields to the form, and group them into sections, in the Design area.

  • Set display and editing properties for fields with the Design area toolbar.

  • Reorder and/or remove fields in the form by selecting a field in the Design area and using the Design area toolbar.

  • Do all of the above for the system-defined default forms.

Note: Name and Type fields cannot be accessed in the Form Designer.

Back to top

Working with forms

Before working with forms, define any custom fields you need. For details, see Work with user-defined fields (UDFs).

  1. In Settings , click Workspaces and select the workspace where you want to create a new form.

  2. Click the Entities tab.

  3. In the Entities list on the left side of the pane, select an item (such as user story, manual test, epic, and so on).

  4. Click the Forms tab. The form designer is divided into the entity list, the form management area, and the form design area.

  5. In the form management area, you can:

    • Click Add in the toolbar to create a new form.

    • Select an existing form.

    • Switch the default forms for new and editing by clicking Set as Default in the toolbar.

    • Select a form, click its drop-down arrow, and then Duplicate to make a copy of it. You can then modify your copy.

    • Select a form (other than the predefined default forms for new and editing), click its drop-down arrow, and then Rename to rename the form.
    • Revert a default form that you modified to its original state by selecting Reset Layout from the drop-down list.

  6. In the form design area, add fields and sections using the Add field and Add section buttons.

    Adding fields
    • When adding a field, you can search for a field using the Type to search box.

    • To associate a field with a section, choose the section before adding the field.

    • Fields are added after the currently-selected field.

    • When adding or editing fields, choose either Regular or Full in the Size drop-down. This setting determines if the field takes up an entire row or if ALM Octane can put it on a row with other fields.

    • When finished adding fields, click outside the list to close the list.

    Adding and deleting required fields

    All required fields must be added to the form. For your convenience, ALM Octane required fields are automatically added to the form for you. You can move them on the form but you cannot delete them.

    Restoring fields Click Restore to revert or discard your changes.
  7. Modify the attributes for each field or section in the design area toolbar. For example, you can set whether a field (other than memo) takes up half the space on the form or the full space by setting the Size to Regular or Full.

    Tip: You can also use the design area toolbar to:

    • Reorder fields

    • Delete fields

    • Delete a section with or without its fields

    • Navigate between fields

  8. Click Set as default if you want to use this form as the default.

Back to top

Customize the list items to provide values for user-defined fields

For the fields in a user-defined field of a specific entity, you can determine the items that are displayed in a list and the order in which these items are displayed.

  1. In Settings , click Workspaces and select the workspace where you want to create a new form.

  2. Click the Lists tab.

    Note: The Lists tab also displays the ALM Octane system fields and their values, such as the possible value for Defect Severity. These are read-only lists and cannot be edited.

  3. Do one of the following:

    To add a new list
    1. In the toolbar, click the + List button.
    2. In the Add List dialog box, give the list a name.
    To edit an existing list Click on the numerical link for the list.
  4. In the Add List dialog box (for new lists) or List Details dialog box (for existing lists), add and reorder the items:

    • Click + to add an additional list item.

    • Select a list item's checkbox and click the arrow button to sort the list alphabetically.

    • Drag and drop an item to assign it to a new place in the list.

    • Select a list item and click the Active icon to deactivate the list item. This list item will not be available for users in the fields that use it.

      In order to deactivate the list item, it must not be in use by an existing user-defined field.

    Tip: If you incorrectly edit a list item, just click the Restore button to return to the list's previously saved order.

  5. To delete the entire list, in the main grid of the Lists tab, select the necessary lists and click X.

    You cannot delete list items that are currently used by existing entities or user-defined fields.

Back to top

Next steps: