Creating the EAR on JBoss

About this task

During the ear build, when JAX-WS webservice creation occurs, Sterling Order Management System Software will look for customer extensions and use them if they exist. If they do not exist, default handler XML and handler classes will be built into the ear and used. Sterling Order Management System Software provides one single set of default handlers that will get used against all beans that are deployed and for which customers have not provided extensions. Customer extensions can be provided on a per JAX-WS bean basis.

Enterprise Archives are built using an ANT (buildEAR.xml) that accepts the following targets:

Main Target
Creates smcfs.ear - the Sterling Order Management System Software application EAR file.
Note: To successfully build the application EAR file in 64-bit JBoss, use the following memory parameters:
-XX:MaxPermSize=768m -Xmx2048m -Xms2048m

You can set these memory parameters during installation or in the sandbox.cfg file after installation.


  1. Add the values of the following properties in the sandbox.cfg file located in the <INSTALL_DIR>/properties directory as follows:
    JBOSS_DIR=<Path to JBoss installation directory>
  2. Run the setupfiles script as follows:
    • Windows<INSTALL_DIR>\bin\setupfiles.cmd
  3. Create the application EAR file, by running the following command from the <INSTALL_DIR>/bin directory:
    ./ -Dappserver=jboss  -Dwarfiles=<application wars> -Dearfile=smcfs.ear -Dasyncejb=true create-ear 
    .\buildear.cmd -Dappserver=jboss  -Dwarfiles=<application wars> -Dearfile=smcfs.ear -Dasyncejb=true create-ear
    Note: Sterling Order Management System Software supports the RPC encoded or document literal style and usage of invocation for Web services. When choosing style and usage for JBoss, pass the following in the ear command line:

    Running this command creates the smcfs.ear file in the <INSTALL_DIR>/external_deployments/ directory. Depending on the application wars provided in the command while creating the EAR, appropriate war files are included in the smcfs.ear. Examples:

    • smcfs.war - the Sterling Order Management System Software or Sterling Configure, Price, Quote war file.
    • sma.war - the System Management Administrator application war file.
    • sbc.war - the Sterling Business Center application war file.


    You can add the following options to the end of the above buildear commands:

    • -Dnowebservice=true if you do not want to use Web services.
    • -Ddevmode=true if you want to use the HTTP API Tester in the development environment.
      Note: If the -Ddevmode is set to true while building the EAR, few struts developer notification errors may be logged while using the application. You can ignore the error log.
    • -Dnodocear=true if you want to skip the documentation build. Use this option when building the ear for a production environment. The doc ear does not contain end-user documentation, such as context-sensitive help files. It contains only development-related documentation, including API Javadoc, ERDs, and XSDs and should not be deployed to a production server.
    • -Dsupport.multi.war=true if you want to copy all the UI jars to <WAR>/WEB-INF/lib. The UI jars will be copied based on the entry in DCL.xml.
    •<application_name> if you want to override the default value of "Sterling applications" and build some other application, particularly in an auto-deploy scenario.
    • -Dasyncejb=true - Use this option only if you are implementing the Parallel Processing functionality.
    Note: When the JBoss server is started, warnings related to batik-rasterizer-1.6.jar are displayed. You can ignore the error log.
    Note: If exceptions are thrown regarding application server startup or EAR deployment, this may indicate failure and require fixing and redeployment. Consult the Troubleshooting and Support topics.