Skip to main content link. Accesskey S

The useful resource for IBM Lotus Domino XPages development

Submit Search


Home > Work with application settings and xpage properties
xpageswiki.com
is maintained by 
Julian Buss.
You can hire me.

Work with application settings and xpage properties

ShowTable of Contents

server wide properties


On the domino server in data/properties there is a xsp.properties.sample file.
In this textfile there are a lot of properties with which you can control various XPages options for all XPages apps on that server, unless they have a property defined on their own.

To set server wide properties, create a new textfile "xsp.properties" in that directory and set the properties you like there, using values the xsp.properties.sample file as a template.

application specific properties


Each application has a xsp.properties file, too. It's accessible if you are in the package explorer view and go to WebContent/WEB-INF/xsp.properties.
You can edit this file and add properties as you like.
Use the xsp.properties file from the Domino server as a template.

useful properties


Some properties are especially useful for most applications:

# Application timeout management
# Defines when an application is discarded from memory after a period of inactivity
# Expressed in minutes 
#xsp.application.timeout=30

# Session timeout management
# Defines when a user session is discarded from memory after a period of inactivity
# Expressed in minutes 
#xsp.session.timeout=30

# This controls the maximum size, in kilobytes, of a file being uploaded as an attachment
#xsp.upload.maximumsize=1024

# Define the directory where the temporary uploaded files are stored
# defaults to <tempdir>/xspupload
#xsp.persistence.dir.xspupload=

# Define the directory where the document attachments are temporarily persisted
# defaults to <tempdir>/xsppers
#xsp.persistence.dir.xsppers=

# Add parameters to the djConfig attribute of Dojo.
# Useful to switch Dojo to debug, using for example:
#   xsp.client.script.dojo.djConfig=isDebug:true
#xsp.client.script.dojo.djConfig=

# Defines the document doctype generated by the engine
# Defaults to HTML 4.01 transitional, but XHTML is available with:
#   html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"
# Note that when using XHTML, the content type is still text/html as IE, as well as Dojo, don't support application/xhtml+xml
#xsp.html.doctype=HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"

# Ask the XPages runtime to generate a <meta> tag in the HTML header defining the content type, and the optional
# character set. This meta tag is the first tag appearing after the <head> one.
# For example, it generates domething like:
#  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
#xsp.html.meta.contenttype=false

# Defines the character set returned for the page
#xsp.html.page.encoding=utf-8

# XSP compression
# this defines the compression mode used when a page is rendered to the client
# the compression is effectively enabled when the client supports it, as specified in the HTTP header of the request
# the possible values are
#    none
#               no compression at all
#    gzip
#       the response contains the content-length header, which forces the data to be buffered. this is the prefered mode
#       and is required to support HTTP 1.1 persistent connections.
#    gzip-nolength
#       The content is compressed but it doesn't compute the content-length, thus it doesn't need to buffer the result.
#xsp.compress.mode=gzip

# Page redirect mode - This happens when the runtime redirects to a new page (navigation rules, API, simple action)
# When this property is true, then the runtime emits an HTTP 302 code to the ask client to redirect to the new page. This ensures
# that the client has the right URL in its address bar, at the cost of an extra client/server roundtrip. Else, the redirection is purely
# done on the server, without any notification to the browser (the URL doesn't change)
#xsp.redirect=true

# Defines which filter should be used by default for some controls (richtext)
# The valid values are:
#    - acf: use the acf library
#    - identity: no filtering is applied
#    - empty: the entire text is stripped out
#    - striptags: all the html tags are stripped out. Only the text pieces remain
#xsp.richtext.default.htmlfilter=acf
#xsp.richtext.default.htmlfilterin=

# Defines the behavior in repeating controls when the rows property 
# evaluates to 0. By default, in that situation 30 rows are displayed 
# per page. With this option set to true no rows would be displayed. 
# This may be useful when computing the number of rows to display, 
# as there may be situations when no rows should be displayed 
# but the control should still be rendered.
#xsp.repeat.allowZeroRowsPerPage = false

# There allows a use to configure the partial update timeout in Designer
# The default is 20 seconds
#xsp.partial.update.timeout=

# Defines how doc/db/view/app links should be saved in a Domino Document
# Valid Values are:
#               - UseNotes: Saves your links with the notes protocol
#               - UseWeb:   Saves your links as web links       
#xsp.save.links=UseNotes

Add Comment

Name:
Comments:
How to take your XPages App to the iPhone, iPad, Android: use Domino To Go!
Do you look for an XPages Workflow solution? Take YouAtNotes Workflow.