Example Behaviour

Change Field Name Example

This example shows you how to change the name displayed for a specific field within the issue creation screen. In this example, the field entitled Summary is changed to Ticket Title in response to a particular team's preferences.

Follow the steps below to create the behaviour:

1. Open the Behaviours tab and click the Create Behaviour button.
   
   You will see the Create Behaviour screen displayed:
   
2. Enter a name and description for the behaviour. It's good practice to make these as descriptive as possible.
3. Ensure the Enable Behaviour toggle is activated.
4. Scroll down to the Behaviour Mapping section and select the relevant Project to which this behaviour will be mapped. For this example, choose the Customer Success project.
5. Select the Issue Type that will be associated with the behaviour. For this example, choose the Task issue type.
6. Scroll down to the Behaviours Scripts section and click Add Script. The Add Field Script pop-up window is displayed where you can add the behaviour script:
   
   

7. Define when the script should run. This can be when the issue creation screen loads initially and/or in response to a field change. For the purpose of this example, check the On load option so that the summary field is renamed when the issue creation screen loads.

   When	Runs
   On load	The script will run when the create screen initially loads. You'll want to choose this option when you want the affected field to populate immediately upon opening the create screen.  For example, a field name or field description is changed, or a value is pre-populated into the field.
   On change	The script will run when the specified supported field change happens. You should choose this option when you've added a condition to the logic and identified a trigger that will update the affected field.

8. Choose Create View from the options to run the script on from Create View, Issue View or Transition View. Refer to the Supported Fields details, as not all field types are supported.
9. Enter your code within the script box, as required. Note that you can open the API documentation directly from here. 
   Alternatively, you can select an example script from the Example Scripts option and modify the code as required, ensuring that you:
   • edit any variables, like custom field names, roles, or groups, in the example code so it's relevant to your instance.
   • choose the right time to run your script on load and/or change so that it runs when needed.
   You can scroll or search for scripts by name in the Example Scripts and use the Copy Code button for scripts you'd like to paste into the Script box. 
10. Click Save Script once you have confirmed the parameters as getFieldById("summary").setName("Ticket Title");.
Now that you have created the behaviour to run when the screen loads, you will see the field entitled 'Summary' change to 'Ticket Title' when you create new tasks within the Customer Success project.
11. Refresh your screen and click the Create button to see the behaviour in action. You are returned to the Create issue screen, where you will see your changes, as shown below:
    
    If you wish to revert back to the original field name, simply click Edit from the ellipsis menu next to your chosen behaviour, as shown below:
    
    and then deselect the Enable Behaviour button.