ASP.net 2.0

Business Activity Monitoring (BAM) and ASP.net 2.0 Web Parts

Rob Addis — Mon, 10 Jul 2006 13:49:00 GMT

Last year at the Microsoft BPI Conference in Seattle over a few beers Scott Alan (a Microsoft integration technology specialist) shared with me his idea about using ASP.net 2.0 Web Parts to present BAM data. The idea was to give managers a more precise, flexible and easy to use interface into their business processes, they could essentially go to one dashboard and get a historical and current view of how various areas of their business unit or organisation were doing.

I’ve searched the blogosphere half a year later and I’m surprised no one has written about this it’s so simple to build.

The only gripe I have is that ASP.net 2.0 Web Parts cannot be deployed to SharePoint Services 2003 you’ll have to wait until the next version out later this year. You can however get to grips with how build Web Parts to show BAM data on an ASP.net 2.0 page now. (you can use Son of SmartPart see feedback below)

This post isn’t going to cover how to enable BAM it also isn’t about how to build Web Parts the basics of which are covered in these 3 tutorials:

WebParts1

WebParts2

WebParts3

Here is a simple BAM dashboard (ok I’m not a graphic designer). From the right hand side of the page the manager selects what data in which format they want to view and where on the page it should sit. Once the web part is on the page they can drag it to where ever they want or get rid of it and display another one.

All the Web Parts

How to plug into BAM

I know of three ways to access BAM data the first is obvious just grab it from the Views in the BAMPrimaryImport database, the second is by accessing the cubes in SQL Server Anaylsis Services the third is by calling the Web Services which the BAM Portal uses to access BAM data (these are installed with BAM):

http://[server]/BAM/BAMQueryService/BamQueryService.asmx

http://[server]/BAM/BAMManagementService/BamManagementService.asmx

I developed 3 simple Web User Controls to display BAM Data, as a best practice I think it’s a good idea if you develop all your web parts as Web User Controls (these will be later wrapped up as Web Parts).

Web Part	Usage	Access method
Orders for Redmond	Graph of all the orders for the city of Redmond	BAM Query Service GetInstanceData web method
Subscribe to alert	Allows a user to subscribe to an existing alert	BAM Management Service GetAlertsSummary and AddSubscription web methods
Orders by city	Report with graph displaying the number of orders per city	View on BAMPrimaryDataBase

1) Orders for Redmond web part

Controls: an ASP.net 2.0 GridView

Code: (create a web reference to the BAMQueryService)

using System;

using System.Data;

using System.Configuration;

using System.Collections;

using System.Web;

using System.Web.Security;

using System.Web.UI;

using System.Web.UI.WebControls;

using System.Web.UI.WebControls.WebParts;

using System.Web.UI.HtmlControls;

using System.Security.Principal;

public partial class OrdersForRedmond : System.Web.UI.UserControl

{

protected void Page_Load(object sender, EventArgs e)

{

try

{

//Create the instance query note that the ActivityID is always the first column returned

BamQueryService.InstanceQuery instanceQuery = new BamQueryService.InstanceQuery();

instanceQuery.SelectClauses = new string[] { "city", "product", "amount", "denied", "approved" };

//Create a filter expression and add it as a where clause

BamQueryService.ArrayOfWhereClausesFilterFilter whereClauseFilter = new BamQueryService.ArrayOfWhereClausesFilterFilter();

whereClauseFilter.Field = "City";

whereClauseFilter.Condition = "=";

whereClauseFilter.Logic = "And";

whereClauseFilter.Value = "Redmond";

instanceQuery.WhereClauses = new BamQueryService.ArrayOfWhereClausesFilterFilter[] { whereClauseFilter };

//Add credentials to call the WS (integrated security)

//Call the GetInstanceData web method and return the result

BamQueryService.BamQueryService bamQueryService = new BamQueryService.BamQueryService();

bamQueryService.Credentials = new System.Net.NetworkCredential("administrator", "pass@word1");

BamQueryService.Column[][] result = bamQueryService.GetInstanceData("SalesManager", "OrderMgmt", instanceQuery, 30);

//Fill a data table this is a quick and dirty way of creating a datasource

//probably a better way to bind a 2d array

DataTable dataTable = new DataTable("OrdersTable");

dataTable.Columns.Add(result[0][0].Name);

dataTable.Columns.Add(result[0][1].Name);

dataTable.Columns.Add(result[0][2].Name);

dataTable.Columns.Add(result[0][3].Name);

dataTable.Columns.Add(result[0][4].Name);

dataTable.Columns.Add(result[0][5].Name);

for (int i = 0; result.GetUpperBound(0) >= i; i++)

{

DataRow dataRow = dataTable.NewRow();

dataRow[0] = result[i][0].Value;

dataRow[1] = result[i][1].Value;

dataRow[2] = result[i][2].Value;

dataRow[3] = result[i][3].Value;

dataRow[4] = result[i][4].Value;

dataRow[5] = result[i][5].Value;

dataTable.Rows.Add(dataRow);

}

//Fill the grid with the result

gvOrders.DataSource = dataTable;

gvOrders.DataBind();

}

catch (Exception ex)

{

System.Diagnostics.EventLog.WriteEntry(this.ToString(), ex.ToString(), System.Diagnostics.EventLogEntryType.Error);

}

2) Subscribe to Alert web part

Note: some alerts must exist already in the BAM Portal

Controls: An ASP.net 2.0 Drop Down List, Text Box and a Button

Code: (create a web reference to the BAMManagementService)

using System;

using System.Data;

using System.Configuration;

using System.Collections;

using System.Web;

using System.Web.Security;

using System.Web.UI;

using System.Web.UI.WebControls;

using System.Web.UI.WebControls.WebParts;

using System.Web.UI.HtmlControls;

using System.Security.Principal;

public partial class SubscribeToAlert : System.Web.UI.UserControl

{

BamManagementService.BamManagementService _BamManagementService;

protected void Page_Load(object sender, EventArgs e)

{

try

{

//Fill the subscriptions combo list box

//Add credentials to call the WS (integrated security)

//Call the GetAlertsSummary web method

_BamManagementService = new BamManagementService.BamManagementService();

_BamManagementService.Credentials = new System.Net.NetworkCredential("administrator", "pass@word1");

BamManagementService.AlertSummary[] alertSummary =

_BamManagementService.GetAlertsSummary("SalesManager");

//Fill a data table this is a quick and dirty way of creating a datasource

//probably a better way to bind a 2d array

DataTable dataTable = new DataTable("AlertsTable");

dataTable.Columns.Add("Alerts");

for (int i = 0; alertSummary.GetUpperBound(0) >= i; i++)

{

DataRow dataRow = dataTable.NewRow();

dataRow[0] = alertSummary[i].Name;

dataTable.Rows.Add(dataRow);

}

//Fill the drop down list

ddlAlerts.DataSource = dataTable;

ddlAlerts.DataTextField = "Alerts";

ddlAlerts.DataValueField = "Alerts";

ddlAlerts.DataBind();

}

catch (Exception ex)

{

System.Diagnostics.EventLog.WriteEntry(this.ToString(), ex.ToString(),

System.Diagnostics.EventLogEntryType.Error);

}

protected void btnSubscribeToAlert_Click(object sender, EventArgs e)

{

try

{

//Create a subscription

BamManagementService.Subscription subscription = new BamManagementService.Subscription();

subscription.ID = new Guid().ToString();

subscription.Type = BamManagementService.SubscriptionType.email;

subscription.UserName = System.Security.Principal.WindowsIdentity.GetCurrent().Name;

subscription.Address = txtEmailAddress.Text;

_BamManagementService = new BamManagementService.BamManagementService();

_BamManagementService.Credentials = new System.Net.NetworkCredential("administrator", "pass@word1");

_BamManagementService.AddSubscription("SalesManager", ddlAlerts.SelectedValue,

new BamManagementService.Subscription[] { subscription });

}

catch (Exception ex)

{

System.Diagnostics.EventLog.WriteEntry(this.ToString(), ex.ToString(), System.Diagnostics.EventLogEntryType.Error);

}

3) Orders by City web part

Create a dataset and connect the BAMPrimaryImport database and select the View which contains the data you’re interested in.
Select add new item and choose report
Drag a Chart from the toolbox onto the report
Go to the Report menu and select Data Sources and then choose the dataset you created above
Play with the properties of the graph until you’re happy i.e. add x y cell data
Add a Web User Control to the project
Add a Report Viewer control and choose the report you just created

Code: none

Now you’ve got your Web User Controls (soon to be web Parts) if you haven’t already do the 3 web part tutorials above and build your page. This is just a simple example of how you can interface with BAM & use ASP.net 2.0 web parts to empower managers.

Best Practice: Frames Vs MasterPages Vs ICallBackEventHandler Vs DataIslands and the dreaded page refresh

Rob Addis — Wed, 27 Apr 2005 18:33:00 GMT

ASP.NET 2.0 hasn’t put the final nail in the coffin of Frames. It does however provide some better alternatives depending on what you are trying to achieve.

I googled up some comparisons of Frames, Master Pages and the ICallBackEventHandler a good overview article on ASP.net 2.0 sates in favour of master pages:

• “Bookmark a page and recall all the information on the specific page, not just the default frame page. A master page isn't really a frame. It's a single page that contains collated content from the master page and the content page that builds on the master. Therefore it looks and acts like a single Web page rather than a frame.

• Work by means of controls and tags rather than HTML. Thanks to Visual Studio, you don't have to worry about opening and closing frame tags or modifying countless HTML attributes to ensure that each frame displays in the correct fashion. You can simply create the place holder and modify its properties through Visual Studio.

• Leverage Visual Studio's code creation to visually design the layout, manage the frames, and provide all of the plumbing to link the content pages into the master page. You can add new content without having to worry that the overall HTML layout of the page will be affected. “

Migrating from ASP.NET 1.x to ASP.NET 2.0

By Jayesh Patel, Bryan Acker, Robert McGovern - Infusion Development, July 2004

https://www.mainfunction.com/DotNetInAction/Technologies/display.aspx?ID=2760&TypeID=17#master

And this extract from an interview with Scott Guthrie Microsoft’s ASP.net Architect discusses how the new callback manager (ICallBackEventHandler) which is basically a XMLHTTP wrapper can also help in reducing the amount of visible page refreshes.

“…So, one is to do what we call, out-of-bound call backs, where you can stay on the same page as an end user, but then through script, you can actually make a call back to the server and fetch new data that you populate down to the client, without having to, again, refresh the entire page, without having to lose scroll position, etc.

…

So will out-of-bound callbacks spell the end of the evil IFRAME?

The IFRAME today has a bum wrap in terms of reputation. I think the combination of out-of-bound callbacks as well as some of the things we're doing in terms of master pages, to provide much cleaner layout of a page, where you can go ahead and rather than have to rely on frames in order to cleanly separate, or integrate content into a site, you can now rely on master pages. I think the combination of those two are going to put the hurt on the IFRAME out there. It's still fully supported, but the nice thing is, there's much richer mechanisms you can rely on now. “

http://www.theserverside.net/talks/videos/ScottGuthrie/interview.tss?bandwidth=56k

Well master pages seem a fantastic tool for development. They give you page inheritance, reusability you can even nest them giving the developer a simple way for you to ensure consistent look and feel to an entire application. So from a developer’s point of view they rock.

But what about the user experience well even if a content page “inherits” a master page each time the page is requested the entire page will refresh whether it is the content part or the master part of the page. Users hate full page refreshes, developers hate trips to the server to retrieve redundant html, the menu bar and advertisement is already on the client’s browser so why go and get it again (even if it is cached on the server).

Can implementing the ICallBackEventHandler help, well yes and no. Use of this technique can only refresh data. For example, enable the user to page through a grid without refreshing the entire page. You can’t really use this to redisplay the entire content area of the page if it contains asp: web controls (well I have done it but using Frames would be much much easier).

If you haven’t already come across the concept of XML Data Islands it has been around for a while along with Frames and XMLHTTP (now the ICallBackEventHandler). This technique requires the use of the DHTML XML tag you use this to build a client side repository of data in XML. For example if a user is entering data to complete a form over a number of pages, it would be more beneficial if you stored the data on the client between pages until the user reaches the final page and presses submit and only then hit the server to update your data source. This potentially has no effect on the dreaded page refresh it is great for relieving the pressure on your database server however. Note this is not the only use for XML Data Island the example is a common one however.

So the only way to stop the entire page refreshing if you are using asp: or user controls on your page (these need to be rendered by the asp.net runtime) and only refreshing the content area of a page is still through the use of Frames. Unfortunately in ASP.net Beta 2 unlike ASP.net 1.X it doesn’t ship with a Frameset template although there will be an online template available and adding the tags yourself won’t cause injury.

So what are the best practices I have come up with many seasoned web developers will already practice these however for those beginners and intermediates I hope this will be of some help and relive you of trial and error driven development. Some of you may disagree with these and I would like to hear back from you guys. Remember it is the users we are building these web applications for not the developers.

Use master pages when

• Not concerned about a full page refresh

• Development requires a highly modifiable inheritable page standard and users will live with a page refresh

• Need to be allow the user to bookmark a specific page

Use the ICallBackEventHandler when

• Want to refresh data or images in a control and not refresh the entire page

• Want to refresh part of the page with simple HTML (no asp: controls) and not refresh the entire page

Use XML Data Islands

• You want to build stores of data on a client and by doing this reduce the number of hits to update the servers data source

Use Frames when

• Don’t want full page refreshes

• Have complex asp: control driven pages which can’t be refreshed by data only i.e. the asp: controls need to be generated into html by the web server first

• Need multiple areas of the page to be refreshed at different times by the user

R. Addis & A. Rambabu

Online VS.net 2.0 Tutorials

Rob Addis — Mon, 18 Apr 2005 11:41:00 GMT

Here are a couple of easy tutorials for ASP.net 2.0.

Themes and skins
http://codeguru.com/vb/vb_internet/aspnet/article.php/c7937/
and
http://www.ondotnet.com/pub/a/dotnet/2004/08/30/themesandskins.html

Personalisation
http://www.ondotnet.com/pub/a/dotnet/2004/08/16/whidbey_personalization.html
and (includes master pages)
http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dnsse/html/VWD_SSE.asp

Client Script call back (Call back manager)
http://www.ondotnet.com/pub/a/dotnet/2004/08/09/callbackmanager.html
and
http://msdn.microsoft.com/msdnmag/issues/04/08/CuttingEdge/

ASP.net 2 Web config help
I have found the MSDN doco on the ASP.net 2.0 config file really helpful (especially when adding new sql providers for membership & role management).
http://winfx.msdn.microsoft.com/library/default.asp?url=/library/en-us/dv_aspnetgenref/html/9e998377-b07f-44c1-ad9b-20a60e83c18f.asp

And this site to help with setting password encryption in web.configs
http://www.aspnetresources.com/tools/keycreator.aspx

R. Addis