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 |
| Yes | Source Script with full path. 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. |
| EBS Database User |
| Yes | DB User to connect with privileges. |
| EBS Database Password |
| Yes | Password to connect for |
| EBS System Password |
| For ADOP | SYSTEM Password for AD Online Patching. |
Project Properties
| Property Name | Property Code | Required | Description |
|---|---|---|---|
| EBS 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 |
| No | Set the classpath, if needed for Java Compilation. |
| EBS Workflow Classpath |
| No | Set the classpath, if needed for Workflow Load (WFXLoad). |
| EBS Forms Classpath |
| No | Set the classpath, if needed for Forms compilation. |
| EBS Database Schema |
| No | ORACLE schema name in which the objects should be created for XDF. Eg: pos |
| EBS Database Schema Password |
| No | ORACLE schema password for |
| EBS SQL Retry Count |
| No | Retry count for SQLs and PL/SQLs. Default is 5 |
FDEBS_AOL_ROOT_DESTINATION_DIR | No | Target directory for AOL (ldt) files. Eg: $XXHR_TOP/admin/aol. Default is PROD_TOP/patch/115/import. | |
| EBS SQL Root Destination Directory |
| No | Target directory for SQL and PLS files. |
| EBS Concurrent Program SQL Root Destination Directory |
| No | Target directory for Concurrent Prorgram's SQLs (Not executed after deploy). |
| EBS Java Root Destination Directory |
| No | Target directory for java,class,xml files. |
| EBS Forms Root Destination Directory |
| No | Target directory for form files (fmx). |
| EBS Forms Root Stage Directory |
| No | Stage directory for form files (fmb). |
| EBS Reports Root Destination Directory |
| No | Target directory for report files. |
| EBS Media Root Destination Directory |
| No | Target directory for image files. |
| EBS HTML Root Destination Directory |
| No | Target directory for html files. |
| EBS Fonts Root Destination Directory |
| No | Target directory for font files. |
| EBS Scripts Root Destination Directory |
| No | Target directory for script files. |
| EBS Perl Root Destination Directory |
| No | Target directory for perl modules. |
| EBS Jar Root Destination Directory |
| No | Target directory for JAR files. |
| EBS Ear Root Destination Directory |
| No | Target directory for ear files. |
| EBS Data Root Destination Directory |
| No | Target directory for Dat files. |
| EBS SQL LDR Root Destination Directory |
| No | Target directory for control (ctl) files. |
| EBS Load Java Root Destination Directory |
| No | Target directory for Java Stored Procedure files. |
| EBS Publisher Root Destination Directory |
| No | Target directory for Publisher files. |
FDEBS_WORKFLOWS_UPLOAD_MODE | No | Upload Mode for WFLOAD. [UPLOAD, UPGRADE, FORCE] Default is UPLOAD. | |
FDEBS_PUBLISHER_CUSTOM_MODE | No | 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 |
| No | List of files (allowing wildcards) to ignore errors. (e.g: DropHRTables.sql, CreateTables.sql, *_ddl.sql) |
FDEBS_JSP_COMPILE | No | 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 |
| No | List of files to force to be deployed even if they haven't changed. The value This is used by Full Deployment Projects only. |
Outputs
Output Name | Required | Description |
|---|---|---|
| No | List of files which were deployed. |
| No | List of files which were skipped. |
FDEBS_OUT_DEPLOYED_FILE_REVISIONS_LIST | No | 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.
- style