SAS^® AppDev Studio^™ 3.0 Developer's Site

Visual Data Explorer: Customizing the Menubar

Data Source: Information Map

This example includes the following customization(s):

Remove the Save As action from the File menu
Add a button to the menu bar to display the name of the cube and date

Please install the latest webAF template updates prior to building this example. For more information about the server-side example templates used by this example, see Web Application Example Templates and Built-in Web Application Templates and Options.

The following example is not meant to be a complete web application, rather it is to show how to use a particular component(s). The example does not address the issue of immediately freeing up resources when the user navigates off the web application or closes the web browser. Any necessary resources created in the example will stay around until the associated HTTPSession times out. If this example were used in a multi-user environment, it is possible to exhaust the available resources until HTTPSessions time out and free up their associated resources.

Step 1: Create a project in webAF

Create a new project named VisualDataExplorer.
Select Web Application from the webAF Projects list.
Accept the defaults as you go through the Web App wizard until you have reached step #4 of the wizard. At this step you will need to select Examples in the radio box titled Display list for. Choose Information Map Viewer Servlet from the list box titled Type of initial content.
Continue accepting defaults as you complete the Web App wizard.

Step 2: Set up access to the data source

Insert the correct metadata password ( omr_password ) in the sas_metadata_source_omr.properties file located in the web-inf\conf directory. This password is used when deploying Foundation Services.
Insert the correct metadata password ( metadata-password ) under the InfoMapViewerExampleControllerServlet's initial parameters in the web.xml file located in the web-inf directory. This password is used to get a user and session context from the Foundation Services.

Replace the contents of the InfoMapViewerControllerServlet.java file with the following code:


package servlets;

import java.io.IOException;
import java.io.PrintWriter;

import javax.servlet.RequestDispatcher;
import javax.servlet.ServletConfig;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;

import com.sas.actionprovider.HttpActionProvider;
import com.sas.services.discovery.DiscoveryService;
import com.sas.services.discovery.DiscoveryServiceInterface;
import com.sas.services.discovery.ServiceTemplate;
import com.sas.services.session.SessionContextInterface;
import com.sas.services.session.SessionServiceInterface;
import com.sas.services.user.UserContextInterface;
import com.sas.services.user.UserServiceInterface;

public class InfoMapViewerExampleControllerServlet extends javax.servlet.http.HttpServlet {
	// Global webapp Strings
	private static final String ACTION_PROVIDER = "sas_actionProvider";

	private static final String SAS_MODEL = "sas_model";

	/*
	 * doPost() Respond to the Post message.
	 */
	public void doPost(HttpServletRequest request, HttpServletResponse response)
			throws ServletException, IOException {
		// Note: Calling doGet to provide same behavior to POST and GET HTTP
		// methods.
		doGet(request, response);
	}

	/*
	 * doGet() Respond to the Get message.
	 */
	public void doGet(HttpServletRequest request, HttpServletResponse response)
			throws ServletException, IOException {
		// Note: Add User DO_GET code here
		HttpSession session = request.getSession();
		// Setup the ActionProvider
		HttpActionProvider sas_actionProvider = null;
		synchronized (session) {

			SessionContextInterface sessionContext = null;
			if (session != null) {
				sessionContext = (SessionContextInterface) session
						.getAttribute(SAS_MODEL);
			}
			if (sessionContext == null) {
				try {
					// Obtain the local discovery service
					DiscoveryServiceInterface discoveryService = DiscoveryService
							.defaultInstance();
					// Use the discovery services to find a user service.
					UserServiceInterface userService = (UserServiceInterface) discoveryService
							.findService(new ServiceTemplate(
									new Class[] { UserServiceInterface.class }));
					ServletConfig sc = getServletConfig();
					String domain = sc.getInitParameter("metadata-domain");
					String username = sc.getInitParameter("metadata-userid");
					String password = sc.getInitParameter("metadata-password");
					UserContextInterface userContext = userService.newUser(
							username, password, domain);
					SessionServiceInterface sessionService = (SessionServiceInterface)
						discoveryService.findService(new ServiceTemplate(
									new Class[] { SessionServiceInterface.class }));
					// Create a session for this user and bind it to the user
					// context.
					sessionContext = sessionService
							.newSessionContext(userContext);
					userContext.setSessionContext(sessionContext);

					if (session != null) {
						session.setAttribute(SAS_MODEL, sessionContext);
					}
				} catch (Exception e) {
					e.printStackTrace();
					throw new RuntimeException(e);
				}
			}
		}

		synchronized (session) {
			if (session != null) {
				sas_actionProvider = (HttpActionProvider) session
						.getAttribute(ACTION_PROVIDER);
			}
			// if ActionProvider is null, create one and put it on the session
			if (sas_actionProvider == null) {
				sas_actionProvider = new com.sas.actionprovider.HttpActionProvider();
				sas_actionProvider.setLocale(request.getLocale());
				sas_actionProvider.setControllerURL(request.getContextPath()
						+ "/InfoMapViewerExample");
				sas_actionProvider.setName(ACTION_PROVIDER);
				// store object in its scope
				if (session != null)
					session.setAttribute(ACTION_PROVIDER, sas_actionProvider);
			}
			// else execute the ActionProvider command
			else {
				try
				{
				sas_actionProvider.executeCommand(request, response, response
						.getWriter());
				}
				catch (Exception ex)
				{
					ex.printStackTrace();
				}
			}
		}
		RequestDispatcher rd = null;
		String sas_forwardLocation = request
				.getParameter("sas_forwardLocation");
		if (sas_forwardLocation != null)
			rd = getServletContext().getRequestDispatcher(sas_forwardLocation);
		else
			rd = getServletContext().getRequestDispatcher("/InfoMapViewerExampleViewer.jsp");
		rd.forward(request, response);

	}
}

Step 3: Add components to the JSP file

Replace the contents of the InfoMapViewerExampleViewer.jsp file with the following code:


<%@page import="com.sas.services.session.SessionContextInterface"%>
<%@page import="com.sas.actionprovider.HttpActionProvider"%>
<%@page import="com.sas.servlet.tbeans.dataexplorer.html.VisualDataExplorer"%>
<%@page import="com.sas.servlet.tbeans.dataexplorer.html.VisualDataExplorerMenuBar"%>
<%@page import="com.sas.dataexplorer.actionprovider.support.dataexplorer.VisualDataExplorerMenuBarAreaInterface"%>
<%@page import="com.sas.actionprovider.ActionOrderList"%>
<%@page import="com.sas.actionprovider.support.ActionProviderSupportTypes"%>

<%@ page pageEncoding="UTF-8"%>
<html>
<head>

    <link href="styles/sasComponents.css" rel="stylesheet" type="text/css">

</head>
<body style="margin: 0px;">
<%
	 String mapPath ="mapName";
    VisualDataExplorer vde = (VisualDataExplorer)session.getAttribute("vde");
    if (vde == null)
    {
    	SessionContextInterface model = (SessionContextInterface)session.getAttribute("sas_model");
    	vde = new VisualDataExplorer(model, mapPath );
    	vde.setId("vde");
    	HttpActionProvider ap = (HttpActionProvider)session.getAttribute("sas_actionProvider");
    	vde.setActionProvider(ap);
    	session.setAttribute("vde", vde);

    }
    if (vde.getActionProvider() == null)
    {
       	HttpActionProvider ap = (HttpActionProvider)session.getAttribute("sas_actionProvider");
    	vde.setActionProvider(ap);
    }

    vde.setRequest(request);
    vde.setResponse(response);
    vde.write(out);

%>

</body>
</html>

Specify the Information Map by double-clicking on the InfoMapViewerExampleViewer.jsp file in the Files Tab of the Project Navigator. Replace the mapName string in the following code:
String mapPath ="mapName";
with your information map URL string.

Customization: Remove the Save As action from the File menu

Add the following import statements to the beginning of the InfoMapViewerExampleViewer.jsp file.


<%@page import="com.sas.servlet.tbeans.dataexplorer.html.VisualDataExplorerMenuBar"%>
<%@page import="com.sas.dataexplorer.actionprovider.support.dataexplorer.VisualDataExplorerMenuBarAreaInterface"%>
<%@page import="com.sas.actionprovider.ActionOrderList"%>

Add the following scriptlet code before the line that reads
vde.setRequest(request);
in InfoMapViewerExampleViewer.jsp.


  VisualDataExplorerMenuBar mb =
  (VisualDataExplorerMenuBar)vde.getComponent(VisualDataExplorer.VISUALDATAEXPLORER_MENUBAR);

ActionOrderList alist = vde.getActionProvider().getActionOrderList(
     ActionProviderSupportTypes.VDE_MENUBAR_SUPPORT, mb,
     VisualDataExplorerMenuBarAreaInterface.MENU_AREA);
ActionOrderList fileList = (ActionOrderList)(alist.get(0));
fileList.remove("SAVE_AS_ACTION");

Customization: Add a button to the menu bar to display the name of the cube and date that it was last updated

Add the following import statements to the beginning of the InfoMapViewerExampleViewer.jsp file


<%@page import="com.sas.actionprovider.HttpAction"%>
<%@page import="com.sas.iquery.metadata.business.BriefInformationMap"%>
<%@page import="com.sas.iquery.metadata.business.BusinessQuery"%>
<%@page import="com.sas.iquery.metadata.IntelligentQueryMetadataServiceInterface"%>
<%@page import="com.sas.services.information.metadata.PathUrl"%>
<%@page import="com.sas.iquery.metadata.business.InformationMapFactory"%>
<%@page import="com.sas.services.session.SessionContextInterface"%>
<%@page import="com.sas.entities.AttributeDescriptorInterface"%>

If you did not add the code described in section "Remove the Save As action from the File menu", please add as instructed, except omit the last line of code: fileList.remove("SAVE_AS_ACTION");

Add the following scriptlet code after the code you just added from the "Remove the Save As action from the File menu" section - after the line that reads
ActionOrderList fileList = (ActionOrderList)(alist.get(0));


java.util.Vector vector = new java.util.Vector();
vector.add(mb);

// create a new HttpAction
if (session.getAttribute("firstTimeThru") == null)
  {
    IntelligentQueryMetadataServiceInterface service =
   	((BusinessQuery)vde.getDataModel()).getBusinessModel().getMetadataService();
    SessionContextInterface sessionInt =
   	((BusinessQuery)vde.getDataModel()).getBusinessModel().getSession();
    InformationMapFactory factory = InformationMapFactory.getInstance();
    BriefInformationMap map =
    factory.newInformationMap(sessionInt, service, new PathUrl(mapPath)).getBriefMap();

    String tableName = map.getName();
    String date = map.getModifyDate().toString();
    HttpAction infoAction = new HttpAction();
    infoAction.setExternal(true);

    infoAction.setActionType("INFO_ACTION");
    infoAction.putValue( infoAction.NAME, "Show Map Info" );
    session.setAttribute("tableName", tableName);
    session.setAttribute("tableDate", date);
    infoAction.setURLBase("info.jsp");

    com.sas.actionprovider.Area menubarArea =
   	new com.sas.actionprovider.Area(VisualDataExplorerMenuBarAreaInterface.MENU_AREA);
    vde.getActionProvider().setAction(infoAction, vector, menubarArea);
    session.setAttribute("firstTimeThru", "false");

Select File New, and then select JavaServer Page to create a new JSP file. Specify info.jsp for the file name and click OK. Select Blank JavaServer Page and click Next. Click Finish. Insert the following code into the new file:
```
 <%

 String name = (String)session.getAttribute("tableName");
 String date = (String)session.getAttribute("tableDate");
 out.println("Table name: " + name);
 out.println("<br>");
 out.println("Last updated: " + date);

%>
```

Resources

SAS^® AppDev Studio^™ 3.0 Developer's Site

Step 1: Create a project in webAF

Step 2: Set up access to the data source

Step 3: Add components to the JSP file

Customization: Remove the Save As action from the File menu

Customization: Add a button to the menu bar to display the name of the cube and date that it was last updated

Step 4: Finish the project

Resources

SAS® AppDev Studio™ 3.0 Developer's Site

Step 1: Create a project in webAF

Step 2: Set up access to the data source

Step 3: Add components to the JSP file

Customization: Remove the Save As action from the File menu

Customization: Add a button to the menu bar to display the name of the cube and date that it was last updated

Step 4: Finish the project

SAS^® AppDev Studio^™ 3.0 Developer's Site