Configuration

Configure access to the Marketplace and field mappings

The configuration screen of the app is accessible under Apps / Manage Apps in Jira.

Marketplace Access

The app access the Atlassian Marketplace REST API via a technical account whose credentials need to be saved. These attibutes are mandatory.

Attribute	Description
Username	Username of the technical account used to access the Marketplace
API token	This is the API token needed to access the Marketplace. The token may be generated in the Atlassian ID profile page of the technical account. https://id.atlassian.com/manage-profile/security/api-tokens
Vendor ID	This is the Marketplace Vendor ID required by the Marketplace REST API.

All configuration elements, including the credentials, are stored in an encrypted form using the Forge Storage API. This means the sensitive information is unreadable to anyone and is stored safely in Atlassian's Forge environment.

The Technical Account

The account used to access the Marketplace API must be a Contact in the Marketplace vendor profile and have the following privleges assigned. Privileges may be configured under Manage Vendor / Contacts.

Why using a technical account?

The Atlassian Marketplace does not support OAuth2 access, therefore this is the only option as of now.

On the hand, using a technical account decouples agents from the Marketplace. Marketplace access rights (and hence access to all sales and customer information) are not needed at all for the team of Customer Service agents.

Entitlement Number and Projects

There are two more mandatory attributes that need to be configured before the app is put in use.

Attribute	Description
Entitlement Number Field	This is a custom field of type Single or Multiline Text where Entitlement Numbers are stored in the customer requests. Entitlement Numbers are crucial to fetch data from the Marketplace.
Enable in Projects	This is picker of Jira Service Management projects. The projects selected may be used to access Marketplace data. Typically a single projects is selected here.

Custom Field Mappings

Custom field mappings allows you to save Marketplace Data in custom fields of the customer requests. This brings lots of benefits such as Marketplace data relative to the Entitlement Number may be easily included in Jira screens, but reporting becomes possible and informative dashboards may be built to show the most relevant and mostly hidden details of your service desk.

Attribute	Description
App Name Field	Custom field to store the App's name. It may be a Text or Single Choice field. The field is case sensitive, so the options of a Single Choice field must exactly be the same as the values coming from the Marketplace.
Hosting Field	Custom field to store the Hosting type of the subscription (Cloud, Data Center or Server). It may be a Text or Single Choice field. The field is case sensitive, so the options of a Single Choice field must exactly be the same as the values coming from the Marketplace.
User Tier Field	Custom field that stores the current user tier of the license or subscription. It may be a short text or number field. Unlimited tiers are stored as 0 in number custom fields.
Company Field	Custom field to store the customer's company name. It may be a single line or multi line text.
Partner Field	Custom field to store the solution partner's name if a partner was involved in the transaction. It may be a single line or multi line text.