Configuring and Deploying SAS® Web Report Studio

Introduction

This document describes how to configure and deploy SAS Web Report Studio after a basic install.

SAS Web Report Studio can be configured and deployed after either a project install or a basic install. If you are using planning worksheets and SAS project directories, you have performed a project install, in which case this document is not applicable to you.

This document assumes that you have successfully installed SAS Web Report Studio, Java, and your web server.

Information about deploying the SAS Help and Documentation for SAS Web Report Studio can be found in webdocinstalldoc.pdf.

Configuring SAS Web Report Studio for Windows and Tomcat 4.1.18

In the following instructions, wrs.config is assumed to exist in the folder where you installed SAS Web Report Studio. That folder is referred to in the following instructions as the installation folder.

It is also assumed that Java has been correctly installed. To verify that Java has been correctly installed, from the command prompt, execute this command:

java -help

If you do not get usage information for Java, you need to properly install Java.

To configure SAS Web Report Studio, follow these steps:

  1. Optional Step If you need to customize the Java Virtual Machine's startup arguments, you can create a file called local.vm.args in the installation folder. This file, if it exists, is used to override the content of config\vm.args. If you create this file, use config\vm.args as a template and modify the setting of $SUN_WIN_VM_ARGS$ to suit your installation's needs.
  2. In the installation folder, you will find a script called sas.wrs.config.bat. Within the installation folder, execute that script. This will create and populate folders named live, wrsstaging, wrspackaging, and remote, and it will create SASWebReportStudio.war in the installation folder. If this step fails, it will typically be because a required property is not set. In that event, go back to the tool that created wrs.config (either the SAS Web Report Studio installer or SAS Management Console) and create a new wrs.config file and retry this step.

Deploying SAS Web Report Studio for Windows and Tomcat 4.1.18

It is assumed that you have already configured SAS Web Report Studio for Windows and Tomcat 4.1.18 as described in the section above (Configuring SAS Web Report Studio for Windows and Tomcat 4.1.18). It is also assumed that you have set the following environment variables:

  1. JAVA_HOME must be set to where you have Java installed, e.g., c:\j2sdk1.4.1
  2. CATALINA_HOME must be set to where you have Tomcat 4.1.18 installed, e.g., c:\Tomcat4.1.18.

These environment variables should be set using your Windows System Properties' settings. For example, in Windows XP, click on the Start button, then Settings, then Control Panel, then System. Within the System panel, select the Advanced tab and then click on Environment Variables. The environment variables should be set as system variables.

Updating the Tomcat catalina.policy file

Using the editor of your choice, add the contents of either sas.wrs.allpermissions.tomcat.policy or sas.wrs.tomcat.policy (both are found in your installation folder's tomcat subfolder) to the end of the catalina.policy file, which is found in the conf folder of your Tomcat installation. sas.wrs.allpermissions.tomcat.policy is recommended for initial setup of SAS Web Report Studio; sas.wrs.tomcat.policy is recommended for production deployment of SAS Web Report Studio. Use of sas.wrs.allpermissions.tomcat.policy will result in SAS Web Report Studio running without security restrictions. If you reconfigure SAS Web Report Studio, you will need to replace the old SASWebReportStudio permissions with the new ones. Instructions for editing Tomcat's catalina.policy file are contained in the sas.wrs.allpermissions.tomcat.policy and sas.wrs.tomcat.policy files.

Deploying SAS Web Report Studio

Execute the sas.wrs.tomcat.deploy.bat script from your installation folder.

Starting Tomcat

After deploying SASWebReportStudio.war, start Tomcat from the sas.wrs.runtomcat.bat script that you'll find in your installation folder's live subfolder.

Starting SAS Web Report Studio

Start SAS Web Report Studio after starting Tomcat by loading http://localhost:8080/SASWebReportStudio in your web browser, e.g., Internet Explorer.

Undeploying SAS Web Report Studio for Windows and Tomcat 4.1.18

To undeploy SAS Web Report Studio, follow these steps:

  1. Stop Tomcat.
  2. Delete the SASWebReportStudio folder and all of its contents from %CATALINA_HOME%\webapps.
  3. Delete the SASWebReportStudio folder and all of its contents from the Tomcat work\Standalone\localhost folder.
  4. Delete sas.wrs.context.xml from %CATALINA_HOME%\webapps.
  5. In the installation folder, execute the sas.wrs.unconfigure.bat script.

Configuring SAS Web Report Studio for Windows and WebLogic 8.1

In the following instructions, wrs.config is assumed to exist in the folder where you installed SAS Web Report Studio. That folder is referred to in the following instructions as the installation folder.

It is also assumed that Java has been correctly installed. To verify that Java has been correctly installed, from the command prompt, execute this command:

java -help

If you do not get usage information for Java, you need to properly install Java.

To configure SAS Web Report Studio, follow these steps:

  1. Optional Step If you need to customize the Java Virtual Machine's startup arguments, you can create a file called local.vm.args in the installation folder. This file, if it exists, is used to override the content of config\vm.args. If you create this file, use config\vm.args as a template and modify the setting of $SUN_WIN_VM_ARGS$ to suit your installation's needs.
  2. In the installation folder, you will find a script called sas.wrs.config.bat. Within the installation folder, execute that script. This will create and populate folders named live, wrsstaging, wrspackaging, and remote, and it will create SASWebReportStudio.war in the installation folder. If this step fails, it will typically be because a required property is not set. In that event, go back to the tool that created wrs.config (either the SAS Web Report Studio installer or SAS Management Console) and create a new wrs.config file and retry this step.
  3. In the installation folder, you will find a script called sas.wrs.weblogic.prepare.bat. Within the installation folder, execute that script with three parameters:
    1. The WebLogic path (for example, C:\bea\webapps) where you will be deploying SAS Web Report Studio.
    2. A deployment folder (for example, SASWebReportStudio); this folder will be parented to the WebLogic path you specified in the first parameter.
    3. The name of the SAS Web Report Studio war file (typically SASWebReportStudio.war) that you are deploying.



For example:

sas.wrs.weblogic.prepare.bat
C:\bea\webapps SASWebReportStudio SASWebReportStudio.war

The full deployment path is the concatenation of the first two parameters (for example, C:\bea\webapps\SASWebReportStudio). Remember this path, as it must be supplied to WebLogic in step 4 of Deploying SAS Web Report Studio, below.

The WebLogic path must exist before executing the script. The deployment folder will be created under that path if the deployment folder doesn't already exist. If the deployment folder already exists, the script will empty it of all content before deploying the war file.

Deploying SAS Web Report Studio for Windows and WebLogic 8.1

It is assumed that you have already configured SAS Web Report Studio for Windows and WebLogic 8.1 as described in the section above (Configuring SAS Web Report Studio for Windows and WebLogic 8.1). It is also assumed that you have the WebLogic Node Manager Service installed and running.

Creating the Server

Creating a server for SAS Web Report Studio is typically a one-time operation and needs to be done before using SAS Web Report Studio for the first time. If SAS Web Report Studio is being installed with other SAS web applications, you may be able to use the same server that was created for other SAS web applications. If other SAS web applications have been installed and employ the same authentication mechanism as SAS Web Report Studio (metadata server authentication or web authentication), you should not create a separate server for SAS Web Report Studio. Instead, you should use the same server that was created for the other SAS web applications that employ the same authentication mechanism. The steps to creating a server are:

  1. Open the WebLogic Server Console and log in.
  2. In the Domain Configurations section, under Network Configuration, select Servers.
  3. Select Configure a new Server.
  4. Under the General tab, enter the data appropriate to your SAS Web Report Studio server. BE CAREFUL NOT TO REUSE EXISTING PORT NUMBERS FOR THE Listen Port AND SSL Listen Port FIELDS! When finished, click on the Create button. Remember what you entered for the Listen Port field - you will need that to bring up SAS Web Report Studio in your browser. You will also need to remember what you entered in the Name field, as you will need that to control the server. Keep the name field value short - there is a 254 character limit on the server path name, and this field becomes a part of that path name.
  5. Select the Remote Start tab. In the Arguments field, enter the contents of remote_start_win.arguments (found in the live subfolder in the installation folder). In the Security Policy File field, enter the contents of remote_start.security.policy.file (also found in the live subfolder in the installation folder). The contents of remote_start.security.policy.file refer to sas.wrs.allpermissions.weblogic.policy. For production setup of SAS Web Report Studio, change the security policy file entry from ...\live\sas.wrs.allpermissions.weblogic.policy to ...\live\sas.wrs.weblogic.policy. Use of sas.wrs.allpermissions.weblogic.policy will result in SAS Web Report Studio running without security restrictions.
  6. Click on the Apply button.

Starting the Server

The server for SAS Web Report Studio must be started before deploying SAS Web Report Studio. This section assumes that you know the name of your server, referred to as servername in the following steps. The steps to start the server are:

  1. Open the WebLogic Server Console and log in.
  2. In the Domain Configurations section, under Network Configuration, select Servers.
  3. Select the server by name.
  4. Select the Control tab.
  5. Select the Start/Stop tab.
  6. Select the Start this server link.
  7. In answer to the question Are you sure you want to start server servername?, click on the Yes button.
  8. When the Current Status section shows a State of RUNNING and a Status of TASK COMPLETED, the server has successfully started.

Deploying SAS Web Report Studio

SAS Web Report Studio must be deployed before it can be run. As with creating the server, there is a one-time operation to be performed the first time that SAS Web Report Studio is deployed. This operation assumes that you have started the server on which you wish to deploy SAS Web Report Studio. The steps to deploy SAS Web Report Studio for the first time are:

  1. Open the WebLogic Server Console and log in.
  2. In the Domain Configurations section, under Your Deployed Resources, select Web Application Modules.
  3. Select Deploy a new Web Application Module.
  4. Navigate to the folder chosen when you executed the sas.wrs.weblogic.prepare.bat script. Clicking on the links in the Location line takes you up to the folder clicked on; selecting a folder in the table below the Location line takes you down to the selected folder. Select the folder and click on the Target Module button.
  5. In the Independent Servers table, select the server(s) you want to deploy on. This would usually be the server started in the steps listed above (Starting the Server). NEVER SELECT THE SERVER THAT IS RUNNING YOUR ADMIN CONSOLE! When finished selecting the server(s), click on the Continue button.
  6. Under the Source Accessibility heading, select Copy this Web Application module onto every target for me. (This is the default setting). Under the Identity heading, enter the name you want to use to identify SAS Web Report Studio. This name must be unique among the web application modules deployed in WebLogic. Keep the Identity field value short - there is a 254 character limit on the server path name, and this field becomes a part of that path name. Remember this name; you will use it to manage deployment of SAS Web Report Studio. Click on the Deploy button.
  7. The Deploy tab will become active. Wait for the Module Status column to change to Active and the Status of Last Action to change to Success.
  8. Select the Configuration tab.
  9. Select the General tab.
  10. Note the Context Root value. You will need this value to bring up SAS Web Report Studio in your browser.

To deploy SAS Web Report Studio after the first time, such as after stopping and restarting the server, perform the following steps:

  1. Open the WebLogic Server Console and log in.
  2. In the Domain Configurations section, under Your Deployed Resources, select Web Application Modules.
  3. Under the Configuration tab, you will see a table of deployed applications. Click on the link for your deployment of SAS Web Report Studio in the Name column.
  4. Under the Deploy tab, you will see a table showing the status of your deployment. If SAS Web Report Studio is already deployed, you will see Stop and Redeploy buttons in the Actions column; otherwise, you will see a Deploy button in the Actions column. Click on the appropriate button (Redeploy or Deploy).
  5. Wait for the Module Status column to change to Active and the Status of Last Action to change to Success.

Note:

Due to JSP precompilation, it will take several minutes to deploy SAS Web Report Studio. If the delay caused by JSP precompilation is a concern, JSP precompilation may be disabled by editing weblogic.xml, which is found in the WEB-INF folder. To disable JSP precompilation, find the two jsp-param elements whose param-name values are keepgenerated and precompile. Change the param-value for these jsp-param elements from true to false:

 
    <jsp-param>
      <param-name>keepgenerated</param-name>
      <param-value>true</param-value>
    </jsp-param>
    .
    .
    .
    <jsp-param>
      <param-name>precompile</param-name>
      <param-value>true</param-value>
    </jsp-param>
                  

becomes

 
    <jsp-param>
      <param-name>keepgenerated</param-name>
      <param-value>false</param-value>
    </jsp-param>
    .
    .
    .
    <jsp-param>
      <param-name>precompile</param-name>
      <param-value>false</param-value>
    </jsp-param>
                  

Starting SAS Web Report Studio

This section assumes that you have followed the steps listed above to deploy SAS Web Report Studio and that you know the name of the Windows machine that WebLogic is running on (referred to in the next paragraph as machine) and the listen port (referred to in the next paragraph as port), and the context root (referred to in the next paragraph as root). Recall that the listen port was defined when you created the server and that the context root was created when you deployed SAS Web Report Studio.

Substituting the appropriate values for machine, port, and root, start SAS Web Report Studio by loading http://machine:port/root in your web browser, e.g., Internet Explorer.

Undeploying SAS Web Report Studio for Windows and WebLogic 8.1

To undeploy SAS Web Report Studio, follow these steps:

  1. Open the WebLogic Server Console and log in.
  2. Click on Web Application Modules under the Your Deployed Resources middle column, under the second section Domain Configurations, in the right-hand pane.
  3. Click on the name of the SAS Web Report Studio deployment (such as SASWebReportStudio).
  4. Click on the Deploy tab, then click on the Stop button under the Actions column. Wait until this step completes.
  5. Click on the Targets tab. Deselect (remove the check from) the servers to which SAS Web Report Studio was deployed. Click the Apply button.
  6. In the left-hand pane of the WebLogic console, navigate from <yourdomain>->Deployments->Web Application Modules. Expand Web Application Modules, and then right-click on the name of the SAS Web Report Studio deployment. Choose "Delete <Web Report Studio deployment name>..." Choose Yes at the confirmation page.
  7. Now remove the server in which SAS Web Report Studio was deployed: from the home page of the WebLogic console, click on Servers under the Network Configuration column in the Domain Configurations section in the right-hand pane.
  8. Click on the name of the server in which SAS Web Report Studio was deployed. Click on Force Shutdown of this server..., and choose Yes at the confirmation page. Wait until the server is shut down.
  9. In the left-hand pane of the WebLogic console, navigate to <yourdomain>->Servers. Expand Servers. Right-click on the server which was shutdown in the previous step. Choose Delete <servername>... and choose Yes at the confirmation page.
  10. Delete the entire directory which was the target of the sas.wrs.weblogic.prepare.bat script, such as c:\bea\webapps\SASWebReportStudio.
  11. From the installation folder, execute the sas.wrs.unconfigure.bat script.

Configuring SAS Web Report Studio for Windows and WebSphere 6.1

In the following instructions, wrs.config is assumed to exist in the folder where you installed SAS Web Report Studio. That folder is referred to in the following instructions as the installation folder.

It is assumed that when SAS Web Report Studio was installed, it was installed with the container name set to WebSphere. If wrs.config does not contain a line that reads $CONTAINER_NAME$=WebSphere (note: the word WebSphere may not be capitalized as it is in this document; if so, this is not a problem.), you need to go back to the tool that created wrs.config (either the SAS Web Report Studio installer or SAS Management Console) and create a new wrs.config file.

It is also assumed that WebSphere has been installed and the server you are using has been properly configured for use with SAS Web Report Studio. To check your server's configuration, follow these steps:

  1. Log on to the WebSphere Application Console.
  2. In the tree on the left hand side of the page, click on Servers and then click on the Application Servers link.
  3. In the right hand side of the page, click on the link for the server you intend to deploy SAS Web Report Studio on.
  4. Under the Configuration tab, expand the Java and Process Management under the Server Infrastructure section and click on the Process Definition link.
  5. In the Additional Properties table, click on the Java Virtual Machine link.
  6. In the General Properties table, check the value in the Generic JVM arguments field. See page 66 of the “Web Application Administration Guide, Third Edition” for recommended arguments for the JVM. The specified arguments all go in the Generic JVM arguments field.
  7. If you update the Generic JVM arguments field, click on the OK button. Then click on the Save link, and then click on the Save button. You will need to restart WebSphere for your changes to take effect.
  8. Use the tree on the left side of the console to navigate to the Global Security wizard (for example, Security->Secure administration, applications, and infrastructure). Enable Java 2 security by selecting the Use Java 2 security to restrict application access to local resources check box.

To configure SAS Web Report Studio, find a script called sas.wrs.config.bat in the installation folder. Within the installation folder, execute that script. This will create and populate folders named live, wrsstaging, wrspackaging, and remote, and it will create SASWebReportStudio.war in the installation folder. If this step fails, it will typically be because a required property is not set. In that event, go back to the tool that created wrs.config (either the SAS Web Report Studio installer or SAS Management Console) and create a new wrs.config file and retry this step.

Deploying SAS Web Report Studio for Windows and WebSphere 6.1

It is assumed that you have already configured SAS Web Report Studio for Windows and WebSphere 6.1 as described in the section above (Configuring SAS Web Report Studio for Windows and WebSphere 6.1).

It is also assumed that you know the folder where WebSphere is installed. That folder is referred to in the following instructions as the WebSphere root folder.

Updating wsjaas.conf

Using the editor of your choice, add the contents of login.config (found in your installation folder's live subfolder) to the end of the wsjaas.conf file, which is found in the profiles\AppSrv01\properties subfolder of your WebSphere root folder. Comment lines from the login.config file should not be copied into the wsjaas.conf file.  If the comment lines are added, the wsjaas.conf file becomes unusable.  If you reconfigure SAS Web Report Studio, you will need to replace the old PFS value from the old login.config file with the value from the new file.

Deploying SAS Web Report Studio

Follow these steps to deploy SAS Web Report Studio:

  1. Copy SASWebReportStudio.war from your installation folder to the webapps subfolder of your WebSphere root folder. The webapps subfolder is not created by WebSphere; if it does not exist, create it.
  2. Log on to the WebSphere Administrative Console. In the tree on the left hand side of the page, click on Applications, and then click on the Install New Application link. On the right hand side of the page, select Local file system and either enter the path (in the webapps subfolder of your WebSphere root folder) of SASWebReportStudio.war into the text box, or use the browse button to locate SASWebReportStudio.war in the webapps subfolder of your WebSphere root folder. In the Context Root section of the page, enter SASWebReportStudio. Then, click on the Next button.
  3. The next screen is step 1 of the Install New Application wizard. At steps 1 through 3, click on the Next button to accept the defaults. On step 4, click on the Finish button to accept the defaults.
  4. When this last step finishes (it takes a few minutes), you will see a link to Save directly to Master Configuration. Click on the link, then click on the Save button.
  5. There are two files in the live subfolder of your installation folder that define permissions that SAS Web Report Studio needs at run time: sas.wrs.allpermissions.websphere.policy (recommended for initial setup of SAS Web Report Studio) and sas.wrs.websphere.policy (recommended for production deployment of SAS Web Report Studio). Select one of these two files and copy it to the profiles\AppSrv01\config\cells\<machine name>\applications\SASWebReportStudio_war.ear\deployments\SAS_WebReportStudio_war\META-INF subfolder of your WebSphere root folder (where <machine name> is the name of the machine where you've deployed SAS Web Report Studio). Rename the copy to was.policy.

Starting SAS Web Report Studio

Follow these steps to start SAS Web Report Studio:

  1. After SAS Web Report Studio has been deployed in WebSphere, the next time you start WebSphere, SAS Web Report Studio will start automatically. However, immediately following deploying SAS Web Report Studio, following the steps above, you can manually start SAS Web Report Studio. To do so, return to the left side of the page and, under the Applications heading, click on Enterprise Applications. On the right side of the page, you will see SASWebReportStudio_war with a red X to the right. Click on the check box next to SASWebReportStudio_war and click on the Start button. When the red X changes to a green arrow symbol, SAS Web Report Studio has started.
  2. When SAS Web Report Studio has started, load http://localhost:9080/SASWebReportStudio in your web browser.

Undeploying SAS Web Report Studio for Windows and WebSphere 6.1

To undeploy SAS Web Report Studio, follow these steps:

  1. Log on to the WebSphere Administrative Console. In the left-hand section, expand the Applications link. Click on Enterprise Applications.
  2. In the right-hand pane, select (enable the check mark of) the name of the deployed SAS Web Report Studio application, such as SASWebReportStudio_war. Click on Stop.
  3. Once more, select the name of the deployed SAS Web Report Studio application. Click on Uninstall.
  4. In the "Message(s)" area, click on the Save link.
  5. In the Save to Master Configuration box, click on the Save button.
  6. Delete the SASWebReportStudio.war file which should be in the installableApps subfolder of the WebSphere root folder.
  7. In the installation folder, execute the sas.wrs.unconfigure.bat script.

Configuring SAS Web Report Studio for UNIX and Tomcat 4.1.18

In the following instructions, wrs.config is assumed to exist in the directory where you installed SAS Web Report Studio. That directory is referred to in the following instructions as the installation directory.

It is also assumed that the server is properly configured. In particular, if you are using an IBM JDK, the Java Virtual Machine must have access to a valid X display. This can be accomplished by either setting the DISPLAY environment variable to point to a running X server or by configuring IBM's X Virtual Frame Buffer.

It is also assumed that Java has been correctly installed. To verify that Java has been correctly installed, from the command prompt, execute this command:

java -help

If you do not get usage information for Java, you need to properly install Java.

To configure SAS Web Report Studio, follow these steps:

  1. Optional Step If you need to customize the Java Virtual Machine's startup arguments, you can create a file called local.vm.args in the installation directory. This file, if it exists, is used to override the content of config/vm.args. If you create this file, use config/vm.args as a template and modify the setting of $SUN_UNIX_VM_ARGS$ or $IBM_VM_ARGS$ to suit your installation's needs.
  2. In the installation directory, you will find a script called sas.wrs.config.sh. Within the installation directory, execute that script. This will create and populate directories named live, wrsstaging, wrspackaging, and remote, and it will create SASWebReportStudio.war in the installation directory. If this step fails, it will typically be because a required property is not set. In that event, go back to the tool that created wrs.config (either the SAS Web Report Studio installer or SAS Management Console) and create a new wrs.config file and retry this step.

Deploying SAS Web Report Studio for UNIX and Tomcat 4.1.18

It is assumed that you have already configured SAS Web Report Studio for UNIX and Tomcat 4.1.18 as described in the section above (Configuring SAS Web Report Studio for UNIX and Tomcat 4.1.18). It is also assumed that you have set the following environment variables:

  1. JAVA_HOME must be set to where you have Java installed, e.g., /opt/sasjre/1.4.1
  2. CATALINA_HOME must be set to where you have Tomcat 4.1.18 installed, e.g., /opt/tomcat/4.1.18.

Updating the Tomcat catalina.policy file

Using the editor of your choice, add the contents of either sas.wrs.allpermissions.tomcat.policy or sas.wrs.tomcat.policy (both are found in your installation directory's tomcat subdirectory) to the end of the catalina.policy file, which is found in the conf directory of your Tomcat installation. sas.wrs.allpermissions.tomcat.policy is recommended for initial setup of SAS Web Report Studio; sas.wrs.tomcat.policy is recommended for production deployment of SAS Web Report Studio. Use of sas.wrs.allpermissions.tomcat.policy will result in SAS Web Report Studio running without security restrictions. If you reconfigure SAS Web Report Studio, you will need to replace the old SASWebReportStudio permissions with the new ones. Instructions for editing Tomcat's catalina.policy file are contained in the sas.wrs.allpermissions.tomcat.policy and sas.wrs.tomcat.policy files.

Deploying SAS Web Report Studio

Execute the sas.wrs.tomcat.deploy.sh script from your installation directory.

Starting Tomcat

After deploying SASWebReportStudio.war, start Tomcat from the sas.wrs.runtomcat.sh script that you'll find in your installation directory's live subdirectory.

Starting SAS Web Report Studio

Start SAS Web Report Studio after starting Tomcat by loading http://localhost:8080/SASWebReportStudio in your web browser.

Undeploying SAS Web Report Studio for UNIX and Tomcat 4.1.18

To undeploy SAS Web Report Studio, follow these steps:

  1. Stop Tomcat.
  2. Delete the SASWebReportStudio directory and all of its contents from $CATALINA_HOME/webapps.
  3. Delete the SASWebReportStudio directory and all of its contents from the Tomcat work/Standalone/localhost directory.
  4. Delete sas.wrs.context.xml from $CATALINA_HOME/webapps.
  5. In the installation folder, execute the sas.wrs.unconfigure.sh script.

Configuring SAS Web Report Studio for UNIX and WebLogic 8.1

In the following instructions, wrs.config is assumed to exist in the directory where you installed SAS Web Report Studio. That directory is referred to in the following instructions as the installation directory.

It is also assumed that the server is properly configured. In particular, if you are using an IBM JDK, the Java Virtual Machine must have access to a valid X display. This can be accomplished by either setting the DISPLAY environment variable to point to a running X server or by configuring IBM's X Virtual Frame Buffer.

It is also assumed that Java has been correctly installed. To verify that Java has been correctly installed, from the command prompt, execute this command:

java -help

If you do not get usage information for Java, you need to properly install Java.

To configure SAS Web Report Studio, follow these steps:

  1. Optional Step If you need to customize the Java Virtual Machine's startup arguments, you can create a file called local.vm.args in the installation directory. This file, if it exists, is used to override the content of config/vm.args. If you create this file, use config/vm.args as a template and modify the setting of $SUN_UNIX_VM_ARGS$ or $IBM_VM_ARGS$ to suit your installation's needs.
  2. In the installation directory, you will find a script called sas.wrs.config.sh. Within the installation directory, execute that script. This will create and populate directories named live, wrsstaging, wrspackaging, and remote, and it will create SASWebReportStudio.war in the installation directory. If this step fails, it will typically be because a required property is not set. In that event, go back to the tool that created wrs.config (either the SAS Web Report Studio installer or SAS Management Console) and create a new wrs.config file and retry this step.
  3. In the installation folder, you will find a script called sas.wrs.weblogic.prepare.sh. Within the installation directory, execute that script with three parameters:
    1. The WebLogic path (for example, /bea/webapps) where you will be deploying SAS Web Report Studio.
    2. A deployment directory (for example, SASWebReportStudio); this directory will be parented to the WebLogic path you specified in the first parameter.
    3. The name of the SAS Web Report Studio war file (typically SASWebReportStudio.war) that you are deploying.



For example:

sas.wrs.weblogic.prepare.sh
/bea/webapps SASWebReportStudio SASWebReportStudio.war

The full deployment path is the concatenation of the first two parameters (for example, /bea/webapps/SASWebReportStudio). Remember this path, as it must be supplied to WebLogic in step 4 of Deploying SAS Web Report Studio, below.

The WebLogic path must exist before executing the script. The deployment directory will be created under that path if the deployment directory doesn't already exist. If the deployment directory already exists, the script will empty it of all content before deploying the war file.

Deploying SAS Web Report Studio for UNIX and WebLogic 8.1

It is assumed that you have already configured SAS Web Report Studio for UNIX and WebLogic 8.1 as described in the section above (Configuring SAS Web Report Studio for UNIX and WebLogic 8.1). It is also assumed that you have the WebLogic Node Manager Service installed and running.

Creating the Server

Creating a server for SAS Web Report Studio is typically a one-time operation and needs to be done before using SAS Web Report Studio for the first time. If SAS Web Report Studio is being installed with other SAS web applications, you may be able to use the same server that was created for other SAS web applications. If other SAS web applications have been installed and employ the same authentication mechanism as SAS Web Report Studio (metadata server authentication or web authentication), you should not create a separate server for SAS Web Report Studio. Instead, you should use the same server that was created for the other SAS web applications that employ the same authentication mechanism. The steps to creating a server are:

  1. Open the WebLogic Server Console and log in.
  2. In the Domain Configurations section, under Network Configuration, select Servers.
  3. Select Configure a new Server.
  4. Under the General tab, enter the data appropriate to your SAS Web Report Studio server. BE CAREFUL NOT TO REUSE EXISTING PORT NUMBERS FOR THE Listen Port AND SSL Listen Port FIELDS! When finished, click on the Create button. Remember what you entered for the Listen Port field - you will need that to bring up SAS Web Report Studio in your browser. You will also need to remember what you entered in the Name field, as you will need that to control the server.
  5. Select the Remote Start tab. In the Arguments field, enter the contents of remote_start_unix.arguments (for all supported UNIX operating systems except AIX) or remote_start.aix.arguments (for AIX) (both found in the live subdirectory in the installation directory). In the Security Policy File field, enter the contents of remote_start.security.policy.file (also found in the live subdirectory in the installation directory). The contents of remote_start.security.policy.file refer to sas.wrs.allpermissions.weblogic.policy. For production setup of SAS Web Report Studio, change the security policy file entry from .../live/sas.wrs.allpermissions.weblogic.policy to .../live/sas.wrs.weblogic.policy. Use of sas.wrs.allpermissions.weblogic.policy will result in SAS Web Report Studio running without security restrictions.
  6. Click on the Apply button.

Starting the Server

The server for SAS Web Report Studio must be started before deploying SAS Web Report Studio. This section assumes that you know the name of your server, referred to as servername in the following steps. The steps to start the server are:

  1. Open the WebLogic Server Console and log in.
  2. In the Domain Configurations section, under Network Configuration, select Servers.
  3. Select the server by name.
  4. Select the Control tab.
  5. Select the Start/Stop tab.
  6. Select the Start this server link.
  7. In answer to the question Are you sure you want to start server servername?, click on the Yes button.
  8. When the Current Status section shows a State of RUNNING and a Status of TASK COMPLETED, the server has successfully started.

Deploying SAS Web Report Studio

SAS Web Report Studio must be deployed before it can be run. As with creating the server, there is a one-time operation to be performed the first time that SAS Web Report Studio is deployed. This operation assumes that you have started the server on which you wish to deploy SAS Web Report Studio. The steps to deploy SAS Web Report Studio for the first time are:

  1. Open the WebLogic Server Console and log in.
  2. In the Domain Configurations section, under Your Deployed Resources, select Web Application Modules.
  3. Select Deploy a new Web Application Module.
  4. Navigate to the directory chosen when you executed the sas.wrs.weblogic.prepare.sh script. Clicking on the links in the Location line takes you up to the directory clicked on; selecting a directory in the table below the Location line takes you down to the selected directory. Select the directory and click on the Target Module button.
  5. In the Independent Servers table, select the server(s) you want to deploy on. This would usually be the server started in the steps listed above (Starting the Server). NEVER SELECT THE SERVER THAT IS RUNNING YOUR ADMIN CONSOLE! When finished selecting the server(s), click on the Continue button.
  6. Under the Source Accessibility heading, select Copy this Web Application module onto every target for me. (This is the default setting). Under the Identity heading, enter the name you want to use to identify SAS Web Report Studio. This name must be unique among the web application modules deployed in WebLogic. Remember this name; you will use it to manage deployment of SAS Web Report Studio. Click on the Deploy button.
  7. The Deploy tab will become active. Wait for the Module Status column to change to Active and the Status of Last Action to change to Success.
  8. Select the Configuration tab.
  9. Select the General tab.
  10. Note the Context Root value. You will need this value to bring up SAS Web Report Studio in your browser.

To deploy SAS Web Report Studio after the first time, such as after stopping and restarting the server, perform the following steps:

  1. Open the WebLogic Server Console and log in.
  2. In the Domain Configurations section, under Your Deployed Resources, select Web Application Modules.
  3. Under the Configuration tab, you will see a table of deployed applications. Click on the link for your deployment of SAS Web Report Studio in the Name column.
  4. Under the Deploy tab, you will see a table showing the status of your deployment. If SAS Web Report Studio is already deployed, you will see Stop and Redeploy buttons in the Actions column; otherwise, you will see a Deploy button in the Actions column. Click on the appropriate button (Redeploy or Deploy).
  5. Wait for the Module Status column to change to Active and the Status of Last Action to change to Success.

Note:

Due to JSP precompilation, it will take several minutes to deploy SAS Web Report Studio. If the delay caused by JSP precompilation is a concern, JSP precompilation may be disabled by editing weblogic.xml, which is found in the WEB-INF directory. To disable JSP precompilation, find the two jsp-param elements whose param-name values are keepgenerated and precompile. Change the param-value for these jsp-param elements from true to false:

 
    <jsp-param>
      <param-name>keepgenerated</param-name>
      <param-value>true</param-value>
    </jsp-param>
    .
    .
    .
    <jsp-param>
      <param-name>precompile</param-name>
      <param-value>true</param-value>
    </jsp-param>
                  

becomes

 
    <jsp-param>
      <param-name>keepgenerated</param-name>
      <param-value>false</param-value>
    </jsp-param>
    .
    .
    .
    <jsp-param>
      <param-name>precompile</param-name>
      <param-value>false</param-value>
    </jsp-param>
                  

Starting SAS Web Report Studio

This section assumes that you have followed the steps listed above to deploy SAS Web Report Studio and that you know the name of the Windows machine that WebLogic is running on (referred to in the next paragraph as machine) and the listen port (referred to in the next paragraph as port), and the context root (referred to in the next paragraph as root). Recall that the listen port was defined when you created the server and that the context root was created when you deployed SAS Web Report Studio.

Substituting the appropriate values for machine, port, and root, start SAS Web Report Studio by loading http://machine:port/root in your web browser, e.g., Internet Explorer.

Undeploying SAS Web Report Studio for UNIX and WebLogic 8.1

To undeploy SAS Web Report Studio, follow these steps:

  1. Open the WebLogic Server Console and log in.
  2. Click on Web Application Modules under the Your Deployed Resources middle column, under the second section Domain Configurations, in the right-hand pane.
  3. Click on the name of the SAS Web Report Studio deployment (such as SASWebReportStudio).
  4. Click on the Deploy tab, then click on the Stop button under the Actions column. Wait until this step completes.
  5. Click on the Targets tab. Deselect (remove the check from) the servers to which SAS Web Report Studio was deployed. Click the Apply button.
  6. In the left-hand pane of the WebLogic console, navigate from <yourdomain>->Deployments->Web Application Modules. Expand Web Application Modules, and then right-click on the name of the SAS Web Report Studio deployment. Choose "Delete <Web Report Studio deployment name>..." Choose Yes at the confirmation page.
  7. Now remove the server in which SAS Web Report Studio was deployed: from the home page of the WebLogic console, click on Servers under the Network Configuration column in the Domain Configurations section in the right-hand pane.
  8. Click on the name of the server in which SAS Web Report Studio was deployed. Click on Force Shutdown of this server..., and choose Yes at the confirmation page. Wait until the server is shut down.
  9. In the left-hand pane of the WebLogic console, navigate to <yourdomain>->Servers. Expand Servers. Right-click on the server which was shutdown in the previous step. Choose Delete <servername>... and choose Yes at the confirmation page.
  10. Delete the entire directory which was the target of the sas.wrs.weblogic.prepare.sh script, such as /bea/webapps/SASWebReportStudio.
  11. From the installation directory, execute the sas.wrs.unconfigure.sh script.

Configuring SAS Web Report Studio for UNIX and WebSphere 6.1

In the following instructions, wrs.config is assumed to exist in the directory where you installed SAS Web Report Studio. That directory is referred to in the following instructions as the installation directory.

It is assumed that when SAS Web Report Studio was installed, it was installed with the container name set to WebSphere. If wrs.config does not contain a line that reads $CONTAINER_NAME$=WebSphere (note: the word WebSphere may not be capitalized as it is in this document; if so, this is not a problem.), you need to go back to the tool that created wrs.config (either the SAS Web Report Studio installer or SAS Management Console) and create a new wrs.config file.

It is also assumed that the server is properly configured. In particular, if you are using an IBM JDK, the Java Virtual Machine must have access to a valid X display. This can be accomplished by either setting the DISPLAY environment variable to point to a running X server or by configuring IBM's X Virtual Frame Buffer.

It is also assumed that WebSphere has been installed and the server you are using has been properly configured for use with SAS Web Report Studio. To check your server's configuration, follow these steps:

  1. Log on to the WebSphere Application Console.
  2. In the tree on the left hand side of the page, click on Servers and then click on the Application Servers link.
  3. In the right hand side of the page, click on the link for the server you intend to deploy SAS Web Report Studio on.
  4. Under the Configuration tab, expand the Java and Process Management under the Server Infrastructure section and click on the Process Definition link.
  5. In the Additional Properties table, click on the Java Virtual Machine link.
  6. In the General Properties table, check the value in the Generic JVM arguments field. See page 66 of the “Web Application Administration Guide, Third Edition” for recommended arguments for the JVM. The specified arguments all go in the Generic JVM arguments field.
  7. If you update the Generic JVM arguments field, click on the OK button. Then click on the Save link, and then click on the Save button. You will need to restart WebSphere for your changes to take effect.
  8. Use the tree on the left side of the console to navigate to the Global Security wizard (for example, Security->Secure administration, applications, and infrastructure). Enable Java 2 security by selecting the Use Java 2 security to restrict application access to local resources check box.

To configure SAS Web Report Studio, find a script called sas.wrs.config.sh in the installation directory. Within the installation directory, execute that script. This will create and populate directories named live, wrsstaging, wrspackaging, and remote, and it will create SASWebReportStudio.war in the installation directory. If this step fails, it will typically be because a required property is not set. In that event, go back to the tool that created wrs.config (either the SAS Web Report Studio installer or SAS Management Console) and create a new wrs.config file and retry this step.

Deploying SAS Web Report Studio for UNIX and WebSphere 6.1

It is assumed that you have already configured SAS Web Report Studio for UNIX and WebSphere 6.1 as described in the section above (Configuring SAS Web Report Studio for UNIX and WebSphere 6.1).

It is also assumed that you know the directory where WebSphere is installed. That directory is referred to in the following instructions as the WebSphere root directory.

Updating wsjaas.conf

Using the editor of your choice, add the contents of login.config (found in your installation folder's live subfolder) to the end of the wsjaas.conf file, which is found in the profiles\AppSrv01\properties subfolder of your WebSphere root folder. Comment lines from the login.config file should not be copied into the wsjaas.conf file.  If the comment lines are added, the wsjaas.conf file becomes unusable.  If you reconfigure SAS Web Report Studio, you will need to replace the old PFS value from the old login.config file with the value from the new file.

Deploying SAS Web Report Studio

Follow these steps to deploy SAS Web Report Studio:

  1. Copy SASWebReportStudio.war from your installation folder to the webapps subfolder of your WebSphere root folder. The webapps subfolder is not created by WebSphere; if it does not exist, create it.
  2. Log on to the WebSphere Administrative Console. In the tree on the left hand side of the page, click on Applications, and then click on the Install New Application link. On the right hand side of the page, select Local file system and either enter the path (in the webapps subfolder of your WebSphere root folder) of SASWebReportStudio.war into the text box, or use the browse button to locate SASWebReportStudio.war in the webapps subfolder of your WebSphere root folder. In the Context Root section of the page, enter SASWebReportStudio. Then, click on the Next button.
  3. The next screen is step 1 of the Install New Application wizard. At steps 1 through 3, click on the Next button to accept the defaults. On step 4, click on the Finish button to accept the defaults.
  4. When this last step finishes (it takes a few minutes), you will see a link to Save directly to Master Configuration. Click on the link, then click on the Save button.
  5. There are two files in the live subfolder of your installation folder that define permissions that SAS Web Report Studio needs at run time: sas.wrs.allpermissions.websphere.policy (recommended for initial setup of SAS Web Report Studio) and sas.wrs.websphere.policy (recommended for production deployment of SAS Web Report Studio). Select one of these two files and copy it to the profiles\AppSrv01\config\cells\<machine name>\applications\SASWebReportStudio_war.ear\deployments\SAS_WebReportStudio_war\META-INF subfolder of your WebSphere root folder (where <machine name> is the name of the machine where you've deployed SAS Web Report Studio). Rename the copy to was.policy.

Starting SAS Web Report Studio

Follow these steps to start SAS Web Report Studio:

  1. After SAS Web Report Studio has been deployed in WebSphere, the next time you start WebSphere, SAS Web Report Studio will start automatically. However, immediately following deploying SAS Web Report Studio, following the steps above, you can manually start SAS Web Report Studio. To do so, return to the left side of the page and, under the Applications heading, click on Enterprise Applications. On the right side of the page, you will see SASWebReportStudio_war with a red X to the right. Click on the check box next to SASWebReportStudio_war and click on the Start button. When the red X changes to a green arrow symbol, SAS Web Report Studio has started.
  2. When SAS Web Report Studio has started, load http://localhost:9080/SASWebReportStudio in your web browser.

Undeploying SAS Web Report Studio for UNIX and WebSphere 6.1

To undeploy SAS Web Report Studio, follow these steps:

  1. Log on to the WebSphere Administrative Console. In the left-hand section, expand the Applications link. Click on Enterprise Applications.
  2. In the right-hand pane, select (enable the check mark of) the name of the deployed SAS Web Report Studio application, such as SASWebReportStudio_war. Click on Stop.
  3. Once more, select the name of the deployed SAS Web Report Studio application. Click on Uninstall.
  4. In the "Message(s)" area, click on the Save link.
  5. In the Save to Master Configuration box, click on the Save button.
  6. Delete the SASWebReportStudio.war file which should be in the installableApps subdirectory of the WebSphere root directory.
  7. In the installation folder, execute the sas.wrs.unconfigure.sh script.

Installing Metadata

Interaction between SAS Web Report Studio and other SAS products such as SAS Enterprise Guide requires installation of metadata into your metadata repository. To install the required metadata, you will need to run a SAS program that is provided with SAS Web Report Studio called LoadDefaultPreferences.sas. This program is found in the live subfolder of your SAS Web Report Studio installation folder after executing the sas.wrs.config.bat or sas.wrs.config.sh script. You will then need to define a profile in metadata.

Running LoadDefaultPreferences.sas

Note: LoadDefaultPreferences.sas may have already been run as part of installing other SAS products. If LoadDefaultPreferences.sas has already been run, it will abort. It will do no harm to attempt to run it more than once.

LoadDefaultPreferences.sas must be run on a machine that has the SAS Foundation installed. If the machine you installed SAS Web Report Studio on does not have SAS Foundation installed, you may copy LoadDefaultPreferences.sas to a machine with SAS Foundation installed and run LoadDefaultPreferences.sas on that machine.

To load the required metadata, follow the appropriate steps for your platform:

Windows

1.     In Windows Explorer, navigate to the folder where LoadDefaultPreferences.sas is located.

2.     Right-click on LoadDefaultPreferences.sas and select Batch Submit with SAS 9.1.

3.     When the program is finished, look for the message, "NOTE: Successfully loaded metadata" near the bottom of the log file to validate the metadata installation.

UNIX

1.     Navigate to the directory where LoadDefaultPreferences.sas is located.

2.     Submit LoadDefaultPreferences.sas with SAS 9.1.

3.     When the program is finished, look for the message, "NOTE: Successfully loaded metadata" near the bottom of the log file to validate the metadata installation.

Defining a profile in metadata

A profile (SAS) must be defined in metadata. Using SMC: Foundation Services Manager, navigate to Query and Reporting -> BIP Core Services -> Platform User Service. Right-click on Platform User Services and select Properties. Select the Service Configuration tab. Click on Edit Configuration, then select the Profiles tab. Click on Add to add a new profile. You will enter values for the Application, Domain URL, and Class fields as shown in this table:

Field

What to Enter

Application

SAS

Domain URL

A profile called global should already exist. Use its Domain URL value.

Class

com.sas.preferences.SASProfile


Enabling Report Web Services

Interaction between SAS Web Report Studio and other SAS products such as SAS Enterprise Guide requires enabling Report Web Services.

Before Report Web Services can be enabled, SAS Web Report Studio must be configured and deployed in its web application container (Tomcat, WebLogic, or WebSphere) and the web application container must be running, and the enable script has to be configured with an appropriate URL. You will need to create a definition file to configure the enable script.

The definition file is a UTF-8 encoded text file containing definitions for the three necessary components of the URL. These components are described in the table below:

Component

Tag

Default Value

Example

Machine name

$WRS_URL_MACHINE$

localhost

$WRS_URL_MACHINE$=server.sas.com

Port

$WRS_URL_PORT$

8080

$WRS_URL_PORT$=7001

Root

$WRS_URL_ROOT$

SASWebReportStudio

$WRS_URL_ROOT$=wrs

Here is an example of a definition file:

 
$WRS_URL_MACHINE$=server.sas.com
$WRS_URL_PORT$=7001
$WRS_URL_ROOT$=wrs

Any definitions omitted from the definition file will default to the values shown in the Default Value column in the table above.

To enable Report Web Services, ensure that the web application container is running and that you can bring up the SAS Web Report Studio logon screen, and follow the appropriate steps for your platform:

Windows

1.     In the installation folder, execute configureReportWebServicesScripts.bat definitionsFile, where definitionsFile is the definitions file described above.

2.     In the installation folder, execute enableReportWebServices.bat (Note: this script was created by the previous step).

UNIX

1.     In the installation directory, execute configureReportWebServicesScripts.sh definitionsFile, where definitionsFile is the definitions file described above.

2.     In the installation directory, execute enableReportWebServices.sh (Note: this script was created by the previous step).

To test whether Report Web Services is functional, the last line of the configured enableReportWebServices script will contain a URL in quotes, of the form http://<machine name>:<port> /<root>/servlet/AxisServlet. That URL should take you to a valid web page. If it does not, check that the machine name, port, and root are identical to the beginning of the URL you use to access SAS Web Report Studio, and check that you can bring up the SAS Web Report Studio logon screen.


SAS and all other SAS Institute Inc. product or service names are registered trademarks or trademarks of SAS Institute Inc. in the USA and other countries. ® indicates USA registration. Other brand and product names are trademarks of their respective companies.

Copyright © 2006 SAS Institute Inc., Cary, NC, USA. All rights reserved.