Show TOC Start of Content Area

Procedure documentation Developing a Custom Logon Screen  Locate the document in its SAP Library structure

Use

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.

Note 

If you only want to make minor changes to the logon screen, such as changing the branding images, see SAP Help Portal Logon Screen Customization.

Prerequisites

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

Procedure

...

       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

Recommendation 

To avoid inconsistencies in class references, add the class folder of the logon logic application to the libraries of the Java build path of the imported logon UI application.

You can find the class folder of the default logon logic application under the following path:

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

       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.

                            a.      To start the EAR Application Project wizard, choose File New Project, and select Enterprise Application Project from the J2EE folder.

                            b.      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.

                            a.      Enter a provider name for your application.

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

Example 

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

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

                            b.      Choose References and choose This graphic is explained in the accompanying text with the quick info text Add element.

                            c.      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.

Syntax 

<?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.

Example

ume.logon.application.ui_resources_alias=/custom_logon

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

       8.      Restart the AS Java.

Example

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.

Syntax 

ยท         <?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>

.

End of Content Area