Configuring global Jira settings

Global Jira settings for Assets include configuration for the Assets app itself, rather than object schemes, object types, or even objects. Here you can configure log settings, date and time, Assets reindexing, and so on. Read on for more details on available settings.

Accessing global Jira settings

To access global Jira settings for Assets:

  1. Go to Administration > Manage apps.
  2. Look for pages in the Assets section.

General configuration

To open general configuration, select Assets configuration.

SettingDescription
User interaction

Attribute default label

The text type attribute to be used as default label for every object type. You can change this on the specific object type configuration too.

Note that this affects only for those object types that are created after this setting has changed.

Attribute default description

The description for the default label attribute. You can change this on the specific object type configuration too.

Open Object dialog event

Determines if the object dialog should open when a user selects an object link or when the user hovers with the mouse over an object link.

This will also apply when you view Assets object fields while you view a Jira issue.

Default number of objects fetched in custom fields

This indicates the number of objects that Assets will fetch in custom fields for each request. The default value is set to 25.

Once the user starts to search any objects on the custom field, more objects matching the search criteria are fetched from server asynchronously. Hence, the default limit of 25 is recommended and should be enough.

If you increase this number, it will affect the performance since more objects would then have to be fetched on every request.

General configuration

Assets Audit Log enabled

If you check this checkbox, it is ensured that all Assets object events are logged to an audit log file.

Include attribute values in audit log

This checkbox is enabled only if the above "Assets Audit Log enabled" is checked.

If checked, this will include all attribute values of an object in the audit log.

Restore Assets index from file

This will ensure that on start up, Assets index will be restored from a file. This will help increase the startup time. 

Assets will perform a consistency check of the file against the database on startup and recreate the index if they mismatch.

If you uncheck this, you may experience a slower start up time. However, it could remove the risk of a potential corrupted index file which may cause data inconsistency.

By default, this is checked. The file is located at {$JIRA_HOME/caches/assets_indexes}

 E.g, path of the file on MacOS will be {/var/atlassian/application-data/jira/caches/assets_indexes} 

Store cache on shutdown

This indicates that the Assets index should be persisted to a file on Assets shutdown (e.g, in cases of a plugin upgrade, Jira restart, Assets disable etc).

It is recommended that if "Restore Assets index from file" is checked, this property should be switched on too.

Restrict Assets Cache

This helps to limit the amount of objects allowed to be stored in Assets. This will subsequently limit the memory footprint by allowing only a limited number of objects to reside in the cache.

The default and recommended way to use Assets is to not restrict objects in cache. The limit will have negative performance impact.

Number of objects allowed in cache

This is enabled only if "Restrict Assets Cache" is checked.

This property indicates the number of Assets objects that will be be stored in the cache.

The recommended way is to not limit objects in cache.

Maximum File upload size

The maximum file upload size in bytes when uploading files, images, attachments into Assets. 

Assets parallelism

This is number of threads that Assets will spawn to perform parallel tasks, e.g, importing data, re-indexing etc.

If this number is set to a lower value, Assets will put less strain on Jira. However, it will come at the cost of a low performance speed.

Process data sources via temp files during imports

Temporarily store data on disk when using the import modules to reduce memory footprint during import.

Use a custom locale for Assets

This is used to indicate if the data stored in Assets should be sorted by a locale other than Jira's default one.

Fetching of objects may be slower if this option is switched on. Hence, by default, this is disabled to avoid performance issues.

The locale for Assets

This is enabled only if "Use a custom locale for Assets" is checked.

This determines the language Assets should use when sorting data.

Jira Service Management portal search text (single)

Placeholder for the Assets field on the Jira Service Desk portals (Single fields)

Jira Service Management portal search text (multiple)

Placeholder for the Assets field on the Jira Service Desk portals (Multiple fields)

Dedicated scheduling and import node

This setting is available only if you have a multi-node Data Center set up.

This node will be the dedicated node to execute Assets scheduling tasks, such as Importers, Automation, manual imports etc.

Note that, if a node was selected as the dedicated scheduling node and happens to be unavailable at the time of running a scheduled task, then that task will not run.

Date settings

All dates in Assets use the Jira administrator settings, and can be changed under the following URL:

https://host:port/secure/admin/AdvancedApplicationProperties.jspa

Log files

Logs are located in the following directory:

<Jira-shared-home>/log

Attachments

Assets attachments are stored accordingly in subfolders named avatars, files, icons, and objects in the following directory:

<Jira_home>/data/attachments/assets

Indexing

To open indexing configuration, select Indexing Assets.

You can select from the following options for indexing:

  • Clean re-index
    A clean re-index means that all objects will be removed from the index, and then will be indexed again. This is recommended if you want to have a fresh state of the index. Once the indexing is in progress, you won't be able to search for objects or filter them.

  • Re-index
    A re-index means that all objects will stay in the index during the process, and Assets will index them again. You can search for objects during the process.

  • Persist Assets index to file
    You can manually persist (copy) the index on your disk. This is useful if you have a big Assets environment with a large number of objects and are planning to reinstall the app. With the index on your disk, Assets won't have to recreate it from scratch.

Testing Groovy scripts

To test Groovy scripts, select Assets script console. It gives you a quick and easy way to test Groovy scripts that you want to use in Assets automation or post-functions.

Syncing reports

To open reports syncing configuration, select Assets reports. Here you can set up a cron schedule, which syncs the data in your reports.

Analytics

To open analytics configuration, select Mindville analytics.

Additional Data Center configuration

Configure data retention period for clustermessage table 

Configuring the data retention period helps you avoid performance issues that might result from overloading the clustermessage table. If you import large data sets to Assets in a short period of time, the clustermessage table will be filled with information and can cause performance issues.

To configure the data retention period, complete the following steps:

  1. Go to Administration System.
  2. Scroll down to the Advanced section and select Services.
  3. Under Add Service, under Class, select Build-in services.
  4. Select Cluster messaging flush service.
  5. Enter the following information:
    1. Name - Cluster Messaging Flush Service
    2. Class  - com.atlassian.jira.service.services.cluster.ClusterMessageCleaningService
    3. Schedule  - 0 0 4/12 * * ?
  6. Select Add Service.
  7. Enter the following for Retention Period  - 2880m
  8. Select Update

Configure frequency of updates for the Process results tab

This setting is available only if you have a multi-node Data Center set up.

The progression of imports is shared across your database for the number of executed units of work that you can set in the Assets configuration. A unit of work quantifies the frequency of updates to the database for an operation in progress. We recommend changing this value only if you notice any user experience performance issues.

For example, in the case of a CSV import, a unit of work represents a single row in the CSV file where a row is an Assets object. For the interval of 100 units of work, the status of the import operation will be updated in the database every time 100 new objects are imported.

The default number of units of work is 100. To change this value:

  1. Go to Administration > Manage apps.
  2. In the left-side panel, select Assets configuration.
  3. Select Edit settings.
  4. In the Data Center section, edit the value of Frequency of updates for the status of an action in progress.
  5. Select Save.
Last modified on Nov 1, 2023

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.