OpenEdge Application Archive Structure
- Last Updated: March 16, 2023
- 2 minute read
- OpenEdge
- Version 12.2
- Documentation
An OpenEdge Application Archive (OEAR) is specific type of zip file that contains web application resources that can be deployed to a PAS for OpenEdge instance in a single operation. It contains an Ant build script that gets executed during an import or export operation, and is where you can customize the configuration of your application.
An OpenEdge Application Archive is comprised of the following artifacts:
-
conf/ —The files in the conf
directory will be in the target PAS for OpenEdge instance's ${CATALINA_BASE}/ablapps/${oepas-app}/conf directory. This
directory is required for generating and deploying an OpenEdge Application Archive.
- conf/MANIFEST.MF —The MANIFEST.MF file contains a description of the ABL application and version name. See the "Manifest Attributes" section in this topic for more information.
- conf/oeablSecurity.properties —The oeablSecurity.properties sets the security configuration for the ABL application of the target instance.
-
tlr/ —The files in the tlr
directory are used for configuring the ABL application and will be in the the
target instance's ${CATALINA_BASE}/ablapps/${oepas-app}/tlr
directory. This directory is required for generating and deploying an OpenEdge
Application Archive.
-
tlr/merge.properties —The
merge.properties file contains configuration settings relating to PROPATH,
agent, and session manager settings. This file requires the ABL application name as a section
header, and the webApps property be set to a comma separated list of web applications
included in the ABL application. For example, if the ABL application name is SSOApp, the ABL
application section looks similar to the following:
[SSOApp] webApps=Payments,nginx,SSOProd - tlr/build.xml —The required build.xml file contains tailoring instructions for the ABL application. For more information about tailoring your build.xml file, see Tailor an ABLApp installation using Ant.
-
tlr/merge.properties —The
merge.properties file contains configuration settings relating to PROPATH,
agent, and session manager settings. This file requires the ABL application name as a section
header, and the webApps property be set to a comma separated list of web applications
included in the ABL application. For example, if the ABL application name is SSOApp, the ABL
application section looks similar to the following:
-
webapps/ —The applications in the webapps directory are deployed as part of the instance to the
target location's ${CATALINA_BASE}/webapps/${oepas-webapp}
directory. The following web application types are supported:
- ${oepas-webapp}.war : self-contained archive for complete installs
-
${oepas-webapp}.zip : archive for overlays on a
newly-deployed version of the current
${CATALINA_HOME}/extras/oeabl.war.
- openedge/ —The openedge directory contains r-code and other related artifacts for the ABL application to be deployed to the target instance's ${CATALINA_BASE}/ablapps/${oepas-app}/openedge directory. This directory is recommended for generating and deploying an OpenEdge Application Archive.
- bin/ —The optional bin directory contains scripts relating to the ABL application to be deployed to the target ${CATALINA_BASE}/bin directory.
- instance/ —The optional instance directory contains non-mergable configurations or ABL code to be copied into the ${CATALINA_BASE}/conf or ${CATALINA_BASE}/openedge directories.
Note: The
tcman export command currently does not support populating the bin and instance
directories. In order to include these directories in your OpenEdge Application Archive, use the
ABLApp Ant Task described in Create an OpenEdge Application Archive using an Ant Build. Manifest Attributes
The manifest for the OpenEdge Application Archive specifies the following ABL
application attributes:
| Attribute Name | Sample Value | Description |
|---|---|---|
ABL-Application-Name
|
oepas1
|
This value should match the folder name. If not, a warning is written into the deployment logs. |
ABL-Application-Version
|
1.0.0
|
A semantic version identifier for this ABL application. |
You can add additional attributes to the manifest as needed.