Guides/Fusion.md
... ...
@@ -0,0 +1,143 @@
1
+#Izenda Fusion
2
+
3
+##How the Izenda Fusion Driver works
4
+
5
+The Izenda Fusion Driver composes data sources from several connections (data providers) into a single data source. This is very similar to how [[SSAS|http://technet.microsoft.com/en-us/library/ms175609(v=sql.90).aspx]] works, but using Fusion you can aggregate data not only from MSSQL databases but from very different data sources. For example, you can get data from the [[OData|Guides/OData]] data provider (i.e. without a direct connection to the database). All you need to do is set up the data sources' connections and you will be able to work with aggregated data as a single data source.
6
+
7
+Below is a schematic diagram of Fusion Driver:
8
+
9
+![Izenda Fusion Driver Schematic](http://wiki.izenda.us/Guides/Developer-Links-and-Guides/fusion_driver_schematic.png)
10
+
11
+##How to set up and configure Fusion Driver?
12
+
13
+Configuring the Izenda Fusion Driver is almost the same as configuring the Izenda Driver with single connection. The main differences are:
14
+
15
+* Allows you to set up more then one data source end point
16
+* Allows you to set up database constraints separately for each connection
17
+* Needs to use additional connection strings for the AdHoc table if your reports are stored in your database
18
+
19
+Configuring the Izenda Fusion Driver consists of several steps:
20
+
21
+###1. Create the Fusion Driver
22
+
23
+At first you should create FusionDriver object and set up it as default driver for the Izenda AdHoc. Here is example how to do it in C#:
24
+
25
+FusionDriver fusionDriver = new FusionDriver();
26
+AdHocContext.Driver = fusionDriver;
27
+
28
+###2. Add connections to the driver
29
+
30
+Now you can add connections to the data sources end points. The end point could be a direct connection to the MSSQL database or it can be an OData connection to the MSSQL or Oracle database.
31
+
32
+####a) Adding a connection to the local MSSQL database.
33
+
34
+You should specify the connection nickname in first parameter, the connection type of MSSQL in the second parameter, and the connection string in the last parameter:
35
+
36
+```csharp
37
+fusionDriver.AddConnection("SqlNW", FusionConnectionType.MsSql, "server=(local);database=Northwind;Trusted_Connection=True;");
38
+```
39
+
40
+####b) Adding a connection to the OData provider.
41
+
42
+You should specify the connection nickname in first parameter, the connection type of OData in the second parameter, and the link to the OData end point in the last parameter:
43
+
44
+```csharp
45
+fusionDriver.AddConnection("OrclNW", FusionConnectionType.OData, "http://www.providerdomain.com/provider_endpoint.aspx");
46
+```
47
+
48
+###3. Set up additional settings
49
+
50
+The Izenda Fusion Driver has several additional settings:
51
+
52
+####1) VisibleDataSources
53
+
54
+This is setup the same way as for a single connection. Only data sources with the specified names will be available:
55
+
56
+```csharp
57
+fusionDriver.VisibleDataSources = new string[] { "Orders", "Customers", "Order Details" };
58
+```
59
+
60
+####2) Constraints
61
+
62
+This is setup the same as for single connection except that you are able to specify separate constraints for each connection by using connection nicknames. Note that you can use wildcard characters to set up constraints:
63
+
64
+```csharp
65
+fusionDriver.AddConstraint("SqlNW/Order.Id", "SqlNW/*.OrderID");
66
+fusionDriver.RemoveConstraint("OrclNW/Account.Id", "OrclNW/User.AccountID");
67
+```
68
+
69
+####3) ReportingConnectionString
70
+
71
+If reports are stored in the database you should specify connection string to that database. Note that in addition to this, you should also use FusionAdHocConfig instead of DatabaseAdHocConfig. The following example sets up the connection string to the database using the reports table. If you store reports in the file system then skip this step(use FileSystemAdHocConfig if you do this).
72
+
73
+```csharp
74
+((FusionAdHocConfig)AdHocSettings.AdHocConfig).ReportingConnectionString = "server=(local);database=Reports;Trusted_Connection=True;";
75
+```
76
+
77
+####4) Set up cache
78
+
79
+Getting data from several data source providers may take a lot of time and resources when many connections are added. This will result in a slow connection to the providers due to large amount of data being transferred, etc. That’s why the cache is enabled by default for the Izenda Fusion Driver. By default, cache expiration time is set to 12PM on Saturday. This means that every Saturday, the cache will be cleared and all data will be requested from the providers during the next session.
80
+
81
+You can configure the cache yourself by using the following properties and methods:
82
+
83
+* **DataCacheExpiration:** Sets the date for cache expiration. All data in the cache older than the specified date will be cleared (removed from the cache). For example, if you want to clear all data more than two days old, you should set: ``fusionDriver.DataCacheExpiration = DateTime.Now.AddDays(-2);``
84
+* **CacheAllReports method:** Adds all available reports to the cache: ``fusionDriver.CacheAllReports();``
85
+* **CacheReport method:** Adds a single report with the specified name to the cache: ``fusionDriver.CacheReport(string reportFullName);``
86
+
87
+###Sample use
88
+
89
+Below is a full example of how to set up and configure Fusion Driver with several connections and reports stored in database:
90
+
91
+```asp
92
+<%@ Application Language="C#" %>
93
+<%@ Import Namespace="System.Data"%>
94
+<%@ Import Namespace="Izenda.AdHoc.Database"%>
95
+<%@ Import Namespace="Izenda.AdHoc" %>
96
+<%@ Import Namespace="System.Configuration" %>
97
+
98
+<script runat="server">
99
+ void Session_Start(object sender, EventArgs e)
100
+ {
101
+ // Set license key. Note: "+FUSION" must be in license key
102
+ AdHocSettings.LicenseKey = "LICENSE KEY";
103
+
104
+ // Set config. Note: config class must derive from FusionAdHocConfig or FileSystemAdHocConfig
105
+ AdHocSettings.AdHocConfig = new CustomFusionAdHocConfig();
106
+
107
+ // Create Fusion driver and set it as default driver for AdHoc
108
+ FusionDriver fusionDriver = new FusionDriver();
109
+ AdHocContext.Driver = fusionDriver;
110
+
111
+ // Add connection to the local MSSQL database
112
+ fusionDriver.AddConnection("SqlNW", FusionConnectionType.MsSql, "server=(local);database=Northwind;Trusted_Connection=True;");
113
+ // Add connection to the OData provider which is connected to the Oracle database
114
+ fusionDriver.AddConnection("OrclNW", FusionConnectionType.OData, "http://www.providerdomain.com/Oracle/FusionEndpoint.aspx");
115
+
116
+ // Add visible data sources
117
+ fusionDriver.VisibleDataSources = new string[] { "Orders", "Customers", "Order Details" };
118
+
119
+ // Configure constraints for connections
120
+ fusionDriver.AddConstraint("SqlNW/Order.Id", "SqlNW/*.OrderID");
121
+ fusionDriver.RemoveConstraint("OrclNW/Account.Id", "OrclNW/User.AccountID");
122
+
123
+ // Clear cache
124
+ fusionDriver.DataCacheExpiration = DateTime.Now;
125
+
126
+ // Add some reports to the cache
127
+ fusionDriver.CacheReport("Financial reports\Sales");
128
+ fusionDriver.CacheReport("Common reports\Employees");
129
+
130
+ // Set connection to the database with reports table
131
+ ((FusionAdHocConfig)AdHocSettings.AdHocConfig).ReportingConnectionString = "server=(local);database=ReportsDB;Trusted_Connection=True;";
132
+ }
133
+
134
+ [Serializable]
135
+ public class CustomFusionAdHocConfig : FusionAdHocConfig
136
+ {
137
+ public override void ConfigureSettings()
138
+ {
139
+
140
+ }
141
+ }
142
+</script>
143
+```