TELCOMA Global / Portal Details for Jira Service Management / Documentation
Show customers more about their request.
Portal Details adds a panel called Details next to each request in the customer portal. You choose what it shows, per service project and per request type: fields, the assignee, SLA targets and linked requests. The app only reads. It has no permission to change a request.
Install
Two steps, both inside Jira.
Find the app
In Jira go to Settings → Apps → Find new apps and search for Portal Details. Approve the permissions: they are read permissions only.
Start the free trial
The app is paid per agent through the Atlassian Marketplace, with a free trial. While the trial runs, the settings page shows how many days are left.
Nothing appears on the portal until someone sets up a service project and saves. A new panel shows nothing: every part is off until you choose it.
Where to set it up
Two settings pages, the same screen.
- Settings → Apps → Portal Details is for Jira administrators. Choose any service project from Service project. Projects that already show the panel are marked on the portal.
- Project settings → Apps → Portal Details is for project administrators (and Jira administrators). It appears only in service projects, opens that project straight away, and can change only that project.
The app asks Jira, as you, whether you hold the right permission every time the page loads or saves. If you don't, the page says No access and does nothing else.
At the top of a project you see its name, whether it is On the portal or Not on the portal, and when the settings were last saved and by whom.
Request types
One default panel, and exceptions where you need them.
The Settings for list starts with All request types (default). Every request type uses these settings unless you change it. Each request type is listed after it, with how it is set: uses the default, own settings or panel hidden.
Pick a request type and choose under Which settings this request type uses:
- Use the default settings.
- Use its own settings. They start as a copy of the default, and you change them from there.
- Don't show the panel. Customers see nothing on requests of this type.
The note under the default tells you how many request types have their own settings or have the panel hidden.
Fields
Only the fields you are happy for customers to read.
- Use Add a field to search the site's fields. System fields are marked (system field). Fields agents fill in that are not on the request form can be chosen too.
- Each chosen field shows its name In Jira and a box for what Customers see it as. Leave the box empty to use the field's own name. Labels can be up to 60 characters.
- Up and Down set the order customers see. Remove takes a field off.
- Under each name the page says how the value is shown: Rich text, shown as plain text, Date, Date and time, Number or Link.
- Show a field even when it is empty, with the word "None". Off by default, so empty fields are left out.
A panel holds up to 20 fields. A value is reduced to the words a person would read: a person becomes their name, an option becomes its value, rich text becomes plain paragraphs (cut at 4,000 characters, images left out). Emails, avatar links and internal IDs are dropped before anything reaches the portal.
Assignee and SLA targets
Who is working on it, and when it is due.
Assignee
Choose Show the agent's name, Show only whether someone is assigned, or Don't show. Set a Label if you like; the default is Assigned to or Assignee. Customers see the name, Assigned, or Not assigned yet.
SLA targets
Use Add an SLA to pick up to 6 of the site's SLAs, and give each a label. If the site has no SLAs, the page says so.
What customers read
A running target reads Due with the date and time, and how long until then. A stopped clock shows Paused. A finished target shows Met with the time.
Missed targets
Hide targets that were missed is on by default. It hides targets that are overdue or were missed. Turn it off to show them as Overdue or Missed.
Times are shown in each customer's own time zone and language, from their Atlassian profile.
Linked requests
Linked requests, without naming internal work.
Choose one of three options:
- Don't show.
- Show linked requests the customer can open. A linked request is shown with its key, title and status only to a customer who raised it, was added to it, or is in an organization it is shared with.
- Also count other linked work, by status only (no keys or titles). Anything the customer cannot open is counted by relation and status, for example Is blocked by 2 other items: 1 open, 1 done.
Only these link types limits the panel to the link types you pick, up to 30. Leave it empty for all link types. If you pick more than 30, the page names the ones that will not be saved.
The panel reads the first 20 linked items of a request. When there are more and you chose to count other work, the count says so, for example 20 or more other items. Linked requests show a status category (Open, In progress or Done), not the workflow's own status name, because those can be internal.
Preview, save and turn off
See it as the customer does, before anyone else.
Preview
Pick a Recent request (the 15 newest you can see) or type a key under Or a key, then click Preview. The panel is drawn as the person who raised the request sees it, with your unsaved changes. Times are in your time zone here.
Save
Save is active once there are Unsaved changes. Discard changes goes back to what is saved. After a save, customers see the change the next time they open a request.
Turn off for this project
Asks first. Customers stop seeing the panel, and the settings for the project are deleted. Nothing in Jira changes.
Two people at once
If someone else saved while you were editing, your save is refused and the page offers Reload. Switching project with unsaved changes asks you to stay or discard.
The preview shows nothing from a request you cannot open yourself. If the customer can open a linked request that you cannot, it is left out of the preview and the page tells you how many.
Every save is checked against the site's own fields, request types and link types. Anything that no longer exists or is over a limit is named in the message after the save.
What customers see
A Details panel beside their request.
The panel lists, in this order: the assignee, the SLA targets, the fields, and the linked requests. Each linked request shows its relation (for example Relates to), its key as a link to its portal page, its status and its title. If nothing is linked, the section says None.
Who sees the panel on a request:
- The customer who raised it, people added to it, and members of an organization it is shared with. Portal-only customers, who hold no Jira licence, see it too.
- An agent who opens the request on the portal, if Jira lets them open it.
Nobody else sees it. If a check fails, if nothing chosen has a value, or if the request type has the panel hidden, the panel draws nothing. If the details can't be loaded, customers read Details are not available right now. Refresh the page to try again.
Without an active subscription, customers see nothing and the settings page explains how to subscribe.
What it can't show
Some things are left out on purpose.
- Assets fields. Jira's API returns object IDs for them, not names, so they are not offered.
- Approvals and satisfaction ratings. Not offered. The portal already shows approvals.
- Attachments, comments and work logs. Not single values, so not offered. The portal already shows attachments and comments.
- Workflow status names on linked requests. Only the status category is shown.
- A title per request type. The panel is always called Details. When a request has nothing to show, the panel draws nothing, but the portal may still show the title.
- Limits per panel: 20 fields, 6 SLAs and 30 link types. Very large settings, with many request types that each have their own full panel, are refused with a plain message; let more request types use the default.
The app reads requests through the atlassian-addons-project-access role, which Jira gives "Browse projects". If a project's permission scheme removed that role, the preview says so.
Your data
Nothing about requests or customers is stored.
Only the fields you chose, plus the reporter, participants, organizations and request type, to check who may see the panel. For linked requests: title, status and the same checks. Service projects, request types, fields and link types for the settings page.
Nothing in Jira. The app has no write permission.
The panel settings for each service project, with the account ID of whoever saved last. Names are looked up from Jira when a page is shown. Stored in Atlassian's own storage for your site.
Only to the portal panel, for people who can open the request. No servers of our own, no requests outside Atlassian.
Full details in the privacy policy.
Frequently asked
The questions admins ask first.
How is it priced?
Per agent, billed through Atlassian, with a free trial. The price will be on the Atlassian Marketplace listing.
Can customers see a field I didn't choose?
No. The panel reads only the fields you chose, and sends only their readable words to the portal.
Will customers see internal linked work?
No. Work they cannot open is never named. At most it is counted by status, and only if you choose that.
Can a project admin set it up?
Yes, for their own project, from Project settings → Apps → Portal Details. Jira administrators can set up any service project.
Why is the panel empty for a customer?
They can't open the request, the request type has the panel hidden, nothing you chose has a value yet, or there is no active subscription. Use Preview on the same request to check.
Does it change requests?
No. It has no write permission. Turning it off deletes only the app's settings for that project.
Support
Ask the people who built it.
When reporting a problem, include your site URL, the request key and what you expected to happen. We never need passwords or tokens.
Get help
One business day, usually much less.
- [email protected]
- Support page
- Known limits, what to include, status
- Response time
- Within one business day