Set up Data Center to scan for customizations

Before you can see your customizations on the Customizations page, you need to scan your Jira or Confluence Data Center instance with the Customizations Scanner. The scanner is part of the Portfolio insights app for your product. The scan creates a customization report on your instance, which you later include in a support zip and upload to Portfolio insights.

はじめる前に

要件

• Jira Data Center 10.3 or later, or Confluence Data Center 9.2 or later, with the Portfolio insights app version listed below.

• System administrator permissions on the Data Center instance.

• The latest version of the Atlassian Troubleshooting and Support Tools app. You need it to create the support zip.

• To detect ScriptRunner scripts and Automation rules, your instance base URL needs to use HTTPS. On HTTP, these two scanners are skipped.

• To see the results, an organization admin of your Atlassian organization uploads the support zip in Atlassian Administration. Get started with Portfolio insights

考慮事項

• Scanners only read data from your instance. They don't change your configuration or data.

• A scan runs in the background on the node where you start it. In a cluster, you only need to run it on one node, and only one scan can run at a time.

• Your instance keeps only the latest report. Each new scan replaces the previous one.

Install the Portfolio insights app

The Customizations Scanner is included in these versions of the Portfolio insights app, or later. If you already use the app to connect your instance to Portfolio insights, update it to one of these versions to get the scanner.

To install or update the app:

1. In Data Center, go to Administration, then Manage apps.

2. Select Find new apps and search for Portfolio Insights.

3. Select Install, or Update if you already have the app.

The DC Customizations Scanner app is installed automatically with the Portfolio insights app. It's listed separately in Manage apps.

You can also download the app from the Atlassian Marketplace and upload it manually: Portfolio Insights for Jira Data Center or Portfolio Insights for Confluence Data Center. Pick the version that matches your product version.

Choose what to scan

All scanners are turned on by default, except Project info in Jira. You can change this before you run a scan.

To review the scanner settings:

1. In Data Center, go to Administration, then Manage apps.

2. Find DC Customizations Scanner and select Configure.

3. Under Scanners, turn individual scanners on or off. Scanners that are off are skipped.

4. Optionally, select Enable usage collection for a scanner. Usage data, such as how often a customization runs and when it was last used, is off by default. It helps you see which customizations are still in use.

Changes to the settings apply to new scans.

App decompilation

For custom apps, which are apps that don't come from the Marketplace, the scanner decompiles the app and attaches its source code to the report. This lets the AI analysis understand what the app does. Marketplace apps aren't decompiled. For those, the scanner only collects the name, key, version, and vendor.

Decompilation is on by default. On the settings page, under App decompilation, you can:

• Turn off Enable app decompilation. Reports won't include app source code, and recommendations for custom apps will be less detailed.

• Change the Decompilation depth, which controls how many levels of nested JAR files are decompiled. The default is 2. A higher depth can significantly increase scan time, disk use, and report size.

• Add Global exclusion patterns to leave out files you don't want in the report, such as configuration files that could contain sensitive values.

Run a scan

To run a scan:

1. In Data Center, go to Administration, then Manage apps, then DC Customizations Scanner.

2. Select Start scan. If you've scanned before, select New scan.

3. Wait for the scan to finish. This can take a few minutes. You can leave the page, and the scan continues in the background.

When the scan finishes, you'll see the list of detected customizations. If some scanners couldn't finish, the report shows Done with issues and a message that explains what to do. You can still upload the report, but it may be incomplete.

Creating a support zip doesn't start a new scan. The zip includes the latest saved report, so run a new scan whenever you want the uploaded data to reflect recent changes.

What the scanner detects

次のステップ

Once the scan has finished, create a support zip that includes the customization report. If someone else is the organization admin, send them the file to upload to Portfolio insights.

Collect and upload customization data