Custom Fields and Layouts for Bugs

• Understanding Bug Layouts and Fields
  • What is a layout?
  • What is a section?
  • What is a field?
  • Standard layout
• Feature availability
• Create layout
• Associate projects with a bug layout
• View layout
• Delete layout
• Create or edit section
• Delete section
• Create custom field
• Edit custom field
• Reorder custom field
• Remove custom field
• Delete custom field
• Create a custom status

Feature availability

What is a layout?

Bug Layouts are used for creating forms where customers can fill details relevant to the bug. Create unique layouts based on the business requirement.

What is a section?

The various parts of the layout are called a section. The standard layout has a default section called Bug information. You can customize each section by adding fields based on the requirements. 

What is a field?

Customize fields to collect bug details based on your requirement. You can add a new field or an existing field to your layout. The default fields can neither be edited nor deleted. They can only be reordered. 

Reporter, Assignee, Created, Last closed time, Modified, Due date, Status & Workflow, Severity, Release Milestone, Affected Milestone, Module, Classification, Is it Reproducible and Flag are the default fields in a layout.

Standard layout

• Every portal will have a Standard Layout to start with.
• Users can clone the standard layout and create a new layout. After cloning, they will be able to add new sections and fields to the new layout.

Create layout

1. Click in the upper-right corner of the top navigation bar.
2. Navigate to Portal Configuration > Layouts and Fields > Bugs.
3. Click Create Layout in the upper-right corner.
4. Select a base layout that you want to build (clone) your new layout on. If you have not created any layouts, the standard layout will be listed in the drop-down.
5. Enter a Layout Name.
6. Click Create.

Associate projects with a bug layout

1. Click  in the upper-right corner of the top navigation bar.
2. Navigate to Portal Configuration > Layouts and Fields > Bugs.
3. Click to the right of the selected layout.
4. Select one or more projects from the drop-down to associate.
5. Confirm your action.
6. Click Associate.

View layout

1. Click in the upper-right corner of the top navigation bar.
2. Navigate to Portal Configuration > Layouts and Fields > Bugs.
   • In the Layouts section, you can view the list of bug layouts that have been created already.
   • The layouts that are listed cannot be reordered.
3. Click the layout you want to edit, do the necessary changes, and save.

Delete layout

1. Click  in the upper-right corner of the top navigation bar.
2. Navigate to Portal Configuration > Layouts and Fields > Bugs.
3. Click the Layouts section.
   • Hover over a layout that you would like to delete and click the trash icon .
   • Confirm your action.

Create or edit section

1. Click in the upper-right corner of the top navigation bar.
2. Navigate to Portal Configuration >Layouts and Fields > Bugs.
3. Click a layout to add a section.
4. Drag and drop the Add Section component from the left tray to the layout editor (main panel). Initially, the sections will be named "Untitled Section", "Untitled Section 1", "Untitled Section 2" and so on as you keep adding new sections in the layout editor.
5. Hover over the section name and edit it.
   • You can also add new or existing custom fields to your section.
6. Click Save Layout.

Delete section

1. Click in the upper-right corner of the top navigation bar.
2. Navigate to Portal Configuration > Layouts and Fields > Bugs.
3. Click a layout to delete a section in the layout.
4. Hover over the section and click .
   • The icon will be visible only when all the custom fields inside the section are removed. We recommend you to remove the custom fields first and then delete the section.
5. Confirm your action.

Create custom field

1. Click in the upper-right corner of the top navigation bar.
2. Navigate to Portal Configuration > Layouts and Fields > Bugs.
3. Click a layout to add a custom field.
4. Drag and drop a field type from the New Fields tray into the layout editor (main panel).
5. Set a Default Value if necessary.
6. Select Mandatory checkbox if you want the field to be filled compulsorily. 
7. Select Insert Tooltip checkbox if you want to set tooltip information for the field. 
8. Click Add to Layout to include the field in the layout. When you Cancel, the field is never stored anywhere.

You can create the following custom fields:

• Single-line text field: Add one line of text. Single line text fields can be marked as containing Personally Identifiable Information (PII). If you select Encrypt Field, the data will be encrypted at the backend.
• Multi-line text field: Add multiple lines of text. Hit Enter to key in more information. Multi-line text fields can be marked as containing Personally Identifiable Information (PII). If you select Encrypt Field, the data will be encrypted at the backend.
• Pick List field: Create your own dropdown using a picklist. Set values and wrap them under a picklist as per your business needs.
• User Pick List field: Use this field when you need to store usernames.
• Date: Store dates in this field. 
• Number: Store numbers in this field. A number can have a maximum of 19 digits. Number fields can be marked as containing Personally Identifiable Information (PII). If you select Encrypt Field, the data will be encrypted at the backend.

Edit custom field

1. Navigate to > Portal Configuration > Layouts and Fields > Bugs.
2. Open the layout editor and hover over the custom field you would like to edit.
3. Click the pencil icon .
4. Edit the field properties except for the field name. You can change the field name also, but the new name will be reflected in all the projects.
5. Click Save Changes.

Reorder custom field

1. Navigate to > Portal Configuration > Layouts and Fields > Bugs.
2. Open the layout editor and hover over the custom field you would like to reorder.
3. Drag and swap with another field in the editor. You can reorder the fields as many times as you want until you get the desired order.
4. Click Save Field Order.

Remove custom field

1. Navigate to > Portal Configuration > Layouts and Fields > Bugs.
2. Open the layout editor and hover over the custom field you would like to dissociate.
3. Click  .
4. Confirm your action.

Delete custom field

1. Navigate to > Portal Configuration > Layouts and Fields > Bugs > Fields.
2. Hover over the field you would like to delete.
3. Click .
   • The data stored in the field cannot be retrieved.
4. Confirm your action.

Note:

• The standard layout and the layouts associated with a project cannot be deleted. You can delete other layouts after associating the projects to a different layout.

Create custom status

1. Navigate to  > Portal Configuration  >  Layouts and Fields  >  Bugs  >  Layouts.
2. Open an existing layout or create a new layout.
3. Click Customize on the right-side of Status & Workflow.​
4. Change the default status for a bug under Set Default Status section.
5. Click the +Add Status link to create a new bug status.
   • A new status will fall under either Open or Closed status types.
   • Default Status can't be deleted and there should be at-least one open & one closed status. 

6. Give a status name.
   • Click  or to the left of the status name to assign a color. Pick any color from the palette that matches the status name and type.
7. Define a Workflow by selecting the next available status. The workflow is determined by the next available status specified in the box.
8. Click Save to add the Status.