Agent view

This pages lists the Jira Service Desk modules for the agent view. These can be used to inject new groups (tabs) in the Jira Service Desk agent view.

Queue group

A group of serviceDeskQueues.

Module type

serviceDeskQueueGroups

Screenshot

Sample JSON

1
2
3
4
5
6
7
8
9
10
"modules": {
    "serviceDeskQueueGroups": [ 
        { 
            "key": "my-custom-queues-section", 
            "name": { 
                "value": "My custom queues section" 
            }
        }
    ]
}

The group will not be displayed if there are no serviceDeskQueues that reference it in the "group" property or if all the queues that reference it are not displayed because of conditions.

Properties

key

  • Type: string (^[a-zA-Z0-9-]+$)
  • Required: yes
  • Description: A key to identify this module. This key must be unique relative to the app, with the exception of Confluence macros: their keys need to be globally unique. Keys must only contain alphanumeric characters and dashes.

name

  • Type: i18n Property
  • Required: yes
  • Description: A human readable name.

weight

  • Type: integer
  • Default: 100
  • Description: Determines the order in which the web item appears in the menu or list. The "lightest" weight (i.e., lowest number) appears first, rising relative to other items, while the "heaviest" weights sink to the bottom of the menu or list.
    Built-in web items have weights that are incremented by numbers that leave room for additional items, such as by 10 or 100. Be mindful of the weight you choose for your item, so that it appears in a sensible order given existing items.

conditions


Queue

A queue in the queues sidebar.

Module type

serviceDeskQueues

Screenshot

Sample JSON

1
2
3
4
5
6
7
8
9
10
11
12
"modules": {
    "serviceDeskQueues": [ 
        { 
            "key": "my-custom-queue", 
            "name": { 
                "value": "My custom queue" 
            }, 
            "group": "my-custom-queues-section", 
            "url": "/sd-queue-content" 
        }
    ]
}

Properties

key

  • Type: string (^[a-zA-Z0-9-]+$)
  • Required: yes
  • Description: A key to identify this module. This key must be unique relative to the app, with the exception of Confluence macros: their keys need to be globally unique. Keys must only contain alphanumeric characters and dashes.

name

  • Type: i18n Property
  • Required: yes
  • Description: A human readable name.

weight

  • Type: integer
  • Default: 100
  • Description: Determines the order in which the web item appears in the menu or list. The "lightest" weight (i.e., lowest number) appears first, rising relative to other items, while the "heaviest" weights sink to the bottom of the menu or list.
    Built-in web items have weights that are incremented by numbers that leave room for additional items, such as by 10 or 100. Be mindful of the weight you choose for your item, so that it appears in a sensible order given existing items.

group

  • Type: string
  • Required: no
  • Description: References the key of a serviceDeskQueueGroup. If this property is not provided, the queue will appear in a generic "Apps" group.

url

  • Type: string, uri-template
  • Required: yes
  • Description: The URL of the app resource that provides the content. This URL must be relative to the app's baseUrl. Your app can receive additional context from the application by using variable tokens in the URL attribute.

conditions


Report group

A group of serviceDeskReports.

Module type

serviceDeskReportGroups

Screenshot

Sample JSON

1
2
3
4
5
6
7
8
9
10
"modules": {
    "serviceDeskReportGroups": [ 
        { 
            "key": "my-custom-reports-section", 
            "name": { 
                "value": "My custom reports section" 
            }
        }
    ]
}

The group will not be displayed if there are no serviceDeskReports that reference it in the "group" property or if all the reports that reference it are not displayed because of conditions.

Properties

key

  • Type: string (^[a-zA-Z0-9-]+$)
  • Required: yes
  • Description: A key to identify this module. This key must be unique relative to the app, with the exception of Confluence macros: their keys need to be globally unique. Keys must only contain alphanumeric characters and dashes.

name

  • Type: i18n Property
  • Required: yes
  • Description: A human readable name.

weight

  • Type: integer
  • Default: 100
  • Description: Determines the order in which the web item appears in the menu or list. The "lightest" weight (i.e., lowest number) appears first, rising relative to other items, while the "heaviest" weights sink to the bottom of the menu or list.
    Built-in web items have weights that are incremented by numbers that leave room for additional items, such as by 10 or 100. Be mindful of the weight you choose for your item, so that it appears in a sensible order given existing items.

conditions


Report

A report in the reports sidebar.

Module type

serviceDeskReports

Screenshot

Sample JSON

1
2
3
4
5
6
7
8
9
10
11
12
"modules": {
 "serviceDeskReports": [ 
     { 
         "key": "my-custom-report", 
         "name": { 
             "value": "My custom report" 
         }, 
         "group": "my-custom-reports-section", 
         "url": "/sd-report-content" 
        }
    ]
}

Properties

key

  • Type: string (^[a-zA-Z0-9-]+$)
  • Required: yes
  • Description: A key to identify this module. This key must be unique relative to the app, with the exception of Confluence macros: their keys need to be globally unique. Keys must only contain alphanumeric characters and dashes.

name

  • Type: i18n Property
  • Required: yes
  • Description: A human readable name.

weight

  • Type: integer
  • Default: 100
  • Description: Determines the order in which the web item appears in the menu or list. The "lightest" weight (i.e., lowest number) appears first, rising relative to other items, while the "heaviest" weights sink to the bottom of the menu or list.
    Built-in web items have weights that are incremented by numbers that leave room for additional items, such as by 10 or 100. Be mindful of the weight you choose for your item, so that it appears in a sensible order given existing items.

group

  • Type: string
  • Required: no
  • Description: References the key of a serviceDeskReportGroup. If this property is not provided, the report will appear in a generic "Apps" group.

url

  • Type: string, uri-template
  • Required: yes
  • Description: The URL of the app resource that provides the content. This URL must be relative to the app's baseUrl. Your app can receive additional context from the application by using variable tokens in the URL attribute.

conditions


Organization Panel

A panel in the organization screen.

Module type

organizationAgentViewPanel

Screenshot

Sample JSON

1
2
3
4
5
6
7
8
9
"modules": {
 "organizationAgentViewPanel": [ 
     { 
         "key": "my-custom-organization-panel", 
         "weight" : 200,   
         "url": "/sd-organization-panel-content" 
        }
    ]
}

Properties

key

  • Type: string (^[a-zA-Z0-9-]+$)
  • Required: yes
  • Description: A key to identify this module. This key must be unique relative to the app, with the exception of Confluence macros: their keys need to be globally unique. Keys must only contain alphanumeric characters and dashes.

weight

  • Type: integer
  • Default: 100
  • Description: Determines the order in which the web item appears in the menu or list. The "lightest" weight (i.e., lowest number) appears first, rising relative to other items, while the "heaviest" weights sink to the bottom of the menu or list.
    Built-in web items have weights that are incremented by numbers that leave room for additional items, such as by 10 or 100. Be mindful of the weight you choose for your item, so that it appears in a sensible order given existing items.

url

  • Type: string, uri-template
  • Required: yes
  • Description: The URL of the app resource that provides the content. This URL must be relative to the app's baseUrl. Your app can receive additional context from the application by using variable tokens in the URL attribute.

conditions


Organization Actions

Actions for the organization screen.

Module type

serviceDeskOrganizationActions

Screenshot

Sample JSON

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
"modules": {
 "serviceDeskOrganizationActions": [ 
        {
            "key": "org-action-link",
            "url": "/sd-action-url",
            "weight": 200,
            "name": {
                "value": "link name"
            },
            "target": {
                "type": "page"
            }
        },
    ]
}

Properties

key

  • Type: string (^[a-zA-Z0-9-]+$)
  • Required: yes
  • Description: A key to identify this module. This key must be unique relative to the app, with the exception of Confluence macros: their keys need to be globally unique. Keys must only contain alphanumeric characters and dashes.

name

  • Type: i18n Property
  • Required: yes
  • Description: A human readable name.

weight

  • Type: integer
  • Default: 100
  • Description: Determines the order in which the web item appears in the menu or list. The "lightest" weight (i.e., lowest number) appears first, rising relative to other items, while the "heaviest" weights sink to the bottom of the menu or list.
    Built-in web items have weights that are incremented by numbers that leave room for additional items, such as by 10 or 100. Be mindful of the weight you choose for your item, so that it appears in a sensible order given existing items.

url

  • Type: string, uri-template
  • Required: yes
  • Description: The URL of the app resource that provides the content. This URL must be relative to the app's baseUrl. Your app can receive additional context from the application by using variable tokens in the URL attribute.

target

  • Type: web item target
  • Description: Defines the way the URL is opened in the browser, such as in its own page or a modal dialog. If omitted, the URL behaves as a regular hyperlink.

conditions