Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This article explains how to set the scope of a filter in Jira to either Global or Private using Jira Command Line Interface (CLI).

...

The setShareScope action in Jira Command Line InterfaceCLI, allows the filters to be available to either globally or privately with Global or and Private settings respectively.

  1. Before creating a filter in Jira, set the scope of the filter using the action setShareScope as given in the example below example.:

    Code Block
    themeMidnight
    --action setShareScope --value Global

    The above This action defaults the filter share scope for the current user to GLOBALGlobal.

  2. Create a filter using the createFilter action as given in the example below example:

    Code Block
    themeMidnight
    --action createFilter --name filterforTSboard --jql "project = TESTER01 ORDER BY Rank ASC"

    The above This action creates a filter named "filterforTSboard" for the Jira project "TESTER01".

  3. To verify Verify the filter permissions from Jira UI , follow with the instructions below instructions:
    1. Log in to into Jira as an administrator. 
    2. From the top navigation bar, click on click Issues.
    3. From the dropdown select the Manage filters option, as shown in the screenshot below:

      As the screenshot below screenshot indicates, the filter "filterforTSboard" has no restrictions and can be viewed by any logged-in user.
  4. Similarly, the filters can be restricted by setting the scope to "PRIVATE" Private. Refer to the sample action given below for the same.:

    Code Block
    themeMidnight
    --action setShareScope --value private


    Code Block
    themeMidnight
    --action createFilter --name filterforTSboard-1 --jql "project = TESTER01 ORDER BY Rank ASC"


  5. The filter "filterforTSboard-1" is set as Private in Jira as shown in the screenshot below screenshot:
Info

Please note that the scope of the filter scope can only be applied during filter creation but not while updating. Hence setShareScope doesn't set the filter scope when performing updateFilter CLI action.

...

Info

It is recommended to test this scenario in a non-production environment, or , run the action with the --simulate parameter to verify the behavior before deploying.

...