Deploys EBS Artifacts to the specified EBS server. This operation checks each file for changes and only deploys each file if it has changed or is set to forced. This operation is equal to apply phase if you are using adop phases for applying manual changes. The environment/instance property for the source script can be used to choose what patch mode is used. If the source script is just the path to the source script, the deployment is equivalent to apply_mode=online, and the files are applied to the patch edition. If instead, " run" is appended to the source script, the deployment can be done equivalently to either downtime or hotpatch apply_mode by either leaving the server running, or stopping it before the operation. If you do not wish to use ADOP, append the " run" to the end of the source script.

If you need to execute the SQL files other than the default user (EBS Database User), you need to prefix the file name with SCHEMAXXX_. Eg: SCHEMAPOS_PER_SQF.sql and define a pair of properties on your workflow as below:

FDEBS_DB_SCHEMAPOS_USER
FDEBS_DB_SCHEMAPOS_PASSWORD

If you need to execute the XDF files other than default user, please create the pair of properties for primary schema as above.

...

Environment/Instance Properties

EBS Database PasswordEBS

Property Name

Property Code

Required

Description

EBS Source Script

FDEBS_SOURCE_SCRIPT

Yes

Source Script with full path.
e.g. /u1/apps/apps_st/appl/APPSorcl_ebs01.env

If you would like to apply changes directly to run edition for EBS R 12.2+, specify the run param after the script. By default it connects to patch edition when performing the deploy operation. All other operations are sourced from run by default.

e.g. /u1/apps/apps_st/appl/APPSorcl_ebs01.env run

EBS Database User

FDEBS_DB_USER

Yes

DB User to connect with privileges.
eg: Apps.
Make sure you have permission to execute sqls with this user for all schemas.

Adding patch to the end is not allowed. This is because it will be added automatically if run is not added and you are deploying.

Tip
If you are adding more than one endpoint for an environment/instance, this file must be same location for all endpoints. If necessary you should create symbolic links on each endpoint, so location of environment file is same.

EBS Database User

FDEBS_DB_PASSWORDUSER

Yes

Password DB User to connect for EBS Database User.

with privileges.
eg: Apps.
Make sure you have permission to execute sqls with this user for all schemas.

EBS Database Password

FDEBS_DB_PASSWORD

Yes

Password to connect for EBS Database User.

EBS System Password

FDEBS_SYSTEM_PASSWORD

For ADOP

SYSTEM Password for AD Online Patching.

Project Properties

Property Name	Property Code	Required	Description
EBS

Stop on Error

Application Short Name

FDEBS_

STOP

APPLICATION_

ON

SHORT_

ERROR

No

Stop deploying, if any error occurs. If false or not specified, deploying of other files will be continued.

EBS Java Classpath

FDEBS_JAVA_CLASSPATH

No

Set the classpath, if

`NAME`		App short name (e.g. XXAR). If source includes multiple custom tops, leave it empty and make sure top directory matches top name.
OAF Java Root Destination Directory	`FDEBS_JAVA_ROOT_DESTINATION_DIR`	No	Target directory for java,class,xml files. Eg: $JAVA_TOP/MyCompany Default is $JAVA_TOP
OAF Java Classpath	`FDEBS_JAVA_CLASSPATH`	No	Set the classpath, if needed for Java Compilation. Added along with the default classpath while compiling java files.

EBS Workflow Classpath

OAF MDS Root Destination Directory

FDEBS_MDS_ROOT_

WORKFLOW

DESTINATION_

CLASSPATHEBS Forms Classpath

FDEBS_FORMS_CLASSPATH

No

Set the classpath, if needed for Forms compilation.

EBS Database Schema

FDEBS_SCHEMA_DB_USER

No

ORACLE schema name in which the objects should be created for XDF. Eg: pos

EBS Database Schema Password

FDEBS_SCHEMA_DB_PASSWORD

No

ORACLE schema password for EBS Database Schema.

EBS SQL Retry Count

FDEBS_SQL_RETRY_COUNT

No

Retry count for SQLs and PL/SQLs. Default is 5

EBS AOL

DIR

No

Set the classpath, if needed for Workflow Load (WFXLoad).

Target directory for MDS files (webui xmls). Default is PROD_TOP/mds. (e.g. $XXHR_TOP/mds).
Concurrent Program SQL Root Destination Directory	`FDEBS_CP_SQL_ROOT_DESTINATION_DIR`	No	Target directory for Concurrent Program's SQLs (Not executed after deploy). Eg: $XXHR_TOP/admin/sql. Default is PROD_TOP/sql.
Java Stored Procedure Root Destination Directory	`FDEBS_LOAD_JAVA_ROOT_DESTINATION_DIR`	No	Target directory for Java Stored Procedure files. Eg: $XXHR_TOP/java. Default is JAVA_TOP.
SQL Root Destination Directory	`FDEBS_`

AOL

SQL_ROOT_DESTINATION_DIR

No

Target directory for

AOL (ldt)

SQL and PLS files.
Eg: $XXHR_TOP/admin/

aol

sql.
Default is PROD_TOP/patch/115/

import

sql.

EBS

SQL

Root Destination Directory

Retry Count

FDEBS_SQL_

ROOT

RETRY_

DESTINATION_DIR

COUNT

No

Target directory

Retry count for

SQL and PLS files.
Eg: $XXHR_TOP/admin/sql.
Default is PROD_TOP/patch/115/sql.EBS Concurrent Program SQL Root Destination

SQLs and PL/SQLs. Default is 5
SQL Ignore Compile Errors	`FDEBS_SQL_IGNORE_COMPILE_ERRORS`	No	Ignore SQL compilation errors.
SQL*Loader Root Destination Directory	`FDEBS_`

CP

SQL_

SQL

LDR_ROOT_DESTINATION_DIR

No

Target directory for

Concurrent Program's SQLs (Not executed after deploy)

control (ctl) files.
Eg: $XXHR_TOP/admin/

sql

bin.
Default is PROD_TOP/

sql

bin.

EBS Java

AOL Root Destination Directory FDEBS_

JAVA

AOL_ROOT_DESTINATION_DIR

No

Target directory for

java,class,xml

AOL (ldt) files.
Eg:

$JAVA

$XXHR_TOP/

MyCompany

admin/aol.
Default is

$JAVA

PROD_TOP/patch/115/import.

EBS

Forms Root Destination Directory

FDEBS_FORMS_ROOT_DESTINATION_DIR

No

Target directory for form files (fmx).
Eg: $XXAR_TOP/forms
Default is $PROD_TOP/forms

EBS

Forms Root Stage Directory	`FDEBS_FORMS_ROOT_STAGE_DIR`	No	Stage directory for form files (fmb). Eg: $XXAR_TOP/forms. Default is AU_TOP/forms.
Forms Classpath	`FDEBS_FORMS_CLASSPATH`	No	Set the classpath, if needed for Forms compilation.

EBS

Reports Root Destination Directory

FDEBS_REPORTS_ROOT_DESTINATION_DIR

No

Target directory for report files.
Eg: $XXAR_TOP/reports
Default is $PROD_TOP/reports

EBS Media

Workflow Root Destination Directory

FDEBS_

MEDIA

WORKFLOWS_ROOT_DESTINATION_DIR

No

Target directory for

image

workflow files.
Eg: $XXAR_TOP/

media

workflow
Default is

$OA_MEDIAEBS HTML Root Destination Directory

$PROD_TOP/patch/115/import
Workflow Upload Mode	`FDEBS_`

HTML

WORKFLOWS_

ROOT

UPLOAD_

DESTINATION_DIR

MODE No

Target directory for html files.
Eg: $XXAR_TOP/html

Upload Mode for WFLOAD. [UPLOAD, UPGRADE, FORCE]

Default is

$OA_HTML

UPLOAD.

EBS Fonts Root Destination Directory

Workflow Classpath

FDEBS_

FONTS_ROOT_DESTINATION_DIREBS Scripts

WORKFLOW_CLASSPATH

No

Target directory for font files.
Eg: $XXAR_TOP/fonts
Default is $OA_JRE_TOP/lib/fonts

Set the classpath, if needed for Workflow Load (WFXLoad).
Libraries Root Destination Directory	`FDEBS_`

SCRIPTS

LIBRARIES_ROOT_DESTINATION_DIR

No

Target directory for

script files.
Eg: $FND_TOP/bin

form library files (plx).

Default is PROD_TOP/

bin.EBS Perl Root Destination Directory

FDEBS_PERL_ROOT_DESTINATION_DIR

No

Target directory for perl modules.
Eg: $FND_TOP/perl.
Default is PROD_TOP/perl.

EBS Jar

forms. (e.g. $XXAR_TOP/forms).
Publisher Root Destination Directory	`FDEBS_`

JAR

PUBLISHER_ROOT_DESTINATION_DIR

No

Target directory for

JAR

Publisher files.
Eg:

$JAVA

$XXHR_TOP/

jar

publisher.
Default is PROD_TOP/patch/115/

jar

publisher.

EBS Ear Root Destination Directory

Publisher Default Custom Mode FDEBS_

EAR

PUBLISHER_

ROOT

CUSTOM_

DESTINATION_DIREBS Data

MODE No

Target directory for ear files.
Eg: $JAVA_TOP/ear.
Default is PROD_TOP/patch/115/ear.

When populating or evaluating files deployed with XDOLoader, set the CUSTOM_MODE of publisher files to this.

[FORCE, NOFORCE]

Default is FORCE.

Fonts Root Destination Directory

FDEBS_

DAT

FONTS_ROOT_DESTINATION_DIR

No

Target directory for

Dat

font files.
Eg:

$XXHR

$XXAR_TOP/

admin/import.

fonts
Default is

PROD

$OA_JRE_TOP/

patch/115/import.EBS SQL LDR

lib/fonts
Scripts Root Destination Directory	`FDEBS_`

SQL_LDR

SCRIPTS_ROOT_DESTINATION_DIR

No

Target directory for

control (ctl)

script files.
Eg:

$XXHR

$FND_TOP

/admin

/bin.
Default is PROD_TOP/bin.

EBS Load Java

Perl Module Root Destination Directory

FDEBS_

LOAD_JAVA

PERL_ROOT_DESTINATION_DIR

No

Target directory for

Java Stored Procedure files

perl modules.
Eg:

$XXHR

$FND_TOP/

java

perl.
Default is

JAVA

PROD_TOP/perl.

EBS Publisher

Media Root Destination Directory

FDEBS_

PUBLISHER

MEDIA_ROOT_DESTINATION_DIR

No

Target directory for

Publisher

image files.
Eg:

$XXHR

$XXAR_TOP/

publisher.

media
Default is

PROD_TOP/patch/115/publisher.EBS Workflows UploadFDEBS_WORKFLOWS_UPLOAD_MODENo

Upload Mode for WFLOAD. [UPLOAD, UPGRADE, FORCE]

Default is UPLOAD.

EBS Publisher Default Custom ModeFDEBS_PUBLISHER_CUSTOM_MODENo

When populating or evaluating files deployed with XDOLoader, set the CUSTOM_MODE of publisher files to this.

[FORCE, NOFORCE]

Default is FORCE.

EBS Ignore Errors File List

FDEBS_IGNORE_ERRORS_FILE_LIST

No

List of files

$OA_MEDIA
HTML Root Destination Directory	`FDEBS_HTML_ROOT_DESTINATION_DIR`	No	Target directory for html files. Eg: $XXAR_TOP/html Default is $OA_HTML.
JSP Compile Option	`FDEBS_JSP_COMPILE`	No	The selected option will be used while generating deploy command for JSP files. Default is No. Jsp files will not be compiled. If set to Compile, the JSP files will be compiled. The other option is Compile with Flush which will compile all deployed jsp files and their parents.
Stop on Error	`FDEBS_STOP_ON_ERROR`	No	Stop deploying, if any error occurs. If false or not specified, deploying of other files will be continued.
Ignore Errors File List	`FDEBS_IGNORE_ERRORS_FILE_LIST`	No	List of files (allowing wildcards) to ignore errors. (e.g: DropHRTables.sql, CreateTables.sql, *_ddl.sql)

JSP Compile Option

File Permissions

FDEBS_

JSP

FILE_

COMPILENo

The selected option will be used while generating deploy command for JSP files.

Default is No. Jsp files will not be compiled.

If set to Compile, the JSP files will be compiled.

The other option is Compile with Flush which will compile all deployed jsp files and their parents.

Inputs

Input Name

Input Code

Required

Description

Force

PERMISSIONS

Target File Permission. The target file will be set to this permission level after deployment using chmod. eg: 755

Inputs

FORCEList to force to be deployed even if they haven't changed.
During the deployment, typically only changed artifacts will be get deployed. If you would like to force any artifacts, use this input. Separate files with comma.

The value ALL may be used to indicate that all files should be deployed even if the files exist on the file system. This is useful if the database is out of sync with the filesystem and it is desired to force all of the scripts to be run again.

This is used by Full Deployment Projects only.

Input Name	Input Code	Required	Description
Include Object Types	`FDEBS_INP_INCLUDE_TYPES`	No	Select types that should be deployed. If nothing selected, all types will be deployed. Partial Deployments only. Select one or more object types. This option is useful when files are deployed selectively across application tier nodes.
Exclude Object Types	`FDEBS_INP_EXCLUDE_TYPES`	No	Select types that should not be deployed. Partial Deployments only. Select one or more object types. This option is useful when files are deployed selectively across application tier nodes.
Include Files	`FDEBS_INP_`	`DEPLOY_INCLUDE_FILES`	No	Provide comma separated list of files
Skip Files	`FDEBS_INP_SKIP_FILES`	No	Skip files from Package. Separate files with comma. Not applicable for Full Deployment. Use ALL to skip all files.
Include Object Types	`FDEBS_INP_INCLUDE_TYPES`	No	Select types that should be deployed. If nothing selected, all types will be deployed. Partial Deployments only. Select one or more object types. This option is useful when files are deployed selectively across application tier nodes.
Exclude Object Types	`FDEBS_INP_EXCLUDE_TYPES`	No	Select types that should not be deployed. Partial Deployments only. Select one or more object types. This option is useful when files are deployed selectively across application tier nodes.

Outputs

...

Output Name

...

Description

...

List of files which were deployed.

...

List of files and their revisions which were deployed.

The version is only present for Partial Deploy Projects.

...

Comma separated string of Object Type Codes deployed. For example, SQL, OAF_JAVA etc.

@Since 4.6.0.3

Artifacts

This operation consumes artifacts from artifact repository. It consumes the zip file added by the build operation to the artifact repository.

Endpoint Selection

This operation delegates the selection of endpoints to the workflow developer.

Endpoint Execution

This operation delegates the selection of any or all of the endpoints to be executed on to the workflow developer.

Special Considerations

See EBS Object Types Reference for supported objects and considerations.

...

that should be deployed. If nothing is provided, all files will be deployed. Use * to indicate wildcard. Partial Deployments only. You can use wild card like /java/, /java/oracle/apps/pos/** @since 5.3.0.4
Exclude Files	`FDEBS_INP_SKIP_FILES`	No	Provide comma separated list of files that should not be deployed. Use * to indicate wildcard. Partial Deployments only. Use ALL to skip all files. You can use wild card like /java/, /java/oracle/apps/pos/**
Force Deploy Files	`FDEBS_INP_FORCE_FILES`	No	List of files to force to be deployed even if they haven't changed. During the deployment, typically only changed artifacts will be get deployed. If you would like to force any artifacts, use this input. Separate files with comma. The value `ALL` may be used to indicate that all files should be deployed even if the files exist on the file system. This is useful if the database is out of sync with the filesystem and it is desired to force all of the scripts to be run again. This is used by Full Deployment Projects only.
Fail if patching in progress	`FDEBS_INP_FAIL_IF_PATCH_IN_PROG`	No	Fail the workflow step if a patching cycle is in progress and deploying to RUN edition (defaults to TRUE) . Applies to EBS 12.2+ only.
Copy Files to Patch File System	FDEBS_INP_DEPLOY_OR_COPY_FILES_TO_PATCH_FILE_SYSTEM	No	Option to sync files with patch file system. If selected, Operation will use deploy command for Program Files and HTML types but others types are simply copied onto patch file system. For Java files, class files will be copied. For form files, fmb and fmx files will be copied. @Since EBS Plugin version 5.5.0.3.11

Outputs

Output Name	Description
FDEBS_OUT_DEPLOYED_FILES_LIST	List of files which were deployed.
FDEBS_OUT_SKIPPED_FILES_LIST	List of files which were skipped.
FDEBS_OUT_DEPLOYED_FILE_REVISIONS_LIST	List of files and their revisions which were deployed. The version is only present for Partial Deploy Projects.
FDEBS_OUT_DEPLOYED_TYPES_LIST	Comma separated string of Object Type Codes deployed. For example, SQL, OAF_JAVA etc. @Since 4.6.0.3

...

Artifacts

This operation consumes artifacts from artifact repository. It consumes the zip file added by the build operation to the artifact repository.

Endpoint Selection

This operation delegates the selection of endpoints to the workflow developer.

Endpoint Execution

This operation delegates the selection of any or all of the endpoints to be executed on to the workflow developer.

Special Considerations

See EBS Object Types Reference for supported objects and considerations.

Deploy operation will create ebs.deploy.processed file as a marker for completion in workflow execution folder at same level as temp folder. (@Since 4.6.0.3)

If performing clone operations between environments, consider using the Post Refresh feature of FlexDeploy. Read more on the Post Refresh Requests page.

By default, FlexDeploy utilizes the Oracle client that is installed on the EBS application tier. In some cases, the database object being deployed requires a newer version of the Oracle client. In this scenario, it may be required to upgrade the Oracle database client on the application tier or deploy this object from a different server with a newer client. The same is also true for using proxy database users. In most cases, the Oracle database client installed on the application is not at the minimum level to utilize proxy users. To use proxy database users, the client must be at version 10.2 or higher.

Deployment to custom TOP on non-shared file systems

Following feature to support non shared file system is only available since 5.1.0.1.

In most cases file systems are shared between application tier nodes for EBS. For shared file system use Any as Endpoint Specification Execution as shown below.

Image Added

But if you do not have shared file system between application tier nodes, then use All for Endpoint Specification Execution.

Image Added

The following is for non-shared file systems only.

Additionally, for non-shared file systems create a resource type named EBS Secondary Node. When the Endpoints are associated to the environment/instance make sure to select EBS Secondary Node for all but one node. Also, you need to associate Endpoints for all nodes to the environment/instance that are part of that particular environment. For example, if you have ebsdev1, ebsdev2 in DEV environment you will add both endpoints on DEV/EBS and EBS Secondary Node will be selected for ebsdev2. Now if you have ebsqa1, ebsqa2, ebsqa3, ebsqa4 in QA environment, then you will add all 4 endpoints to QA/EBS and EBS Secondary Node will be selected for ebsqa2, ebsqa3, ebsqa4.

FlexDeploy will deploy Java, Program Files, Form, Libraries, Font, Media, and HTML types (using deploy command) but others are simply copied onto the secondary nodes. For example, DB Objects are executed on the primary node and copied to all secondary nodes.

Versions Compared

Old Version 40

New Version Current

Key

Environment/Instance Properties

Project Properties

Inputs

Inputs

Outputs

Artifacts

Endpoint Selection

Endpoint Execution

Special Considerations

Outputs

Artifacts

Endpoint Selection

Endpoint Execution

Special Considerations

Deployment to custom TOP on non-shared file systems

Page Comparison

Versions Compared

Old Version 40

New Version Current

Key

Environment/Instance Properties

Project Properties

Inputs

Inputs

Outputs

Artifacts

Endpoint Selection

Endpoint Execution

Special Considerations

Outputs

Artifacts

Endpoint Selection

Endpoint Execution

Special Considerations

Deployment to custom TOP on non-shared file systems