deploy (EBS)

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.

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

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 Application Short Name

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

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 form files (fmx).
Eg: $XXAR_TOP/forms
Default is $PROD_TOP/forms

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.

Reports Root Destination Directory

FDEBS_REPORTS_ROOT_DESTINATION_DIR

No

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

Workflow Root Destination Directory


FDEBS_WORKFLOWS_ROOT_DESTINATION_DIR


No

Target directory for workflow files.
Eg: $XXAR_TOP/workflow
Default is $PROD_TOP/patch/115/import

Workflow Upload ModeFDEBS_WORKFLOWS_UPLOAD_MODENo

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_LIBRARIES_ROOT_DESTINATION_DIRNo

Target directory for form library files (plx).

Default is PROD_TOP/forms. (e.g. $XXAR_TOP/forms).

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.

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

Scripts Root Destination Directory

FDEBS_SCRIPTS_ROOT_DESTINATION_DIR

No

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

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.

Media Root Destination Directory

FDEBS_MEDIA_ROOT_DESTINATION_DIR

No

Target directory for image files.
Eg: $XXAR_TOP/media
Default is $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.

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

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.

Outputs

Output Name

Description

FDEBS_OUT_DEPLOYED_FILES_LIST

List of files which were deployed.

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

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.

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

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.