Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Transfer

Image Added

Overview

  • eMite Transfer is an application to copy/transfer pages from one system to another with a simple user interface.
  • eMite Transfer is available and compatible with eMite version 6.0.2 and above.

...

  • The transfer happens over three modules.

      ...

        • Reports/Pages

      ...

        • Transfer.

      ...

        • RTBI Transfer (Includes

      ...

        • Factqueries

      ...

        • and

      ...

        • underlying

      ...

        • schema).

      ...

        • KPI Transfer (Includes

      ...

        • TransactionKPIs,

      ...

        • TransactionKPIGroups,

      ...

        • TransactionKPITemplates,

      ...

        • TransactionKPIRanges,

      ...

        • TransactionKPITemplateSets,

      ...

        • TransactionKPISets,

      ...

        • TransactionKPIVariables,

      ...

        • TransactionKPITemplateVariables).

      ...

      ...

      • eMite Transfer is available on the dashboard UI only for the

      ...

      • admin users.

      ...

      • eMite Transfer tool can only work if there is at least one page available for the admin to transfer RTBI  (this helps in initializing the configurations).
        The export basically copies pages and its entire hierarchy including RTBI schema and KPIs schema.
                        E.g: The system has 3 fact queries (cubes) and KPIs and if the selected export page has only one fact query, transfer tool only transfers just one fact query and its hierarchy of RTBI schema and KPIs.
      • Extremely bulky import cannot be handled at the moment (example: 109 pages). Once the pages are exported via the dashboard, on the Import screen few pages can be selected at a time to complete the import properly.
      • The transfer process starts by performing Export which gives the

      ...

      • transfer pack JSON file bundling the pages,

      ...

      • fast queries, and KPIs

      ...

      • .
      • The exported file can then be downloaded/saved onto

      ...

      • the desired location.

      ...

      • The second part of the transfer is Import, which allows the user to browse to the exported file and perform Import.
      • The Import basically adds missing schema in the new system or simply updates the existing schema.

      Export 

      This feature allows you to export selected pages including its hierarchy of RTBI and KPI schema. 

      Image Added


      1. Select the pages from the left pane and click on the right arrow button to transfer pages to the selection panel which is on the right.
      2. Page Groups can also be selected for Export instead of individual pages, and by doing so all the pages belongs to that group will be transferred to the right panel. Example below.
      3. The pages selection can be altered by using left and right arrows in the middle.
      4. Once the pages are selected, Click on 'Export' button
      5. The exported JSON file will be downloaded in the user's default “Download folder” of user’s computer.

      Import

      The TransferPack.json file exported from one system can be imported into another system by browsing to the TransferPack.json file and uploading in the Import section of the Transfer.

      1. Click on 'Select Files' icon to browse the TransferPack.json file 
      2. Click on 'Import Options' tab for more options. 
      3. Click on 'Import' button to start the Import process.
      4. A confirmation message 'Done' will be displayed if the transfer is successful

      Image Added

      Import Options

      This section provides the following options:

      Import All Modules - Transfers all pages, fact queries, and KPI 

      Import Pages Only - Only transfers pages. By expanding 'Pages' on the right hand, you should be able to select all or a few pages. 

      Import Fact Queries Only - Only transfers fact queries. By expanding 'FactQueries' on the right hand, you should be able to select all or a few fact queries. 

      Import KPIs Only Only transfers KPIs. By expanding 'KPIs' on the right hand, you should be able to select all or a few KPIs. 

      'Allow Update' will give you an option to update or not update existing schema if the pages/fact queries/KPIs already exist with the same name.

      Image Added

      NOTE: 

      If the "Allow Update" checkbox is not checked, then fact query is only inserted if it does not exist, but no updates are made to the fact queries or its dependent tables.

      If the "Allow Update" checkbox is checked;

      • The fact query will be inserted if fact query does not exist in the destination system.
      • The fact query will be updated if fact query exists in the destination system. All its dependent tables also will be updated/ new record added whichever is relevant.


      Project Requirements

           1.	Use Transfer Tool during the time when the system is not too busy as it might impact the speed.
           2.	In order to use transaction support to rollback the transfer in event of errors, transactionscope can be used. This feature can be enabled by selecting "Allow MSDTC" on the Import screen and needs enabling MSDTC on user's machine.
           3. MSDTC must be enabled on both the App box, DB box and web box.
           4. Steps to enable MSDTC can be found in below link
              [https://wiki.emite.com/wiki/Enable_MSDTC]
                
      

      Limitations

      • This tool can be used to import only few pages at one time [Beta version]
      • MSDTC helps use transaction control over the import as import involves three different modules (Pages, Factqueries and KPIs). So, if any exception occurs, having transaction control would help rollback to normal state. If transaction control is not used, then it would lead to inconsistent import.
      • MSDTC must be enabled in both Web box, App box and database box.
      • Any error messages can be found in the logs instead of UI [Beta version]. Logs for Transfer tool are found in the location [Emite Installation folder]\logs\Dashboard\EmiteTransfer

      ...

      eMite Transfer is a new feature added in the Manage menu of the Dashboard with the caption “Transfer”. By clicking this menu, it opens up a new screen with two tabs, one for Export and another for Import. 

      Export

      Export feature allows exporting selected pages including its hierarchy of RTBI and KPI schema. The export feature works like below.

      • Select the pages from left pane and click on right arrow button to transfer pages to the selection panel which is the right pane.
      • Page Groups can also be selected for Export instead of individual pages, and by doing so all the pages belonging to that group would be transferred in the right panel. Example below.
      • The pages selection can be altered by using left and right arrows in the middle.
      • Once the pages are selected, Export button is clicked to perform the Export.
      • The exported schema then appears in the file which is downloaded for the user by default in the “Download folder” of user’s computer.

      Import

      • The TransferPack.json file exported from one system can be imported into another system by browsing to the TransferPack.json file and uploading in the Import section of the Transfer.
      • Browse to the TransferPack.json file and click on upload to start the Import process.

      As can be seen above, the transferpack from file shows on UI in a tree structure. The tree consists of user choices among selecting all modules for import or selecting just individual modules as "Pages only"/"FactQueries only"/"KPIs only". On the other hand,it shows pages, factqueries and kpis with option to select "Allow Update" on each module level i.e., to select all pages or all factqueries or all kpis or individual factquery/kpi can be used for "Allow Update" option.

      Allow Update Feature 'Allow Update' checkbox as shown above,if checked is used to make decision to allow update to the factquery and its children tables.

      • If this checkbox is not checked(which is the default behaviour), then in this case
      • If the fact query does not exist, then it is inserted into the destination system.
      • But if the Fact query exists, then the fact query is not updated and also no new additional dependent children are added or updated.
      • In conclusion, If the "Allow Update" checkbox is not checked, then fact query is only inserted if does not exist, but no updates are made to the fact queries or its dependent children.

      If the "Allow Update" checkbox is checked, then two scenarios can occur

      • If fact query does not exist in the destination system, then it is inserted.
      • If fact query exists in the destination system, then the fact query is updated and all its dependent children have any new addition or updates which ever is relevant.

      ...


      Logs

      • If there is any exception on the Import process, the import will stop with a red colored warning. More details about the errors can be found in the installation log. eMite Transfer logs can be found in: [EmiteInstallationDirectory]\eMite\[EmiteVersion]\logs\Dashboard\EmiteTransfer.txt