Use the serviceDeploy command to package
Service Component Architecture (SCA) compliant modules as Java™ applications that can be installed on a
server. The command is useful when performing batch installs through
wsadmin.
Purpose
The
serviceDeploy command
builds an .ear file from a .jar or .zip file that contains service
components.
Note: Parameters are not case-sensitive.
Roles
This command can be issued by users
with the following roles:
Syntax

>>-serviceDeploy-- --inputarchive------------------------------->
>--+---------------------------------+-------------------------->
'- -workingDirectory-- --temppath-'
>--+-------------------------------------------------+---------->
'- -outputApplication-- --+-inputarchiveApp.ear-+-'
'-outputpathname.ear--'
>--+----------------+--+------------+--------------------------->
'- -noJ2eeDeploy-' '- -freeform-'
>--+-----------------------+--+--------+--+----------------+---->
'- -cleanStagingModules-' '- -keep-' '- -ignoreErrors-'
>--+-----------------------------------------------------+------>
'- -classpath-- --jarpathname--;--rarpathname--;--...-'
>--+----------------------------+--+-------------+-------------->
'- -fileEncoding-- --charset-' '- -javaDebug-'
>--+----------------+--+----------------+--+--------+----------><
'- -noJavaSource-' '- -uniqueCellID-' '- -help-'
Parameters
- inputarchive
- A required, positional parameter that specifies the .jar, .zip
or .ear file that contains the application to be deployed. If the
command is not issued from the path in which the file resides, this
must be the full path for the file. The .zip file can be either a
nested archive or an Eclipse Project Interchange format file.
- -classpath
- An optional parameter that specifies the locations of required
resource files (.jar and .rar) files. The path to each file should
be a fully-qualified path separated by semicolons (;) with no spaces.
- -fileEncoding
- An optional parameter that specifies the character set (charset)
required if the application you are deploying uses a charset other
than one supported by the Java virtual
machine's (JVM) default file encoding.
Note: On z/OS®,
the serviceDeploy command always uses ASCII as
the default file encoding.
For example, if the application
contains a business rule table that contains Japanese characters,
you must specify a charset (such as UTF-8) that
supports double-byte characters to prevent data corruption in the
generated Java and class files.
Valid
values for -fileEncoding are located at http://java.sun.com/j2se/1.4.2/docs/api/java/nio/charset/Charset.html.
If not specified, this parameter defaults
to the default character set supported by the Java development
kit (JDK).
Important: This parameter only affects files
generated by serviceDeploy. Existing files retain
their current encoding.
Restriction: If you specify
a charset not supported by the operating system
that is running the serviceDeploy command, the
system processes the archive as if you had not specified -fileEncoding and
messages are written to the system log.
- -freeform
- An optional parameter that specifies that the J2EE subdirectory
in the service.jar should be treated as a free-form project.
- -help
- An optional parameter used to display the parameters for this
command.
- -ignoreErrors
- An optional parameter that specifies that the serviceDeploy command
builds an .ear file regardless of errors while building or validating
the application. By default, the serviceDeploy command
does not generate an .ear file if there are errors with an application.
- -javaDebug
- An optional parameter that specifies whether all debug information
should be included in generated class files.
- -noJavaSource
- An optional parameter that specifies whether the Java source files
should be excluded from the generated EAR file. By default, the Java
source files are included.
- -cleanStagingModules
- An optional parameter that specifies whether to delete staging
modules within an input .ear file before deployment. By default, the serviceDeploy command
imports existing staging modules and their contents.
- -keep
- An optional parameter that specifies whether to save any temporary
files generated after deployment. By default, the serviceDeploy command
deletes the temporary workspace.
- -noJ2eeDeploy
- An optional parameter that specifies whether the application requires
EJB deployment after generating the .ear file. By default, the serviceDeploy command
runs the J2EE deployers for the application.
- -outputApplication
- An optional parameter that specifies the name of the .ear file
the serviceDeploy command creates. The default
is inputarchiveApp.ear, where inputarchive is
the filename minus the extension specified for the input .jar file.
- -outputApplicationMigratedApp.ear
- An optional parameter that specifies that the input archive was
a .jar file migrated from a WebSphere® Interchange Server.
- -uniqueCellID
- An optional parameter that specifies a string
identifier that is used to create a unique instance of the application.
The identifier must be unique in the context of the cell.
- -workingDirectory
- An optional parameter that specifies a directory the serviceDeploy command
uses to write temporary files.
Inputs
The following file types can be used
as input to the
serviceDeploy command:
- jar
- The most useful file type for the simplest applications. The resulting
.ear file contains a single .jar file and any needed generated staging
modules. The .jar file must contain the service.module
file.
- zip (Project Interchange)
- You can export from WebSphere Integration Developer an archive file
in project interchange format. This format is unique to the Eclipse
development. The exported zip file must contains exactly one project
with the service.module file. The resulting .ear
file contains any number of modules, depending upon exactly what is
in the project interchange.
- zip
- You can create a zip file containing .jar files, .war files, and
.rar files. Exactly one .jar file must contain the service.module
file. All contained archives become members of the final exported
.ear file.
- ear
- You can always run the serviceDeploy command
against an .ear file as long as exactly one .jar file in the .ear
file contains a service.module file.
Output
When serviceDeploy completes
processing, it creates an .ear file in the directory from which the
command is run unless the -outputApplication parameter
is specified.
Example of serviceDeploy command
The
following command example:
- Creates an application file called MyValueModule.ear from
the MyValueModule.jar file.
- Specifies that the resources reside in the directories c:\java\myvaluemoduleres.rar and c:\java\commonres.jar.
- Enables the Java subdirectory within the .jar
file as free-form.
- Keeps the temporary files generated during deployment.
servicedeploy MyValueModule.jar
-classpath "c:\java\myvaluemoduleres.rar;c:\java\commonres.jar"
-noj2eedeploy -freeform true -keep