Deploys an Oracle APEX application (produced by a build workflow using the buildAPEX plugin operation) to a target database. This operation manages deployment of builds produced by both the Full Deployment and Partial Deployment models.
Any supporting database objects for the application are outside the scope of this operating, but can be managed in a separate project and workflows using the JDBC Plugin.
This plugin supports deploying the same APEX application to the same database. This requires setting the Offset. This situation is not typical, so most often the offset can be ignored.
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 propertyAPEX Offset Value
(FDAPEX_OFFSET)
for the next deployment.- If you know the offset, select
Use APEX Offset
(FDAPEX_USE_OFFSET)
and set the propertyAPEX 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 SQLcl Home | FD_SQLCL_HOME | Yes* | Folder where SQLcl is installed. |
APEX User | FDAPEX_USER | Yes* | Provide database user APEX_xxxxx or owner (parsing schema) of the application for export and import operations. You can use system user as well. |
APEX Password | FDAPEX_PASSWORD | Yes* | Password for APEX User. |
Oracle Database URL | FDORA_URL | Yes* | JDBC URL for Oracle database. For example:
|
Project Properties
Property Name | Property Code | Required | Description |
---|---|---|---|
APEX Workspace Name | FDAPEX_WORKSPACE_NAME | Yes | APEX Workspace Name. Provide uppercase name. This defaults to FD_INSTANCE_CODE expression, so if you keep instance code same as your workspace, you will not need to change default value. |
APEX Application Id | FDAPEX_APPLICATION_ID | No | Identifying number of application. If not specified, workspace name and application name must be provided. |
APEX Application Name | FDAPEX_APPLICATION_NAME | No | The name of the application to deploy. Required if application id not provided. |
APEX Application Alias | FDAPEX_ALIAS | No | APEX alphanumeric identifier unique within a workspace and page. If alias is not provided APEX Application Id will be used |
APEX Offset value | FDAPEX_OFFSET | No | The 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 | No | Determines if the plugin will attempt to set the Offset. |
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.