Maximizer CRM Customization Suite
Maximizer CRM Web Following Grid Integration Framework Sample
RELEASE NOTES
Version 2020 R1
June 10th, 2020
IMPORTANT - Please read this documentation carefully
before installing, using, or uninstalling
this sample.
This sample demonstrates how to implement the equivalent
of the Business Partner View .NET sample (video store) in
Maximizer Web Access using the Maximizer CRM Web Following Grid
Integration Framework.
This sample code has been developed and compiled in
Microsoft Visual Studio 2010 using C#.
For more information about creating custom following tabs in Web
Access, refer to the Maximizer CRM Customization Suite -
Volume II.
The instructions below assume Maximizer has been installed
to the default location (...\Program Files\Maximizer) on
your machine. If Maximizer is installed to a different
location, alter the specified folder paths accordingly.
Contents
- Configuring the Following Grid Integration Framework Sample
- Building the Following Grid Integration Framework Sample
- Deploying the Following Grid Integration Framework Sample
- Debugging the Following Grid Integration Framework Sample
Configuring the Maximizer CRM Web Following Grid Integration Framework Sample
- In Microsoft Internet Information Services (IIS) Manager, create a new
application pointing to the ..\Program Files\Maximizer\Samples\WebGridFramework\VideoStoreService
folder. Refer to your IIS documentation for information on how to set up a new application.
- In Microsoft SQL Server, create a new database to use for the sample data, and run all of the
following scripts against the database:
The scripts in the ..\Program Files\Maximizer\Samples\WebGridFramework\Database Creation Scripts\01_Table
folder create the tables used by the sample.
- 01_[dbo].[tblGenre]_Create
- 02_[dbo].[tblPrice]_Create
- 03_[dbo].[tblRating]_Create
- 04_[dbo].[tblVideo]_Create
- 05_[dbo].[tblVideoStoreColumnSettings]_Create
The scripts in the ..\Program Files\Maximizer\Samples\WebGridFramework\Database Creation Scripts\02_Data
folder populate the tables with the data used by the sample.
- 01_[dbo].[tblVideoStoreColumnSettings]_Insert
- 02_[dbo].[tblGenre_Insert]
- 03_[dbo].[tblPrice_Insert]
- 04_[dbo].[tblRating_Insert]
- 05_[dbo].[tblVideo_Insert]
The scripts in the ..\Program Files\Maximizer\Samples\WebGridFramework\Database Creation Scripts\03_StoredProcedures
folder create the stored procedures used by the sample.
- 01_[dbo].[CheckTagID_IsExist]_Create
- 02_[dbo].[GetRandom_TagID]_Create
- 03_[dbo].[Video_Delete]_Create
- 04_[dbo].[Video_Insert]_Create
- 05_[dbo].[Video_Update]_Create
Refer to your SQL Server documentation for information on how to create databases
and run SQL scripts.
Building the Maximizer CRM Web Following Grid Integration Framework Sample
This sample can be built using Visual Studio 2010 or later.
- In Visual Studio, open the VideoStoreService.csproj project in the following folder:
...\Program Files\Maximizer\Samples\WebAPIGridFramework\VideoStoreService
- Open the VideoStoreControl.xml file, and replace [SERVER NAME] with the
name of the IIS server where you created the VideoStoreService application in each of
the URLs in the file.
- Open the Web.config file, and update the following application settings:
- VideoStoreServiceUrl - Replace [IIS SERVER NAME] with the name
of the IIS server where you created the VideoStoreService application.
- MaximizerServer - Replace [SQL SERVER NAME] and [DATABASE NAME] with
the name of the SQL Server and Database where you created the Video Store sample database,
and replace [SQL USER ID] and [SQL USER PASSOWRD] with the credentials of a SQL Server login that has sufficient
rights to read and update the sample database.
- Build the project.
Deploying the Maximizer CRM Web Following Grid Integration Framework Sample
- Add the following entry to the <followingWindowSet id="for-ab"> element in the
..\Program Files\Maximizer\Portals\Employee\Config\followingWindowSets.xml file, where [SERVER NAME]
is the name of the IIS server where you created the VideoStoreService application:
<tab id="VideoStore">
<title>Videos(Net)</title>
<url>../../mvc/CustomGrid/FollowingTab/CustomGrid</url>
<serviceURL>http://[SERVER NAME]/VideoStoreService/VideoStoreService.svc</serviceURL>
<visible>Yes</visible>
</tab>
The Video Store tab will appear in the Address Book following pane the next
time you log in to Web Access.
Debugging the Maximizer CRM Web Following Grid Integration Framework Sample
- Open the VideoStoreService.csproj project in Visual Studio.
- Open the properties for the project (click Project > VideoStoreService Properties...) and select the Web tab.
- Select the web server you would like to use to debug your application; the Visual Studio Development Server is selected by default.
Make a note of the URL where the web server you are using is located.
- Open the Web.config file, and replace [IIS SERVER NAME] with the URL of the web server you selected above.
- Update the serviceURL tag that you added to the followingWindowSets.xml file when deploying the service in section 3,
and replace [SERVER NAME] with the URL of the web server you selected above.
- Open the VideoStoreService.svc.cs file, and set one or more breakpoints in the web service methods where you would like
to begin debugging the application. The Initialize, GetColumns, and GetRows methods are the first methods
to be called when the custom following tab is first loaded and populated with data, so these methods make a good starting point for
debugging the application. The other methods are typically called in response to user actions.
- Press F5 or click the Start Debugging button in the Visual Studio toolbar to start the web service.
The next time you log in to Web Access and interact with the Video Store tab, the web service methods running on your
development server will be called and will allow you to debug the project.