Module Development Print

2.1 Module Framework

•    Create blank solution to in visual studio.

•    Add four class library project in solution
     That is Common, Data Access, Business and Presentation.

•    The type of projects must be class library.

•    Common project contain definition about all the data types.

•    In data access all the logic related to database is implemented.

•    In business we communicate between data access and presentation layer.

•    Place the UserControl and its related code in the presentation layer.

•    If we want to create chat module then framework is as shown in below
 


            Figure-1

•    Provide the Common layer's project as a reference to all three layer project.

•    Provide the data access layer's project as a reference to the business layer project.

•    Provide the business layer's project as a reference to the presentation layer.

•    If you are using WCF services then you must have to add configuration.xml file and create node as shown below in configuration.xml file.

 


 

        Figure-2 


•    Where module name is the name of your module.

•    In Dummy client class you have to pass the name of class (“DummyClient”) which contains the method (“ChatClient”) to host the http server and open p2p client.

•    In P2P Dummy Client Class attribute you have to pass the name of class (“P2PChatDummyClient”) which contains the definition of method (“ChatP2PClient”) that     opens the p2p channel.

•    You can also see the video How to create non collaborative module?

•    You can also see the video How to create collaborative module?

 

2.2 Uploading Module in VMukti

•   Compile your whole solution in visual studio.

•   After successful compilation make one directory having the name of module that is if your module name is chat then the name of directory should be chat. 

 

 

Figure -3 

•    Now as shown in above figure make three directories in main directory. The name of  these directories must be Bal, Control, and Dal.

•    I hope you have created particular module in visual studio as explained in Module Framework.doc and successfully compile it.

•    I would like to explain the whole procedure using chat module as reference. 


 

        Figure - 4

 

•    Now just right click on Chat. Common project and select option “Open Folder in Window Explorer” so that you will be navigated to the root directory of your project as shown in  below figure. 

 


 

    Figure - 5


.     Now navigate to bin/debug directory where you will find “Chat.Common.dll” file. Just     copy this dll and place it in bal directory as created in figure -1.

.    Now same way right click on Chat. DataAccess project in visual studio open it in     windows explorer and navigate to the bin/debug directory and select

•    Chat.Dataccess.dll file, copy it and paste it in Dal folder which is created as shown in figure -1.

•    Open Chat. Business project in windows explorer as explain above navigate to bin/debug folder copy the dll file having name Chat.Bussiness.dll and paste it in bal directory which you have already created.

•    At last copy the Chat.Presentation.dll file by navigating to its root directory and paste it in control folder. Also copy the configuration.xml file from the Chat. Presentation projects root directory and paste it in control directory.

•    If you want to place any icon for your module then you can also keep image file in control directory. The name of image file must be the same as root directory. That is in our case it is “Chat” and extension of image file must be .png.

•    If you have used any third party dll then add this dll in respective folder that is if your business class library project has a reference of any third party dll then add this dll to Bal folder. Same condition must be followed for Common, DataAccess and Presentation class library.

•     Now right click on root folder that is chat in figure -1 and convert it in .zip file so now it would be chat.zip.

•    Now browse and login in to VMukti. As shown in figure-4 click on the setting button on the main panel. 


 

Figure: 6 

 


 

Figure:7

 

•    By clicking setting button one window as figure-5 is popped up. Now click on submit new widget button so that you will have a window for uploading your newly created widget to Vmukti Platform as in figure-6.

•    In filename text box browse to the chat.zip file which you have created as explain above by clicking on browse button. By selecting particular zip file, Zip File textbox is automatically filled.

•    For choosing your assembly file, select the presentation dll of your module and corresponding class name from the dropdown list.

•    Provide appropriate module name which would be seen in module explorer in VMukti Platform.

•    Now provide particular version and description of your module.

•    If you are using WCF services in your module then make it as collaborative by checking “Is Collaborative” Field.

•    If you want to allow each user to use your module without login in VMukti then don’t check the “Need Authentication” checkbox. Mostly non collaborative module do not require authentication.

•    By completing this procedure just click save button to save your module. The message would then be displayed when module is successfully uploaded to VMukti server.

 

 

        Figure: 8


 

        Figure:9

 

•    Now when u will browse VMukti again u can see your module with your specified ModuleName  in module explorer.

•    You can also watch video for uploading user created Module at : How to upload module?