This documentation corresponds to a historical version of Yellowfin


Access the latest release, or view a list of available versions of the documentation.

Skip to end of metadata
Go to start of metadata


Yellowfin provides you with the capacity to export all your content definitions including the related entities from one instance of Yellowfin (e.g. QA) and import these into a separate instance (e.g. Production).

Note: When exporting definitions from Yellowfin there are certain limitations. You cannot export security settings that relate to individual users, only group or roles. These will have to be reset when importing them into the new instance of Yellowfin. Source filter information will be exported but only if it is a scheduled SQL query. Manual records and data file records will not be exported. This is because it's assumed that users will differ between instances, but groups and other structures will be the same.

Content Dependencies

When exporting content, it's important to not only select the items you wish to export, but also all other items the main content may depend on to work.

Yellowfin's content dependency structure is illustrated to the right.

For example, if you are exporting a Report you will need to either:

  1. include all images it uses, the category and sub category it's stored in, and the view and source connection it's based on, or
  2. ensure all the items above are already available in the instance you plan on importing the item into



Database Independence

If you are using the export and import functions to migrate Yellowfin across platforms then you will have to be mindful of any hard coded SQL. Examples of this may be:

  1. Created Virtual Tables within the View
  2. Freehand SQL Calculated Fields in the View
  3. Freehand SQL Reports
  4. BIRT or Jasper reports with platform specific SQL

Yellowfin cannot test for these SQL anomalies and you should test your export and import processes across platforms in your test environment prior to migrating into production.

Export Process

1. To export definitions from Yellowfin click on Administration > Export in the main navigation menu.

2. Select the elements you wish to export.

  • From the drop down menu choose the item type (source system, categories, views etc). Based on your selection you will be presented with a list of items to choose from.
  • Select those items you wish to export and click the add button to add selected items to the list. Click next to continue.

3. If you have chosen to export items which have dependencies (for example a dashboard tab) Yellowfin will present you with a list of all the dependent items which you may wish to export as well.

Select those items you wish to include in the export process and click add to add them to the list.

4. When ready to export click the export link.

5. You will be prompted to save the file to your local drive. Save the file onto your local file server – for later use.

Import Process

1. To import definitions into Yellowfin click on Administration > Import in the main navigation menu.

2. Select the exported XML file from your file server by clicking the browse button and using the file upload form to select the appropriate file. Click next to continue.

3. Yellowfin will now display each element in the import file on the right hand side of your screen and provide you import options in the central form on your screen.

You can choose to import or skip any item in the import file. If you skip dependent items such as a data source for a report then Yellowfin will prompt you to select the appropriate substitutes for those specific items.

Choose your import options for each item and click next to navigate through all the items in the file until you reach the summary.

4. On the summary - if all items have been processed correctly - you can click Import to complete the process.

If an error has been detected Yellowfin will display the error message for the problematic artefact. You can choose to continue to Import or fix the issue and begin the process again.