Project Fields

Managing Project Fields

Issues in Squish are defined by information contained in a number of fields, as well as user comments. A few fields are provided by default in Squish to get you started, and you can add, delete, deactivate, re-order, or edit those fields or their lookups as necessary. Project managers can customize the fields and their settings to fit the project, but some default fields and settings are necessary for Squish to keep track of your issues. From any project screen, click Admin > Fields on the navigation bar to access the Fields screen, where all of these changes can be made.

project_field_list.png

  • Reordering - The order that the fields appear on the screen can be changed easily from the Fields screen.  Click on the move icon (three parallel lines before the name) and drag the field to the position you want it moved.
  • See an overview of all fields and issue types - Click this option to open a table displaying each field as a row and each issue type as a column. A checkbox in the cell for a given fields and issue type means that fields is active for the issue type.
  • Field Name - Select the field name to edit the properties and lookup values for that field.
    • Active Fields - Active field names are blue and inactive ones are gray. To change active status of the field click on the name to open the editing screen.
  • Developer - Fields with a value of Yes in this column are only available for users with roles permissions to view developer-only fields.
  • Create a New Field - Click to add additional fields to the project.

Default Fields

Certain fields are required for Squish to work. All of the required fields are included by default when creating a new project. The names of all default fields can be changed, but the functionality of the fields does not change. The following fields are added to Squish projects by default:

  • Issue ID - This field is necessary to Squish functionality and therefore cannot be deleted or edited for issues.
  • Audit trail fields - The Submitted By, Resolved By, Date Submitted, Date Resolved, and Date Modified fields are necessary to Squish functionality and therefore cannot be deleted or edited for issues.
  • Subject - This field is necessary to Squish functionality and therefore cannot be deleted. The field size can be changed and it can be edited for issues. It is always required.
  • Type - This field is necessary to Squish functionality and therefore cannot be deleted. The field size can be changed and it can be edited for issues. This field is always required.
  • Description - This field is necessary to Squish functionality and therefore cannot be deleted. The field size can be changed and it can be edited for issues. This field is always required.
  • Status - This field can be inactivated and is not required, though milestones and any statistics will not be usable if Status is inactive. There are two special properties of Status field values:
  • Resolved - if selected for a Status value, that field value will affect the date resolved for the issue, searching and project management notifications.
  • Require Resolution - If selected for a value, issues with this field value will require a value to be entered in the Resolution field.
  • Milestone - This field has a type of "Project/Milestone". This field is linked to the Milestones feature.
  • Assigned To - This field is linked to a list of project members. In an issue, if a user is selected for this field, that user may receive email notifications related to the issue.
  • Confidential - If an issue is marked as confidential via this field, then only the submitting user and users with the Can view developer-only fields and comments role permission will be able to access the issue.

Adding Project Fields

  1. creating_a_new_field.pngClick +Create a new field on the Project Fields screen to add a new field.
  2. Select a Type from the drop-down list.
  3. Enter a Name for the field. This will be the field label.
  4. Enter the Plural name for the field.
  5. Enter a description if desired. This will appear in lighter letters beneath the field. This is a good place to put any special instructions for the field.
  6. Check the boxes next to the options you want. See Fields for more information on some of the options.
    • Require this field to have a value - The field cannot be blank when submitting or updating an issue. Corresponds to Required column on the Fields screen.
    • Display this field on submit pages - The field will be available when submitting an issue. Corresponds to Submit column on the Fields screen.
    • Display this field as read-only on update pages - When adding or changing information in an issue, the field will be read-only.
    • Displayed this field in search results by default - The field will be included in the list of fields on the left on the Search screen. Corresponds to Search column on the Fields screen.
    • Record history for this field - Changes to the data in the field will be tracked and can be displayed.
    • Only display this field to developers and managers - Only users who role has Is Developer or Is Manager permissions.
    • Allow this field to be mass changed - Project managers can update the data in this field for a group of issues using the Mass Change feature. Corresponds to Change column on the Fields screen.
  7. Select the issue type(s) that you want the field to appear in.
  8. Key in a Regular Expression Validator if wanted.
  9. Add a default value if needed.
  10. Click Create Field to create the new field. Depending on the field type selected, additional fields will be available to fill in after clicking Create Field. See Field Types for information on the additional fields.

Note: The Plural name field is only important when the plural for the name is not just an s. It's purpose is only grammatical, to ensure that when a field name appear in plural it is correctly spelled.

configuring_issue_types.png

Editing & Deleting Fields

From any project screen click on Admin>Fields to open the Project Fields screen.

editing_a_field.png

Editing Fields

From the Project Fields screen click on the name of the field you want to edit. An editing screen like the one above will open. Make the changes you need to make and click on the Submit Changes  button.

Company Administrators may convert one field to another kind. You can do this by clicking on the Convert Field button. A screen will open with the types of fields to which you are able to covert.  Select a type and click on the Convert Field button. A dialog will ask you if you are sure. Click OK to complete the conversion.

Note: You cannot convert back to the original field type.

Deleting Fields

Only fields that you have added that have not been used yet can be deleted. If a field can be deleted, there will be a Delete Field button at the bottom of the editing screen. Click on the Delete Field button to delete the field. A Delete field screen will ask you if you are sure. Click the Delete Field button. A dialog will ask you if you are sure. Click OK to complete the deletion.

Field Types

There are several different field types that can be selected. Depending on which type is selected, additional options will be displayed once you fill out the initial fields on the Field screen and click Create Field. The additional options are listed below under each field type:

Text

Use the text field type when you would like to allow users to type in free-form text using letters, number and/or symbols.

  • Size - The maximum number of characters that can be entered in the field.  Enter a whole number.
  • Default Value - The text that will appear in the field when a new issue is created. Can be left blank.

Lookup

Use a lookup field when there is a finite number of responses and you would like to create a list of the responses so users can select one.

  • Default Value - The value that is selected by default when a new issue is created. Note - The values will only be available after saving the changes to the field and selecting the field name again.
  • Lookups table - Active - When checked, the value will appear in the lookup for the field
    • Order - Lookup values can be dragged and dropped by using the move icon (three parallel lines) before the label.
    • Label - What will appear in the lookup.
    • Description - What the entry in the Label column means.
    • Delete - Check the box to remove the value when the field is updated.
    • Alphabetize lookups on next update - Check box to display the values in alphabetical order. The numbers in the Order column will be changed to reflect the new order.
  • A check box labeled Display inactive values when searching on this field is added to the section of the screen with the other check boxes. Check the box if you want inactive values from the Lookups table to appear in the search criteria and search results.

Boolean (Yes/No)

The only valid values for the field are Yes and No.

  • Default Value - The value that is selected by default when a new issue is created. Can be left blank.

Integer

Only whole numbers can be entered in the field.

  • Default Value - The number that will appear in the field when a new issue is created. Can be left blank.

Decimal

Numbers with a decimal point can be entered in the field.

  • Default Value - The number that will appear in the field when a new issue is created. Can be left blank.

Date

Only a properly formatted date can be entered in the field. The data format each person uses is set on the My Account screen.

  • Default Value - The date that will appear in the field when a new issue is created.  The date will appear in the format that each user has set on the My Account screen. Can be left blank.

Large Text

Use this type if you would like the field to be able to contain a large amount of text.

  • The text that will appear in the field when a new issue is created. Can be left blank.

User List

Use this type if you would like to be able to select from the list of all users who are members of the site.

  • User Roles - Select roles to determine which members will be displayed in the list. Only members who have the selected roles will be included. Select multiple roles by holding down the Ctrl key or hold down the Shift key to select the first and last roles to select a group of consecutive roles.
  • Default Value - The person who's name will appear in the field when a new issue is created. Can be left blank. Note - The values will only be available after saving the changes to the field and selecting the field name again.

Multi-Value Lookup

  • Default Value - The value that is selected by default when a new issue is created. Note - The values will only be available after saving the changes to the field and selecting the field name again.
  • Lookups table - Active - When checked, the value will appear in the lookup for the field.
    • Order - Lookup values can be dragged and dropped by using the move icon (three parallel lines) before the label.
    • Label - What will appear in the lookup.
    • Description - What the entry in the Label column means.
    • Delete - Check the box to remove the value when the field is updated.
    • Alphabetize lookups on next update - Check box to display the values in alphabetical order. The numbers in the Order column will be changed to reflect the new order.
  • A check box labeled Display inactive values when searching on this field is added to the section of the screen with the other check boxes. Check the box if you want inactive values from the Lookups table to appear in the search criteria and search results.

URL

  • A field for URLs.

Issue

  • The types available are set via the Issue Types screen instead of using a lookup. See Issue Types for more information.

Checklist

  • A list of values that can be toggled with a checkbox.