Apama dashboards can be deployed to supported application server environments. Generate a .war file that you then deploy manually using the deployment tools of your application server.
There are additional considerations that are covered in the following topics in this section.
If you are a dashboard developer, see also Preparing Dashboards for Deployment.
For a current list of Apama-supported application servers, see Supported Platforms.
Before deploying a dashboard, you need to first generate the .war file for that dashboard. The .war file is the deployment package for a dashboard. It contains the webapp, servlets, and supporting resources for deploying a dashboard.
You can generate the .war file using a command prompt or script with the dashboard_management utility.
For more information on generating dashboard .war files, see Preparing Dashboards for Deployment.
When deploying to an application server you need to manually install the dashboard .war file to that application server using the tools provided by the server. The details of this vary by application server.
To install a dashboard.war file
Ensure that you are installing to a supported application server. For an up-to-date listing of supported application servers, see Supported Platforms.
Copy your .war file to the appropriate location for your application server. For example it may have a webapps folder.
Configure your application server as desired to support this and to secure access to the dashboard as required. The generated .war file will have form authentication enabled.
Use the deployment tools of your application server to install the dashboard .war file.
Test that you can access your dashboard and that access is secured as intended.
A dashboard .war file contains the webapp, servlets, and supporting resources necessary to deploy your dashboard and for it to connect to your Apama dashboard data or display server. For the most part you do not need to be aware of the contents of the .war file. However, there are several points to consider if you encounter problems.
The generated .war file will have form authentication enabled. You must supply the login page for this and configure your application server accordingly. A servlet in the dashboard .war file needs the ability to determine the identity of the user displaying a dashboard. This is to enable user based filtering. For this the servlet calls request.getRemoteUser(). Any problems calling this will prevent access to the dashboard.
For thin client deployments you need to provide the Apama dashboard display server with access to the resources used by the dashboard. When the display server builds the displays for users, it requires the .rtv files, images, and other files used by the dashboards.
For display server deployments, copy your project’s dashboard directory (the directory that contains the project’s .rtv files) to the system on which you want to deploy. By default, the display server looks for the deployed project files from its current working directory or from the APAMA_WORK/dashboards directory
You need to copy the dashboard project directory, as well as its contents. So, for example, if your dashboard files on the development system are apama-work/dashboards/MyProject/*.rtv, they might be located here on the deployment machine:
deploy-dir/MyProject/*.rtv
In this case, run the display server from deploy-dir, the parent of the dashboard project directory. Do not run the display server from the directory MyProject.
You can also run the display server by using the command-line option --dashboardDir folder. If this option is used, then the display server does not required to be run from the APAMA_WORK/dashboards directory. The deployed project directory described above will be expected under the folder argument.