Deploy (APEX)

Deploy the Apex application to the database. This operation requires one or more exported SQL files, these files can be either specified by using the APEX SQL Files (FDAPEX_SQL_FILES) on Project Properties or the plugin will deploy the ".sql" files in the artifacts folder. Files in artifacts folder during Deploy execution are result of Build workflow execution associated with Project Version selected for deployment.

If there are supporting database objects for Apex application being deployed, you must deploy them as separate project using JDBC Plugin.

This plugin supports deploying the same APEX application to the same database. This requires setting the Offset. This situation is not normal, so most likely you will not have to worry about offset.

  • If the application has never been deployed and you do not currently have an offset, the plugin can generate the offset. Just select Use APEX Offset (FDAPEX_USE_OFFSET), make sure you note the offset value used and set the property APEX Offset Value (FDAPEX_OFFSET) for the next deployment.  

  • If you know the offset, select Use APEX Offset (FDAPEX_USE_OFFSET) and set the property APEX Offset Value (FDAPEX_OFFSET).

You will also need to set the application id and change the alias.

Environment/Instance Properties

Property Name

Property Code

Required

Description

Oracle Database Home

FDAPEX_ORACLE_DB_HOME

Yes

Oracle Database Home for example : /u01/app/oracle/product/11.2.0/dbhome_1

Oracle Database User
FDORA_USER
YesThe username that will be used to connect to the target Oracle Database.
Oracle Database Password
FDORA_PASSWORD
YesThe password for Oracle Database User.

Project Properties

Property Name

Property Code

Required

Description

APEX Workspace Name

FDAPEX_WORKSPACE_NAME

No

The name of the workspace to deploy the application to. Provide uppercase name.

APEX Application Id
FDAPEX_APPLICATION_ID
NoIdentifying number of application.
APEX Application Name
FDAPEX_APPLICATION_NAME
NoThe name of the application to deploy.
APEX SQL Files
FDAPEX_SQL_FILES
NoComma separated list of SQL files to be executed during deployment, they will be executed based on the order in the list. If the SQL files are not provided, the plugin will execute all SQL files in the artifacts folder. The path is relative to the temp folder or can be fully qualified. This list should NOT contain spaces.
APEX Offset value
FDAPEX_OFFSET
NoThe offset value during application import. This value is used to ensure that the metadata for the Application Express application definition does not collide with other metadata on the instance.
Use APEX Offset
FDAPEX_USE_OFFSET
NoDetermines if the plugin will attempt to set the Offset.
APEX Oracle SID
FDAPEX_ORACLE_SID
YesThe SID of the database that will be deployed to.
Database Schema
FDAPEX_DB_SCHEMA
NoUsed to set the parsing (owner) schema of the APEX application. Provide uppercase schema name.
APEX Application Alias
FDAPEX_ALIAS
NoAPEX alphanumeric identifier unique within a workspace and page. If alias is not provided APEX Application Id will be used

Inputs

Input Name

Input Code

Required

Description





Outputs

Output Name

Required

Description




Artifacts

This operation consumes artifacts from the artifacts repository.

Endpoint Selection

This operation will select all available endpoints associated to the environment/instance. You must make sure that APEX Server (database) Endpoint is added to the Environment Instance.

Endpoint Execution 

This operation will execute on any one of the selected endpoints and will be random in the determination of which one.