Fullscreen Image

Export Configuration

The Export Configuration section of the System Administrator Dashboard is used to export elements of a configuration from one environment to import into another environment. A common use case for this feature is to build new configurations in your Train environment, perfect them, and then import them into Production. Another use case is to create back-ups to restore configurations after the monthly Train refresh or a migration to Production.

Additional resources:

To navigate to the Export Configuration page:

  1. Click Admin in the toolbar in the upper-right corner of the window.

    The System Administrator Dashboard page opens.

  2. Click Export Configuration link in the Company Administration column.

    The Export Configuration page opens.

  3. Select the appropriate tab.

    See the Tabs in the Export Configuration Tool section below to learn which tab will contain the appropriate records.

  4. Follow a procedure below.

ClosedBest Practices

  • Always import from the bottom-up, or the parts before the whole.

    Here are three examples you may encounter:

    • Do not import a Budget Summary page until you have imported the Budget Types and Budget Template.

    • Do not import a Work Flow until you have imported the Schedules and Forms that are referenced in the Work Flow.

    • For page layout imports, import list layouts, then sub pages, then summary page layouts.

  • Append the prefix LxDev to the name of all of your configured templates.

    This prefix is used to identify items that need to be exported before a Train refresh. Once you export and import the item into Production, you will remove LxDev from the name. This rule applies to items such as page layouts, forms, templates, and so on.

    The reason you want to append this identifier to your templates is to prevent naming conflicts when you re-import into Production.

  • Be cautious when using the Export All.

    While it makes exporting files easier, using this can have unintended consequences. Since the generated XML file contains all of the configuration files of the types listed on that page in the system, importing the file might introduce new configurations or override existing configurations.

    For example, on the Export Configuration > Others tab, you can export user class security, exchange rates, CPI data, and fiscal period data, amongst other records. Imagine that you made modifications to the data on this page but you decided to exclude the changes made to your user security. If you clicked the Export All button and you imported the configuration into Production, you would overwrite your user security settings in Production.

ClosedBefore Starting

Be sure to perform these actions prior to you or another individual exporting data from your firm:

  1. If you will be having another individual perform exports, review the Manage Export Configuration Security page.

  2. Create a backup folder where you will save your exported XML files.

    We recommend the following naming convention:

    • Folder Naming: Client Name + Date Stamp + Version Number

      • Example: Lucernex 1-1-2019 v1

        The version number is used to document multiple exports on the same day

    • File Naming: Client Name + Spacer + Tab Name + (report type, optional) + Number of files

      • Example: Lucernex - Summary Pages (5)

      • Example: Lucernex - Reports – Integrations (4)

      • Example: Lucernex - Other -Exchange Rates

ClosedTabs in the Export Configuration Tool

This table contains a description of each of the tabs in the Export Configuration tool and the types of records that can be exported from the page.

Tab Name Record Types Data Displayed
Summary Pages
  • All custom Summary pages in your firm

  • Page Layout Name

  • Primary Table

  • Top Menu

  • Previous Layout

Sub Pages
  • All custom Sub Pages in your firm

  • Page Layout Name

  • Primary Table

List Pages
  • All custom List Layouts in your firm

  • Page Layout Name

  • Primary Table

  • Top Menu

Forms
  • All forms in your firm

  • Name

  • Description

  • Work Flow field set?(Yes / No)

Reports
  • All reports created in your firm

    Note:

    This includes all reports you have created, even if the reports are copies of global report templates.

  • Page Layout Name

  • Description

Templates
  • Budget Templates

  • Folder Templates

  • Task Template

  • Work Flow Templates

  • Name

  • Type

  • Description

Others
  • FiscalPeriod: Export your fiscal calendar.

  • UserClassSecurity: Export your user classes and security settings.

    This exports and updates all user classes and security settings.

  • CPI: Export your firm CPI data.

  • BudgetColumnType: Export your budget column types.

  • ReportFolder: Export the folder structure of the Reports page. This will export the entire structure, you cannot pick or choose folders.

  • CustomCodeTable: Export all of your custom fields.

  • Record Type

  • Record Count

ClosedExport Firm Data

To export your firm data:

  1. Select the appropriate tab.

    See the Tabs in the Export Configuration Tool section above to learn which tab will contain the appropriate records.

  2. If you are on the Summary Pages, Sub Pages, List Pages, Forms, or Reports tab, choose between two options:

    • Select the Clone these layouts in this firm and environment check box if you want new layouts and fields to be created when the XML file is imported.

      Important!

      Do not select this check box if you are moving these records from one environment to another (for example, dev to iwms) or one firm to another.

    • Clear the Clone these layouts in this firm and environment check box if you do not want new layouts and fields to be created when the XML file is imported.

  3. If you are on the Templates or Others tab, choose between two options:

    • Select the Allow import into different firm check box if you want your export to be importable into other firms.

      Note:

      This check box is selected by default.

    • Clear the Allow import into different firm check box if you do not want your export to be importable into other firms.

  4. Do one of the following:

    • To export all records, click Export All.

      A status dialog box opens. The system will begin to export your records. This process may take some time.

      Important!

      Be cautious when using the Export All.

      While it makes exporting files easier, using this can have unintended consequences. Since the generated XML file contains all of the configuration files of the types listed on that page in the system, importing the file might introduce new configurations or override existing configurations.

      For example, on the Export Configuration > Others tab, you can export user class security, exchange rates, CPI data, and fiscal period data, amongst other records. Imagine that you made modifications to the data on this page but you decided to exclude the changes made to your user security. If you clicked the Export All button and you imported the configuration into Production, you would overwrite your user security settings in Production.

      Once the export is complete, a Data Export dialog box will open. This dialog box will summarize what was exported, including the types of data and how many records are included in the file.

    • To select individual records to export:

      1. Select the check box next to the rows you want to export.

      2. Click Export Selected.

        A status dialog box opens. The system will begin to export your records. This process may take some time.

        Once the export is complete, a Data Export dialog box will open. This dialog box will summarize what was exported, including the types of data and how many records are included in the file.

  5. Click Save XML File.

    Your computer prompts you with a file dialog box, and asks if you want to save or open the file. Choose your preferred option.

Import Firm Data