CLARITY WRITE BACK CONFIGURATION White Paper

Transcription

1 CLARITY WRITE BACK CONFIGURATION White Paper

2

3 Clarity 7 White Paper: Write-Back Configuration Version 7.0 2nd Edition Microsoft is a registered trademark. Microsoft SQL Server, Office, Excel, Word, Internet Explorer, FrontPage, Query, Windows and Windows NT are trademarks of Microsoft Corporation. Adobe Acrobat and Adobe Acrobat Reader are registered trademarks of Adobe Systems Incorporated. All other brand and product names are registered trademarks of their respective holders. No portion of this manual may be reproduced or transmitted in any form by any means, electronic or mechanical, including photocopying, recording, or using within information storage and retrieval systems, for any purpose other than the purchaser s personal use without express written permission of Clarity Systems. Notice: The information contained in this document is subject to change without notice. Clarity Systems shall not be liable for errors contained herein or consequential damages in connection with the furnishing, performance or use of this material. Clarity Systems Limited 2 Sheppard Avenue East Suite 800 Toronto, ON Canada M2N 5Y Printed in Canada 8/18/2010 Copyright 2010 Clarity Systems Limited. All rights reserved.

4 CLARITY WRITE-BACK Overview Clarity 7 offers two new and improved versions of Clarity Analysis Services write-back depending on the version of SQL Server used. These new versions of Clarity write-back offer improved performance and data integrity. The methods take advantage of new SQL Server 2008 features by passing table variables to stored procedures. Data integrity is controlled by wrapping the entire update inside a single transaction. The step by step save process is: 1. Modify data in clarity template and click save. 2. Clarity creates data table of all 'dirty rows' from template. 3. Batched up inside a single transaction, data table is either: SQL Server 2005 inserted into write-back temp table with unique transaction identifier. write-back stored procedure is called, passing this unique identifier as a parameter. SQL Server passed to write-back stored procedure as table variable. 4. write-back stored procedure completes the following tasks as part of the update: Parse write-back data into temp table. Validate all dimension values ex. Leaf level members, no nulls, etc. Delete all data from write-back table by joining on temp table. Delete all intersections from write-back table that will be updated by this save.) Insert new data into write-back table calculating delta values based on join query between temp table and write-back tables). 5. If using SQL 2005 method, delete records from Clarity write-back temp table matching the transaction id. 6. Commit transaction. Pre-Requisites At a minimum, Clarity Hot Fix ) is required for write-back style methods 2 or 3 above see bottom of page for write-back style methods). SQL Server 2005 or 2008 Enterprise Edition. Clarity write-back methods identified by writebackstyle values of 1, 2 or 3 will only work for C7 templates. Once Clarity write-back has been enabled, it will be used by all templates connecting to this cube from this instance of Clarity Server.

5 Note: Clarity 6.2 templates running within this instance of Clarity 7 will not work as they still use the 6.2 engine. You are required to convert all 6.2 templates to 7, otherwise stay with native write-back until all templates have been converted. If you require a hybrid solution of custom write-back with 6.2 and 7, please contact your designated Clarity Solutions Architect. Configuration Steps 1. Be sure to first disable Analysis Services native write-back. 2. If your member keys and member names are different, you must set the cube property membernamesunique=false for all cube dimensions. Doing this will ensure Analysis services returns the member keys to Clarity which are used to insert data into the write-back table. If you do not wish to set this property to false, you will have to modify the write-back procedure to first lookup key values using name values by joining on dimension tables. 3. Create the new write-back table this can be an exact copy of your fact table. 4. Add a unique clustered index, consisting of all dimension fields, to the new write-back table you just created. 5. Add a unique clustered index, consisting of all dimension fields, to all fact tables referenced in the write-back stored procedure. 6. Ensure you have added indexes to the dimension key columns for all dimension tables. 7. Add the new write-back table you created as a ROLAP partition to the cube. 8. Turn on SQL Server notification for this new ROLAP partition to ensure updated data is available immediately. Within BIDS, right click the new ROLAP partition and choose storage settings. Ensure the storage mode is Real-Time ROLAP. Choose Options. Select the Notifications tab. Ensure notification is set to SQL Server.

6 9. You must use the write-back stored procedure that corresponds to your version of SQL Server: "SQL Server 2005" on page 6 "SQL Server 2008" on page 11 Modify this sample stored procedure for your cube ex. update the dimensions used, fact table names, write-back table names, etc.) Note: The sample write-back stored procedure first deletes rows being updated and then inserts the new values. This was the most optimal approach. This approach will not support more than one write enabled measure per measure group. 10. If you are using SQL Server 2005, you will need to create a temporary write-back table that Clarity 7 uses for intermediate processing during the save. A sample of the script is: USE [testcube] SET ANSI_NULLS ON SET QUOTED_IDENTIFIER ON SET ANSI_PADDING ON CREATE TABLE [dbo].[testcube_wb_temp] [transactionid] [uniqueidentifier] NULL, [amount] [float] NULL,

7 [account] [varchar] 50) NULL, [measures] [varchar]50) NULL, [scenario] [varchar]50) NULL ) ON [PRIMARY] SET ANSI_PADDING OFF USE [testcube] /****** Object: Index [ix_transactionid] Script Date: 03/31/ :50:27 ******/ CREATE CLUSTERED INDEX [ix_transactionid] ON [dbo].[testcube_wb_temp] [TransactionId] ASC )WITH PAD_INDEX = OFF, STATISTICS_NORECOMPUTE = OFF, SORT_IN_TEMPDB = OFF, IGNORE_DUP_KEY = OFF, DROP_EXISTING = OFF, ONLINE = OFF, ALLOW_ROW_LOCKS = ON, ALLOW_PAGE_LOCKS = ON) ON [PRIMARY] Modify this script after your own cube. The naming convention for this temp table is <cube name>_wb_temp. Note: Field names must all be lower case. 11. SQL Server 2008 supports passing a table variable to a stored procedure so when using this version the temp table above is not needed. When saving from a template, Clarity Server generates this table of updated values and passes it as a table variable to the write-back stored procedure. For this to work, a table type must be created in the same databases as the write-back stored procedure. A sample of the script would be: USE [testcube] CREATE TYPE [dbo].[testcube_wbtabletype] AS TABLE [Amount] [decimal]23, 6) NULL, [Account] [varchar]80) NULL, [Measure] [varchar]80) NULL, [Scenario] [varchar]80) NULL )

8 Modify the sample table script after your own cube. The naming convention for this temp table is <cube name>_wbtabletype. The field order for this table type must be: a) Field 1 Amount b) Field 2 to Field n Dimension fields in alphabetical order 12. Update the Cubes table in the clarity database to enable custom write-back. a) Insert the data source name from the...web\bin\config.xml file for the database containing the write-back stored procedure into the writebackalias field. b) Insert the name of the stored procedure into the writebackstoredprocedure field. c) Insert either 2 or 3 into the writebackstyle field depending on your version of SQL Server and method used. The values for this field are: 0 - Native Analysis Services write-back 1 - Clarity custom write-back cell by cell method 2 - Clarity custom write-back SQL Server 2005 all at once method new and improved for C7) 3 - Clarity custom write-back SQL Server 2008 all at once method new and improved for C7) Sample Write-Back Stored Procedures SQL Server 2005 USE [testcube] SET ANSI_NULLS ON SET QUOTED_IDENTIFIER ON CREATE PROCEDURE uniqueidentifier AS BEGIN NVARCHAR4000);

9 NVARCHAR100); nvarchar100); /*CONFIGURABLE TRANSACTION ISOLATION LEVEL*/ SET TRANSACTION ISOLATION LEVEL READ COMMITTED begin transaction --superset WB table for all measure groups CREATE TABLE #WB [Amount] [float] NULL, [Account] [varchar]80) null, [Scenario] [varchar]80) null, [Measure] [varchar]80) null ) CREATE UNIQUE CLUSTERED INDEX [IX_#WB] ON [dbo].[#wb] [Account] ASC, [Scenario] ASC, [Measure] ASC ) --insert transaction data into temporary table insert into #WB[Amount],[Account],[Scenario],[Measure]) select SUMcoalesce[Amount],0.0)),[Account],[Scenario],[Measure] from TestCube_WB_Temp where [transactionid] group by [Account],[Scenario],[Measure] --determine measure group select top from #WB begin --Perform writeback for Measure Group Amount --ensure only one measure from measure group is being written to select TOP from #WB where Measure<>'Amount' BEGIN = N'Incorrect Measure - ' + ';Cannot write to multiple Measures from same dimension';

10 ROLLBACK TRANSACTION --Validate account dimension to ensure it exists in dim table and is a leaf member FROM #WB WB where WB.[Account] not in select [Level0_MemberId] from tbldimaccount) -- check for Unknown member values BEGIN = N'Cannot write data to an Undefined, All or Parent Account ' + ')'; ROLLBACK TRANSACTION --Validate scenario dimension to ensure it exists in dim table and is a leaf member FROM #WB WB where WB.[scenario] not in select [Level0_MemberId] from tbldimscenario) -- check for unknown member values BEGIN = N'Cannot write data to an Undefined, All or Parent Scenario ' + ')'; ROLLBACK TRANSACTION --Delete records from writeback table that will be updated by Clarity DELETE FROM dbo.rolap_budget WHERE EXISTS SELECT *

11 FROM #WB WB WHERE dbo.rolap_budget.[account]=wb.[account] and dbo.rolap_ Budget.[Scenario]=WB.[Scenario]) --Insert deltas for Clarity update into WB table insert into Rolap_Budget [Amount],[Account],[Scenario],sourcedetail,dtstamp) select sumwb.[amount])- sumcoalescefactgroup.[amount],0.0)),wb.[account],wb.[scenario], system_ user,getdate) from #WB WB left outer join select fact.[account],fact.[scenario],sumcoalescefact.amount,0.0)) as Amount from select * from tblfactactual UNION ALL select * from tblfactbudget ) fact group by fact.[account],fact.[scenario] ) factgroup ON WB.[Account] = factgroup.[account] and WB.[Scenario] = factgroup.[scenario] group by WB.[Account],WB.[Scenario] having sumwb.[amount])-sumcoalescefactgroup.[amount],0.0))<>0 end ELSE BEGIN --Perform writeback for Measure Group Count --ensure only one measure from measure group is being written to select TOP from #WB where Measure<>'Count' BEGIN = N'Incorrect Measure - ' + ';Cannot write to multiple Measures from same dimension'; ROLLBACK TRANSACTION

12 --Validate account dimension to ensure it exists in dim table and is a leaf member FROM #WB WB where WB.[Account] not in select [Level0_MemberId] from tbldimaccount) -- check for Unknown member values BEGIN = N'Cannot write data to an Undefined, All or Parent Account ' + ')'; ROLLBACK TRANSACTION --Delete records from writeback table that will be updated by Clarity DELETE FROM dbo.rolap_budget WHERE EXISTS SELECT * from #WB WB where dbo.rolap_budget.[account]=wb.[account]) --Insert deltas for Clarity update into WB table insert into Rolap_Budget_Count [Amount],[Account],sourcedetail,dtstamp) select sumwb.[amount])-sumcoalescefactgroup.[amount],0.0)),wb.[account], system_user,getdate) from #WB WB left outer join select fact.[account],sumcoalescefact.amount,0.0)) as Amount from select * from tblfactactualcount ) fact group by fact.[account] ) factgroup on WB.[Account] = factgroup.[account] group by WB.[Account]

13 having sumwb.[amount])-sumcoalescefactgroup.[amount],0.0))<>0 ELSE BEGIN = N'Measure "' + '" not defined.'; --delete records from physical temp writeback table for this transaction DELETE FROM dbo.testcube_wb_temp WHERE [TransactionId]=@TransactionID --drop stored proc temp table DROP TABLE #WB commit transaction SQL Server 2008 USE [testcube] SET ANSI_NULLS ON SET QUOTED_IDENTIFIER ON CREATE PROCEDURE [dbo].[stp_claritywb_2008] /*This parameter must <cube name>_wbtabletype READONLY AS BEGIN NVARCHAR4000); NVARCHAR100); nvarchar100); /*CONFIGURABLE TRANSACTION ISOLATION LEVEL*/

14 SET TRANSACTION ISOLATION LEVEL READ COMMITTED begin transaction --superset WB table for all measure groups CREATE TABLE #WB [Amount] [float] NULL, [Account] [varchar]80) null, [Scenario] [varchar]80) null, [Measure] [varchar]80) null ) CREATE UNIQUE CLUSTERED INDEX [IX_#WB] ON [dbo].[#wb] [Account] ASC, [Scenario] ASC, [Measure] ASC ) --insert transaction data into temporary table insert into #WB[Amount],[Account],[Scenario],[Measure]) select SUMcoalesce[Amount],0.0)),[Account],[Scenario],[Measure] group by [Account],[Scenario],[Measure] --determine measure group select top from #WB begin --Perform writeback for Measure Group Amount --ensure only one measure from measure group is being written to select TOP from #WB where Measure<>'Amount' BEGIN = N'Incorrect Measure - ' + ';Cannot write to multiple Measures from same dimension'; ROLLBACK TRANSACTION

15 --Validate account dimension to ensure it exists in dim table and is a leaf member FROM #WB WB where WB.[Account] not in select [Level0_MemberId] from tbldimaccount) -- check for Unknown member values BEGIN = N'Cannot write data to an Undefined, All or Parent Account ' + ')'; ROLLBACK TRANSACTION --Validate scenario dimension to ensure it exists in dim table and is a leaf member FROM #WB WB where WB.[scenario] not in select [Level0_MemberId] from tbldimscenario) -- check for unknown member values BEGIN = N'Cannot write data to an Undefined, All or Parent Scenario ' + ')'; ROLLBACK TRANSACTION --Delete records from writeback table that will be updated by Clarity DELETE FROM dbo.rolap_budget WHERE EXISTS SELECT * FROM #WB WB WHERE dbo.rolap_budget.[account]=wb.[account] and dbo.rolap_ Budget.[Scenario]=WB.[Scenario]) --Insert deltas for Clarity update into WB table

16 insert into Rolap_Budget [Amount],[Account],[Scenario],sourcedetail,dtstamp) select sumwb.[amount])- sumcoalescefactgroup.[amount],0.0)),wb.[account],wb.[scenario], system_ user,getdate) from #WB WB left outer join select fact.[account],fact.[scenario],sumcoalescefact.amount,0.0)) as Amount from select * from tblfactactual UNION ALL select * from tblfactbudget ) fact group by fact.[account],fact.[scenario] ) factgroup ON WB.[Account] = factgroup.[account] and WB.[Scenario] = factgroup.[scenario] group by WB.[Account],WB.[Scenario] having sumwb.[amount])-sumcoalescefactgroup.[amount],0.0))<>0 end ELSE BEGIN --Perform writeback for Measure Group Count --ensure only one measure from measure group is being written to select TOP from #WB where Measure<>'Count' BEGIN = N'Incorrect Measure - ' + ';Cannot write to multiple Measures from same dimension'; ROLLBACK TRANSACTION --Validate account dimension to ensure it exists in dim table and is a leaf member

17 FROM #WB WB where WB.[Account] not in select [Level0_MemberId] from tbldimaccount) -- check for Unknown member values if BEGIN = N'Cannot write data to an Undefined, All or Parent Account ' + ')'; ROLLBACK TRANSACTION --Delete records from writeback table that will be updated by Clarity DELETE FROM dbo.rolap_budget WHERE EXISTS SELECT * from #WB WB where dbo.rolap_budget.[account]=wb.[account]) --Insert deltas for Clarity update into WB table insert into Rolap_Budget_Count [Amount],[Account],sourcedetail,dtstamp) select sumwb.[amount])-sumcoalescefactgroup.[amount],0.0)),wb.[account], system_user,getdate) from #WB WB left outer join select fact.[account],sumcoalescefact.amount,0.0)) as Amount from select * from tblfactactualcount ) fact group by fact.[account] ) factgroup on WB.[Account] = factgroup.[account] group by WB.[Account] having sumwb.[amount])-sumcoalescefactgroup.[amount],0.0))<>0 ELSE BEGIN

18 = N'Measure "' + '" not defined.'; --drop stored proc temp table DROP TABLE #WB commit transaction

19