Identifying Impacted Documents
Purpose
This tutorial covers how to identify documents in Workspace that are affected by database changes.
Time to Complete
20 minutes
Topics
This tutorial covers the following topics:
 | Overview |
| Scenario |
| Prerequisites |
| Synchronizing Metadata |
| Creating Connections to the Content Repository |
| Configuring Impact of Change Reports |
| Processing Impact of Change Reports |
| Summary |
| Related information |
Viewing Screenshots
Click icon to show all screenshots
Note: Alternatively, you can click an individual icon (or image) associated with each step to view (or hide) the screenshot associated with that step.
Overview
This tutorial covers how to configure Impact of Change.bqy in Workspace. You can use the Impact of Change reports to learn how database changes are going to impact the Interactive Reporting documents. When you open Impact of Change.bqy, you are presented with a dashboard that lists all database tables and columns and document topics and items that are present in Interactive Reporting documents in Workspace. From there, you can set filters to identify documents that contain specific items. For example, if a database table is changing, you can use Impact of Change.bqy to search for all Interactive Reporting documents that contain that table. This helps you to identify the content that needs to be updated after the database table changes.
There are a few steps that you must complete before opening Impact of Change.bqy. You first need to create an Open Catalog Extension file (OCE) in Interactive Reporting Studio that connects to the content repository. The content repository contains all harvested information about Interactive Reporting documents in Workspace. Next, you need to configure Impact of Change.bqy in Workspace to use that OCE. An administrator must also configure Interactive Reporting Data Access Service to access the content repository. After these tasks are completed, you can open Impact of Change.bqy, and process the dashboards.
Scenario
You want to configure the Impact of Change.bqy document in your Reporting and Analysis system so that you can be aware of how database changes will impact Interactive Reporting content in Workspace.
Prerequisites
Before starting this tutorial, you should:
| 1. | Complete the first four OBEs in this series. |
| 2. | Ensure that Interactive Reporting Studio is installed on your computer. |
| 3. | Ensure that you have access to the Bookmart sample data in Oracle. To connect to this data source, use the Bookmart Sample Database.oce and provide the user name trnadmin and the password oracle. |
| 4. | In Configuration and Management Console (CMC), configure Interactive Reporting Data Access Service to access the content repository in Oracle. |
Synchronizing Metadata
In this topic you synchronize metadata. This operation enables you to harvest new documents that have not yet been harvested or that have changed since the documents were last harvested. Documents in Workspace that were opened, modified, and resaved are also harvested. You can harvest immediately or by schedule (date and time).
To synchronize metadata:
| 1. | In Workspace, select Navigate > Impact Manager > Synchronize Metadata.
|
| 2. | Under Synchronize Options, select a scheduling option, and click Submit. In this example, "Run now" is selected so that the synchronization runs immediately. If you select Schedule, you also need to select a date and time.
|
| 3. | Click OK.
|
Creating Connections to the Content Repository
The Impact of Change reports must process against the Reporting and Analysis content repository, where the harvested metadata is stored. Processing is achieved through a connection file known as an Open Catalog Extension (OCE). You create OCEs in Interactive Reporting Studio.
Before creating an OCE that connects to the content repository, gather the necessary information: connection software, database software, host name, user name and password, and so on. You are prompted through a wizard to provide connection information when you create the OCE. Make sure that you have the appropriate connection software installed on the same computer as Interactive Reporting Studio.
For this example, the content repository resides in Oracle. You want to use native connectivity; therefore, you must install Oracle Net on the client computer. After you create the OCE, you need to import it into Workspace. Later, you associate the OCE with the Impact of Change document, which is available in Workspace.
To create an OCE that connects to the Reporting and Analysis content repository and then import the OCE into Workspace, perform the following steps:
| 1. | Start Interactive Reporting Studio. The Welcome dialog box is displayed.
|
| 2. | Select A New Database Connection File, and click OK.
The Database Connection Wizard is displayed.
|
| 3. | Select Oracle Net for the connection software, select Oracle for the database software, and click Next.
|
| 4. | Enter the connection information, and click Next.
Note: In this example, the SID for the Oracle database is ORCL.
|
| 5. | Click Finish.
The Interactive Reporting Studio dialog box is displayed asking if you want to save the OCE.
|
| 6. | Click Yes.
The Save Open Catalog dialog box is displayed.
|
| 7. | Enter a file name for the OCE, and click Save.
In this example, the OCE is named Content Repository.oce.
|
| 8. | Exit Interactive Reporting Studio, and do not save anything. |
| 9. | Log on to Workspace as the Reporting and Analysis administrator.
|
| 10. | Access the Explore module.
|
| 11. | Right-click the folder to which you want to save the OCE, and select Import > File.
The Choose File page is displayed.
|
| 12. | Select the content repository OCE, and click Next. Note: Click the Browse button to search for the OCE.
The OCE Properties page is displayed.
|
| 13. | Under Processing Interactive Reporting Database Connection Options, select a method for obtaining user credentials (for example, Use the User Name & Password specified below), enter a user name and password if necessary, click Next twice, and click Finish.
The OCE is imported into Workspace. |
Configuring Impact of Change Reports
Each Impact of Change report is linked to a data model. The data models must connect to the content repository. Therefore, you need to modify the properties of Impact of Change.bqy and associate the content repository OCE with each data model section. This enables the reports to process successfully.
To configure the Impact of Change reports, perform the following steps:
| 1. | In the Explore module in Workspace, select View > Show Hidden so that you can see the Administration folder.
|
| 2. | In the View pane, browse to and select the Impact Manager folder. The Impact of Change document is listed in the content area.
|
| 3. | In the content area, right-click the Impact of Change document, and select Properties. General properties are displayed.
|
| 4. | On the left, click Interactive Reporting.
|
| 5. | Under Connecting to Data Sources, select the content repository OCE (in this example, Content Repository.oce) and Defaults for each data model section, and click OK.
Note: Scroll down to configure all five data model sections. |
Processing Impact of Change Reports
Now that you configured the Impact of Change reports to process against the content repository, you are ready to open Impact of Change.bqy and manipulate the reports. Suppose there are proposed changes for the TRNADMIN.STORES table in the database, and you want to view a list of all Interactive Reporting documents that would be affected by this change. By processing the Impact of Change reports, you can query for this information.
To process Impact of Change reports, perform the following steps:
| 1. | In the content area in Workspace, double-click the Impact of Change item. Impact of Change.bqy is opened. Information about Interactive Reporting documents in Workspace is listed on the dashboard.
Impact of Change.bqy automatically queries the harvested information in the content repository and presents it to you upon opening.
|
| 2. | Under Rdbms Table Name, select STORES, and then click the process button on the toolbar.
|
| 3. | View the list of impacted documents and queries.
|
| 4. | Optional: Click other dashboard tabs to view additional information about the TRNADMIN.STORES table.
|
| 5. | To return to the original dashboard frame, click the Query Panel button on the toolbar.
|
| 6. | Close Impact of Change.bqy, and do not save changes. |
Summary
In this tutorial, you learned how to perform these tasks:
| Synchronize metadata |
| Create Interactive Reporting connections to the content repository |
| Configure Impact of Change reports |
| Process Impact of Change reports |
Related Information
To learn more about Impact Manager, you can refer to other OBEs in this series on the OTN Web site:
Printer View