Skip to main content
Pentaho Documentation

Verify BA System Migration

Overview

Provides the steps to verify the migration.

After you have imported the data into the 5.x.x system, verify that migration and the other parts of the migration process occurred properly. Perform these tasks.

Start 4.8.x Version of the Server

Start the 4.8.x version of the server. Wait for the server to start up completely before proceeding to the next task.

Start 5.x.x Version of the Server

Start the 5.x.x version of the server. As the server starts, watch the web application server log carefully and note any errors that might have occured. Resolve any port conflict issues as necessary.

Verification Checklists

Verification largely consists of using the checklists to compare the differences between the 5.x.x and 4.8.x systems. To make this task easier, it is recommended that you view both systems simultaneously so that you can accurately identify differences.

Overall System

Ensure that the 5.x.x version of the BA Server is working properly by using the following checklist.

  • Did the BA Server start properly? Were you able to log in as admin without issues or problems?
  • Did the web application server log have any errors or anomalies?
  • Are you able to log into the Pentaho User Console as admin?
  • If you have configured the BA Server as a service, is it starting and stopping properly?
  • Manually stop and restart the BA Server. Did it stop and restart properly?

Users and Roles

To verify that user and role data have been migrated properly, do these things.

  1. Log into the User Console as admin.
  2. Select Home then Administration, then click Users and Roles to view the Users/Roles page.
  3. Verify the items in the checklist.
    Table 1. User and Roles Verification Checklist
    Verification Item Suggested Verification Approach

    Expected Result/Notes

    Do the active user accounts in the 4.8.x system appear in the 5.x.x system? Compare the names of users in the 4.8.x and 5.x.x systems. The active user accounts from the 4.8.x version of the system should appear in the 5.x.x system. Inactive accounts are not migrated.
    Do the roles in the 4.8.x system appear in the 5.x.x system? Compare the roles in the 4.8.x and 5.x.x systems.
    • 5.x.x System: Review the Manage Users and Manage Roles tab in the User/Roles page in the User Console.
    • 4.8.x System: Review the User & Roles tab in the Administration page in PEC.
    The roles from the 4.8.x version of the system should appear in the 5.x.x system. If some roles are missing, you might need to manually recreate them.
    Was the mapping of user to roles that exist in the 4.8.x system appear in the 5.x.x system? Compare how user accounts map to the roles in the 4.8.x and 5.x.x systems.
    • 5.x.x System: Review the Manage Users tab in the User/Roles page in the User Console.
    • 4.8.x System: Review the User & Roles tab in the Administration page in PEC.
    User accounts mappings to roles in the 4.8.x version of the system should appear in the 5.x.x system. When you click the Manage Roles tab in User Console, in the 5.x.x system, note that the Operation Permissions for roles did not migrate. You will need to change these manually to match the 4.8.x system.
    Did the user passwords in the 4.8.x system migrate properly?
    • 5.x.x System: Log out of the 5.x.x system, then log in again using a different user account and supply the password. You might need to ask users to help with the testing of this item.
    User passwords should match. If some passwords did not migrate properly, reset them.
    Has a home directory been created for each user? If the Home folder does not exist, the Home folder should be created when the user logs in for the first time. If this happens, you might want to test that this occurs.

Data Sources, Solution Content, Generated Content, and Schedules

To verify that solution content, generated content, and schedules were migrated properly, do these things.
  1. Log into the User Console as admin.
  2. Click the Browse Files button to view the Browse Files page.
  3. Verify the items in the checklist.
    Table 2. Solution Content, Generated Content, and Schedules Verification Checklist
    Verification Item How to Check

    Expected Result/Notes

    For each user, do the report folders, subfolders, and files that were in the 4.8.x system, appear in the 5.x.x one? Are the same files in the same folders?
    • 5.x.x System: Review the Browse Files page and review the files and folders for each user.
    • 4.8.x System: Browse the files in the 4.8.x system..
    Note that the structure of the report folders, subfolders, and files have changed. Generated content now appears in each user's home directory.
    Did the file permissions from the 4.8.x version of the system migrate correctly to the 5.x.x system?

    Make sure role permissions are set before performing this step. The permissions settings for version 5.x.x of the system differ from 4.8.x. Version 4.8.x of the system included these permissions: Execute, Subscribe, Create, Update, Delete, and Permissions. Version 5.x.x of the system includes these permissions: All, Read, Write, Manage Access Control (ACL) Management. Mappings between 4.8.x and 5.x.x are:

    • In version 5.x.x, the All permission is assigned to folders that were assigned Execute, Subscribe, Create, Update, Permissions, AND Delete accesses in version 4.8.x of the system.
    • In version 5.x.x, the Read permission is assigned to folders that were assigned Execute and/or Subscribe permissions in version 4.8.x of the system.
    • In version 5.x.x, the Write permission is assigned to folders that were assigned Create, Update, and/or Delete permissions in version 4.8.x of the system.
    • In version 5.x.x, the Manage Access Control (ACL) Management permission is assigned to folders that, in version 4.8.x of the system, Permission access.
    Did the folder permissions from the 4.8.x version of the system migrate correctly to the 5.x.x system?
    • 5.x.x system: Review the permissions in the Share tab of the Properties page.
    • 4.8.x System: Review the permissions in the Share tab of the Properties page.

    Make sure role permissions are set before performing this step. The permissions settings for version 5.x.x of the system differ from 4.8.x. Version 4.8.x of the system included these permissions: Execute, Subscribe, Create, Update, Delete, and Permissions. Version 5.x.x of the system includes these permissions: All, Read, Write, Manage Access Control (ACL) Management. Mappings between 4.8.x and 5.x.x are:

    • In version 5.x.x, the All permission is assigned to folders that were assigned Execute, Subscribe, Create, Update, Permissions, AND Delete accesses in version 4.8.x of the system.
    • In version 5.x.x, the Read permission is assigned to folders that were assigned Execute and/or Subscribe permissions in version 4.8.x of the system.
    • In version 5.x.x, the Write permission is assigned to folders that were assigned Create, Update, and/or Delete permissions in version 4.8.x of the system.
    • In version 5.x.x, the Manage Access Control (ACL) Management permission is assigned to folders that, in version 4.8.x of the system, had Permission access.
    Do users and roles have access to files and reports that they should not have access to? Make sure that you check the permissions for both Mondrian and metadata model-based reports.
    • 5.x.x System: Create test user accounts for each role in your system. Log into the User Console using the test user accounts and attempt to access files that users assigned that role should or should not have access to. Record results and adjust permissions (role or report) as necessary. Compare with the roles on the 4.8.x system.
    Ensure that users and roles do not have access to restricted files.
    Did the schedules for the reports that were in the 4.8.x system migrate properly? See expected results/notes for public vs. private schedule changes. There are no longer public and private schedules. Instead, there are only one set of schedules. You can assign parameters to a schedule. If there is one public schedule that had many subscribers, each subscriber's private schedule is now converted to a schedule. So, if in the 4.8.x system you had a public schedule that had four subscribers, four schedules will appear in the 5.x.x system. If your schedule runs using a cron job, you might want to edit it so that it is in a more easily readable format. Schedules should be paused on the 5.x.x system. If a public schedule had no subscribers in the 4.8.x system, it is not migrated.
    Did the generated content (e.g. the PDFs of previous report runs) on the 4.8.x system migrate correctly?
    • 5.x.x System: These folders appear in each users home directory and might need to be tested by the users themselves.
    If a user was deleted or is inactive, the generated content is not migrated to the 5.x.x system.
    Are the data sources that were in the 4.8.x system migrate properly to the 5.x.x system? If this information did not migrate properly, it might be necessary to manually add the data sources.
    Did the JDBC database connections for the 4.8.x system migrate properly to the 5.x.x system? Is the connection information for each correct?
    • 5.x.x System: Edit a data source from the Data Sources page, then click General in the Database Connection page. Click the Test button in that page to ensure that the connection is still valid.
    • 4.8.x System: Review the Manage Data Sources page in the User Console.
    If this information did not migrate properly, it might be necessary to manually edit them.
    Are the advanced settings configured properly for each database connection?
    • 5.x.x System: Edit a data source from the Data Sources page, then click the different tabs in the page.
    • 4.8.x System: Review the Manage Data Sources page in the User Console.
    If this information did not migrate properly, it might be necessary to manually edit them.
    Open and inspect interactive reports. Ensure that they are displaying properly.
    • 5.x.x System: Retrieve reports from Browse Files page in the User Console.
    • 4.8.x System: Retrieve reports from the Browse page in the User Console.
    If a report does not display properly, and the SQL command contains several joins, ensure the join order has been specified for that report. See the Troubleshooting in the Work with Relational Data Models section for details.
    Open and inspect dashboard reports. Verify that each part of the dashboard displays properly.
    • 5.x.x System: Retrieve reports from Browse Files page in the User Console.
    • 4.8.x System: Retrieve reports from the Browse page in the User Console.
    If a report does not display properly, and the SQL command contains several joins, ensure the join order has been specified for that report. See the Troubleshooting in the Work with Relational Data Models section for details.
    Ensure that drill linking (connections between reports) is working properly.
    • 5.x.x System: Retrieve reports from Browse Files page in the User Console.
    • 4.8.x System: Retrieve reports from the Browse page in the User Console.
     

System Configuration Settings

To ensure that system configuration settings have migrated properly, use the following checklist.

Table 3. System Configuration Settings Verification Checklist
Verification Item How to Check

Expected Result/Notes

Verify that the server base URL, fully qualified server URL, and the locale language in the 5.x.x server match what they were in the 4.8.x server.
  • 5.x.x System: Use a text editor to open the web.xml file.
  • 4.8.x System: In PEC, click the Web Settings tab in the Configuration page.
If you have customized the 4.8.x system with servlets, filters, context parameters or in other ways, you will need to copy these things into the 5.x.x web.xml file.
Build a 5.x.x analyzer report and verify that the custom chart properties appear. Custom chart properties should appear.
Verify that the email server settings in the 5.x.x system match the settings in the 4.8.x one. The email server settings should match.
Verify that custom LDAP settings in the 5.x.x server match those for the 4.8.x server. The LDAP settings should match.
Verify that the custom log4j configuration settings in the 4.8.x system match those in the 4.8.x one. Use a file difference tool to compate the files in the 4.8.x and 5.x.x systems. The log4j settings should match.
Review the settings.xml files in each plugin on the 5.x.x server and compare to the 4.8.x one. Use a file difference tool to compare the files in the 4.8.x and 5.x.x systems. Review the differences between the two files. If customized changes were made, they should have migrated properly. If not, you will need to manually migrate them.
Compare the settings in these files: applicationContext-security-ldap.properties, pentaho.xml, mondrian.properties, settings.xml for various plugins, analyzer.properties, email_config.xml. Also the following tomcat files: web.xml, context.xml, classic-engine.properties, logging.properties, log4j.xml Use a file difference tool to compare the files in the 4.8.x and 5.x.x systems. Review the differences between the two files. If customized changes were made, they should have migrated properly. If not, you will need to manually migrate them. If you update the context.xml file, you will need to delete the pentaho.xml that is in the tomcat\conf\Catalina directory before you start the BA Server again for the changes to take effect.

Users Settings

To verify that user settings were migrated properly, complete these steps.

  1. Have each user log into the User Console.
  2. Have each user verify the items in the checklist.
    Table 4. User Settings Verification Checklist
    Verification Item How to Check

    Expected Result/Notes

    Verify that your recent files list on the 5.x.x system matches what was in the 4.8.x one. If this did not migrate properly, you will need to add this manually.
    Verify that your favorites list on the 5.x.x system matches what was in the 4.8.x one.
    • 5.x.x System: Log into the User Console, then view File > Favorites
    • 4.8.x System: Log into Mobile, then view the favorites.
    In pre-5.x.x this appears in Mobile only. If this did not migrate properly, the user will need to add this manually.
    Verify that your “show descriptions for tooltips” setting on the 5.x.x system matches what was in the 4.8.x one.
    • 5.x.x System: Log into the User Console, then view View > Use Descriptions for Tooltips
    • 4.8.x System: Log into Mobile, then view the tooltip description setting.
    If this did not migrate properly, you will need to add this manually.