Migrate from Development or Test Environment to Production

To migrate the contexts, proceed as follows:

1. Prerequisite: Make sure your schemas are the same in the Development or Testing environment and in the Production environment.

2. Create a CAP that only includes the contexts you created or modified in the Development or Testing environments. For details, see Create a CAP with the ITBA application data

   Note You can migrate Contexts, trees, KPIs, Metrics, user-defined pages, or components using one CAP per type of item or one CAP for all the items you want to export/import/migrate.

   Note You can select to perform a recalculation during the CAP activation by specifying a recalculation date when you create the CAP.
   You can also perform the calculation after all the items are migrated. For details, see Calculation or Recalculation.

3. Export the CAP you created. For details, see Download a CAP to the user's local system.
4. Copy the CAP you downloaded from the Development or Testing environment to the Production environment or from the user's local system to the system where you want to import the item.
5. Upload the CAP to the Production environment. For details, see Upload a CAP to the Business Analytics application.

6. Activate the CAP in ADMIN > Data Management > Activate CAP. For details, see Activate a CAP.

7. Verify the upload by accessing the contexts in Admin > Semantic Layer. For details, see Semantic Layer - Context Designer

To migrate data imported into ITBA using .CSV files, proceed as follows:

1. Create a CAP that only includes the contexts used to import the .CSV files you created or modified in the Development or Testing environments. For details, see Create a CAP with the ITBA application data

   Note You can migrate Contexts, trees, KPIs, Metrics, user-defined pages, or components using one CAP per type of item or one CAP for all the items you want to export/import/migrate.

   Note You can select to perform a recalculation during the CAP activation by specifying a recalculation date when you create the CAP.
   You can also perform the calculation after all the items are migrated. For details, see Calculation or Recalculation.

2. Export the CAP you created. For details, see Download a CAP to the user's local system.
3. Copy the CAP you downloaded from the Development or Testing environment to the Production environment or from the user's local system to the system where you want to import the item.
4. Upload the CAP to the Production environment. For details, see Upload a CAP to the Business Analytics application.

5. Activate the CAP in ADMIN > Data Management > Activate CAP. For details, see Activate a CAP.

6. Verify the upload by accessing the contexts in Admin > Semantic Layer. For details, see View existing Contexts (universes)
7. Reimport the data by accessing the relevant context in Admin > Semantic Layer. For details, see Semantic Layer - Context Management.
8. Perform the calculation for the relevant contexts in the Studio. For details, see Calculation .

You use the export or import feature when you want to import or export out-of-the-box templates, automatically update existing templates, or import new templates, or active trees into the Studio.

The export and import feature is the process used to move from staging environment to production.

The export feature collects the contents of the Active KPIs tree (Scorecards, Perspectives, Objectives, KPIs, Metrics, and Unassigned KPIs). It converts the contents to a configuration.xml file that describes the structure of the active tree or to a <Scorecard_name>.xml file for each Scorecard. These files include the UUID, KPI name of the KPIs, and Metrics name of the Metrics included in the trees. In addition, the process creates a <kpi_or_metric_name>.xml file per KPI or Metric in the system; that file describes the configuration of the KPI or Metric. The XML files are created in a specific directory on the machine.

The import feature collects the content of a specific directory on the machine. The directory can include configuration.xml files, and <kpi_or_metric_name>.xml files according to the same format used by the export feature or can include .xml files with other names. The import feature uses these files to upload the information in the specific area in the Active KPIs tree.

The export and import operations work with XML files with a specific structure. Each configuration.xml file includes information about the hierarchy from the lowest node to the tree root. That information is used to add the new node is added to the relevant location in the relevant tree, or the imported node overrides the relevant node. Each <KPI_or_Metric_name>.xml file includes information about the KPI or Metric configuration. That information is used so that the relevant configuration and calculation details are added to the relevant KPI or Metric.

The export operation uses the KPI or Metric UUID to identify the KPI or the Metric.

In addition, you can import KPIs from Excel files. You can use this capability to import KPIs without consideration about their location in the tree. You can also create an .xml file that provides information about a tree structure and that refers to KPIs that are imported from the Excel file. The import feature uses these files to upload the information in the specific area in the Active KPIs tree.

 When the server on which the Studio is located starts, if the system detects files in the
$HPBA_Home/glassfish/glassfish/domains/BTOA/config/kpitemplates/import directory, it automatically uploads that information. This feature is used when you log on to the Studio for the first time, to upload the out-of-the-box templates.

Export complete trees (with their Scorecards, Perspectives, Objectives, and KPIs), Metrics, or Unassigned KPIs from the Active KPIs pane of the Development/Test environment. For details, see Export nodes using CAPs.

Import these template trees or sub-trees, active trees, active sub-trees, Metrics or Unassigned KPIs into the Active KPIs pane of the Production environment. For details, see Import nodes using CAPs.

To export nodes and hierarchical structure (trees and their Scorecards, Perspectives, Objectives, and KPIs, Unassigned KPIs or Metrics), proceed as follows:

1. Create a CAP that only includes the items you want to export. For details, see Create a CAP with the ITBA application data

   Note You can migrate Contexts, trees, KPIs, Metrics, user-defined pages, or components using one CAP per type of item or one CAP for all the items you want to export/import/migrate.

   Note You can select to perform a recalculation during the CAP activation by specifying a recalculation date when you create the CAP.
   You can also perform the calculation after all the items are migrated. For details, see Calculation or Recalculation.

2. Export the CAP you created to the user local system. For details, see Download a CAP to the user's local system.

   You can now copy the CAP to the another server (for example to the Production server) and then import it into the application. For details, see Import nodes using CAPs.

To import nodes, proceed as follows:

1. Copy the relevant CAP from the Development or Testing environment to the Production server or from the user's local system to the system where you want to import the item.

2. Upload the CAP to the application. For details, see Upload a CAP to the Business Analytics application.

3. Activate the CAP in Admin > Semantic Layer. For details, see Activate a CAP.

4. Verify the upload by accessing Studio and checking that all the items you wanted to import appear in the Active KPIs.

Pages are available or created in the Dashboard. Pages can include components. Components in a page can be wired and can interact with each other using events. For details, about the Dashboard, see Dashboard Display .

The export operation collects the contents of user-defined pages and components. It converts the contents to components.uim.xml and pages.uim.xml files that describes the structure and content of the pages and components . These files include the universally unique identifier (UUID) of the pages and components.

The export operation uses the page and component UUID to identify the page or component .

The import operation collects the contents of a specific directory on the machine. The directory can include components.uim.xml and pages.uim.xml files according to the same format used by the export feature. The import feature uses these files to upload the information into the database. After the import operation, the file is moved to the Loaded directory if the import operation succeeds, or to the Errors directory if the import operation fails.

1. Export user-defined pages and components from the Dashboard page of the Development/Test environment. For details, see About importing or exporting user-defined Pages and Components.
2. Import these user-defined pages and components into the Dashboard page of the Production environment. For details, see Import user-defined pages and components and events using CAPs.

To import user-defined pages and components , proceed as follows:

1. Copy the relevant CAP from the Development or Test environment to the Production environment or from the user local system to the server where you want to import the items.

2. Upload the CAP to the application. For details, see Upload a CAP to the Business Analytics application.

3. Activate the CAP in Admin > Semantic Layer. For details, see Activate a CAP.

4. Verify the upload by accessing the Dashboard and checking that all the user-defined pages and components that you wanted to import appear in the Dashboard.

When you change the definition of a KPI (formula or threshold), the change impacts the KPI's value and impacts the Objectives related to the KPI. You may want to perform the calculation for each KPI in the selected business context for the period specified in the KPI configuration, so the impact of the change is felt immediately in the results displayed in the Dashboard.

To calculate the current data:

1. In the Active KPIs pane, click the Calculation options button in the Active KPIs toolbar, and select the   option.

2. In the Calculate Now dialog box that opens:

   • In Universe/context for recalculation, select the relevant context (data source) you want to use for the recalculation.

   • Select the I understand the implications of this process and would like to proceed with the calculation option to proceed with the calculation.

   Limitations: You perform the calculation for the current period of each KPI within the selected business context.

3. Click Calculate.

The calculation is performed for all KPIs and Objectives with the selected context (universe).

For details, see Calculation.