Ektron CMS400.Net Reference

>>Using Other Development Frameworks > CustomJSPFunctions

Custom JSP Functions

Important: As of 8.01 SP2, the platforms/JSP folder is installed to the program files/Ektron/utilities folder. In order for JSP platform support to function, move the platforms/JSP folder to the Workarea folder and configure it.
Previously, the platforms folder was installed to the Workarea folder by default.

Ektron CMS400.NET maintains and displays content via custom Ektron JSP functions. For the custom JSP functions to work properly, do the following:

In the applicationapi.jsp file, set the WSSoap_address. The applicationapi.jsp file is located by default in:

http://localhost/siteroot/WorkArea/platforms/JSP/applicationapi.jsp

Warning! ContentWS.asmx is the web services file that the custom JSP functions use to talk to Ektron CMS400.NET. The WSSoap_address located in the applicationapi.jsp file must be set to location of the Web services file. The default WSSoap_address is http://localhost/siteroot/WorkArea/WebServices/ContentWS.asmx. If you have changed the location of ContentWS.asmx you need to update the WSSoap_address. For example, if your site is www.example.com, the WSSoap_address would be http://www.example.com/WorkArea/WebServices/ContentWS.asmx.

Add the following line to the top of each template.

<%@ include file=”applicationapi.jsp” %>

This file calls the Ektron custom functions file to allow the page to function properly. It must appear at the top of the template file.

Make sure the contentws.jar file is included in your JSP environment

Ektron recommends running Axis when using a JSP environment. We have tested on TomCat and JRUN with Axis v1.2.1. You can download Axis from http://ws.apache.org/axis/java/.

To customize your Ektron CMS400.NET application, you need to be familiar with these functions.

Function

Description

More Information

Calendar Functions

Calendar

Displays a calendar with different display types.

For example, a daily view calendar.

Calendar Function

Event Calendar

Displays a month view event calendar

Event Calendar Function

Collection Functions

Collection

Displays links generated by collections

Collection Function

CollectionXML

Creates XML for a collection by wrapping tags around all of the collection items and their properties. This allows you to use an XSLT to define how the XML collection is displayed.

XML Collection Function

Random Content

Randomly displays the content of a collection item

Random Content Function

Random Summary

Randomly displays the summary of a collection item

Random Summary Function

RSS Collection

Creates an RSS feed out of the items in a collection.

RSS Collection Function

Content Functions

Add Content

Allows a user to add content to Ektron CMS400.NET programmatically.

Add Content

Content Block

Displays and manages a content block

Content Block Function

Form

Displays a content block associated with a form

Form Function

Language Functions

Language Select

Lets a site visitor select a language in which to view site.

Language Select Function

Login Functions

Login

Adds the login or logout button

Login Function

Menu Functions

DropHTMLMenu

Used to display a DHTML menu

DHTML Menus

GenerateMenu

Works with DropHTMLMenu to display DHTML menus.

DHTML Menus

XML Menu

Creates XML for a menu by wrapping tags around all of the menu items properties.

XML Menu Function

Metadata Functions

Metadata

Displays the metadata for the current Web page.

Metadata Function

Search Functions

Search

Inserts a text box with a search button.

Search Function

Search Display

Creates an area to display search results.

Search Display Function

Summary Functions

List Summary

Displays a list of content block summaries.

List Summary Function

List Summary XML

Creates XML for a list summary by wrapping tags around all of the collection items and their properties. This allows you to use an XSLT to define how the XML collection is displayed.

XML List Summary Function

RSS List Summary

Creates an RSS feed out of the items in a list summary.

RSS List Summary Function

Single Summary

Displays the summary for a content block.

Single Summary Function


Visit the Ektron Dev Center at http://dev.ektron.com 1-866 - 4 - EKTRON

Ektron CMS400.NET Reference Version 8.02 SP1 Rev 1

Ektron Documentation,© 2011 Ektron, Inc.