Advanced export options (plugin versions before v1.5)
This is what the "Advanced export options" page looked like before version 1.5.
.png?version=1&modificationDate=1428676558277&cacheVersion=1&api=v2&effects=border-simple%2Cshadow-kn&width=900&height=440)
The "Filtering custom fields" options selects whether all custom fields will be exported or only those that are used by the exported project(s). Detailed explanations about the criteria for deciding whether a custom field is "used" by a project can be found here. Most users will choose either the option to export all custom fields or the last one, to export only those custom fields that have anything to do with the exported project(s). This feature has been extended in version 1.3.1.
The "User export options" is a set of radio buttons that lets you select one way to handle user data during export. Available options are:
- Full export: This the default mode (and the only one up to and including v 1.0.9). When a user name is found anywhere in the exported configuration, the plugin looks for the user and adds its description to the exported items. If the user is invalid, the export will halt with an error.
- Ignore invalid users: When a user name is found which is not valid, the user and its description are not added to the exported items. The user name still appears as component or project lead, or in a permission/notification/issue security scheme in the exported file. Export will not halt in these cases. Currently, the plugin is able to detect an invalid user name in two situations:
- When it cannot find a user for that name.
- When the found user has an invalid email address (it does not conform to the pattern "X@Y" where X and Y are non empty strings)
- Do not export: No user will be exported, regardless it is valid or not. Export will not halt on an invalid user name.
"Group export options" offers the same choices for export of groups. Take into account that currently the only case detected as an "invalid" group is when a group cannot be found for a given name. Group export options are new in version 1.1.3.
"Filter export options" lets you control export of filters. The choices are:
- None (default): no filter will be exported.
- Only shared filters: export only filters that have been shared with somebody else. This means that private filters, that are only visible to their respective owners, will not be exported.
- All filters: export all filters in the instance.
Finally, the "Project XXX configuration export" launches the export with the selected options ("XXX" will be the project key).
What will happen when I load this configuration file?
When you are about to load a configuration file created with "Ignore invalid ..." or "Do not export" options, it is likely that it contains some references to users or groups (by their names) where those users/ groups are not included in the corresponding section of the configuration file. If a user/group with that name does not already exist in the target instance, there are some implications:
- Except in very rare cases (e.g. users/groups are the default values in a custom field) the load will not fail.
- However you are creating an inconsistency in your target instance. There will be a project, component, scheme,...using a user name or group name that does not correspond to a valid user/group.