Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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. 

Files will be deployed in the order saved in the build step. If the order of deployment must be adjusted, perform a new build. See the build operation for more information about ordering files or search the wiki for more information.

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.

See also EBS Object Types Reference for a list of supported EBS object types.

Info

If performing clone operations between environments, consider using the Post Refresh utilities of flexDeploy. Read more on the Post Refresh Requests page. (new in 5.0)

...

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. 

Files will be deployed in the order saved in the build step. If the order of deployment must be adjusted, perform a new build. See the build operation for more information about ordering files or search the wiki for more information.

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.

See also EBS Object Types Reference for a list of supported EBS object types.

Info

If performing clone operations between environments, consider using the Post Refresh utilities of flexDeploy. Read more on the Post Refresh Requests page. (new in 5.0)

Environment/Instance Properties

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

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_USER

Yes

DB User to connect 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
Source Script
Application Short Name

FDEBS_APPLICATION_

SOURCE

SHORT_

SCRIPT

Yes

Source Script with full path. 

NAME


App short name (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

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_USER

Yes

DB User to connect 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

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.

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.

Workflow Classpath

FDEBS_WORKFLOW_CLASSPATH

No

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

Forms Classpath

FDEBS_FORMS_CLASSPATH

No

Set the classpath, if needed for Forms compilation.

SQL Retry Count

FDEBS_SQL_RETRY_COUNT

No

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

FDEBS_AOL
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.

OAF MDS Root Destination Directory

FDEBS_MDS_ROOT_DESTINATION_DIR

No

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_SQL_ROOT_DESTINATION_DIR

No

Target directory for SQL and PLS files.
Eg: $XXHR_TOP/admin/sql.
Default is PROD_TOP/patch/115/sql.

SQL Retry Count

FDEBS_SQL_RETRY_COUNT

No

Retry count for 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_SQL_LDR_ROOT_DESTINATION_DIR

No

Target directory for control (ctl) files.
Eg: $XXHR_TOP/admin/bin.
Default is PROD_TOP/bin.

FDEBS_AOL_ROOT_DESTINATION_DIRNo

Target directory for AOL (ldt) files.
Eg: $XXHR_TOP/admin/aol.
Default is PROD_TOP/patch/115/import.

Forms Root Destination Directory

FDEBS_FORMS_ROOT_DESTINATION_DIR

No

Target directory for

AOL

form files (

ldt

fmx)

files

.
Eg:

 $XXHR

$XXAR_TOP/

admin/aol.

forms
Default is

PROD

$PROD_TOP/

patch/115/import.EBS SQL Root Destination

forms

Forms Root Stage Directory

FDEBS_

SQL

FORMS_ROOT_

DESTINATION

STAGE_DIR

No

Target

Stage directory for

SQL and PLS files

form files (fmb).
Eg:

 $XXHR

$XXAR_TOP/

admin/sql

forms.
Default is

PROD

AU_TOP/

patch/115/sql.EBS Concurrent Program SQL

forms.

Forms Classpath

FDEBS_FORMS_CLASSPATH

No

Set the classpath, if needed for Forms compilation.

Reports Root Destination Directory

FDEBS_

CP_SQL

REPORTS_ROOT_DESTINATION_DIR

No

Target directory for

Concurrent Program's SQLs (Not executed after deploy)

report files.
Eg:

$XXHR

$XXAR_TOP/

admin/sql.

reports
Default is

PROD

$PROD_TOP/

sql.

reports

EBS Java
Workflow Root Destination Directory


FDEBS_

JAVA

WORKFLOWS_ROOT_DESTINATION_DIR


No

Target directory for

java,class,xml

workflow files.
Eg:

$JAVA

$XXAR_TOP/

MyCompany

workflow
Default is

$JAVA

$PROD_TOP

EBS Forms Root Destination Directory

/patch/115/import

Workflow Upload ModeFDEBS_
FORMS
WORKFLOWS_
ROOT
UPLOAD_
DESTINATION_DIREBS 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.

EBS Reports
MODENo

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

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

Default is UPLOAD.

Workflow Classpath

FDEBS_WORKFLOW_CLASSPATH

No

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

Libraries Root Destination DirectoryFDEBS_
REPORTS
LIBRARIES_ROOT_DESTINATION_DIRNo

Target directory for

report

form library files (plx).

Eg: $XXAR

Default is PROD_TOP/

reports
Default is $PROD

forms. (e.g. $XXAR_TOP/

reportsEBS Media

forms).

Publisher Root Destination Directory

FDEBS_

MEDIA

PUBLISHER_ROOT_DESTINATION_DIR

No

Target directory for

image

Publisher files.
Eg:

$XXAR

$XXHR_TOP/publisher.
Default is PROD_TOP

/media
Default is $OA_MEDIAEBS HTML Root Destination Directory

FDEBS_HTML_ROOT_DESTINATION_DIR

No

Target directory for html files.
Eg: $XXAR_TOP/html
Default is $OA_HTML.

EBS

/patch/115/publisher.

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.

Fonts Root Destination Directory

FDEBS_FONTS_ROOT_DESTINATION_DIR

No

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

EBS
Scripts Root Destination Directory

FDEBS_SCRIPTS_ROOT_DESTINATION_DIR

No

Target directory for script files.
Eg: $FND_TOP/bin.
Default is PROD_TOP/bin.

EBS
Perl Module 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
Media Root Destination Directory

FDEBS_

JAR

MEDIA_ROOT_DESTINATION_DIR

No

Target directory for

JAR

image files.
Eg:

$JAVA

$XXAR_TOP/

jar.

media
Default is

PROD_TOP/patch/115/jar.EBS Ear

$OA_MEDIA

HTML Root Destination Directory

FDEBS_

EAR

HTML_ROOT_DESTINATION_DIR

No

Target directory for

ear

html files.
Eg:

$JAVA

$XXAR_TOP/

ear.

html
Default is

PROD_TOP/patch/115/ear.EBS Data Root Destination Directory

FDEBS_DAT_ROOT_DESTINATION_DIR

No

Target directory for Dat files.
Eg: $XXHR_TOP/admin/import.
Default is PROD_TOP/patch/115/import.

EBS SQL LDR Root Destination Directory

FDEBS_SQL_LDR_ROOT_DESTINATION_DIR

No

Target directory for control (ctl) files.
Eg: $XXHR_TOP/admin/bin.
Default is PROD_TOP/bin.

EBS Load Java 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.

EBS Publisher Root Destination Directory

FDEBS_ PUBLISHER_ROOT_DESTINATION_DIR

No

Target directory for Publisher files.
Eg: $XXHR_TOP/publisher.
Default is PROD_TOP/patch/115/publisher.

FDEBS_WORKFLOWS_UPLOAD_MODENo

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

Default is UPLOAD.

FDEBS_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 (allowing wildcards) to ignore errors. (e.g: DropHRTables.sql, CreateTables.sql, *_ddl.sql)

FDEBS_JSP_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.

$OA_HTML.

FDEBS_JSP_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.

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)

FDEBS_FILE_PERMISSIONS


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

FDEBS_FILE_EXCLUDES


List of files to exclude while Building. Only used in Full Deployment Mode. (e.g. server.xml,web.xml).

FD_PARTIAL_FILE_INCLUDES


Controls files included in Project Files. Enter expressions separated by ##. Leave empty to select all files. Begin or end the expression with * for simple wildcards. Otherwise, regex is used. (e.g. /java/*##*.java##*person*##/java/.*[tT]est.*\.java)

FD_PARTIAL_FILE_EXCLUDES


Controls files excluded from Project Files. Enter expressions separated by ##. Leave empty to select all files. Begin or end the expression with * for simple wildcards. Otherwise, regex is used. (e.g. /java/*##*.java##*person*##/java/.*[tT]est.*\.java)

Inputs

Input Name

Input Code

Required

Description

Force 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.

Skip FilesFDEBS_INP_SKIP_FILESNo

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

NoSelect 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.

...