Specifying Pages to Use

Several parameters define specific pages within the app: the login page, the logout page, the home page, and the login failure page.

See Also
Authentication Parameters
FCS Parameters
Timer Servlet

There are two main uses for these parameters:

  • If a servlet calls one of these four pages, it will forward to the page specified in the corresponding property. For example, the LoginServlet automatically forwards users who are not logged in to the page specified in the ematrix.login.page property.
  • You can reference these pages using methods in the servlet classes. For example, the FrameworkServlet has getHomePage(), getLoginPage(), getLogoutPage(), and getLoginFailurePage() methods that retrieve the pages defined in these parameters. Similarly, the LoginServlet has redirectToHomePage(), redirectToLoginPage(), and redirectToLoginFailurePage() methods that redirect to these pages.

ematrix.login.page—Specifies the login page. If a servlet requires the user to be logged in and they haven't yet been authenticated, the page specified in this property is presented. When installed, the property is set to the ENOVIA app login page:

<context-param id="ContextParam_#">
   <param-name>ematrix.login.page</param-name>
   <param-value>/emxLogin.jsp</param-value>
</context-param>

ematrix.home.page—Specifies the page to present after the user has logged in if no target "next" page is specified in the JSP. When installed, the property is set to the Applet page.

<context-param id="ContextParam_#">
   <param-name>ematrix.home.page</param-name>
   <param-value>/common/emxNavigator.jsp</param-value>
</context-param>

ematrix.logout.page—Specifies the page to display when the user logs out. ENOVIA apps don't use this property but a custom app could. For example:

<context-param id="ContextParam_#">
   <param-name>ematrix.logout.page</param-name>
   <param-value>/emxLogout.jsp</param-value>
</context-param>

ematrix.login.failure.page—Defines the URL for the page to present if the login has failed. If no failure page is specified, sessions that fail to login are forwarded to the home page. ENOVIA apps don't use this property but a custom app could.