Copying a portlet

PDF on how to copy a portlet : JAM 2008 presentation

Steps to install a portlet

JICS Wiki : Installing Portlets page
JICS Wiki : Generating LDIF Files page

1. Copy .ascx files to portlet .ascx directory on web server
2. Copy .dll assembly to portlet /bin directory on server
3. Modify FWK_Globalization (?)
   
4. Make database table and stored procedure changes (?)
   
5. Add a Portlet Template definition to ADAM using an LDIF file
6. If this is a secured portlet, sync global operations (?)
   
7. Restart IIS
   

Steps to code a portlet

Steps to create a portlet - jics wiki

1. Create a class library project, and set a bunch of custom settings

• Change the assembly name (see assembly naming conventions)
  
• Set a post-build event that copies the compiled files into the correct directories (see directory naming conventions)
  
• Enable debugging
  
• Add reference to Jenzabar.Portal.Framework.Web
  

2. Create a C# class that inherits from PortletBase, which contains a GetCurrentScreen() function.

• Ordinary portlets inherit from PortletBase
• Secured portlets inherit from SecuredPortletBase
• GetCurrentScreen() determines which view will be loaded when the portlet loads.
  

3. Create a user control for each view you want to use for your portlet

• Required views are Default_view and Main_view
• Each usercontrol inherits from the C# base class you created earlier.
• Ordinary portlets inherit from PortletBase
• Secured portlets inherit from SecuredPortletBase

JICS : LDIF files and ADAM

When a portlet is installed, we have to stick some data into ADAM so JICS knows that our portlet exists.

Related pages :

http://www.jicswiki.com/index.php?title=GeneratingLDIFFiles
http://www.jicswiki.com/index.php?title=InstallingPortlets

JICS : ASCX pages

With web controls, you have an .ascx page that defines how things look, and a .dll file that contains the code for the page. The info below is gleaned from JICS Portlet Creation page

Create a different .ascx file for each view.

There are two required views. Default_View, and Main_View. The ascx files for these must be located in Default_View.ascx and Main_View.ascx.

All the .ascx files for the portlet go in their own directory on the server

Every portlet has it's own directory. That directory goes in [Type]\Portal\Portlets\CUS\[Portlet name]. For more info on this directory, see "Naming Conventions"

All the .dll files for all portlets go in one directory

That directory is \Portal\bin

Question : How does the system know where our portlet's .ascx files are located?

Question : Can we build a portlet that has all the web controls defined in the .dll, and doesn't have an .ascx page?

Question : It looks like there are add-ons, such as LMS and CRM, that have their own portal directories. Do LMS portlet dll's go in LMS\Portal\bin, or is there a master \Portal\bin where all the data goes?

JICS Naming Conventions

Naming standard page : JICS Wiki

Portlets should be named :

[Two character ERP type] + [Short description] + [Institution Name]

Tables should be named :

"CUS_" + [Portlet name] + [table description]

Assemblies should be named :

"Portlet." + [Portlet name]

Root directory for .ascx files should be :

"\Portlets\CUS\" + [User-defined Subdirectory (optional)] + [Portlet name]

Question : Why are they removing the word 'portlet' from directory, namespace, and class names, but leaving it there for assembly / dll names?