User Guide

How to configure

Adding a new SIL User Picker Custom Field is as easy as adding any other custom field.

To do that:

1. Log into your Jira as Admin.
2. Go to Administration > Custom Fields > Add Custom Field, and select SIL User Picker Custom Field from the list.
3. Follow the on-screen instructions.
   
   
   
   
4. Go to the Configure link.
   
   
   
5. Click the Edit SIL Script link to define the SIL script.
   
   
   
6. Click the Save button and the script is associated with the current custom field. The values returned by the script are the values available for the custom field.

In our example, the SIL User picker field is configured to filter only users that are members of group jira-developers or jira-administrators.

To set the number of characters that user autocomplete feature is triggered for the field use the global autocomplete threshold parameter from User Group Picker PRO configuration page. The default value for autocomplete threshold is set to 2.

For example, if you choose value 3 for autocomplete threshold in the configuration page as shown in the above example, the list of suggested users matching the criteria in the user group picker are shown after the third character in the input is introduced:

How to use it

1. Go to an issue and check the users available for selection by clicking the user picker icon or by typing something in the input. Only users retrieved from the SIL script will be available for selection (in this case administrators and developers).

2. Choose any user and save it on the current issue. The field value appears on the right side of the view issue screen, in the people section as in the image below:

3. Edit the field on view issue by clicking on the inline edit icon next to the field to see suggested users filtered accordingly to the SIL script.

That's it.

Other Examples

Here are certain SIL scripts examples that you can use to configure your SIL user picker fields. Basically, by means of SIL you can restrict the users selection to whatever criteria you want.

Issue Assignees

string[] assignees;
assignees = addElementIfNotExist(assignees, assignee); 
string[] assigneeHistory = fieldHistory(key, "assignee"); 
for(number i = 1; i < size(assigneeHistory); i = i + 2) {
 string assigneeName = getElement(assigneeHistory, i);
 assignees = addElementIfNotExist(assignees, assigneeName); 
}
return assignees;

Users in specific role

return usersInRole(project, "Developers");

Users in specific group

return usersInGroups("jira-developers");

Search Issues

When creating a new SIL User Picker custom field the default searcher set is SIL User Picker and Group Searcher. This filters the available users for the custom field in issue navigator accordingly to the configured SIL script.

However, when using SIL issue specific variables in the script (for instance project, key, assignee, reporter), you have to use Jira's standard searcher User Picker and Group Searcher for that field, or otherwise you will not be able to select any value for filtering.

1. Go to Administration->Custom fields
2. Click Edit for the desired custom field
3. Choose the proper Search Template for your custom field

4. After a searcher has been set for the SIL User Picker custom field, you can perform a search for all issues containing the desired value for that custom field

For a detailed explanation on searching issues in Jira, you can check the Searching for Issues tutorial from the Jira documentation.