c360 Forums / SDK for Microsoft CRM / Version 3 Product Questions / Samples

Available Products

Jeremie Desautels — Mon, 02 Oct 2006 22:01:25 GMT

Overview

The scenario that was used for this sample is that a user wanted to simplify adding products to an Opportunity. This sample demonstrates the following:

List all products in a grid using a system view
Add a “CustomAction” to a grid (the “delete” action)
Use an “ActionPage” to implement the custom action
Implement a custom “DoubleClickHandler” in a grid
Use an “Edit” page to create new records and update existing ones

Installation

Step 1 – Edit ISV.config This sample must be added as a new link on the left navigation bar of the Microsoft CRM opportunity edit screen . Therefore we need to edit the “opportunity” entity section in Microsoft CRM’s ISV.config file like so:

[code]<Entity name="opportunity">

<NavBarItem Title="Available Products"

Icon="/_imgs/ico_18_debug.gif"

Url="http://localhost:1465/c360Sdk/Samples/AvailableProducts/AvailableProducts.aspx"

Id="availableProducts" />

</NavBar>

</Entity>[/code]

Note: you will need to adjust the url in the above sample to match your environment.

Step 2 – Copy files In your Visual Studio 2005 project, make sure you have a folder called “Samples” and create a sub-folder called “AvailableProducts”. In this new folder, copy the two ASPX pages and their corresponding code behind files:

AddSelectedProducts.aspx
AddSelectedProducts.aspx.cs
AvailableProducts.aspx
AvailableProducts.aspx.cs

Screenshots

Notes in grid

Jeremie Desautels — Wed, 07 Mar 2007 14:46:03 GMT

Overview

The goal of this sample is to display in a grid all the CRM Notes related to a “parent” record such as a Contact for example.

This sample demonstrates the following:

List CRM Notes in a grid
Create new "child" records (note that when you click on the ‘Create New’ button, the ‘regarding’ field is pre-populated with the parent record).

Installation

Step 1 – This sample must be added as a new link on the left navigation bar of the Microsoft CRM contact edit screen. Therefore we need to edit the "contact" entity section in Microsoft CRM's ISV.config file like so:

[code]<Entity name="contact">
<NavBar ValidForCreate="0" ValidForUpdate="1">
<NavBarItem Icon="/_imgs/ico_16_5_d.gif" Title="Notes in grid"
Url=" http://localhost:5517/c360Sdk /Samples/NotesInGrid/Notes.aspx"
Id="notesInGrid" />
</NavBar>
</Entity>[/code]

Note: you will need to adjust the url in the above sample to match your environment.

Step 2 – Copy files In your Visual Studio 2005 project, make sure you have a folder called “Samples” and create a sub-folder called “NotesInGrid”. In this new folder, copy the two ASPX pages and their corresponding code behind files:

Notes.aspx
Notes.aspx.cs
NotesFetchData.aspx
NotesFetchData.aspx.cs

Screenshots

Lookup with linked header and detail grids

Jeremie Desautels — Tue, 20 Feb 2007 00:59:31 GMT

Overview

This sample was requested by a member on our online forum. What she wanted to do is build a page with a lookup control and two grids and wanted to filter the data in the first grid based on the selected lookup item and also filter the data in the second grid based on the record selected in the first grid. This is very similar to the "Multiple Lookups" sample except that grids are used instead of lookup controls. This sample demonstrates the following:

How to refresh a grid when the user selects an item in a lookup control
How to refresh a "detail" grid when the user selects a record in the "header" grid

Installation

Step 1 – Edit ISV.config This sample must be added as a new link under a “top level” menu (i.e.: a pull down menu on the top menu bar at the top of the main CRM window). Therefore we need to edit the “CustomMenus” section in Microsoft CRM’s ISV.config file like so:

[code]<Menu Title="Testing c360 SDK">

<MenuItem Title="Lookup with linked grids"

Url="http://localhost:5517/c360Sdk/Samples/LookupWithLinkedGrids/LookupWithLinkedGrids.aspx"

WinMode="0"

Client="Web,OutlookWorkstationClient"

AvailableOffline="false" />

</Menu>[/code]

Note: you will need to adjust the url in the above sample to match your environment.

Step 2 – Copy files In your Visual Studio 2005 project, make sure you have a folder called “Samples” and create a sub-folder called “LookupWithLinkedGrids”. In this new folder, copy the ASPX page and its corresponding code behind file:

LookupWithLinkedGrids.aspx
LookupWithLinkedGrids.aspx.cs

Screenshots

All Controls

Jeremie Desautels — Mon, 02 Oct 2006 21:45:52 GMT

Overview

This very simple sample includes one of every c360 web control on one page. This sample is great to get familiar with all the controls included in the SDK. This sample demonstrates the following:

Edit page to enfore the CRM look and feel but hide the menu bar and button bar
Use a ‘LeftNav’ control to mimic the Microsoft left navigation menu
Use the ‘TabBar’ control to mimic the Microsoft CRM tabs on the edit page
Insert one of every type of c360 control in one of the tabs

Installation

[code]<Menu Title="Testing c360 SDK">

<MenuItem Title="All Controls"

Url="http://localhost:5517/c360Sdk/Samples/AllControls/AllControls.aspx"

WinMode="0"

Client="Web,OutlookWorkstationClient"

AvailableOffline="false" />

</Menu>[/code]

Note: you will need to adjust the url in the above sample to match your environment.

Step 2 – Copy files In your Visual Studio 2005 project, make sure you have a folder called “Samples” and create a sub-folder called “AllControls”. In this new folder, copy the ASPX page and its corresponding code behind file:

AllControls.aspx
AllControls.aspx.cs

Screenshots

Grid Preferences

Jeremie Desautels — Tue, 17 Oct 2006 14:32:10 GMT

Overview

The goal of this sample is to demonstrate how the GridPreferences control can be used in conjuction with a Grid to allow the end-user to select the fields he or she wants to see. Furthermore, this sample also demonstrates how to preserve user preference and how to subsequently retrieve them.

This sample demonstrates the following:

Use a Save dialog page to present the GridPreferences control.
Read metadata about an entity and display the list of fields in the GridPreferences control.
Save the user selections
Use an AreaPage to display a standard grid
Retrieve the user preferences and display only the selected fields in the Grid

Installation

Step 1 – Edit ISV.config

This sample must be added as a new link under a “top level” menu (i.e.: a pull down menu on the top menu bar at the top of the main CRM window). Therefore we need to edit the “CustomMenus” section in Microsoft CRM’s ISV.config file like so:
<Menu Title="Testing c360 SDK">
<MenuItem Title="Grid Preferences" Url="http://localhost:5517/c360Sdk/Samples/GridPreferences/Grid.aspx" WinMode="0" Client="Web,OutlookWorkstationClient" AvailableOffline="false" />
</Menu>

Note: you will need to adjust the url in the above sample to match your environment.

Step 2 – Copy files

In your Visual Studio 2005 project, make sure you have a folder called “Samples” and create a sub-folder called “GridPreferences”.

In this new folder, copy the image, the two ASPX page and their corresponding code behind files:

18_settings.gif
Grid.aspx
Grid.aspx.cs
GridPreferences.aspx
GridPreferences.aspx.cs

There is also one file included in this sample that must be copied to the App_Code folder in your solution:
GridPreferences.cs

Screenshots

Multiple Lookups

Jeremie Desautels — Mon, 30 Oct 2006 22:41:16 GMT

This sample is based on a suggestion by John Marx.

Overview

The goal of this sample is to demonstrate how you can have multiple lookup controls on one page and make the second control dependant on the value selected in the first control and make the third controls dependant on the value selected in the second control. Initially, only the first control is enabled, but when you select a record the second control becomes available and the third control becomes available when you make a selection in the second one. In this sample, the user will be prompted to select a territory. When he makes his selection, he will be able to select only accounts in this territory and when he selects an account, he will be able to select contacts who are linked to this account. This sample demonstrates the following: Use three Lookup controls to allow searching for Territory, Account and Contact Client-side event handler to execute code when a value is selected in a lookup control.

Installation

Step 1 – Edit ISV.config

This sample must be added as a new link under a “top level” menu (i.e.: a pull down menu on the top menu bar at the top of the main CRM window). Therefore we need to edit the “CustomMenus” section in Microsoft CRM’s ISV.config file like so:
<Menu Title="Testing c360 SDK">
<MenuItem Title="Multiple Lookups" Url="http://localhost:5517/c360Sdk/Samples/MultipleLookups/MultipleLoookups.aspx" WinMode="0" Client="Web,OutlookWorkstationClient" AvailableOffline="false" />
</Menu>

Note: you will need to adjust the url in the above sample to match your environment.

Step 2 – Copy files

In your Visual Studio 2005 project, make sure you have a folder called “Samples” and create a sub-folder called “MultipleLookups”.

Copy the ASPX page and its corresponding code behind file:

MultipleLookups.aspx
MultipleLookups.aspx.cs

Screenshots

'ExternalLink' column type

Jeremie Desautels — Mon, 30 Oct 2006 14:11:44 GMT

This sample shows you how to use the new "ExternalLink" grid column type in release 3.0.7.

WARNING: this sample does not work with release 3.0.6 or older.

This new column type allows you to have a column in your grid that users can click on to open a popup window and redirect them to a URL of your choice.

When you pass a DataTable to the grid, you unfortunately do not have a lot of control and the only thing you can do is specify the URL of the link. The attached exercice 4.3e demonstrates this simple situation. Here's a screenshot:

However, when you pass a "resultset", you have more flexibility and you can not only control the URL but also the caption visible in the grid, the height and width of the popup window, the 'name' of the window (this is important if you want links to reuse the same window or open in different windows) and you can also specify additionnal parameters such as:

do you want the status bar to be visible?
do you want the menu bar to be visible?
etc.

The attached exercise 4.3f demonstrates this more advanced situation. Here's a screenshot:

User preferences

Jeremie Desautels — Wed, 11 Oct 2006 15:51:02 GMT

In Microsoft CRM, users have a certain number of personal settings they can update. An example of a user setting is the number of records per page the user wants to see in a grid. However there is an important limitation associated with user settings: developers cannot add new ones for their own purpose.

Our SDK solves this problem by allowing you to save and read User Preferences (we call them 'preferences' to prevent any confusion with the 'settings'). The preferences are loaded and cached in memory and therefore are very fast to access. However, because they are in memory, I recommended that you use it only for a few small values and not for storing large amount of data. Just be reasonable! ;)

There are three methods that you can use to read and save preferences:

GetPreference(preferenceName)
RemovePreference(preferenceName)
SetPreference(preferenceName, preferenceValue)

Here are examples:

[code]Instance.CurrentUser.SetPreference("FavoriteColor", "Green");

string favoriteColor = Instance.CurrentUser.GetPreference("FavoriteColor");

Instance.CurrentUser.RemovePreference("FavoriteColor");[/code]

Behind the scenes, the preferences are saved in small XML files in a folder called 'UserPreferences' off of the root of your solution. I have noticed that this folder is not included in the current release of the SDK. I will make sure that this is corrected in the next release but in the mean time, you will need to create it manually.

IMPORTANT: Since each user will be updating their preference XML file, you need to make sure that you grant your users the ability to read and write in this folder.

Google map

Jeremie Desautels — Mon, 02 Oct 2006 22:16:27 GMT

Overview

The goal of this sample is to display a map of the area where an account or contact is located. Also, in the case of an order, we want to display directions to get to the delivery destination. (Please note that the starting address for the directions has be set to c360 Solutions' main office in Atlanta, but feel free to change it to your own address).

This sample demonstrates the following:

Fetch data about the current account or order
Redirect the user to Google map and pass the information expected by Google in order to be able to display a map

Installation

Step 1 – Edit ISV.config

This sample must be added as a new link on the left navigation bar of the Microsoft CRM account edit screen and the order edit screen as well. Therefore we need to edit the “account” and the “salesorder” entity sections in Microsoft CRM’s ISV.config file like so:

[code]<ENTITY name="account">

<NAVBARITEM id=googleMap

title="Google map"

Url="http://localhost:4589/c360Sdk/Samples/GoogleMap/GoogleMap.aspx"

Icon="http://localhost:4589/c360Sdk/Samples/GoogleMap/GoogleMap.jpg" />

</NAVBAR>

</ENTITY>

<NAVBARITEM id=googleMap

title="Google map"

Url="http://localhost:4589/c360Sdk/Samples/GoogleMap/GoogleMap.aspx"

Icon="http://localhost:4589/c360Sdk/Samples/GoogleMap/GoogleMap.jpg" />

</NAVBAR>

</ENTITY>[/code]

Note: you will need to adjust the url in the above sample to match your environment.

Step 2 – Copy files

In your Visual Studio 2005 project, make sure you have a folder called “Samples” and create a sub-folder called “GoogleMap”. In this new folder, copy the image, the ASPX page and it’s corresponding code behind file:

GoogleMap.jpg
GoogleMap.aspx
GoogleMap.aspx.cs

Screenshots

Stock Price

Jeremie Desautels — Mon, 02 Oct 2006 22:49:49 GMT

Overview

The goal of this sample is to display stock market information for publicly traded companies. This sample demonstrates the following:

Fetch the stock symbol of the current account
Redirect the user to Google finance and pass the information expected by Google in order to be able to display the financial information.

Installation

Step 1 – Edit ISV.config

This sample must be added as a new link on the left navigation bar of the Microsoft CRM account edit screen. Therefore we need to edit the “account” entity section in Microsoft CRM’s ISV.config file like so:

[code]<ENTITY name="account">

<NAVBARITEM id=stockPrice

title="Stock Price"

Url="http://localhost:4589/c360Sdk/Samples/StockPrice/StockPrice.aspx"

Icon=" /_imgs/ico_16_salesprocess.gif" />

</NAVBAR>

</ENTITY>[/code]

Note: you will need to adjust the url in the above sample to match your environment.

Step 2 – Copy files

In your Visual Studio 2005 project, make sure you have a folder called “Samples” and create a sub-folder called “StockPrice”. In this new folder, the ASPX page and its corresponding code behind file:

StockPrice.aspx
StickPrice.aspx.cs

Screenshots

Investment Accounts

Jeremie Desautels — Mon, 02 Oct 2006 22:40:42 GMT

Overview

The goal of this sample is manage “investment accounts” related to CRM contacts. This information is maintained in an external database and we want to display the data in a grid at the contact level. We wan to be able to create new record, delete and update existing ones. This sample demonstrates the following:

List records from an external database in a grid
Add a “CustomAction” to a grid (the “delete” action)
Use an “ActionPage” to implement the custom action
Implement a custom “DoubleClickHandler” in a grid
Use an “Edit” page to create new records and update existing ones

Installation

Step 1 – Edit ISV.config

This sample must be added as a new link on the left navigation bar of the Microsoft CRM contact edit screen . Therefore we need to edit the “contact” entity section in Microsoft CRM’s ISV.config file like so: Note: you will need to adjust the url in the above sample to match your environment.

Step 2 – Copy files

In your Visual Studio 2005 project, make sure you have a folder called “Samples” and create a sub-folder called “InvestmentAccounts”. In this new folder, copy the four ASPX pages and their corresponding code behind files:

Delete.aspx
Investment.aspx
Investments.aspx
InvestmentsFetchData.aspx

There are also three files included in this sample that must be copied to the App_Code folder in your solution:

InvestmentAccount.cs
SqlHelper.cs
Util.cs

Step 3 – Create the sample database

For your convenience, a SQL script called “CreateSampleDatabase.sql” is included with our samples to help you create the database but you can also choose to create it manually if you prefer. If you decide to create it manually, make sure to name it “c360SdkSamples”.

Step 4 – Create the table in the sample database

For you convenience, we have included a SQL script file called “CreateInvestmentAccountsTable.sql” to create this table and all the required fields.

Step 5 – Update the connection string

In you project’s web.config add the following:

[code]<CONNECTIONSTRINGS>

<ADD name="c360SdkSamples"

providerName="System.Data.SqlClient"

connectionString="Data Source=(local);database=c360SdkSamples;Integrated Security=True;" />

</CONNECTIONSTRINGS>[/code]

Make sure to edit this connection string to match your environment.

Screenshots

Google news

Jeremie Desautels — Mon, 02 Oct 2006 22:25:50 GMT

Overview

The goal of this sample is to fetch and display news articles related to an account. This sample demonstrates the following: · Fetch data about the current account

Fetch news articles from Google’s RSS news feed
Display the articles

Installation

Step 1 – Edit ISV.config This sample must be added as a new link on the left navigation bar of the Microsoft CRM account edit screen. Therefore we need to edit the “account” entity section in Microsoft CRM’s ISV.config file like so:

[code]<ENTITY name="account">

<NAVBARITEM id=googleNews

title="Google news"

Url="http://localhost:4589/c360Sdk/Samples/GoogleNews/GoogleNews.aspx"

Icon="http://localhost:4589/c360Sdk/Samples/GoogleNews/GoogleNews.gif" />

</NAVBAR>

</ENTITY>[/code]

Note: you will need to adjust the url in the above sample to match your environment.

Step 2 – Copy files In your Visual Studio 2005 project, make sure you have a folder called “Samples” and create a sub-folder called “GooleNews”. In this new folder, copy the image, the ASPX page and it’s corresponding code behind file:

GoogleNews.gif
GoogleNews.aspx
GoogleNews.aspx.cs

Screenshots