.ear file with the given Oracle BPM applications.
Specify a nested element for each application you want to include in the .ear.
To generate only the .war file for each of the Oracle BPM web applications, see tasks
<buildworkspace>, <buildpapiws>, <buildfeeds>, <buildconsole>, <buildportaladmin>.
Example 1: Building .ear containing only the Process Execution Engine application.
<target name="build-engine" description="Build Engine EAR">
<fuego.j2ee:buildear fuegobasedir="${fuego.basedir}"
destfile="${destination.file}"
displayName="${displayName}"
workdir="${fuego.workdir}"
directoryfile="${fuego.directory.file}"
engineid="${engine.name}"
includelibs="true">
<fuego.j2ee:engine />
</fuego.j2ee:buildear>
</target>
Example 2: Building .ear containging Engine and WorkSpace applications,
secured for using authentication provided by the container (for Single Sign On).
<fuego.j2ee:buildear fuegobasedir="${fuego.basedir}"
destfile="${destination.file}"
displayName="${displayName}"
workdir="tmp/workspace"
directoryfile="${directory.file}"
engineid="${engine.name}"
includelibs="true"
secured="true"
roleName="ALBPM-role">
<!-- map security role to these Principals in WebLogic -->
<fuego.j2ee:principals>
<fuego.j2ee:principal name="ALBPM"/>
<fuego.j2ee:principal name="user1"/>
</fuego.j2ee:principals>
<!-- build Engine application -->
<fuego.j2ee:engine/>
<!-- build WorkSpace application -->
<fuego.j2ee:workspace webResourceName="workspace-resource">
<fuego.j2ee:loginconfig>
<fuego.j2ee:authmethod value="FORM"/>
<fuego.j2ee:realm name="myrealm"/>
<fuego.j2ee:formloginconfig loginpage="login.jsp" errorpage="error.jsp"/>
</fuego.j2ee:loginconfig>
</fuego.j2ee:workspace>
</fuego.j2ee:buildear>
| Attribute | Description | Type | Required? |
| webresourcename |
Descriptive name for the web resources of modules included in this EAR. Used in
<web-resource-name> tag in web.xml deployment descriptors.
You can also set this option individually for each application, specifying
webresourcename on each nested element.
|
String |
No Required if secured attribute is set to true.
|
| rolename |
Name of j2ee role to declare in nested application modules.
You can also set this option individually for each application, specifying
rolename on each nested element.
|
String |
No Defaults to ALBPM_Role. Used only when
secured attribute is set to true.
|
| includelibs | Include the required libs for the ear inside the ear itself. | boolean | No Defaults to True if an Engine is included in this ear, and defaults to False otherwise. |
| destdir | The destination directory where the archive file will be written. The file name of the destination archive is calculated based on the module included in the ear. This ear should contain a single module. | File | Yes required if destFile has not been specified |
| directorypreset | Specify a "preset" for authentication to the BPM directory. | String | No Defaults to the "engine" preset. |
| destfile | The file name of the destination archive file. | File | Yes required if destDir has not been specified |
| engineid | The Fuego Server identification. The server is used to obtain the Application Server Vendor and configure the EAR based on it. | String | Yes |
| verbose | Verbose output. | boolean | No Default is false |
| displayname | The description of the ear application. | String | No |
| secured |
If set to true, the application modules included in this EAR declare a security
constraint so that only the specified j2ee role can access the application.
Use this option if you want to leverage the authentication mechanism of your
container (e.g. WebLogic) and Single-Sign-On configurations.
You can also set this option individually for each application, specifying
secured on each nested element.
See also attributes rolename and webresourcename.
|
boolean | No Defaults to false |
| fuegobasedir | Path to Oracle BPM Enterprise installation directory. | File |
No Defaults to value of fuego.basedir property of your
Ant script.
|
| loaderref | Reference to BPM classloader. Used internally. | Reference | No |
| templateset | Sub-directory name from which descriptor template files are loaded. For example: <ORABPM_HOME>/weblogic/templates/engine/default/*. | String | No Defaults to "default". |
| directoryfile |
Path to the directory.xml configuration file, used to connect to the BPM
directory.
|
File | No |
| workdir | A writable directory where temporary files are generated. All the content of the workDir will be delete before executing the task | File | Yes The directory must exist and it must be writable. |
| Attribute | Description | Type | Required |
| expanded |
If set to true, this application module is generated in a directory, instead of a
.war archive file.
|
boolean | No Defaults to false |
| secured |
If set to true, this application module declares a security constraint so that only the
specified j2ee role can access the application.
Use this option if you want to leverage the authentication mechanism of your
container (e.g. WebLogic) and Single-Sign-On configurations.
See also attributes rolename and webresourcename.
|
boolean |
No Defaults to the value of secured defined in the enclosing <buildear> task.
|
| rolename | Name of j2ee role to declare when this application module is secured. | String |
No Defaults to the value of rolename defined in the enclosing <buildear> task.
|
| webresourcename |
Descriptive name for the web resources of this module. Used in
<web-resource-name> tag in web.xml deployment descriptor.
|
String |
No Defaults to the value of webresourcename defined in the enclosing <buildear> task.
|
| federated |
Set this option to true if you want to generate a BPM application that connects to
multiple BPM Directories. If true, you must also specify attribute
lookupnamefilemapping.
|
boolean | No |
| uri | URI for this web application module. | String | No |
| lookupnamefilemapping |
Path to properties file defining the list of BPM Directories to connect to.
Use only when building applications for a "federated" (multiple directories) BPM environment.
Example contents of this file: /OraBPMEnterpriseHome/conf/directory1.xml.id=Production1 /OraBPMEnterpriseHome/conf/directory1.xml.lookupname=BPM_Dir1 /OraBPMEnterpriseHome/conf/directory1.xml.priority=0 /OraBPMEnterpriseHome/conf/directory1.xml.authenticate=true /OraBPMEnterpriseHome/conf/directory2.xml.id=Production2 /OraBPMEnterpriseHome/conf/directory2.xml.lookupname=BPM_Dir2 /OraBPMEnterpriseHome/conf/directory2.xml.priority=1 /OraBPMEnterpriseHome/conf/directory2.xml.authenticate=true |
File |
Yes Only if federated is set to true.
|
| Attribute | Description | Type | Required |
| expanded |
If set to true, this application module is generated in a directory, instead of a
.war archive file.
|
boolean | No Defaults to false |
| secured |
If set to true, this application module declares a security constraint so that only the
specified j2ee role can access the application.
Use this option if you want to leverage the authentication mechanism of your
container (e.g. WebLogic) and Single-Sign-On configurations.
See also attributes rolename and webresourcename.
|
boolean |
No Defaults to the value of secured defined in the enclosing <buildear> task.
|
| rolename | Name of j2ee role to declare when this application module is secured. | String |
No Defaults to the value of rolename defined in the enclosing <buildear> task.
|
| webresourcename |
Descriptive name for the web resources of this module. Used in
<web-resource-name> tag in web.xml deployment descriptor.
|
String |
No Defaults to the value of webresourcename defined in the enclosing <buildear> task.
|
| type | String | ? | |
| federated |
Set this option to true if you want to generate a BPM application that connects to
multiple BPM Directories. If true, you must also specify attribute
lookupnamefilemapping.
|
boolean | No |
| uri | URI for this web application module. | String | No |
| lookupnamefilemapping |
Path to properties file defining the list of BPM Directories to connect to.
Use only when building applications for a "federated" (multiple directories) BPM environment.
Example contents of this file: /OraBPMEnterpriseHome/conf/directory1.xml.id=Production1 /OraBPMEnterpriseHome/conf/directory1.xml.lookupname=BPM_Dir1 /OraBPMEnterpriseHome/conf/directory1.xml.priority=0 /OraBPMEnterpriseHome/conf/directory1.xml.authenticate=true /OraBPMEnterpriseHome/conf/directory2.xml.id=Production2 /OraBPMEnterpriseHome/conf/directory2.xml.lookupname=BPM_Dir2 /OraBPMEnterpriseHome/conf/directory2.xml.priority=1 /OraBPMEnterpriseHome/conf/directory2.xml.authenticate=true |
File |
Yes Only if federated is set to true.
|
| Attribute | Description | Type | Required |
| expanded |
If set to true, this application module is generated in a directory, instead of a
.war archive file.
|
boolean | No Defaults to false |
| secured |
If set to true, this application module declares a security constraint so that only the
specified j2ee role can access the application.
Use this option if you want to leverage the authentication mechanism of your
container (e.g. WebLogic) and Single-Sign-On configurations.
See also attributes rolename and webresourcename.
|
boolean |
No Defaults to the value of secured defined in the enclosing <buildear> task.
|
| rolename | Name of j2ee role to declare when this application module is secured. | String |
No Defaults to the value of rolename defined in the enclosing <buildear> task.
|
| webresourcename |
Descriptive name for the web resources of this module. Used in
<web-resource-name> tag in web.xml deployment descriptor.
|
String |
No Defaults to the value of webresourcename defined in the enclosing <buildear> task.
|
| federated |
Set this option to true if you want to generate a BPM application that connects to
multiple BPM Directories. If true, you must also specify attribute
lookupnamefilemapping.
|
boolean | No |
| uri | URI for this web application module. | String | No |
| lookupnamefilemapping |
Path to properties file defining the list of BPM Directories to connect to.
Use only when building applications for a "federated" (multiple directories) BPM environment.
Example contents of this file: /OraBPMEnterpriseHome/conf/directory1.xml.id=Production1 /OraBPMEnterpriseHome/conf/directory1.xml.lookupname=BPM_Dir1 /OraBPMEnterpriseHome/conf/directory1.xml.priority=0 /OraBPMEnterpriseHome/conf/directory1.xml.authenticate=true /OraBPMEnterpriseHome/conf/directory2.xml.id=Production2 /OraBPMEnterpriseHome/conf/directory2.xml.lookupname=BPM_Dir2 /OraBPMEnterpriseHome/conf/directory2.xml.priority=1 /OraBPMEnterpriseHome/conf/directory2.xml.authenticate=true |
File |
Yes Only if federated is set to true.
|
| Attribute | Description | Type | Required |
| expanded |
If set to true, this application module is generated in a directory, instead of a
.war archive file.
|
boolean | No Defaults to false |
| secured |
If set to true, this application module declares a security constraint so that only the
specified j2ee role can access the application.
Use this option if you want to leverage the authentication mechanism of your
container (e.g. WebLogic) and Single-Sign-On configurations.
See also attributes rolename and webresourcename.
|
boolean |
No Defaults to the value of secured defined in the enclosing <buildear> task.
|
| rolename | Name of j2ee role to declare when this application module is secured. | String |
No Defaults to the value of rolename defined in the enclosing <buildear> task.
|
| webresourcename |
Descriptive name for the web resources of this module. Used in
<web-resource-name> tag in web.xml deployment descriptor.
|
String |
No Defaults to the value of webresourcename defined in the enclosing <buildear> task.
|
| federated |
Set this option to true if you want to generate a BPM application that connects to
multiple BPM Directories. If true, you must also specify attribute
lookupnamefilemapping.
|
boolean | No |
| uri | URI for this web application module. | String | No |
| lookupnamefilemapping |
Path to properties file defining the list of BPM Directories to connect to.
Use only when building applications for a "federated" (multiple directories) BPM environment.
Example contents of this file: /OraBPMEnterpriseHome/conf/directory1.xml.id=Production1 /OraBPMEnterpriseHome/conf/directory1.xml.lookupname=BPM_Dir1 /OraBPMEnterpriseHome/conf/directory1.xml.priority=0 /OraBPMEnterpriseHome/conf/directory1.xml.authenticate=true /OraBPMEnterpriseHome/conf/directory2.xml.id=Production2 /OraBPMEnterpriseHome/conf/directory2.xml.lookupname=BPM_Dir2 /OraBPMEnterpriseHome/conf/directory2.xml.priority=1 /OraBPMEnterpriseHome/conf/directory2.xml.authenticate=true |
File |
Yes Only if federated is set to true.
|
| Attribute | Description | Type | Required |
| expanded |
If set to true, this application module is generated in a directory, instead of a
.war archive file.
|
boolean | No Defaults to false |
| secured |
If set to true, this application module declares a security constraint so that only the
specified j2ee role can access the application.
Use this option if you want to leverage the authentication mechanism of your
container (e.g. WebLogic) and Single-Sign-On configurations.
See also attributes rolename and webresourcename.
|
boolean |
No Defaults to the value of secured defined in the enclosing <buildear> task.
|
| rolename | Name of j2ee role to declare when this application module is secured. | String |
No Defaults to the value of rolename defined in the enclosing <buildear> task.
|
| webresourcename |
Descriptive name for the web resources of this module. Used in
<web-resource-name> tag in web.xml deployment descriptor.
|
String |
No Defaults to the value of webresourcename defined in the enclosing <buildear> task.
|
| federated |
Set this option to true if you want to generate a BPM application that connects to
multiple BPM Directories. If true, you must also specify attribute
lookupnamefilemapping.
|
boolean | No |
| uri | URI for this web application module. | String | No |
| lookupnamefilemapping |
Path to properties file defining the list of BPM Directories to connect to.
Use only when building applications for a "federated" (multiple directories) BPM environment.
Example contents of this file: /OraBPMEnterpriseHome/conf/directory1.xml.id=Production1 /OraBPMEnterpriseHome/conf/directory1.xml.lookupname=BPM_Dir1 /OraBPMEnterpriseHome/conf/directory1.xml.priority=0 /OraBPMEnterpriseHome/conf/directory1.xml.authenticate=true /OraBPMEnterpriseHome/conf/directory2.xml.id=Production2 /OraBPMEnterpriseHome/conf/directory2.xml.lookupname=BPM_Dir2 /OraBPMEnterpriseHome/conf/directory2.xml.priority=1 /OraBPMEnterpriseHome/conf/directory2.xml.authenticate=true |
File |
Yes Only if federated is set to true.
|
| Attribute | Description | Type | Required |
| expanded |
If set to true, this application module is generated in a directory, instead of a
.war archive file.
|
boolean | No Defaults to false |
| secured |
If set to true, this application module declares a security constraint so that only the
specified j2ee role can access the application.
Use this option if you want to leverage the authentication mechanism of your
container (e.g. WebLogic) and Single-Sign-On configurations.
See also attributes rolename and webresourcename.
|
boolean |
No Defaults to the value of secured defined in the enclosing <buildear> task.
|
| rolename | Name of j2ee role to declare when this application module is secured. | String |
No Defaults to the value of rolename defined in the enclosing <buildear> task.
|
| webresourcename |
Descriptive name for the web resources of this module. Used in
<web-resource-name> tag in web.xml deployment descriptor.
|
String |
No Defaults to the value of webresourcename defined in the enclosing <buildear> task.
|
| federated |
Set this option to true if you want to generate a BPM application that connects to
multiple BPM Directories. If true, you must also specify attribute
lookupnamefilemapping.
|
boolean | No |
| uri | URI for this web application module. | String | No |
| lookupnamefilemapping |
Path to properties file defining the list of BPM Directories to connect to.
Use only when building applications for a "federated" (multiple directories) BPM environment.
Example contents of this file: /OraBPMEnterpriseHome/conf/directory1.xml.id=Production1 /OraBPMEnterpriseHome/conf/directory1.xml.lookupname=BPM_Dir1 /OraBPMEnterpriseHome/conf/directory1.xml.priority=0 /OraBPMEnterpriseHome/conf/directory1.xml.authenticate=true /OraBPMEnterpriseHome/conf/directory2.xml.id=Production2 /OraBPMEnterpriseHome/conf/directory2.xml.lookupname=BPM_Dir2 /OraBPMEnterpriseHome/conf/directory2.xml.priority=1 /OraBPMEnterpriseHome/conf/directory2.xml.authenticate=true |
File |
Yes Only if federated is set to true.
|
| Attribute | Description | Type | Required |
| expanded |
If set to true, this application module is generated in a directory, instead of a
.war archive file.
|
boolean | No Defaults to false |
| secured |
If set to true, this application module declares a security constraint so that only the
specified j2ee role can access the application.
Use this option if you want to leverage the authentication mechanism of your
container (e.g. WebLogic) and Single-Sign-On configurations.
See also attributes rolename and webresourcename.
|
boolean |
No Defaults to the value of secured defined in the enclosing <buildear> task.
|
| rolename | Name of j2ee role to declare when this application module is secured. | String |
No Defaults to the value of rolename defined in the enclosing <buildear> task.
|
| webresourcename |
Descriptive name for the web resources of this module. Used in
<web-resource-name> tag in web.xml deployment descriptor.
|
String |
No Defaults to the value of webresourcename defined in the enclosing <buildear> task.
|
| federated |
Set this option to true if you want to generate a BPM application that connects to
multiple BPM Directories. If true, you must also specify attribute
lookupnamefilemapping.
|
boolean | No |
| uri | URI for this web application module. | String | No |
| lookupnamefilemapping |
Path to properties file defining the list of BPM Directories to connect to.
Use only when building applications for a "federated" (multiple directories) BPM environment.
Example contents of this file: /OraBPMEnterpriseHome/conf/directory1.xml.id=Production1 /OraBPMEnterpriseHome/conf/directory1.xml.lookupname=BPM_Dir1 /OraBPMEnterpriseHome/conf/directory1.xml.priority=0 /OraBPMEnterpriseHome/conf/directory1.xml.authenticate=true /OraBPMEnterpriseHome/conf/directory2.xml.id=Production2 /OraBPMEnterpriseHome/conf/directory2.xml.lookupname=BPM_Dir2 /OraBPMEnterpriseHome/conf/directory2.xml.priority=1 /OraBPMEnterpriseHome/conf/directory2.xml.authenticate=true |
File |
Yes Only if federated is set to true.
|
When buildling a secured application, the security role must be mapped to a Principal in the application server.
You can define <principals> individually for each application module. When this element is specified as a direct child of <buildear>, it becomes the default for the nested application modules.
| Attribute | Description | Type | Required |
| Attribute | Description | Type | Required |
| secured |
If set to true, this application module declares a security constraint so that only the
specified j2ee role can access the application.
Use this option if you want to leverage the authentication mechanism of your
container (e.g. WebLogic) and Single-Sign-On configurations.
See also attributes rolename and webresourcename.
|
boolean |
No Defaults to the value of secured defined in the enclosing <buildear> task.
|
| rolename | String | ? | |
| webresourcename |
Descriptive name for the web resources of this module. Used in
<web-resource-name> tag in web.xml deployment descriptor.
|
String |
No Defaults to the value of webresourcename defined in the enclosing <buildear> task.
|
web.xml deployment descriptors.
You can define <loginconfig> individually for each application module. When this element is specified as a direct child of <buildear>, it becomes the default for the nested application modules.
| Attribute | Description | Type | Required |
| Attribute | Description | Type | Required |
| expanded |
If set to true, this application module is generated in a directory, instead of a
.war archive file.
|
boolean | No Defaults to false |
| secured |
If set to true, this application module declares a security constraint so that only the
specified j2ee role can access the application.
Use this option if you want to leverage the authentication mechanism of your
container (e.g. WebLogic) and Single-Sign-On configurations.
See also attributes rolename and webresourcename.
|
boolean |
No Defaults to the value of secured defined in the enclosing <buildear> task.
|
| rolename | Name of j2ee role to declare when this application module is secured. | String |
No Defaults to the value of rolename defined in the enclosing <buildear> task.
|
| webresourcename |
Descriptive name for the web resources of this module. Used in
<web-resource-name> tag in web.xml deployment descriptor.
|
String |
No Defaults to the value of webresourcename defined in the enclosing <buildear> task.
|
| federated |
Set this option to true if you want to generate a BPM application that connects to
multiple BPM Directories. If true, you must also specify attribute
lookupnamefilemapping.
|
boolean | No |
| uri | URI for this web application module. | String | No |
| lookupnamefilemapping |
Path to properties file defining the list of BPM Directories to connect to.
Use only when building applications for a "federated" (multiple directories) BPM environment.
Example contents of this file: /OraBPMEnterpriseHome/conf/directory1.xml.id=Production1 /OraBPMEnterpriseHome/conf/directory1.xml.lookupname=BPM_Dir1 /OraBPMEnterpriseHome/conf/directory1.xml.priority=0 /OraBPMEnterpriseHome/conf/directory1.xml.authenticate=true /OraBPMEnterpriseHome/conf/directory2.xml.id=Production2 /OraBPMEnterpriseHome/conf/directory2.xml.lookupname=BPM_Dir2 /OraBPMEnterpriseHome/conf/directory2.xml.priority=1 /OraBPMEnterpriseHome/conf/directory2.xml.authenticate=true |
File |
Yes Only if federated is set to true.
|