Guide for Jira admins
How to set the site-wide limits: blocked fields and disabled spaces.
FieldPeek lets space admins show extra Jira fields to customers on the customer portal's request view. As a Jira admin, you set the site-wide limits: which fields may never be shown, and which spaces may use the app at all.
Day-to-day setup, such as choosing fields for each request type, is done by space admins. See the guide for space admins.
What FieldPeek can show
Space admins can add any Jira field to a layout, including fields that are not on the request form. Customers who can open a request then see those fields, read-only.
This means a space admin could expose a field you consider internal. The two controls below are how you prevent that.
Open the site settings
- Open Jira admin settings from the cog icon.
- Switch to Marketplace apps.
- Under Apps, select FieldPeek.
Only Jira admins can open this page or change these settings.
Block fields site-wide
Use this for fields that must never reach customers, such as internal notes, cost or time tracking fields.
- Open Blocked fields.
- Search for a field and select it. Repeat for each field to block.
- Select Save.
What blocking does:
- The field stops showing in the customer portal immediately, in every space.
- Space admins can no longer add it to a layout.
- If it is already in a layout, it is removed the next time that layout is saved.
To unblock a field, remove it from Blocked fields and select Save. Space admins then need to add it to their layouts again if it was removed.
Disable FieldPeek for a space
Use this when a space should not show extra fields to customers at all.
- Open Spaces where FieldPeek is disabled.
- Select the space. Repeat for each space to disable.
- Select Save.
What disabling does:
- Customers see no FieldPeek fields on requests in that space.
- The space's admins see a "Disabled for this space" notice and cannot change layouts.
- The space's layouts are kept. Removing the space from the list and saving brings them back as they were.
Only Jira Service Management spaces with a customer portal are listed. Customer Service Management spaces are not supported and do not appear.
Who can do what
| Role | Can do |
|---|---|
| Jira admin | Block fields site-wide; disable FieldPeek per space |
| Space admin | Create and edit layouts for their own space |
| Customer | Read the fields on requests they can already open |
A Jira admin who is also an admin of a space can do both.
What customers can and cannot see
- Fields only appear on the portal's request view, for a request the signed-in customer is allowed to open. Opening a request they do not have access to shows Jira's "No access" page and no FieldPeek fields.
- Customers are never asked to grant FieldPeek access to their account.
- Anonymous portal visitors do not see FieldPeek fields.
- All values are read-only.
Licence
If the FieldPeek subscription lapses, customers stop seeing FieldPeek fields. Layouts and site settings are kept, and both admin pages show a "No active licence" notice until the licence is active again.
Data and permissions
- Runs on Atlassian Forge. The app makes no requests to services outside Atlassian.
- What it stores: configuration only, in Forge storage: layouts, the blocked fields list and the disabled spaces list. Field values are read from Jira each time a request is viewed and are not stored.
- Permissions it requests: read Jira work items and fields, read service space and request type details, and store its own configuration. It has no permission to change work items.
- Uninstalling deletes all layouts and site settings. They cannot be recovered by reinstalling.
Troubleshooting
| What you see | What to check |
|---|---|
| A space is missing from the disable list | It is not a Jira Service Management space with a customer portal. |
| A space admin cannot find a field | Check whether it is in Blocked fields. |
| A space admin says everything is greyed out | The space is in Spaces where FieldPeek is disabled. |
| A blocked field still appears in a space's layout page | It is removed when that layout is next saved. It already no longer shows to customers. |
| Customers see no fields anywhere | Check the licence notice on this page, then ask the space admin to check the layout for that request type. |