JBoss.orgCommunity Documentation

Administration Guide

For JBoss ESB administrators

JBoss Community


The Administration Guide contains information on how to configure and manage the JBoss Enterprise Service Bus (ESB).

The JBossESB supports a number of JMS providers. Currently we have successfully tested JBoss Messaging, JBossMQ, ActiveMQ and Websphere MQ Series (version 5.3 and 6.0). We recommend JBoss Messaging. At this time we know of no reasons why other JMS implementations should not also work, but have not been able to verify this.

How can I configure them?

JMSListeners and JMSGateways can be configured to listen to a Queue or Topic. For this you can use set the following parameters in the service configuration file: jndi-URL, jndi-context-factory, jndi-pkg-prefix, connection-factory, destination-type and destination-name. Furthermore you will need to add the client jms jars of the JMS-provider you want to use to the classpath.

When using JMS, JBossESB utilizes a connection pool to improve performance. By default the size of this pool is set to 20, but can be over-ridden by setting the org.jboss.soa.esb.jms.connectionPool property in the transports section of the JBossESB configuration file. Likewise, if a session cannot be obtained initially, JBossESB will keep retrying for up to 30 seconds before giving up. This time can be configured using the org.jboss.soa.esb.jms.sessionSleep property.

The JBoss ESB's JmsConnectionPool pools JMS Sessions and is used by all JMS based components – JMS Listeners, JMS Couriers, JMS Router etc.

Some JMS providers limit the number of JMS Sessions per connection. This means that the JMS Components in JBoss ESB need to support a control mechanism for the maximum number of sessions created from each JMS Connection managed by a single JmsConnectionPool instance. This is done simply be specifying one or both of the following properties in the JNDI configuration of the JMS Component (JMS Provider/Bus, JMSRouter etc):

So if neither of the above parameters are configured, the JmsConnectionPool will create a single JMS Connection and create all JMS Sessions off that Connection instance.

These configurations should be made as generic property configurations on the JMS Provider configuration e.g.

<jms-provider ...>

    <property name="max-sessions-per-connection" value="5" />
    <property name="max-xa-sessions-per-connection" value="1" />

    <!-- And add providers.... -->

  1. For Websphere MQ Series, you should set the main JNDI parameters to:

  2. You will also need to configure the max-xa-sessions-per-connection property to a value of “1” if using XA Connections. For more on how to configure this property, see the Max Sessions Per Connection section.

  3. On your classpath you should have

  1. For Oracle AQ you should set the parameters to:

  2. Use the following properties:

    <property name="java.naming.factory.initial"    value="org.jboss.soa.esb.oracle.aq.AQInitialContextFactory"/>
    <property name="java.naming.oracle.aq.user"     value="<user>"/>
    <property name="java.naming.oracle.aq.password" value="<pw>"/>
    <property name="java.naming.oracle.aq.server"   value="<server>"/>
    <property name="java.naming.oracle.aq.instance" value="<instance>"/>
    <property name="java.naming.oracle.aq.schema"   value="<schema>"/>
    <property name="java.naming.oracle.aq.port"     value="1521"/>
    <property name="java.naming.oracle.aq.driver"  value="thin"/>
  3. Optionally specify a database connection url:

    <property name="java.naming.factory.initial"    value="org.jboss.soa.esb.oracle.aq.AQInitialContextFactory"/>
    <property name="java.naming.oracle.aq.user"     value="<user>"/>
    <property name="java.naming.oracle.aq.password" value="<pw>"/>
    <property name="java.naming.oracle.aq.url"   value="jdbc:oracle:thin:@(description=(address_list=(load_balance=on)(failover=on)(address=(protocol=tcp)(host=host1)(port=1621))(address=(protocol=tcp)(host=host2)(port=1621)))(connect_data=(service_name=SID)(failover_mode=(type=select)(method=basic)))) "/>

The ESB uses a database for persisting Registry services, and the Message-Store.

Database scripts for each of these can be found under:

Message-Store: ESB_ROOT/services/jbossesb/src/main/resources/message-store-sql

Service Registry: The service registry is now jUDDI v 3.0.1, which does not use SQL scripts but uses the persistence layer to initialize the database schema.

A few database types and their scripts are provided, and you should be able to easily create one for your particular database (if you do, please contribute it back to us).

For the Message-Store you will need to also update the data-source setting properties in the main ESB config file jbossesb-properties.xml. The following are settings you will need to change, based on the connection information appropriate to your environment – these settings are found in the DBSTORE section of the file.

As long as there is script for your database the ESB will auto-create the schema's on startup. By default JBossESB is configured to use a JEE DataSource.

<properties name="dbstore">
    <property name="org.jboss.soa.esb.persistence.db.conn.manager" 

    <!-- this property is only used if using the j2ee connection manager -->
    <property name="org.jboss.soa.esb.persistence.db.datasource.name"

When running from the standalone bootstrapper use:

<properties name="dbstore">
    <!--  connection manager type -->
    <property name="org.jboss.soa.esb.persistence.db.conn.manager"
    <!-- FIXME: is this a typo ? -->
    <property name="org.jboss.soa.esb.persistence.db.conn.manager"
    <property name="org.jboss.soa.esb.persistence.db.connection.url"
    <property name="org.jboss.soa.esb.persistence.db.jdbc.driver"
    <property name="org.jboss.soa.esb.persistence.db.user" value="sa"/>
    <property name="org.jboss.soa.esb.persistence.db.pwd" value=""/>        
    <property name="org.jboss.soa.esb.persistence.db.pool.initial.size" value="2"/>
    <property name="org.jboss.soa.esb.persistence.db.pool.min.size" value="2"/>
    <property name="org.jboss.soa.esb.persistence.db.pool.max.size" value="5"/>
    <property name="org.jboss.soa.esb.persistence.db.pool.test.table" value="pooltest"/>        
    <property name="org.jboss.soa.esb.persistence.db.pool.timeout.millis" value="5000"/> 

The Service Registry database information is contained in the esb.juddi.xml file. You should consult the Service Registry section of this document for more detailed information on what settings and their values and how they effect the behavior of the ESB.

JBoss server comes with a pre-installed hypersonic database (HSQLDB). The database can only be accessed in the same JVM. The data-source definition can be found in the jbossesb.sar/message-store-ds.xml.

This section describes the steps to move from using the default hypersonic database to postgres. These steps should be the same for any other database. Just replace postgres with the database you want to switch to.

Procedure 1.1. Changing the database to PostgreSQL

  1. Remove deploy/hsqldb-ds.xml and add the following in a file named deploy/postgres-ds.xml:

    <?xml version="1.0" encoding="UTF-8"?>
                <type-mapping>PostgreSQL 7.2</type-mapping>
                select count(*) from jbm_user

    Modify the above to suite your needs, connection parameters and such. Make sure the name of the DS is the same though (DefaultDS)

  2. Replace deploy/jbossesb-registry.sar/juddi-ds.xml with the same configuration in the previous step (change the database name if needed).
Again make sure the keep the jndi-name(juddiDB). 

  3. Replace deploy/jbossesb.esb/message-store-ds.xml with the same configuration in step one (change the database name if needed).
Again make sure the keep the jndi-name(JBossESBDS).

  4. Replace the database name in the 'message-store-sql' element in deploy/jbossesb.esb/jbossesb-service.xml:

    <?xml version="1.0" encoding="UTF-8"?>
        <mbean code="org.jboss.internal.soa.esb.dependencies.DatabaseInitializer"
            <attribute name="Datasource">java:/JBossESBDS</attribute>
            <attribute name="ExistsSql">select * from message</attribute>
            <attribute name="SqlFiles">
  5. Edit jbossesb-registry.sar/META-INF/persistence.xml. The hibernate.dialect property must be set to the type of database that you are using in your datasource (org.hibernate.dialect.PostgreSQLDialect for example).

  6. Replace deploy/jboss-messaging/hsqldb-persistence-service.xml with the postgres-persistence-service.xml from the version of JBM that you are running.

    This needs to match the same version and might not work it the versions mismatch. These files can be found in src/etc/server/default/deploy of a JBM distribution.

  7. Copy the database driver to the servers lib directory and fire up the server.

JBossESB allows for multiple message store implementations via a plugin-based architecture. As an alternative to the default database message store, a JSR-170 (Java content repository) message store may be used. The JCR implementation included with JBossESB is Apache Jackrabbit. To enable the JCR message store, add the following property to the "core" section of jbossesb-properties.xml in the root of the jboss-esb.sar (or the root of deployers/esb.deployer on AS5):

<property name="org.jboss.soa.esb.persistence.base.plugin.jcr"

This adds the JCR plugin to the list of available message stores. The JCR message store can use an existing repository via JNDI or can create a standalone instance locally on the application server. The following list of properties should be added in the "dbstore" section of jbossesb-properties.xml to configure repository access:

<property name="org.jboss.soa.esb.persistence.jcr.jndi.path" value="jcr"/>
<property name="org.jboss.soa.esb.persistence.jcr.username" value="username"/>
<property name="org.jboss.soa.esb.persistence.jcr.password" value="password"/>
<property name="org.jboss.soa.esb.persistence.jcr.root.node.path"

An easy test for whether the JCR message store is configured properly is to add the org.jboss.soa.esb.actions.persistence.StoreJCRMessage action onto an existing service. The action will attempt to store the current message to the JCR store.

It is possible to trace any and all Messages sent through JBossESB. This may be important for a number of reasons, including audit trail and debugging. In order to trace Messages you should ensure that they are uniquely identified using the MessageID field of the Message header: as mentioned in the Programmers Guide, this is the only way in which Messages can be uniquely identified within the ESB.

By default, JBossESB components (e.g., gateways, ServiceInvoker and load balancing) log all interactions with Messages through standard logger messages. Such log messages will contain the entire header information associated with the Message which will enable correlation across multiple JBossESB instances. You can identify these messages by looking for the following in your output:

header: [ To: EPR: PortReference < <wsa:Address ftp://foo.bar/> >, From: null, ReplyTo: 
EPR: PortReference < <wsa:Address http://bar.foo/> >, FaultTo: null, Action: urn:dowork, 
MessageID: urn:foo/bar/1234, RelatesTo: null ]

Furthermore, you can enable a logging MetaData Filter, whose only role is to issue log messages whenever a Message is either input to an ESB component, or output from it. This filter, org.jboss.internal.soa.esb.message.filter.TraceFilter, can be placed within the Filter section of the JBossESB configuration file, in conjunction with any other filters: it has no effect on the input or output Message. Whenever a Message passes through this filter, you will see the following log at info level:

TraceFilter.onOutput ( header: [ To: EPR: PortReference < <wsa:Address ftp://foo.bar/> >, 
From: null, ReplyTo: EPR: PortReference < <wsa:Address http://bar.foo/> >, FaultTo: null, 
Action: urn:dowork, MessageID: urn:foo/bar/1234, RelatesTo: null ] )

TraceFilter.onInput ( header: [ To: EPR: PortReference < <wsa:Address ftp://foo.bar/> >, 
From: null, ReplyTo: EPR: PortReference < <wsa:Address http://bar.foo/> >, FaultTo: null, 
Action: urn:dowork, MessageID: urn:foo/bar/1234, RelatesTo: null ] )

TraceFilter will only log if the property org.jboss.soa.esb.messagetrace is set to on/ON (the default setting is off/OFF). By default, if enabled it will log all Messages that pass through it. However, for finer grained control you may enable finer grained control over which Messages are logged and which are ignored. To do this make sure that the property org.jboss.soa.esb.permessagetrace is set to on/ON (the default is off/OFF). Once enabled, those Messages with a Property of org.jboss.soa.esb.message.unloggable set to yes/YES will be ignored by this filter.

Beginning with JBossESB 4.2, there is now support for fail-over of stateless services. You should consult the Programmers Guide for further details, but the pertinent issues to note are:

JBossESB uses Endpoint References (EPRs) to address messages to/from services. As described in the Programmers Guide, messages have headers that contain recipient addresses, sequence numbers (for message correlation) and optional addresses for replies, faults etc. Because the recommended interaction pattern within JBossESB is based on one-way message exchange, responses to messages are not necessarily automatic: it is application dependent as to whether or not a sender expects a response.

As such, a reply address (EPR) is an optional part of the header routing information and applications should be setting this value if necessary. However, in the case where a response is required and the reply EPR (ReplyTo EPR) has not been set, JBossESB supports default values for each type of transport. Some of these ReplyTo defaults require system administrators to configure JBossESB correctly.

There are a number of options for monitoring and managing your ESB server. Shipping with the ESB are a number of useful JMX MBeans that help administrators monitor the performance of their server.

Under the jboss.esb domain, you should see the following MBean types:

deployment=<ESB package name>

Deployments show the state of all of the esb packages that have been deployed and give information about their XML configuration and their current state.

listener-name=<Listener name>

All deployed listeners are displayed, with information on their XML configuration, the start time, maxThreads, state, etc. The administrator has the option of initialising/starting/stopping/destroying a listener.


Message counters break all of the services deployed for a listener down into their separate actions and give counts of how many messages were processed, as well as the processing time of each message.

service-name=<Service name>

Displays statistics per-service (message counts, state, average size of message, processing time, etc). The message counts may be reset and services may be stopped and started.


Additionally, jms domain MBeans show statistics for message queues, which is useful information when debugging or determining performance.

JBossESB provides management and monitoring through Embedded JOPR: (http://localhost:8080/admin-console).

The JBossESB monitoring console gathers information on the performance of different ESB services that are deployed . As of JBoss ESB 4.2.0.GA, the monitoring console allows users to get message counts by service, action, and node, as well as other information like processing time, number of failed messages, bytes transferred, and last successful and failed message date time. As of JBoss ESB 4.6, the previous ESB monitoring tool has been deprecated.

The monitoring console is installed automatically in the stand-alone ESB server and JBossAS.

Below is a screenshot of the console. The console requests MBean information from each node within the ESB registry, and then displays it back.

The JBoss Web Console (http://community.jboss.org/wiki/WebConsole) is a utility within both the JBoss AS and the JBoss ESB Server that is capable of monitoring and sending alerts based off of JMX MBean properties. You can use this functionality to receive alerts for ESB-related events – such as the DeadLetterService counter reaching a certain threshold.

  1. Configure ./deploy/mail-service.xml with your SMTP settings.

  2. Change ./deploy/monitoring-service.xml – uncomment the EmailAlertListener section and add appropriate header related information.

  3. Create a file ./deploy to serve as your monitor MBean.

<?xml version="1.0" encoding="UTF-8"?>
<mbean code="org.jboss.monitor.ThresholdMonitor"
  <attribute name="MonitorName">ESB DeadLetterQueue Monitor</attribute>
  <attribute name="ObservedObject">
  <attribute name="ObservedAttribute">overall service message count</attribute>
  <attribute name="Threshold">4</attribute>
  <attribute name="CompareTo">-1</attribute>
  <attribute name="Period">1000</attribute>
  <attribute name="Enabled">true</attribute>
  <depends-list optional-attribute-name="AlertListeners">

This MBean will serve as a monitor, and once the DeadLetterService counter reaches 5, it will send an e-mail to the address(es) specified in the monitoring-service.xml. Note that the alert is only sent once – once the threshold has been reached. If you want to be alerted again once resetting the counter, you can reset the alerted flag on your monitoring service MBean (in this case jboss.monitor:service=ESBDLQMonitor).


For more details on how to use the JBoss Web Console monitoring, please see http://community.jboss.org/wiki/JBossMonitoring.

JBossAS as well as the JBossESB-Server are always checking the 'deploy' directory for new files to deploy. So we're really talking about hot redeployment. So here is what you have to do to make it redeploy an existing deployment for the different components.

  1. SAR files

    The jbossesb.sar is hot deployable. It will redeploy when

    • the timestamp of the archive changes, if the sar is compressed archive.

    • the timestamp of the META-INF/jboss-service.xml changes, if the sar is in exploded from.

  2. ESB files

    Any *.esb archive will redeploy when

    • the timestamp of the archive changes, if the esb is compressed archive.

    • the timestamp of the META-INF/jboss-esb.xml changes, if the esb is in exploded from.

    Our actions have lifecycle support, so upon hot deployment it goes down gracefully, finishes active requests, and does not accept any more incoming messages until it is back up. All of this can be done by simply redeploying the .esb archive. If you want to update just one action, you can use groovy scripting to modify an action at runtime (see the groovy QuickStart: http://wiki.jboss.org/wiki/Wiki.jsp?page=JBossESBQuickStart.)

  3. rule files

    There are two options to refresh rule files (drl or dsl)

    1. redeploy the jbrules.esb (see 2)

    2. turn on the 'ruleReload' in the action config (see http://wiki.jboss.org/wiki/Wiki.jsp?page=JBossESBContentBasedRouting). Now if a rule file *changes* it will be reloaded. .) After doing so, if a rule file is changed, it will be re-loaded.

  4. transformation files

    The only way to refresh transformation files is to redeploy the esb archive in which the transformation file resides.

  5. Business Process Definitions

    When using jBPM new Business Process Definitions can be deployed. From within the jBPM eclipse plugin you can deploy a new definition to the jbpm database. New process instances will get the new version, in flight processes will finish their life cycle on the previous definitions. For details please see the documentation on jBPM.

The jBPM integration within ESB now support additional Message and Scheduler services, distinct from those offered natively by jBPM. In addition to the standard jBPM configurations we now also support a JMS based Message Service, driven using JCA inflow, and three additional Scheduling Services, based on JBoss Messaging, hornetq and quartz.

The configuration, as shipped by default within ESB, uses the jBPM JobExecutor and the database implementations of the Message and Scheduler service.

<service name="message" factory="org.jbpm.msg.db.DbMessageServiceFactory" /> 
<service name="scheduler" factory="org.jbpm.scheduler.db.DbSchedulerServiceFactory" /> 

<bean name="jbpm.job.executor" class="org.jbpm.job.executor.JobExecutor"> 

In order to utilize the alternative services it is necessary to replace the active configurations with the versions specific to your requirements.

The configuration for the alternative services can be found within the jbpm.esb/config directory

The configuration files within the appropriate directory should be used to replace the active configurations within the jbpm.esb directory, remembering to remove the .config suffix from each. It should also be noted that only one of the quartz message queue service definitions should be used, either hornetq-jms.xml, jbm-queue-service.xml or jbmq-queue-service.xml, depending on which JMS implementation is currently in use.

The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software - to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.) You can apply it to your programs, too.

When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things.

To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it.

For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.

We protect your rights with two steps:

Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations.

Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all.

The precise terms and conditions for copying, distribution and modification follow.

You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions:

  1. You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change.

  2. You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License.

  3. If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: If the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.)

These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it.

Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program.

In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.

You may copy and distribute the Program (or a work based on it, under Section 2 in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following:

  1. Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,

  2. Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,

  3. Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.)

The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable.

If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code.

If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program.

If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances.

It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice.

This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License.

If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.

To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.

<one line to give the program's name and a brief idea of what it does.> Copyright (C) <year> <name of author>

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Also add information on how to contact you by electronic and paper mail.

If the program is interactive, make it output a short notice like this when it starts in an interactive mode:

Gnomovision version 69, Copyright (C) year name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type “show w”. This is free software, and you are welcome to redistribute it under certain conditions; type “show c” for details.

The hypothetical commands “show w” and “show c” should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than “show w” and “show c”; they could even be mouse-clicks or menu items--whatever suits your program.

You should also get your employer (if you work as a programmer) or your school, if any, to sign a “copyright disclaimer” for the program, if necessary. Here is a sample; alter the names:

Yoyodyne, Inc., hereby disclaims all copyright interest in the program “Gnomovision” (which makes passes at compilers) written by James Hacker.

<signature of Ty Coon>, 1 April 1989 Ty Coon, President of Vice

This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Library General Public License instead of this License.

Revision History
Revision 1Fri Jul 16 2010David Le Sage, Darrin Mison
Initial conversion from OpenOffice ODT files.