The SAP Roambi Cloud SSRS Delivery Extension simplifies the process of updating a Roambi report with data coming from a SSRS reports.

Transcription

1 1

2 Table of Contents I. Overview Introduction II. Setup Requirements Roambi Requirements Created a Roambi View to be used as a template SAP Roambi Cloud API Token Install and configure RoambiScript SSRS Requirements Roambi Configuration Creating a New API Token Setting up RoambiScript III. How to Use Preparation Create Subscription Create Data-Driven Subscription Appendix A: Troubleshooting and Common Issues Appendix B: Resources 2

3 I. Overview Introduction The SAP Roambi Cloud SSRS Delivery Extension simplifies the process of updating a Roambi report with data coming from a SSRS reports. With the new Roambi Cloud Delivery Extension, a SSRS user can integrate their SSRS reports with Roambi Cloud with the use of subscriptions. Once the user has created the Roambi template file based on an Excel file created from a SSRS report, the user can create a subscription to the SSRS report to schedule the generation of the target Roambi file. Subscriptions can also be data-driven subscriptions. Data-driven subscriptions provide a way to customize the distribution of a report based on dynamic data to several recipients. Data-driven subscriptions require that the users specify a data source (a table) where each row contains the information about the report parameters and the delivery extension parameters that define one subscription recipient. 3

4 II. Setup Requirements Roambi Requirements 1. Create a Roambi View to be used as a template 2. Administrator access to SAP Roambi Cloud 3. Roambi Cloud API Token 4. Install and configure RoambiScript 5. Roambi Users invited into Account SSRS Requirements 1. SSRS 2014, SSRS 2012 or SSRS 2008 R2 2. Permissions to add SSRS extension (need folder access to the SSRS server installation path) 3. Administrator access to SSRS 4. Recipient information has correct address Roambi Configuration The Roambi SSRS Delivery Extension uses an existing Roambi report as template and the Roambi API 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. 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 or select a SSRS report that contains the data. As a best practice, remove any header, footer, and additional formatting from the report. 3. Export the report as Excel file 4. Upload to Roambi Cloud and create your Roambi report 5. 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. Creating a new API Token 4

5 SAP Roambi SSRS Delivery Extension leverages the Roambi Cloud API to facilitate the creation of Roambi Cloud reports. No programming or API knowledge is required to use the components, but you do need to create an API token. 1. Go to View Account > API Tokens 2. Give it a name and click + 3. Copy the token and store it somewhere secure Note: This is the only time you will see the token. Get the Account UID 1. Go to Invite Users > Info 2. Copy the Account UID 5

6 SSRS Configuration To enable the Roambi Publisher Extension, it requires placing two files on the SSRS server RoambiScript - API utility that SSRS delivery extension will use to communicate to SAP Roambi Cloud. Roambi SSRS Delivery Extension - A dll file to be deployed on the SSRS Server Setting up RoambiScript 1. Download RoambiScript from SAP Service Marketplace. Create a folder on the SSRS Server that can be easily referenced. In this documentation, RoambiScript is installed in C:\roambiscript folder. For more information on RoambiScript, see RoambiScript Publishing SDK. 2. Run roambiscript configure in the terminal to generate a properties file. java -jar roambi-api-cli.jar configure 3. After executing the above command, it will create a roambi-api.cli.properties file. 6

7 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 SAP Roambi Cloud organization. Additionally, please note the RoambiScript installation path (in this example it is C:\roambiscript). The publisher extension will need to reference this directory path. Setting up Roambi Delivery Extension 1. Download the Roambi SSRS Delivery Extension 2. Move the Roambi.SSRSDeliveryExtension.dll to: C:\Program Files\Microsoft SQL Server\MSRS10_50.MSSQLSERVER\Reporting Services\ReportServer\bin 3. Deploy to Report Server: a. Add the following lines to rsreportserver.config located in C:\Program Files\Microsoft SQL Server\MSRS10_50.MSSQLSERVER\Reporting Services\ReportServer Inside <Extensions><Delivery>... </Delivery></Extension> <Extension Name="Roambi Business" Type="Roambi.SSRSDeliveryExtension.RoambiDeliveryProvi der,roambi.ssrsdeliveryextension"> <MaxRetries>3</MaxRetries> <SecondsBeforeRetry>900</SecondsBeforeRetry> <Configuration> 7

8 <RoambiScriptFolder>c:\roambiscript</RoambiScriptFolder> </Configuration> </Extension> Inside <Extensions><DeliveryUI>... </DeliveryUI></Extension> <Extension Name="Roambi Business" Type="Roambi.SSRSDeliveryExtension.RoambiDeliveryUIPro vider,roambi.ssrsdeliveryextension"/> b. Add the following lines to rssrvpolicy.config located in C:\Program Files\Microsoft SQL Server\MSRS10_50.MSSQLSERVER\Reporting Services\ReportServer The lines need to be added inside the <CodeGroup> </ClodeGroup> with description: "This code group grants MyComputer code Execution permission. <CodeGroup class="firstmatchcodegroup" version="1" PermissionSetName="FullTrust" Description="This code group grants MyComputer code Execution permission. "> <IMembershipCondition class="zonemembershipcondition" version="1" Zone="MyComputer" </CodeGroup> 4. Deploy to Report Manager: a. Copy Roambi.SSRSDeliveryExtension.dll to C:\Program Files\Microsoft SQL Server\MSRS10_50.MSSQLSERVER\Reporting Services\ReportManager\bin b. Add the following lines to rsmgrpolicy.config located in C:\Program Files\Microsoft SQL Server\MSRS10_50.MSSQLSERVER\Reporting Services\ReportManager The lines need to be added inside the <CodeGroup> </ClodeGroup> with description: "This code group grants MyComputer code Execution permission. <CodeGroup 8

9 class="firstmatchcodegroup " version="1" PermissionSetName="Execution" Description="This code group grants MyComputer code Execution permission."> <IMembershipCondition class="zonemembershipcondition" version="1" Zone="MyComputer"/> </CodeGroup> 5. Restart Report Server 9

10 III. How to Use We will use an example to illustrate all the steps you need to perform to create a personalized Roambi report for your recipients powered by SSRS. Preparation 1. Create the SSRS report. The following is a report that shows some sales data for the given country that is defined as a parameter. It is recommended that the report just contain the table or matrix 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

11 2. Export the report to Excel and use that Excel file to create the Roambi template. In this example the Roambi template is a Card View saved to /Templates/SSRS Sales Report in Roambi File System. Once the SSRS report and the corresponding Roambi template are created, the SSRS user can create a subscription to the SSRS report to generate one or many Roambi files by using the new SAP Roambi Cloud Delivery Extension. 11

12 Create Subscription Open the SSRS report, navigate to the report properties page and click on the Subscription tab to the right. Then click on the New Subscription button. Fill the new Subscription form: 12

13 Delivery by: Roambi Business This is the delivery extension to use. Select Roambi Business. Roambi Business Delivery Extension Parameters: Roambi Template: i.e. /Templates/SSRS Sales Report This is the full path to the Roambi template file in RFS. Roambi Title: i.e. Sales Report US Name of the Roambi file that will be generated. Roambi Folder Destination: i.e. /Roambi Files 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 Roambi users given in the Roambi Users parameter. Roambi Users: This a semicolon separated list of roambi users to grant permissions to open the generated Roambi file. This parameter is optional if you use Roambi Groups parameter. Roambi Groups: i.e. Sales Group This parameter is optional. This a semicolon separated list of roambi groups to grant permissions to open the generated Roambi file. SSRS Report Parameters: Country: i.e. United States Select a value from the list. Schedule the subscription. Every time the subscription runs, the SAP Roambi Cloud Delivery Extension will export the SSRS report to Excel, and generate the Roambi file based on the given Roambi template, granting permissions to the given Roambi users and groups. Create Data-Driven Subscription 13

14 With data-driven subscriptions and the new SAP Roambi Cloud Delivery Extension, SSRS users can generate multiple Roambi files for different Roambi users and groups from a single SSRS report. Data-driven subscriptions require that the users specify a data source (a table) where each row contains the information about the report parameters and the delivery extension parameters that define one subscription recipient. The table for this sample was created in a MS SQL Server Database that is accessible by SSRS. The structure of the table and its name does not need to follow any specific format. This is the table created for this sample. Table Name: SalesReportPublishInfo In this sample, the data-driven subscription will generate three Roambi files. One for each row in the table. The first one will run the SSRS report with the Country parameter set to United States, and generate the Roambi file SSRS Sales Report United States in the RFS folder /Roambi Files using the Roambi template /Templates/SSRS Sales Report. It will grant permissions to the Roambi user mauricio@abc.com. The second report SSRS Sales Report Brazil, will be generated using the same SSRS report but using the Country parameter set to Brazil and the permissions will be granted to both Roambi users mauricio@abc.com and daniel@abc.com. The third report SSRS Sales Report Mexico will be generated using the Country parameter set to Mexico and permissions will be granted to the Roambi group Sales Group. Open the SSRS report, navigate to the report properties page and click on the Subscription tab to the right. Then click on the New Data-driven Subscription button. Step 1 14

15 Description: Sales Report by Country Provide a description for the subscription. Specify how recipients are notified: Roambi Business This is the delivery extension to use. Select Roambi Business. Specify a data source that contains recipient information. Select Specify for this subscription only option. Step 2 15

16 Data source type: Microsoft SQL Server The database server type where the table is created. Connection string: i.e. data source=msdb2008; initial catalog=test The connection string to the database. Connect using User name and password to connect to the database. Step 3 16

17 Provide the SQL query to the table. In this sample the query is: select * from SalesReportPublishInfo Click on Validate button to validate the connection and query. Step 4 In this step, set the values for the Roambi Cloud Delivery Extension parameters. The values may come from a column in the table or it could be a static value. In this sample, the values come from the columns in the table. 17

18 Step 5 In this step, set the values for the SSRS report parameters. The values may come from a column in the table or it could be a static value. In this sample, the value for Country parameter come from the column Country of the table. 18

19 Step 6 Schedule the subscription. Specify when the subscription is processed. When the subscription is processed, the Roambi Cloud Delivery Extension will generate one Roambi file per row in the table as explained before. 19

20 20

21 Appendix A: Troubleshooting and Common Issues Where do I find RoambiScript, SSRS Delivery Extension, and API Key? RoambScript: Find it in SAP Service Marketplace. Roambi SSRS Delivery Extension: Link Roambi API Key: Please refer to How do I create a Roambi API client? I am getting empty data set in my Roambi file Please check the following items 1. Report does not contain header, footer, or other decorative formats 2. You provisioned the right users, and you are using a provisioned user to test the RBI contents 3. Check that your source report matches the dimensions used in the Roambi Report. 4. The profile values and filters for the user actually matches the data in the source report. Make sure you do not have additional query filter that restrict the data than intended 5. Check that your RBI template can be accessed Where can I find log files? SSRS default log to check if the DLL has been correctly installed: C:\Program Files\Microsoft SQL Server\MSRS12.MSSQLSERVER\Reporting Services\LogFiles Look for ERROR or Roambi on this file. You ll usually find file not found, or permission errors here. Fix it according to above setup doc. Roambi Cloud Delivery Extension log file: C:\Users\sqlservice\AppData\Local\Temp\roambi-delivery-provider.log RoambiScript also has its own log file: C:\roambiscript\log\roambi.log Check those log files in case of errors when executing subscriptions using the Roambi Cloud Delivery Extension. Finally you can check the Excel files been output from SSRS at: 21

22 C:\Users\ReportServer\AppData\Local\Temp Filenames will look like roambi-{guid}.xlsx I still have issues with the extension Please contact support. Please be sure to provide the following information: - SSRS version - Brief summary of what you are trying to accomplish - Time of publication event - RoambiScript Log (This can be found in the folder where you installed RoambiScript) - SSRS log files - Parameters used - Subscription used - Screenshot of report 22

23 Appendix B: Resources Delivery Extensions Overview Tutorial: Creating a Data-Driven Subscription 23

24 Appendix C: Version History Version 1.0: January, General Release of Roambi SSRS Delivery Extension Version 2.0: October, Add support for multiple Roambi Users and Roambi Groups permissions. Version 2.1: May, Update support link and SAP Service Marketplace link. 24

25 25