{"id":4023,"date":"2015-06-16T19:49:15","date_gmt":"2015-06-16T11:49:15","guid":{"rendered":"http:\/\/localhost\/help\/?page_id=4023"},"modified":"2024-08-19T13:16:46","modified_gmt":"2024-08-19T05:16:46","slug":"exporting-your-config","status":"publish","type":"page","link":"https:\/\/oihelp.corporate.ifs.com\/help\/p2-server\/importexport\/exporting-your-config\/","title":{"rendered":"Exporting Your Configuration"},"content":{"rendered":"\n

This article applies to versions 4.5.1 and later of IFS OI Server. For more, see Release History<\/a>.\u00a0<\/p>\n

IFS OI Server Management allows you to export all the data in the IFS OI Server database to an Excel\u00ae spreadsheet. The main reason for doing this is so you can more easily update the configuration<\/a>\u00a0in bulk. It also allows you to download a blank template, useful for when you are initially setting up your configuration.<\/p>\n

In v4.17, support for exporting areas has been added.<\/span><\/p>\n

\"\"<\/a><\/p>\n

\n

Contents of the Export File<\/h2>\n

Depending on what objects you choose to export, the export file will either be a .zip file or an .xslx file.<\/p>\n

Excel File<\/strong><\/p>\n

You will export an .xslx file if your exported configuration does not contain images, or if you export the template.<\/p>\n

Zip File<\/strong><\/p>\n

You will export a .zip file if your exported configuration contains images. Your zip file will contain the .xslx configuration file as well as a folder containing the images. Images are organised by image group.<\/p>\n

\"\"<\/a><\/p>\n

\n

Exporting The Whole Configuration<\/h2>\n

Exporting the entire configuration is simple.<\/p>\n

    \n
  1. In IFS OI Server Management, click the Import\/Export \"\"\u00a0icon in the navigation bar.<\/li>\n
  2. Select the Export<\/strong>\u00a0\"\" option from the middle panel.<\/li>\n
  3. From the Export Options<\/strong>, choose\u00a0Select All<\/strong>.<\/li>\n
  4. Click the Export Server Data<\/strong>\u00a0button.<\/li>\n<\/ol>\n

    \"\"<\/a><\/p>\n

    The 'Save As<\/strong>' dialog box opens and you will be prompted to save the zip file to your computer.\u00a0<\/p>\n

    Important!<\/strong><\/span> You must keep the Export page open during the export process. The time taken for the export depends on the size of your database.\u00a0<\/p>\n

    During export, you can see its progress in the download status bar at the bottom of your screen.<\/p>\n

    \"\"<\/a><\/p>\n

    Note that in the .xslx file, the Global Id<\/strong> column has been filled in for all tabs, for existing entries only. This is the GUID that corresponds directly to the records\u00a0in the database, and is the field that allows the database to be updated by re-importing this spreadsheet.\u00a0A Global ID will be created automatically for any new entries.<\/p>\n

    \"\"<\/a><\/p>\n

     <\/p>\n

    \n

    Exporting Part of The Configuration<\/h2>\n

    You can export a spreadsheet that contains only selected objects. You should do this if you only need to update part of your configuration.\u00a0Your exported file will contain only the configuration tabs for the selected objects.<\/p>\n

    When updating your configuration, you should be aware that dependencies may exist for the configuration you wish to update. A dependency exists if the selected object requires information from another object. For example, if you want to only update links, a dependency exists between links and link groups. Be especially careful when updating attribute values and tags, as these objects have many dependencies.\u00a0<\/p>\n

    Read more: Understanding Object Dependencies<\/a><\/p>\n

      \n
    1. In IFS OI Server Management, click the Import\/Export icon in the navigation bar.<\/li>\n
    2. Select the Export<\/strong>\u00a0option from the middle panel.<\/li>\n
    3. De-select Select All<\/em>, and select Include Dependencies<\/strong>. Then select the objects you want to export.\u00a0As you select an object, other objects will also be selected if your selected object has a dependency.
      \nNote: You may elect to not include dependencies by using Select All and unselecting the objects you do not want to export. Use this with caution.\u00a0If you attempt to import a spreadsheet in which the dependencies are not resolved, the import of the relevant sheets may fail.<\/em><\/li>\n
    4. Click the Export Server Data<\/strong>\u00a0button.<\/li>\n<\/ol>\n

      \"\"<\/a><\/p>\n

      Save the file to your computer, and edit as required before importing.<\/p>\n

      Remember to ensure that the Global Id<\/strong> column is retained for all tabs, for existing entries only. This is the GUID that corresponds directly to the records\u00a0in the database, and is the field that allows the database to be updated by re-importing this spreadsheet. A Global ID will be created automatically for any new entries.<\/p>\n

       <\/p>\n

      \n

      Exporting Selected Hierarchies<\/h2>\n

      You can export a spreadsheet that contains only selected hierarchies, and their associated objects. You should do this if you only need to update some hierarchies in your configuration.<\/p>\n

      Your exported file will contain all of the configuration tabs, but only the configuration associated with the selected hierarchies will be exported.<\/p>\n

      When updating your configuration, you should be aware that dependencies may exist for the configuration you wish to update. A dependency exists if the selected object requires information from another object. Be especially careful when updating attribute values, as this object has many dependencies.\u00a0<\/p>\n

      Read more: Understanding Object Dependencies<\/a><\/p>\n

      1. In IFS OI Server Management, click the Import\/Export icon in the navigation bar.<\/p>\n

      2. Select the Export<\/strong>\u00a0option from the middle panel.<\/p>\n

      3. For the Export Mode<\/strong>, select Hierarchy.<\/em><\/p>\n

      4. From the Hierarchy<\/strong> drop-down list, select the check boxes for the hierarchies you want to export.<\/p>\n

      \"\"<\/a><\/p>\n

      5. If your hierarchy requires additional configuration that is not directly included in the hierarchy, you should select the datasources containing the additional configuration. For example, some of the calculations assigned to attribute values for entities in your hierarchy may reference tags from other datasources that would not normally be included in the export.<\/p>\n

      \"\"<\/a><\/p>\n

      6. If you want to export all images within a group, and not just those referenced in the hierarchy, you should select the image groups you want to include in the export.<\/p>\n

      \"\"<\/a><\/p>\n

      7. If your hierarchy contains calculations assigned to attribute values for entities, and those calculations contain additional calculations that are not included in the hierarchy, you will need to export all calculations in the system.<\/p>\n

      \"\"<\/a><\/p>\n

      8. When you have finished selecting your options, click the Export Server Data<\/strong>\u00a0button at the bottom of the page.<\/p>\n

      \"\"<\/a><\/p>\n

      Save the file to your computer, and edit as required before importing.<\/p>\n

      Remember to ensure that the Global Id<\/strong> column is retained for all tabs, for existing entries only. This is the GUID that corresponds directly to the records\u00a0in the database, and is the field that allows the database to be updated by re-importing this spreadsheet. A Global ID will be created automatically for any new entries. Object dependencies must also be maintained.<\/p>\n

       <\/p>\n

      \n

      Exporting a Template<\/h2>\n

      You can download a blank version of the spreadsheet that has\u00a0the same tabs and column headings, but does not contain any data. You should use this if you are importing configuration into a fresh database.<\/p>\n

      Read more:\u00a0Importing from Scratch<\/a><\/p>\n

        \n
      1. In IFS OI Server Management, click the Import\/Export icon in the navigation bar.<\/li>\n
      2. Select the Export<\/strong>\u00a0option from the middle panel, and choose Select All<\/strong>, or choose individual objects as required.<\/li>\n
      3. Click the Export Template<\/strong>\u00a0button.<\/li>\n<\/ol>\n

        \"\"<\/a><\/p>\n

        Save the file to your computer, and edit as required before importing.<\/p>\n

        Read more:\u00a0Tips on Filling in the Import Spreadsheet<\/a><\/p>\n

        \n

        Release History<\/h2>\n