Portlet Show Modes Guidelines for Creating PLSQL Portlets

8-4 Oracle Fusion Middleware Developers Guide for Oracle Portal some additional guidelines. The guidelines for mobile portlets are described fully in Section 6.1.4, Guidelines for Mobile Portlets . For information on how to build mobile-enabled portlets, refer to Section 8.12, Enhancing Portlets for Mobile Devices .

8.2 Building PLSQL Portlets with the PLSQL Generator

To facilitate the development of database providers and PLSQL portlets, you can use the PLSQL Generator, a utility that creates installable PLSQL code for a database provider and its portlets. The PLSQL Generator is a standalone Web application that receives the provider and portlet definitions in the form of an XML file similar in format to the provider.xml file. The XML tags used for the provider and portlet definition are a subset of the XML tags used for defining Web providers with PDK-Java. The output of the PLSQL Generator is a SQL script that can be run from SQLPlus. The script contains SQL commands for installing the provider and portlet packages in the correct order. You can download the PLSQL Generator along with its installation instructions from: http:www.oracle.comtechnologyproductsiasportalfilesplsqlgenerat or.zip The general model for working with the PLSQL Generator is as follows: 1. Create an XML file that defines the provider and portlets that you want to build, as described in Section 8.2.1, Creating the Input XML File . 2. Run the PLSQL Generator using the XML file as input, as described in Section 8.2.2, Running the PLSQL Generator . 3. Publish the generated PLSQL portlet, which includes the following steps: ■ Install the provider generated by the PLSQL Generator into the database, as described in Section 8.2.3.1, Installing the Packages in the Database . ■ Register the database provider with the Oracle Application Server, as described in Section 8.2.3.2, Registering the Database Provider . ■ Add the generated portlet to a page, as described in Section 8.2.3.3, Adding Your Portlet to a Page .

8.2.1 Creating the Input XML File

The source XML file starts and ends with the provider and provider tags, and can include one or more portlet definitions. Each portlet definition is bracketed by the portlet and portlet tags. A portlet definition includes the XML tags that specify values for the portlet record attributes and enable the links in the portlet header. For example, the name tag specifies the portlet name in the provider domain and the title tag specifies the portlet display name or title. When set to true, the showEdit tag enables the Edit mode for the portlet and the corresponding link in the portlet header. Table 8–3 lists the available XML tags for PLSQL Generator input. Table 8–3 XML Tags for PLSQL Generator Input XML Tag Definition Value Type provider Encloses provider definition tags. Not applicable portlet Encloses portlet definition tags. Not applicable Creating PLSQL Portlets 8-5 id Specifies the portlet ID in the provider. This value must be unique within the provider. string name Specifies the portlet name. The name should not contain any spaces. The generator uses the information provided in the name tag for the portlet package name. string title Specifies the portlet display name. string shortTitle Specifies the portlet short display name. This tag is useful for mobile portlets. string description Specifies the portlet description. string defaultLocale Specifies the language the portlet renders by default. The value is the two letter ISO language and country codes expressed as language.country. string timeout Specifies the portlets timeout interval in seconds. number timeoutMsg Specifies the message to display when the portlet times out. string showEdit Indicates whether the portlet supports Edit mode, which enables the user to personalize the portlets properties. Boolean showEditDefault Indicates whether the portlet supports the Edit Defaults mode, which enables page administrators to personalize the default values of the portlets properties. Boolean showDetails Indicates whether the portlet can be viewed in Full Screen mode. In this mode, the entire browser window is dedicated to the portlet. Full screen mode enables the portlet to show more details than when it shares the page with other portlets. Boolean showPreview Indicates whether the portlet supports the Preview mode. Boolean hasHelp Indicates whether the portlet supports the Help mode. Boolean hasAbout Indicates whether the portlet supports the About mode. Boolean language Defines the portlets default language for example, en. string contentType Indicates the default content type supported by the portlet. The tag can take one of the following values: wwpro_api_provider.CONTENT_TYPE_HTML wwpro_api_provider.CONTENT_TYPE_XML wwpro_api_provider.CONTENT_TYPE_MOBILE string apiVersion Specifies the version of the Oracle Portal PLSQL API to which the portlet conforms. The value should be wwpro_api_provider.API_VERSION_1. string callIsRunnable Indicates whether OracleAS Portal must check for the users credentials before displaying the portlet. The default value is true. Boolean Table 8–3 Cont. XML Tags for PLSQL Generator Input XML Tag Definition Value Type