User manual SAS DEVELOPING JSR-168-COMPLIANT PORTLETS FOR INFORMATION DELIVERY PORTAL 4.3

[. . . ] Developing JSR-168Compliant Portlets for the SAS Information Delivery Portal 4. 3 ® SAS® Documentation The correct bibliographic citation for this manual is as follows: SAS Institute Inc. Developing JSR-168-Compliant Portlets for the SAS® Information Delivery Portal 4. 3. Developing JSR-168-Compliant Portlets for the SAS® Information Delivery Portal 4. 3 Copyright © 2010, SAS Institute Inc. , Cary, NC, USA All rights reserved. For a hardcopy book: No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, photocopying, or otherwise, without the prior written permission of the publisher, SAS Institute Inc. [. . . ] The value of the title attribute corresponds to the "portlet. description" entry in the locale-specific portletDisplayResources_locale-name. properties file in the portlet's generated PAR file. description specifies the locale-specific description for the portlet. The value of the description attribute corresponds to the "portlet. description" entry in the locale-specific portletDisplayResources_locale-name. properties file in the portlet's generated PAR file. For example, the following file deploys two portlets and specifies localization options for the second portlet: <webapps server-type="websphere" work-dir="c:/temp/pdt-test" > <webapp servlet-context-name="HelloUserJSR168PortletSample" web-app-name="sample. hellouser. jsr168" portlet-ear-file-name="sample. hellouser. jsr168. ear" portlet-ear-file-path="C:/SAS/EBI/Lev1/Web/Staging/sample. hellouser. jsr168. ear" default-supported-portlet-modes="all" > </webapp> <webapp servlet-context-name="HelloUserJSR168PortletSample2" web-app-name="sample2. hellouser. jsr168" portlet-ear-file-name="sample2. hellouser. jsr168. ear" portlet-ear-file-path="C:/SAS/EBI/Lev1/Web/Staging/sample2. hellouser. jsr168. ear" default-supported-portlet-modes="all" > <portlets> <portlet name="HelloUserSample2" supported-portlet-modes="view help"> <locales> <locale name="zh_CN" title="\u4e66\u7b7e" description="\u7528\u6765\u7ba1\u7406\u4e66\u7b7e\u7684 Portlet" /> <locale name="en" title="CheckWindowStateNormalTestPortlet" description="The HelloUserSample 2 portlet" /> </locales> </portlet> </portlets> </webapp> </webapps> Using the Portlet Deployment Tool 11 Execute the PDT Script To execute the PDT with the build. properties file, follow these steps: 1. In a command shell, navigate to the SAS-config-directory/Levn/Web/ Applications/SASBIPortlets<version>/PortletDeploymentTool/ src directory. 2. On Windows, enter the following command: . . \. . \. . \. . \. . \level_env. bat On UNIX, enter the following command: . . /. . /. . /. . /. . /level_env. sh 3. On Windows, enter the following command: . . \. . \. . \. . \. . \. . \Utilities\launchant. bat On UNIX, enter the following command: . . /. . /. . /. . /. . /. . /Utilities/launchant. sh To execute the PDT with the xmlpropfile. xml file, follow these steps: 1. If you do not have Apache Ant on your machine, download it from ant. apache. org and install it by using the instructions from Apache. In a command shell, navigate to the SAS-config-directory/Levn/Web/ Applications/SASBIPortlets<version>/PortletDeploymentTool/ src directory. 3. On Windows, enter the following command: . . \. . \. . \. . \. . \level_env. bat On UNIX, enter the following command: . . /. . /. . /. . /. . /level_env. sh 4. On Windows, enter the following command: ant -lib "%DEPLOYWIZ%"\ant-contrib. jar -lib "%DEPLOYWIZ%"\bsf. jar -lib "%DEPLOYWIZ%"\bsh. jar -Dxmlpropfile=xmlpropfile. xml On UNIX, enter the following command: ant -lib $DEPLOYWIZ/ant-contrib. jar -lib $DEPLOYWIZ/bsf. jar -lib $DEPLOYWIZ/bsh. jar -Dxmlpropfile=xmlpropfile. xml Add Portlets to the BI Portlets Web Application To add your portlets to the BI Portlets Web Application: 1. Stop the Web application server on which the SAS Information Delivery Portal and the BI Portlets Web application are running. 12 Chapter 2 · Tools for Creating JSR-168-Compliant Portlets 2. Specify the parameters for your custom portlet in build. properties or, for multiple portlets, in xmlpropfile. xml. The new portlets are added to the custom content area for the BI Portlets Web application. If you want to add additional portlets, repeat steps 2­3 as needed. Rebuild the BI Portlets and SAS Information Delivery Portal Web applications by using the SAS Deployment Manager. For more information about rebuilding Web applications, see "Rebuilding the SAS Web Applications" in the "Middle-Tier Administration" chapter of the SAS Intelligence Platform: Web Application Administration Guide. Redeploy the SAS Information Delivery Portal and the BI Portlets Web applications. These files are located in the SAS-config-directory/Levn/Web/Staging/ directory. For more information about redeploying Web applications, see "Redeploying the SAS Web Applications" in the "Middle-Tier Administration" chapter of the SAS Intelligence Platform: Web Application Administration Guide. Restart the Web application server on which the SAS Information Delivery Portal is deployed. Remove Custom Portlets from the BI Portlets Web Application If you want to remove any custom portlets that you added previously, follow these steps: 1. Stop the Web application server on which the SAS Information Delivery Portal and the BI Portlets Web application are running. [. . . ] Check the customconfig. log file to ensure that the script completed successfully. Step 11: Load the Portlet into BI Portlets Custom Content Area Use the Portlet Deployment Tool to load the new portlet into the BI Portlets custom content area: 1. the value needs to be the same # as the value of the <context-root> tag in the # META-INF/application. xml file of the portlet ear. # # example: SASBIDashboardJsr168 servlet-context-name=HelloUserJSR168PortletSample # the name of the war file that will be processed inside the portlet # ear. Note that this version of the Portlet Deployment Tool can only # process one war file. [. . . ]