Developing a Custom Logon Screen

The SAP NetWeaver Application Server (AS) Java ships with a standard set of logon screens. SAP bundles these screens into the logon user interface (UI) application com.sap~tc~sec~ume~logon~ui. The application includes for example, the logon screen and the password help screen. You can change these screens to reflect your company's look and feel. This procedure describes how to import the default logon UI application into the SAP NetWeaver Developer Studio from the AS Java, modify the application, and deploy the customized application to your AS Java. This enables you to customize the existing application to meet your needs instead of creating a brand new logon UI.

This procedure requires you to restart the AS Java, so you should plan for the required downtime while the AS Java restarts.

1. Import the WAR file of the default logon user interface application into the SAP NetWeaver Developer Studio.

   To import the WAR file, choose File → Import and navigate to the default logon UI application under the following path:

   <ASJava_Installation>/j2ee/cluster/apps/sap.com/com.sap.security.core.logon/servlet_jsp/logon_ui_resources/sap.com~tc~sec~ume~logon~ui.war

   Note  

   To avoid inconsistencies in class references, add the JAR file of the default logon logic application tc~sec~ume~logon~logic_api.jar to the libraries of the Java build path of the imported logon UI application. You can find the JAR file under the following path:

   <ASJava_Installation>/j2ee/cluster/apps/sap.com/com.sap.security.core.logon/servlet_jsp/logon_app/root/WEB-INF/lib

2. Change the content of the imported WAR file as needed.
3. Create a new EAR Application Project project and include the module of the default logon UI application.You must use EAR version 1.4 for that project.
   1. To start the EAR Application Project wizard, choose File → New →Project, and select Enterprise Application Project from the J2EE folder.
   2. Add the module of the default logon UI application sap.com~tc~sec~ume~logon~ui.war to the project.
4. In the EAR, view the General tab of the file <project_name>/EARContent/META-INF/application-j2ee-engine.xml .
   1. Enter a provider name for your application.

      The provider name defines your namespace where your applications reside on the AS Java.

      Tip  

      If you enter example.com , the application deploys to the following path:

      <ASJava_Installation>/j2ee/cluster/apps/ example.com/ <project_name>

   2. Choose References and choose  with the quick info text Add element.
   3. Choose Create new and enter the required data.

   Reference Data for the Logon Application

   Field Name	Data
   Reference target	com.sap.security.core.logon
   Reference type	hard
   Reference target type	application
   Provider name	sap.com

5. In the EAR, edit the file <project_name>/EARContent/META-INF/application.xml , and define the URL alias and for your custom logon UI.
   Note  

   <?xml version="1.0" encoding="UTF-8"?>
    <application
    xmlns="http://java.sun.com/xml/ns/j2ee"
    id="Application_ID"
    version="1.4"
    xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/application_1_4.xsd">
      <description/>
      <display-name>custom_logon</display-name>
       <icon/>
       <module
       id="WebModule_1183039485065">
       <web>
         <web-uri>sap.com~tc~sec~ume~logon~ui.war</web-uri>
         <context-root>custom_logon</context-root>
       </web>
     </module>
   </application>

6. Deploy the application.
7. Change the user management engine (UME) property ume.logon.application.ui_resources_alias to the URL alias of the new application.
   Tip

   ume.logon.application.ui_resources_alias= /custom_logon

   For more information about editing UMEproperties, see Editing UME Properties .

8. Restart the AS Java.

The following is an example of the file application-j2ee-engine.xml with a hard reference to the default logon application and example.com as the provider name.

●        <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE application-j2ee-engine SYSTEM 'application-j2ee-engine.dtd'>

<application-j2ee-engine
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:noNamespaceSchemaLocation="application-j2ee-engine.xsd">
  <reference 
    reference-type="hard" >
    <reference-target 
      provider-name="sap.com" 
      target-type="application">com.sap.security.core.logon </reference-target>
  </reference>  
  <provider-name> example.com </provider-name>
  <start-up
    mode="manual"/>
</application-j2ee-engine>

.