Bulk Operations

Export Configurations

Save configurations as JSON file:

  1. Go to Apps → Customer Portal Fields Panel settings
  2. Click Bulk Operations tab
  3. Select configurations to export
  4. Click Export Selected or Export All

The exported file contains all selected panel configurations in JSON format. The actor of a configuration is not exported.

Tip: Export configurations before making major changes as a backup.


Import Configurations

Load configurations from JSON or CSV file:

Import Configurations
  1. Go to Bulk Operations tab
  2. Click Import
  3. Choose file format (JSON or CSV)
  4. Paste file content
  5. Click Validate to review
  6. Confirm import

Note: Imported configurations with duplicate names will be renamed automatically.

Portals on import

Portal IDs mean nothing on another site, so for configurations bound to portals the import asks what to do: Show on the selected portals, Import disabled or Do not import. Portals of this site with the same project key as in the file (portalKeys) are pre-selected - check them before importing.

Empty cells in CSV

In a CSV file an empty cell of a true/false column means “not set” and imports the way the configuration form shows an unset value: isEnabled, isShowName, isShowDescription and isShowCount import as true. Write false to turn them off.


Import Limits

Imports enforce the following limits:

Limit Value
Max configurations per import 200
Max file size 10 MB
Max CSV rows (excluding header) 1000

Imports exceeding these limits are rejected during validation.


JSON Format Reference

The JSON export wraps configurations in a package with metadata. Each configuration is a flat object - all fields live at the top level (no nested groups).

{
  "metadata": {
    "version": "1.0.0",
    "exportedAt": 1715000000000,
    "totalConfigs": 1
  },
  "configs": [
    {
      "name": "Request details",
      "description": "Key fields of the request",
      "linkType": "EMPTY",
      "linkedIssuesFieldId": [],
      "linkTypes": [],
      "displayFieldIds": ["priority", "status", "components"],
      "fieldsMetadata": {},
      "portals": [],
      "requestTypes": [],
      "displayJql": "",
      "displayModule": "jiraServiceManagement:portalRequestDetailPanel",
      "isEnabled": true,
      "isShowName": true,
      "isShowDescription": true,
      "isShowCount": true,
      "rowsPerPage": 10
    }
  ]
}

Key Fields

Field Description
name Configuration name (max 250 characters)
description Free-form description
linkType "EMPTY" (no table) or "LINKED_ISSUES" - source of linked requests for the panel
linkedIssuesFieldId Field IDs for issues link source (when linkType is "LINKED_ISSUES")
linkTypes Array of { id, name, direction, directionName } objects (when linkType is "LINKED_ISSUES")
displayFieldIds Field IDs to display in the panel table
fieldsMetadata Object keyed by field ID with rendering metadata
requestTypes Context filter - empty array means all request types
displayJql Additional JQL gating panel visibility on the current issue
displayModule Surface where the panel appears (see Modules)
isEnabled true to activate the configuration
isShowName, isShowDescription, isShowCount Toggle visibility of panel header elements
rowsPerPage Rows per page (1-100)
portals IDs of the portals the configuration is shown on - empty means all portals
portalKeys Project keys of those portals, a hint for the import step
linkButtons Link buttons of the panel
translations Texts of the panel in other languages
isShowEmptyFields, isShowColonInFieldName, isShowValueUnderName Panel layout options
dateFormat, dateTimeFormat Date patterns of the panel layout

Note: Exports may also include _isGlobal: true for global configurations (no project filter). This marker is read-only - it appears in exports but is ignored on import.

Tip: Generate a working JSON file by exporting a single real configuration from your instance, then edit it. This is more reliable than writing from scratch.


CSV Format Reference

The CSV export uses semicolon (;) as the column delimiter. Each row is one configuration.

Value encoding

Value type Encoding
Simple string array (e.g., projects, issueTypes, displayFieldIds) Values joined with pipe | - e.g., PROJ1|PROJ2
Complex array or object (e.g., linkTypes, fieldsMetadata) JSON string inside the cell - quoted if it contains ;
Boolean true or false
Number Plain digits
Empty / null Empty string

Columns

The CSV export has one column per configuration setting. The main columns:

Column Description
name Configuration name (max 250 characters)
description Free-form description
linkType EMPTY, LINKED_ISSUES
linkedIssuesFieldId Pipe-joined field IDs
linkTypes JSON array of { id, name, direction, directionName }
displayFieldIds Pipe-joined field IDs
fieldsMetadata JSON object keyed by field ID
requestTypes Pipe-joined request type IDs
displayJql Display JQL (max 1000 characters)
displayModule Surface identifier
isEnabled true / false
isShowName true / false
isShowDescription true / false
isShowCount true / false
rowsPerPage 1-100
portals Pipe-joined portal IDs
portalKeys Pipe-joined project keys of those portals, a hint for the import step
linkButtons JSON array of link buttons
translations JSON object with the panel texts in other languages
isShowEmptyFields, isShowColonInFieldName, isShowValueUnderName true / false
dateFormat, dateTimeFormat Date patterns
_isGlobal Read-only on import - present in exports for global configs, ignored when importing

Note: CSV is convenient for bulk review and spreadsheet editing. For full fidelity, use JSON.


Validation Details

When importing configurations, the Validate step checks:

Check Description
Name uniqueness Detects duplicate names across existing and imported configurations
Required fields Ensures name and module are present
Module validity Checks that the module identifier is valid
JQL syntax Basic JQL syntax validation (if applicable)
Field limits Validates field counts don’t exceed limits
JSON structure Validates the JSON/CSV structure is well-formed

Name Conflict Resolution

When an imported configuration has the same name as an existing one:

  • The import tool flags the conflict during validation
  • You can choose to rename the imported configuration (a suffix is added automatically)
  • Existing configurations are never overwritten during import

Migration Between Instances

Use export/import to migrate configurations between Jira instances (e.g., dev → staging → production).

Migration Workflow

  1. Export all configurations from the source instance
  2. Review the exported JSON for environment-specific values:
    • Project keys - must match on the target instance
    • Issue type names - must match on the target instance
    • Custom field IDs - may differ between instances
    • Portal IDs - differ between instances; the import pre-selects the portals of the target site by project key
  3. Edit the JSON if needed to adjust values for the target environment
  4. Import into the target instance
  5. Validate and review the import preview
  6. Test imported configurations with real issues

Tips for Migration

  • Project keys: Keep project keys consistent across environments when possible
  • Portals: the import picks the portals of the target site by the project key of each portal (portalKeys) - check the pre-selected portals before importing (see Portals on import)
  • Module settings: Module enable/disable settings are not included in export - configure these separately on each instance

Duplicate Configuration

Create a copy of existing configuration:

  1. Click … menu on the configuration row
  2. Select Duplicate
  3. New configuration created with “(Copy)” suffix

Bulk Enable/Disable

Enable or disable multiple configurations at once:

  1. Go to Bulk Operations tab
  2. Select configurations using checkboxes
  3. Click Enable Selected or Disable Selected

This is useful for:

  • Temporarily disabling all panels during maintenance
  • Enabling a set of new configurations together
  • Testing by toggling configurations on/off

Tip: You can also toggle individual configurations using the switch in the configuration list.


Configuration Management

Edit

  1. Click on configuration name or row
  2. Modify settings
  3. Click Save

Delete

Remove configuration permanently:

  1. Click … menu
  2. Select Delete
  3. Confirm deletion

Warning: Deletion is permanent. Export configuration first if you may need it later.


Settings from Connect

The Settings from Connect block on the Bulk Operations tab shows the transfer of the Connect edition’s settings to this Forge edition:

  • whether settings of the Connect edition were found on the site;
  • when they were imported;
  • how many configurations were created, skipped or created disabled, and what to check.

Import again re-runs the transfer and still skips configurations whose name already exists. When no settings were found, paste the transfer file of the Connect edition into the block and select Import from Connect file. Only a Jira administrator can do this.

See Moving from the Connect edition for what is transferred and what to check afterwards.


Next Steps