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.

  

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

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

EBS 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

FDEBS_WORKFLOW_CLASSPATH

No

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

EBS 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

FDEBS_AOL_ROOT_DESTINATION_DIRNoTarget directory for AOL (ldt) files.
Eg: $XXHR_TOP/admin/aol.
Default is PROD_TOP/patch/115/import.
EBS 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.

EBS Concurrent Program SQL Root Destination Directory

FDEBS_CP_SQL_ROOT_DESTINATION_DIR

No

Target directory for Concurrent Prorgram's SQLs (Not executed after deploy).
Eg: $XXHR_TOP/admin/sql.
Default is PROD_TOP/sql.

EBS 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

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.

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 Root Destination Directory

FDEBS_MEDIA_ROOT_DESTINATION_DIR

No

Target directory for image files.
Eg: $XXAR_TOP/media
Default is $OA_MEDIA

EBS HTML Root Destination Directory

FDEBS_HTML_ROOT_DESTINATION_DIR

No

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

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

FDEBS_JAR_ROOT_DESTINATION_DIR

No

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

EBS Ear Root Destination Directory

FDEBS_EAR_ROOT_DESTINATION_DIR

No

Target directory for ear files.
Eg: $JAVA_TOP/ear.
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

Added in 4.5.1.5

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

Added in 4.5.2

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

  

Outputs

Output Name

Required

Description

FDEBS_OUT_DEPLOYED_FILES_LIST

No

List of files which were deployed.

FDEBS_OUT_SKIPPED_FILES_LIST

No

List of files which were skipped.
FDEBS_OUT_DEPLOYED_FILE_REVISIONS_LISTNo

List of files and their revisions which were deployed.

The version is only present for Partial Deploy Projects.

  

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 Supported EBS Object Types at the end of this document for supported objects and considerations.