SAS 9.1.3 Integration Technologies » SAS Web Infrastructure Kit: Developer's Guide


Developing Custom Portlets
Development Steps
Creating a Deployment Descriptor
Creating Display Resources Files
Developing the Presentation JSP Page
Creating Action Classes
Implementing Portlet Help
Creating a PAR File
Use Cases
Simple Display Portlet
Localized Portlet
Portlet Template (Editable Portlet)
Remote Portlet
Tips and Best Practices
Using the Portlet API
Sample Portlets
Localized Display Portlet (Welcome)
Interactive Form Portlet (FormExample)
Portlet Template, or Editable Portlet (DisplayURL)
Web Application (HelloUserWikExample)
Remote Portlet (HelloUserRemote
Portlet
Sample: Web Application (HelloUserWikExample)

Step 2: Make Deployment Configurations Available for Local and Remote Services

The HelloUserWikExample application requires access to both local and remote services. The way that you provide this access depends on which service deployment configuration option was selected when your portal Web application was installed. There are two methods for providing access:

Use the appropriate procedure for your installation.

Note: In SAS 9.1.2 Integration Technologies and subsequent releases, the Web Infrastructure Kit supports the use of either XML files or a SAS Metadata Server to store service deployment configurations. In SAS 9.1 Integration Technologies, the Web Infrastructure Kit supports only the use of XML files to store service deployment configurations. For more information, see Service Deployment Configurations in the "Foundation Services and WebDAV Server Deployment" chapter in the SAS Intelligence Platform: Web Application Administration Guide.

Using the SAS Metadata Server to Store Local and Remote Service Deployment Configurations

If you are using the SAS Metadata Server to store local and remote service deployment configurations, then you must create a local services deployment on the SAS Metadata Server for the HelloUserWikExample application.

In addition, you must create a local services properties file (sas_metadata_source_client.properties) and a remote services properties file (sas_metadata_source_server.properties) for the HelloUserWikExample application. These files tell the application where to find the configuration information. The files must be placed in the path /WEB-INF/conf in the Web application's directory structure.

To create the local services deployment and the properties files, you can do the following:

  1. Use SAS Management Console to create a local services deployment for the HelloUserWikExample application. For instructions, see Defining Service Deployments in the SAS Integration Technologies: Administrator's Guide.

  2. Copy the portal Web application's local services properties file (sas_metadata_source_client.properties) to a separate file with the same name.

  3. Copy the portal Web application's remote services properties file (sas_metadata_source_server.properties) to a separate file with the same name.

  4. Place the new files in the path /WEB-INF/conf in the HelloUserWikExample application's directory structure.

Here is a sample of a local services properties file for an installation that uses a SAS Metadata Server:

software_component=ID Portal Local Services
deployment_group_1=BIP Local Services OMR

omr_host=hostname.na.abc.com
omr_port=8561
omr_user=hostname\\saswbadm
omr_password=Admin123
omr_repository=Foundation

Note: If you copy this sample file, be sure to update it with the correct values for your installation.

Using XML Files to Store Local and Remote Service Deployment Configurations

If you are using XML files to store local and remote service deployment configurations, then the following files are required to enable access to the services: a local services deployment definition, a local services properties file, a remote services deployment definition, and a remote services properties files. Use these steps to create the files:

  1. Create a definition file for local services deployment for the HelloUserWikExample application. The definition file must be installed in the SAS Foundation Services directory on the machine on which the HelloUserWikExample application will be installed. The contents of the HelloUserWikExample application's local services deployment definition can be exactly the same as the definition that is used by the portal Web application. The portal Web application's local deployment definition is called sas_services_idp_local_omr.xml and it can generally can be found in the following path:

    C:\SAS\BIEntServerMin\Lev1\web\Deployments\

    Use these steps to create the local services deployment definition:

    1. On the machine on which the portal Web application is installed, copy the portal Web application's local deployment definition file (sas_services_idp_local_omr.xml) to a separate file. Give the new file a different name (for example, sas_services_hellouser_local_omr.xml).

    2. If you are installing the HelloUserWikExample application on a different machine than the portal Web application, and if SAS Foundation Services is not installed on this machine, then create the following directory structure on the machine on which the HelloUserWikExample application will be installed: C:\SAS\BIEntServerMin\Lev1\web\Deployments\. (Note: It is not necessary to install SAS Foundation Services on this machine.)

    3. On the machine on which the HelloUserWikExample application will be installed, create a new directory under C:\SAS\BIEntServerMin\Lev1\web\Deployments\. For example:

      C:\SAS\BIEntServerMin\Lev1\web\Deployments\HelloUserWikExample\

      Then place the new deployment definition file in the new directory.

      Note: As a best practice, Web applications should not share the same local services deployment definition. Therefore, you should follow these steps even if the HelloUserWikExample application will be installed on the same machine as the portal Web application.

  2. Create a local services properties file (sas_metadata_source_client.properties), which tells the HelloUserWikExample application where to find the configuration information for local service deployment. This file must be placed in the path /WEB-INF/conf in the Web application's directory structure.

    To create this file, you can do the following:

    1. Copy the portal Web application's local services properties file (sas_metadata_source_client.properties) to a separate file with the same name.

    2. Edit the new file to specify a URL with the actual location and file name of the local services deployment definition that you created for the HelloUserWikExample application.

    3. Place the new file in the path /WEB-INF/conf in the HelloUserWikExample application's directory structure.

      Here is a sample of a local services properties file for an installation that uses XML files for the deployment configuration:

      software_component=ID Portal Local Services
      deployment_group_1=BIP Local Services OMR
      
      type=URL
      url=file:///C:/SAS/BIEntServerMin/Lev1/web/Deployments/
          HelloUserWikExample/sas_services_hellouser_local_omr.xml

      Note: The line breaks in the url property statement are for display purposes only. If you copy this example into your properties file, then you must put the entire statement on one line. In addition, be sure to update the URL with the actual location and file name of the local services deployment definition that you created for the HelloUserWikExample application.

  3. The HelloUserWikExample application requires a definition file for remote services deployment.

    If the HelloUserWikExample application will be installed on the same machine as the portal Web application, then it can use the same remote services deployment definition (sas_services_idp_remote_omr.xml) that the portal Web application uses. It is not necessary, nor is it recommended, to make another copy of this file for the HelloUserWikExample application.

    If the HelloUserWikExample application will be installed on a different machine from the portal Web application, then follow these steps to create the remote services deployment definition:

    1. On the machine on which the portal Web application is installed, copy the portal Web application's remote deployment definition file (sas_services_idp_remote_omr.xml) to a separate file with the same name.

    2. On the machine on which the HelloUserWikExample application will be installed, place the new deployment definition file in the directory in which the new local deployment definition file is located. For example:

      C:\SAS\BIEntServerMin\Lev1\web\Deployments\HelloUserWikExample\
      
  4. Create a remote services properties file (sas_metadata_source_server.properties), which tells the HelloUserWikExample application where to find the definition file for the remote services. The file must be placed in the path /WEB-INF/conf in the HelloUserWikExample application's directory structure.

    To create this file, you can do the following:

    1. Copy the portal Web application's remote services properties file (sas_metadata_source_server.properties) to a separate file with the same name.

    2. If necessary, edit the new file to specify a URL with the actual location and file name of the remote services deployment definition that you created for the HelloUserWikExample application. If these are the same as that used by the portal Web application, then you can skip this step.

    3. Place the new file in the path /WEB-INF/conf in the HelloUserWikExample application's directory structure.

      Here is a sample of a remote services properties file for an installation that uses XML files for the deployment configurations:

      software_component=Remote Services
      deployment_group_1=BIP Remote Services OMR
      
      type=URL
      url=file:///C:/SAS/BIEntServerMin/Lev1/web/Deployments/
          RemoteServices/sas_services_idp_remote_omr.xml
      

      Note: The line breaks in the url property statement are for display purposes only. If you copy this example into your properties file, you must put the entire statement on one line. In addition, be sure that the URL contains the actual location of your remote services deployment file.