1. Configure the config.json file.

The config.json file tells the utility everything it needs to know about the data to export and where to put it. Follow the guide below to configure the file.

Example config.json file:

{
  "jira_server_url": "https://your.local.jira",
  "jira_server_username": "local_user",
  "jira_server_password": "pass1234",
  "projects_to_migrate": [ "PROJ" ],
  "fields_to_migrate": [ ],
  "overwrite_previous_exports": "ask"
  "max_issues_per_file": 1000,
  "jql_filter": "",
  "jira_cloud_url": "https://cloud.atlassian.net",
  "jira_cloud_username": "jira_cloud_user",
  "jira_cloud_api_key": "apikey123456789",
  "path_to_files": "exports"
}

The user will be prompted to enter password and api key if they are not entered in the configuration file.

Properties

The config.json file has the following properties:

Property Name	Description	Default Value

Property Name	Description	Default Value
jira_server_url	The URL for the Jira Server instance. This must start with http:// or https:// and should not end with a trialing slash (“/”). This can be entered at runtime.	null
jira_server_username	A user that has access to the projects to export. This can be entered at runtime.	null
jira_server_password	The plain text password for the jira_server_username. This can be entered at runtime.	null
projects_to_migrate	A list of Project Keys of projects to export from Jira Server. This can be entered at runtime.	null
fields_to_migrate	A list of fields to export from Jira Server. The field names must match both Jira Server and Jira Cloud exactly. Only text fields are currently supported.	VERA Sync ID, Pending Tasks, Revision Number ** Issue Key will always be exported.
overwrite_previous_exports	(yes/no/ask) Tells the utility what to do if it finds an existing export for the Project Key being processed. Yes will cause the utility to overwrite the files automatically. No will cause it to skip the export of the project if it has been exported already. Ask will ask the user during execution if they want to overwrite the files.	ask
max_issues_per_file	The maximum number of issues per export file. This is capped at 1000 by Jira settings, but a smaller number can be provided if needed.	1000
jql_filter	A valid JQL Filter string to be used in filtering issues to be exported. This JQL filter will be used on all projects.	null
jira_cloud_url	The URL for the Jira Cloudinstance. This can be entered at runtime.	null
jira_cloud_username	A user that has access to the projects to updated. This can be entered at runtime.	null
jira_cloud_api_key	The plain text API Key for the jira_cloud_username. This can be entered at runtime.	null
path_to_files	The path to the export files to import. This can be changed if you want to import just a subset of previously exported files.	exports

Once the file has been configured as you need, then follow the next step: 2. Executing the Jira Cloud Utility