FieldPeek for Jira Service Management

Guide for space admins

How to choose which fields customers see, for each request type in your space.

FieldPeek shows extra Jira fields to customers when they view a request in the customer portal. As a space admin, you choose which fields appear, where, and in what order, for each request type in your space.

Customers can only read these fields. They cannot edit them.

Before you start

  • You need to be an administrator of a Jira Service Management space that has a customer portal.
  • The first time you open FieldPeek, Jira may ask you to Allow access. This is a one-time prompt that lets FieldPeek confirm you are an admin of the space.
  • Anything you add to a layout becomes visible to every customer who can open a request of that type, even if the field is not on the request form. Only add fields you are happy for customers to read.

Open FieldPeek

  1. Go to your service space.
  2. Open Space settings.
  3. Under Apps, select FieldPeek.

How layouts work

A layout is a list of fields to show, assigned to one or more request types.

  • A space can have as many layouts as you need.
  • One layout can serve several request types, so similar request types can share the same setup.
  • Each request type can use only one layout. Request types already used by another layout are not offered in the list.
  • Request types with no layout show nothing extra in the portal.

Each layout has two places to put fields:

PlaceWhere customers see it
Below the request titleAt the top of the request, above the description and activity
Right-hand panelIn the panel on the right, under an "Additional details" heading

Create a layout

  1. Select New layout.
  2. Type a name in Layout name. Customers never see this name; it is only for you.
  3. In Request types using this layout, pick one or more request types.
  4. Under Below the request title, open Add a field and pick a field. Repeat for each field you want. Each new field starts with Hide when empty turned on.
  5. Under Right-hand panel, do the same for fields you want in the side panel.
  6. Select Save.

Nothing changes for customers until you select Save. After that, customers see the new layout the next time they open or reload a request.

Check your layout in the portal

FieldPeek only shows a field when it has a value on that request, unless you turn Hide when empty off. A request a customer has just raised usually has values only for the fields on its request form, so if your layout uses fields that are not on the form, the new request can look exactly as it did before. This is expected: the fields appear as soon as an agent, an automation rule or a workflow fills them in.

To see your layout working:

  1. Raise a request of a type that uses the layout, or pick an existing one.
  2. In Jira, open the request as an agent and fill in the fields in your layout.
  3. As a customer, open the request from Requests in the portal, or reload it if it is already open.

The fields appear on the request view, not on the form customers use to raise a request.

To see every field in your layout even while it is empty, turn Hide when empty off for those fields and select Save. They then show "None" until they have a value. The right-hand panel and its "Additional details" heading only appear on a request once at least one right-hand field is showing.

Adjust how fields appear

Each field in a layout is a row with these controls:

ControlWhat it does
Display nameThe name customers see. Leave it empty to use the field's Jira name.
Hide when emptyOn (the default for new fields): the field and its name are hidden on requests where it has no value. Off: the field shows "None".
RemoveTakes the field out of this layout.

To change the order, drag a row up or down. Each of the two places has its own order.

Group fields with section headings

  1. Select Add section heading under the list you want to group.
  2. Type the heading text in the Display name box of the new row.
  3. Drag the heading above the fields it should introduce.

A heading is hidden automatically on requests where none of the fields beneath it are showing. A heading with no text is removed when you save.

Change or delete a layout

  • To edit another layout, pick it in the Layout list at the top of the page.
  • To delete the selected layout, select Delete layout, then Save.

How values look in the portal

Field typeHow it appears
Short values (priority, status, numbers, short text)On the same line as the field name
Long text and rich textOn its own line below the field name, with formatting kept
Select, multi-select, radio buttons, checkboxesAs tags
Cascading selectParent and child together, for example "Hardware › Laptop"
Date, and date and timeIn the customer's language and time zone
UserThe person's name
URLA link that opens in a new tab. Customers are asked to confirm before leaving for an external site.

Things to know

  • Blocked fields. A Jira admin can block fields for the whole site. Blocked fields are not offered in Add a field. If a field in your layout is blocked later, it stops showing in the portal straight away and is removed from the layout the next time you save.
  • Disabled spaces. A Jira admin can disable FieldPeek for a space. You will see a "Disabled for this space" notice, your layouts are kept, and nothing can be changed until it is enabled again.
  • No active licence. If the FieldPeek subscription lapses, you will see a "No active licence" notice. Customers see no FieldPeek fields until the licence is active again. Your layouts are kept.
  • Right-hand panel heading. The "Additional details" heading cannot be renamed. The panel is hidden on requests where it has nothing to show.
  • Signed-in customers only. Customers must be signed in to the portal. Anonymous visitors do not see FieldPeek fields.
  • Fields that are not supported yet. Jira Assets object fields show as empty. SLA fields and fields from other Marketplace apps have not been tested.

Troubleshooting

What you seeWhat to check
A field is missing from Add a fieldA Jira admin may have blocked it.
A request type is missing from the listIt is already used by another layout in this space.
Customers see no fields on a new requestThe fields are probably still empty. New fields have Hide when empty on, and a new request only has values for the fields on its request form. Fill the fields in as an agent, or turn Hide when empty off, then reload the request. See Check your layout in the portal above.
Customers see no fields on a request that has valuesCheck that the request's type is assigned to this layout, that you selected Save, and that you are looking at the request view rather than the form for raising a request.
The right-hand panel is missingIt only appears when at least one right-hand field is showing. Empty fields with Hide when empty on do not count.
A field shows in Jira but not in the portalIt may be empty on that request with Hide when empty on, or it may be a field type that is not supported yet.
Everything is greyed outA Jira admin has disabled FieldPeek for this space.
"FieldPeek only works in Jira Service Management spaces"The space is not a JSM service space, or has no customer portal. Customer Service Management spaces are not supported.