Table of Contents
Total Page:16
File Type:pdf, Size:1020Kb
SAP BusinessObjects Roambi Cloud Cognos Adapter - May 2016 Table of Contents I. Overview Introduction II. Setup Requirements Roambi Requirements Cognos Requirements Roambi ConFiguration Creating API Key Setting up RoambiScript III. How to Use Option 1: Cognos is conFigured to save ALL report outputs to the File system. Installation and Configuration Preparation ConFigure Cognos Report For Bursting Update roambi-integration.conFig Schedule the Cognos Report Log Files Option 2: Cognos is conFigured to save Individual report outputs to the File system. Installation and Configuration Preparation ConFigure Cognos Report For Bursting Update roambi-integration.conFig Schedule the Cognos Report Log Files Appendix A: Troubleshooting and Common Issues 1 SAP BusinessObjects Roambi Cloud Cognos Adapter - May 2016 I. Overview Introduction Cognos allows users to create reports. Reports can be scheduled to run on diFFerent time intervals and the output can be saved in content manager or sent by email to difFerent recipients. Optionally users can burst the report to produce multiple reports based on a key. Cognos oFFers two methods to save report outputs to the File system. You can conFigure Cognos to save All report outputs to the File system, or enable users to save individual reports to a speciFic Folder in the File system. When conFiguring Cognos to save the All report outputs to the File system, you can provide a batch script that will be called every time a report output File is saved to the File system. In that script we can include the logic to launch the integration with SAP BusinessObjects Roambi Cloud. With this option, the integration with Roambi Cloud is basically controlled by Cognos. When conFiguring Cognos to save Individual report outputs to a speciFic Folder, the integration with Roambi Cloud is not triggered automatically by Cognos, since with this option the script is not executed after each report output, the execution must be triggered manually or using an external scheduler. 2 SAP BusinessObjects Roambi Cloud Cognos Adapter - May 2016 II. Setup Requirements Roambi Requirements 1. Created a Roambi View to be used as a template. 2. Administrator access to Roambi. 3. Roambi API Client Key. 4. Install and configure RoambiScript. 5. Roambi Users invited into Account. Cognos Requirements 1. Cognos Versions: 10.1, 10.1.1, 10.2.0, 10.2.2 Roambi Configuration The SAP BusinessObjects Roambi Cloud Cognos Adapter enables users to upload File to Roambi File System or use an existing Roambi report as template to create personalized Roambi reports to your recipients. IF you have not created a Roambi Report, please review our getting started material and select a Roambi View to create your First report. There are examples in this user guide as well. When creating a Roambi report as a template, the general workFlow is: 1. Determine the data to be shared with your recipients. Decide iF all recipients will get the same data or it will be Filtered by speciFic category, product, or country. 2. Create a sample data File as a template 3. Upload to Roambi and create your Roambi report 4. Review and reFine the Roambi View As with all design processes, creating a Roambi report will take Few iterations and practice. General recommendation is to work through the steps outlined here, and get early Feedback From recipients before investing on perFecting the smaller details. 3 SAP BusinessObjects Roambi Cloud Cognos Adapter - May 2016 Creating API Key The Roambi Cloud Cognos Adapter leverages the Roambi API to Facilitate the creation of Roambi reports. No programming or API knowledge is required to use the components, but you do need to register an API client. To set up an API client please Follow the steps outlined in the knowledge base article How do I create a Roambi API client? Please keep the details oF the API client readily available, as it will be used in the next section. Setting up RoambiScript 1. Download RoambiScript From SAP Service Marketplace. Create a folder that can be easily referenced. In this documentation, RoambiScript is installed in C:\roambiscript folder. For more information on RoambiScript, see this KBase. 2. Run roambiscript configure in the terminal to generate a properties File. 4 SAP BusinessObjects Roambi Cloud Cognos Adapter - May 2016 java -jar roambi-api-cli.jar configure 3. After executing the above command, it will create a roambi-api.cli.properties file. Open Note you will be required to enter the API client details you previously created in “Creating API Key.” This will ensure that this API utility is provisioned to talk to your Roambi Enterprise organization. Additionally, please note the RoambiScript installation path (in this example it is C:\roambiscript). The components will need to reFerence this directory path. 5 SAP BusinessObjects Roambi Cloud Cognos Adapter - May 2016 III. How to Use There are two options to conFigure your Cognos to work with Roambi Cloud. It depends on how you want to conFigure the report export. These are: ● Save ALL report outputs to the File system. ● Save INDIVIDUAL report outputs to the File system. Option 1: Cognos is configured to save ALL report outputs to the file system. Everytime Cognos saves a report output to the File system, it saves two Files: the actual report output File (the excel File in our case) and the descriptor File which is an xml File with metadata including the report search path and the burst key. After saving those Files, Cognos automatically invokes a script that was previously conFigured. Cognos passes the path oF the output File and the descriptor File to the script. This script contains a line to call the roambi-cognos-integration.jar with the path oF both files. The roambi-cognos-integration.jar program will check if the File is used by any Roambi file and refresh it. The program uses the roambi-integration.conFig File. This File is a csv file that contains the mapping between cognos reports and roambi files. roambi-integration.conFig sample: 6 SAP BusinessObjects Roambi Cloud Cognos Adapter - May 2016 ReportSearchPath BurstKey Template DestinationFolder RoambiFileName Users Groups /content/folder[@na Americas /Templates/Cognos /Roambi Files Sales Report [email protected]; Sales me='Mauricio']/report Sales Report Americas [email protected] Group [@name='Sales Report'] /content/folder[@na Asia PaciFic /Templates/Cognos /Roambi Files Sales Report Asia [email protected] Sales me='Mauricio']/report Sales Report PaciFic Group [@name='Sales Report'] Each entry is a map between a Cognos report and the Roambi File: ● ReportSearchPath: Cognos report search path. (i.e “/content/Folder[@name='Mauricio']/report[@name='Sales Report']”) ● BurstKey: Burst key. Applies only For burst reports. (i.e “Americas”) ● Template: This is the Full path to the Roambi template File in RFS. (i.e “/Templates/Sales Report”) ● DestinationFolder: This parameter is optional. It is the Folder in RFS where the Roambi File will be generated. IF it is not speciFied, the Roambi file will be created in the “My Documents” folder of the given Roambi users. (i.e “/Roambi Files”) ● RoambiFileName: Name oF the Roambi File that will be generated. (i.e “Sales Report Americas”) ● Users: Optional. Roambi users. Those users will have the permission to open the generated Roambi File. Use semicolon to separate multiple users. i.e. “[email protected];[email protected]”. ● Groups: 7 SAP BusinessObjects Roambi Cloud Cognos Adapter - May 2016 Optional. Roambi groups. Those groups will have the permission to open the generated Roambi file. Use semicolon to separate multiple groups. i.e. “Sales Group”. Installation and Configuration ConFigure Cognos to save reports to File system and run script every time a File is saved: 1. In Cognos Configuration in the Explorer tree, select Data Access > Content Manager node and set the “Save report outputs to a File system?” option to True. 2. Set CM.OUTPUTLOCATION and CM.OUTPUTSCRIPT properties in Cognos Connection Administration: In Cognos Connection Administration, select “Status” tab and click on “System” option located in the left panel. Then in the “Scorecard” section of the Status/System UI, select the “All servers” drop down and navigate to “Services” > “Content Manager”. 8 SAP BusinessObjects Roambi Cloud Cognos Adapter - May 2016 For the Active Content Manager Service, select the drop down and select “Set Properties”. Select “Settings” tab and click on “Environment” > “Advanced Settings” > “Edit”. 9 SAP BusinessObjects Roambi Cloud Cognos Adapter - May 2016 Set the values For CM.OUTPUTLOCATION and CM.OUTPUTSCRIPT CM.OUTPUTLOCATION: This is the path to the Folder where the Cognos reports will be saved. CM.OUTPUTSCRIPT: This is the path to the script that runs aFter a report output is saved to the target directory. The Full File names oF the output File and descriptor are passed to the script. Edit the script you conFigure in the CM.OUTPUTSCRIPT property and add the following line: java -jar C:\roambiscript\roambi-cognos-integration.jar %* >> "%2-roambi.log" Preparation 1. Create the Cognos report. The Following is a report with sales data. It is recommended that the report just contain the table or crosstab with the data you want to import in Roambi. Avoid decorations like titles, header, Footers. The report will be exported to Excel and iF you include decorations, Roambi may not be able to import the report correctly. 10 SAP BusinessObjects Roambi Cloud Cognos Adapter - May 2016 2. Export the report to Excel 2007 and use that Excel File to create the Roambi template. In this example the Roambi template is a Card View saved to “/Templates/Cognos Sales Report” in RFS. 11 SAP BusinessObjects Roambi Cloud Cognos Adapter - May 2016 Once the Cognos report and the corresponding Roambi template are created, the Cognos user can automate the process of refreshing one or many Roambi files from the same Cognos report.