Storing passwords in SAP PI modules.

Setting user and password inside a module is slightly different from normal adapter module parameters as the text can’t be kept in clear-text in module parameters.

Three strategies we can use:

1)  Hard coded values: Use hard-coded user id and password in the module. Not a great approach but sometimes this can be the only feasible option. The advantage of course is that there is no risk of locking the user.

2) Comm channel params starting with specific strings: Setting in comm channel as a secure parameter ( displayed as asterisk ).

Here, user can be set as a normal string parameter. For passwords, we don’t want the password to show up in clear text. Hence, password can be the following:

  • – If password parameter  starts with pwd, it’s displayed as asterisks when entered and displayed. However, the database folder is unencrypted.
  • – If password parameter starts with cryptedpassword, the database folder is encrypted. This is more secure as the database folder is encrypted.

The advantage is that the values can be configured for each system and the drawback being if the password is not correctly entered it can get locked and trying to find the comm channel which is locking the user can be time consuming.

3) Setting values in Application Properties. This  combines the best of both worlds – we’re able to configure values in each environment and as we’re configuring it in only one location, the chances of accidentally locking the user due to incorrect values is reduced.

i) for >= 7.1 environment

The values can be modified from NWA. The path is:


Configuration Management->Infrastructure->Java System Properties

Steps required to add configuration capacity.

a)  Add to the module EJB project.

Path to get the client library: /usr/sap/<SID>/<instance>/j2ee/cluster/bin/services/configuration/lib/private/

b) Create file under META-INF. It’s essentially a  .properties file.


Sample content to make User modifiable and appear as clear text

## Comment for user

#? secure = false; onlinemodifiable = true

#% type = STRING;

User =

Sample content to make User modifiable and appear as asterisk when entering in NWA.

## Comment for password

#? secure = true; onlinemodifiable = true

#% type = STRING;

Password =

c) Update module code to read the property

Sample code will look something like this ( to be added in the module code )

// Obtain the JNDI context

InitialContext ctx = new InitialContext();

// access the Application-Configuration-Façade service

ApplicationPropertiesAccess appCfgProps = (ApplicationPropertiesAccess) ctx.lookup(“ApplicationConfiguration”);

java.util.Properties appProps = appCfgProps.

if (appProps == null) {

// perform error handling




userID = appProps.getProperty(“

password = appProps.getProperty(“Password”);


d) Update application deployment descriptor to indicate the library being used. Add this to application-j2ee-engine.xml .

<reference reference-type=“hard”>

    <reference-target provider-name=“”





ii) For 7.0 environment

a) Replace

ApplicationPropertiesAccess appCfgProps;

appCfgProps = (ApplicationPropertiesAccess) ctx.lookup(“ApplicationConfiguration”);

java.util.Properties appProps = appCfgProps.getApplicationProperties();


ApplicationConfigHandlerFactory cfgHandler = (ApplicationConfigHandlerFactory)ctx.lookup(“ApplicationConfiguration”); 

java.util.Properties appProps = cfgHandler.getApplicationProperties();

b) Update application-j2ee-engine.xml

<reference reference-type=”hard”>

    <reference-target provider-name=””





c) Update the property in Visual Admin:

Server -> services -> configuration adapter-> Runtime -> Display configuration-> Configurations -> apps -> <YOURAPP>-> appcfg -> Propertysheet

d) it can be displayed in.


Local System->apps->> <YOUR APP >-> appcfg -> Propertysheet

To report this post you need to login first.


You must be Logged on to comment or reply to a post.

  1. brahmaji atla

    Hi Vikas Singh,

    Thanks for the information which you provided, but i did not get user,password under properties tab in NWA (mentioned location in the blog).

    Could you please guide me to get out of this issue.

    More appreciate for your help.

    Thanks brahmaji


Leave a Reply