IBM Rational System Architect Cognos Reports Quick Start Guide Release

Transcription

1 IBM Rational System Architect Cognos Reports Quick Start Guide Release

2 Before using this information, read the Notices section. This edition applies to IBM Rational System Architect, version and to all subsequent releases and modifications until otherwise indicated in new editions. Copyright IBM Corporation 1986, 2010 US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

3 Table of Contents Ready to use content for Rational System Architect Cognos integration... 1 Prerequisites for using the predefined reports... 2 Using the predefined packages and reports... 2 Configuring the encyclopedia property set... 2 Modifying the USRPROPS.TXT file... 3 Properties that require numeric values... 4 Generating an ODS database... 5 Populating the ODS database with retrieved data... 5 Using the predefined reports... 5 Download the sample reports... 6 Create a sign-on user... 7 Configure the data source... 7 Executing predefined reports... 8 Modifying and Creating Reports... 8 Notices Trademarks... 12

4 This page intentionally left blank. ii Rational System Architect and Rational System Architect XT Installation Guide

5 Ready to use content for Rational System Architect Cognos integration The IBM Rational System Architect Bridge delivered with SA enables you to use Rational System Architect SQL Server encyclopedias as data sources to author, generate, and manage IBM Cognos Business Intelligence reports. The integration leverages Rational System Architect's REST API and fits within Rational's overall reporting strategy. The IBM Rational System Architect Bridge provides a Schema Generator to create a schema for an Operational Data Source database that is used by the IBM Cognos Framework Manager to create packages for reports. It also provides an SA Data Retriever executable to populate the ODS database with encyclopedia data. You can run the SA Data Retriever from a command line or schedule it to run through the Windows Task Scheduler. While you can create packages and reports to fit your own requirements, a predefined package with reports is also available to accompany Rational System Architect The ready to use package and reports provided support for TOGAF9 theme. They work in English locale only and are only supported beginning with Rational System Architect IMPORTANT: This documentation is intended for an IBM Cognos Administrator with knowledge of and access to the IBM Cognos system. The scope of this document is limited to the tasks an Administration needs to execute to get, configure, and manage the data from Rational System Architect, in IBM Cognos.

6 IBM Rational System Architect Cognos Reports Quick Start Guide Prerequisites for using the predefined reports Refer the IBM Rational System Cognos Bridge online for information about the following: IBM Cognos Required Components Generating an ODS Schema from the encyclopedia Retrieving encyclopedia data from IBM Cognos Publishing Packages for Reports Configuring SAEM for SQL Server to access IBM Cognos Generating reports from Rational System Architect Using the predefined packages and reports A sample encyclopedia, with the property sets already configured to work with predefined packages and reports, is provided in the MyDeveloperWorks Wiki site, %20Enterprise%20Architecture%20Wiki?lang=en_US. The encyclopedia is provided as an MDF file and it is named 'J K Enterprises Cognos Version 1.0.mdf.' To use this encyclopedia, start SAEM for SQL Server, click 'Database Menu' and select 'Attach.' Browse to the folder where you saved the MDF file and attach it. If you choose to create a new encyclopedia to use with the reports, you must configure the property sets in that encyclopedia, and modify the USRPROPS.TXT file. Both of these tasks are described below. Configuring the encyclopedia property set If you use these predefined reports against any encyclopedia, note that the encyclopedia should be Workspace enabled; the sample encyclopedia provided along with the predefined reports is Workspace enabled by default. To set the encyclopedia property set proceed as follows: 1. From the Tools menu, select Customize Method Support, Encyclopedia Configuration. The System Architect Property Configuration dialog appears. 2. Toggle on the TOGAF. 3. Click Advanced. The Configure Property Set dialog is displayed. 2 IBM Rational System Architect Cognos Reports Quick Start Guide

7 Using the predefined packages and reports 4. In the Property Sets field (in the Available column), select the Activity Based Costing (ABC), all the TOGAF property sets, and click Add. The property sets you selected and added should now appear on the Property Sets field (in the Selected column). 5. Click OK, and OK to close the dialogs. A dialog informs you that changes to encyclopedia configuration will not take effect until you open the encyclopedia. 6. Click OK to close the information dialog. 7. Select File, Open Encyclopedia for the changes to take effect. Modifying the USRPROPS.TXT file To enable your encyclopedias to use the sample reports, you also need to modify the encyclopedia s USPROPS.TXT file, as follows: 1. In Rational System Architect, select Tools, Customize User Properties, Export USRPROPS.TXT ( Encyclopedia). 2. In the Export User Properties dialog, select a target folder and click Save. The file will be opened automatically from that location. 3. Add the following code to USPROPS.TXT: RENAME DEFINITION "User 1" TO "Energy Cost" DEFINITION "Energy Cost" { CHAPTER "Costs" PROPERTY "Electricity Cost (p per Wh) "{ EDIT NUMERIC LENGTH 10} } #ifdef "TOGAF 9" DEFINITION "Organization Unit" { CHAPTER "Costs" LAYOUT { ALIGN OVER TAB COLUMNS 3 } PROPERTY "Annual Salary"{ EDIT NUMERIC LENGTH 10 Label "Annual Salary($)"} PROPERTY "Annual Bonuses"{ EDIT NUMERIC LENGTH 10 Label "Annual Bonuses($)"} PROPERTY "Other Contributions"{ EDIT NUMERIC LENGTH 10 Label "Other Contributions($)"} } DEFINITION "Technology Component" { REM "Physical Technology Component" CHAPTER "Green Enterprise" IBM Rational System Architect Cognos Reports Quick Start Guide 3

8 IBM Rational System Architect Cognos Reports Quick Start Guide {TESTPROC TestPropertyValue TESTPROPERTY "Is Physical" TESTSTRING { "T" }} LAYOUT { ALIGN OVER TAB COLUMNS 3 } PROPERTY "For Powering (Wh)" {EDIT NUMERIC LENGTH 8} PROPERTY "For Cooling (Wh)" {EDIT NUMERIC LENGTH 8} PROPERTY "Value (Disposal Cost)" {EDIT NUMERIC LENGTH 8} PROPERTY "Energy Supplier Cost"{ EDIT OneOf "Energy Cost" LENGTH 81} } #ifdef "TOGAF 9 Extension: Data" DEFINITION "Data Component" { REM "Physical Data Component" CHAPTER "Costs" {TESTPROC TestPropertyValue TESTPROPERTY "Is Physical" TESTSTRING { "T" }} PROPERTY "Annual Maintenance Cost"{ EDIT NUMERIC LENGTH 10 Label "Annual Maintenance Cost($)"} } #endif #endif DEFINITION "Location" { CHAPTER "Costs" PROPERTY "Water Rates"{ EDIT NUMERIC LENGTH 10 Label "Water Rates($)"} PROPERTY "Electricity Rates"{ EDIT NUMERIC LENGTH 10 Label "Electricity Rates($)"} PROPERTY "Yearly Rental Cost"{ EDIT NUMERIC LENGTH 10 Label "Yearly Rental Cost($)"} PROPERTY "Purchase Cost"{ EDIT NUMERIC LENGTH 10 Label "Purchase Cost($)"} } DEFINITION "Project" { CHAPTER "Costs" PROPERTY "Approximate Cost"{ EDIT NUMERIC LENGTH 10} } 4. Save and close the USRPROPS.TXT file. 5. Import USRPROPS.TXT from the Tools menu, Customize User Properties, Import USRPROPS.TXT (Encyclopedia) command. 6. Reopen the encyclopedia (File, Open Encyclopedia) for the changes to take effect. 4 IBM Rational System Architect Cognos Reports Quick Start Guide

9 Using the predefined packages and reports Properties that require numeric values Because reports calculate sums, certain definition properties in the encyclopedias should contain numeric values for the reports to return useful information. The definitions and the properties shown below are defined in the encyclopedia metamodel (saprops.cfg): Definition Application PROPERTY "Perpetual License Cost" { EDIT Text LENGTH 10 } PROPERTY "Yearly Maintenance Cost" { EDIT Text LENGTH 10 } PROPERTY "Yearly Rental Cost" { EDIT Text LENGTH 10 } PROPERTY "Build Cost" { EDIT Text LENGTH 10 } Definition Process CHAPTER "Activity Based Costing (ABC)" PROPERTY "Total Cost"{ EDIT Text LENGTH 10 HELP} The properties are defined as Text type to hold Integer or Float values. For the reports, ensure these properties contain numeric values only in your encyclopedia. If any properties contain alphabetic characters, the reports will fail to work. Generating an ODS database The next step in the process is to generate an ODS database from the Sample encyclopedia provided using the Rational System Architect Cognos Bridge. Please consult the Rational System Architect Cognos Bridge online help for the steps to generate the ODS database. Populating the ODS database with retrieved data The next step in the process is to populate the ODS database with retrieved data. Please consult the Rational System Architect Cognos Bridge online help for the steps to populate the ODS database. Using the predefined reports To use the predefined reports requires three overall tasks, in which you download and import the sample reports into the Cognos Content Store, create a sign-on user, and configure the data source. Each of these tasks is detailed in the sections that follow. IBM Rational System Architect Cognos Reports Quick Start Guide 5

10 IBM Rational System Architect Cognos Reports Quick Start Guide Download the sample reports To download the sample reports, proceed as follows: 1. Go to MyDeveloperWorks Wiki site ( /Rational%20Enterprise%20Architecture%20Wiki?lang=en_US.) and download the TogafContentDeployment.zip file. 2. Extract the contents of the TogafContentDeployment.zip file to the deployment folder, in the Cognos installation folder (by default (C:\Program Files\cognos\c8\deployment). 3. Start your Internet Browser and go to 4. Click Administer IBM Cognos Content, and select Configuration, and Content Administration. 5. Click New Import on top right of the screen. 6. Select TogafContentDeployment.zip and proceed. Provide password TogafContent when prompted. 7. In the specify Name and Description page click next. 8. Select the public folder SaCognos Reporting Data Model (IBM Rational System Architect) and click next. 9. Make sure Include data sources and connections and Include signons options are checked. Leave all other options unchanged and proceed through the next two pages. 10. Review the Summary page, and click Next. 11. Choose the Save and Run Once option and click Finish. 12. If you have the package SaCognos Reporting Data Model (IBM Rational System Architect) due to an earlier import, select upgrade all report specifications to the latest version. 13. Refresh the screen to see the completed the import. 6 IBM Rational System Architect Cognos Reports Quick Start Guide

11 Using the predefined packages and reports Create a sign-on user To create a sign-on user, proceed as follows: 1. Create an SQL user named csuser, with following options: Do not Enforce Password policy. Provide Server roles Public and sysadmin. 2. Proceed to complete the creation of the sign-on user. Configure the data source To configure the data source proceed as follows: 1. Click Administer IBM Cognos Content, Configuration, and Data Source Connection. 2. Click SAODS and SAODS again. 3. On the ensuing page, select properties for SAODS, on the right. 4. Go to the Sign-on tab and Edit the Sign-on. 5. Enter the same password for the csuser user as you configured in SQL Server, and click OK to complete the change. Note: You can change the sign-on user name to something other than csuser, as long as you apply the change both in Cognos administration and in the SQL Server Management Studio. 6. Return to the Data Source Connections list. 7. Click SAODS, and on the next page select properties for SAODS on the right. 8. Select the Connection Tab, and edit the connection string. 9. Change the server name to the SQL server instance you are using. 10. Provide the database name as the ODS database you just created. Test the Connection (Keep the Sign-On as SAODS). 11. Click OK repeatedly until you complete the configuration. From the main Configuration page, click Launch, IBM Cognos Connection, on the top right. 12. Click SACognos Reporting Data Model (IBM Rational System Architect) and click the reports in the package to execute them. IBM Rational System Architect Cognos Reports Quick Start Guide 7

12 IBM Rational System Architect Cognos Reports Quick Start Guide Executing predefined reports 1. In most of the reports, you can select the Workspace name in a drop-down, and the full workspace path is displayed based on selection. 2. By default all workspaces are selected - the drop-down selection shows as WorkspaceName but the selection All Workspaces is printed below. 3. After selecting individual workspaces, if you want to select All Workspaces again, select WorkspaceNAme in the drop-down. 4. Clicking on some predefined reports (usually charts) will execute drill-down report in a new window. Note that drill-downs are executed on clicking a populated area of a chart and not a blank area. 5. When you execute reports after reconfiguring the Data Source, use a new browser window to browse and execute reports. This ensures that the cache is refreshed and the reports with new data(source) is displayed. Note: If you are creating more reports on your own (as described below), reports in PDF or HTML format are limited to show a maximum of 16 pie or gauge charts. To see more pie or gauge charts, run the report in Excel Single Sheet format. Modifying and Creating Reports Once you have completed the processes described above, you can create more reports using the Report Studio. In your reports, you can reference the predefined logical data types of Rational System Architect that are available in the Consolidated View. See the Rational System Architect Cognos Bridge online help for information on working with new reports. You can also reference existing reports for more information. Additionally, you can publish more logical data types from Rational System Architect by republishing the SaCognos Reporting Data Model (IBM Rational System Architect package. To do this, proceed as follows: 1. Get the Framework Manager package files that were used to create the package to which the reports refer. The package files are model.xml and SACognos.cpf that are available in the same location as the TogafContentDeployment.zip. 2. Copy these files to your local file system where IBM Cognos Framework Manager stores its projects, in a subfolder named SACognos. To indentify the location, start IBM Cognos Framework Manager and create a new project (the location will be similar to C:\Documents and Settings\Administrator\My Documents\My Projects\SACognos). 8 IBM Rational System Architect Cognos Reports Quick Start Guide

13 Using the predefined packages and reports Once you copy the files in the SACognos folder, you can see that the SACognos project can be opened by the IBM Cognos Framework Manager. 3. Modify the Physical Metadata and Consolidate View and republish the SACognos Reporting Data Model (IBM Rational System Architect package. See the Rational System Architect Cognos Bridge online help for information. While creating new queries in Report Studio, note that Query Data Items that refer to Binary Large Objects (BLOB/CLOB data types) in Framework manager may need to be cast to character types (where the data content of the Binary Large Objects is actually text and you wish to print it in the report). IBM Rational System Architect Cognos Reports Quick Start Guide 9

14 IBM Rational System Architect Cognos Reports Quick Start Guide Notices Copyright IBM Corporation 1986, This information was developed for products and services offered in the U.S.A. IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-ibm product, program, or service. IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send written license inquiries to: IBM Director of Licensing IBM Corporation North Castle Drive Armonk, NY For license inquiries regarding double-byte character set (DBCS) information, contact the IBM Intellectual Property Department in your country or send written inquiries to: IBM World Trade Asia Corporation Licensing 2-31 Roppongi 3-chome, Minato-ku Tokyo , Japan The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions. Therefore, this statement may not apply to you. This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the 10 IBM Rational System Architect Cognos Reports Quick Start Guide

15 Notices product(s) and/or the program(s) described in this publication at any time without notice. Any references in this information to non-ibm Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk. IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you. Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact: Intellectual Property Dept. for Rational Software IBM Corporation 1 Rogers Street Cambridge, MA U.S.A Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee. The licensed program described in this document and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement or any equivalent agreement between us. Any performance data contained herein was determined in a controlled environment. Therefore, the results obtained in other operating environments may vary significantly. Some measurements may have been made on development-level systems and there is no guarantee that these measurements will be the same on generally available systems. Furthermore, some measurements may have been estimated through extrapolation. Actual results may vary. Users of this document should verify the applicable data for their specific environment. Information concerning non-ibm products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-ibm products. Questions on the capabilities of non-ibm products should be addressed to the suppliers of those products. This information contains examples of data and reports used in daily business IBM Rational System Architect Cognos Reports Quick Start Guide 11

16 IBM Rational System Architect Cognos Reports Quick Start Guide Trademarks operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental. Copyright license This information contains sample application programs in source language, which illustrate programming techniques on various operating platforms. You may copy, modify, and distribute these sample programs in any form without payment to IBM, for the purposes of developing, using, marketing or distributing application programs conforming to the application programming interface for the operating platform for which the sample programs are written. These examples have not been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of these programs. Each copy or any portion of these sample programs or any derivative work, must include a copyright notice as follows: (your company name) (year). Portions of this code are derived from IBM Corp. Sample Programs. Copyright IBM Corp If you are viewing this information softcopy, the photographs and color illustrations may not appear. IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of International Business Machines Corp., registered in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on the Web at Copyright and trademark information at Microsoft and Windows are trademarks of Microsoft Corporation in the United States, other countries, or both. Other company, product or service names mentioned may be trademarks or service marks of others. 12 IBM Rational System Architect Cognos Reports Quick Start Guide