Versions Compared

Old Version 15

changes.mady.by.user Chandresh Patel

Saved on

compared with

New Version Current

changes.mady.by.user Chandresh Patel

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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 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 operation, but can be managed in a separate project and workflows using the JDBC or Oracle Database Plugin.

This plugin supports deploying the same APEX application to the same database. This requires setting the Offset. This situation is not normaltypical, so most likely you will not have to worry about offsetoften 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 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).

...

  • .

Environment/Instance Properties

Property Name

Property Code

Required

Description

Oracle
Database
SQLcl Home
FDAPEX
FD_
ORACLE_DBOracle 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.
SQLCL_HOMEYes

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

Folder where SQLcl is installed.

Use JDK 8 for Endpoint Java due to SQLcl requirements.

APEX UserFDAPEX_USERYesProvide database user APEX_xxxxx or owner (parsing schema) of the application for export and import operations. You can use system user as well.
APEX PasswordFDAPEX_PASSWORDYesPassword for APEX User.  

FDAPEX_RUN_APPLICATION_ONLY

NoDeploy with Run Application Only as build status.
Oracle Database URLFDORA_URLYes

JDBC URL for Oracle database. For example:

  • jdbc:oracle:thin:@HOSTNAME:PORT:SID or
  • jdbc:oracle:thin:@//HOSTNAME:PORT/SERVICENAME

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

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.

If Workspace id is different in each environment, FlexDeploy will still be able to handle that situation by deriving workspace id from workspace name provided.

Parsing Schema

FDAPEX_DB_SCHEMA

No

Parsing schema (owner) of APEX application.

If not provided, value in exported sql file will be used, which means that schema name will be same in all environments.

APEX Application Id
FDAPEX_APPLICATION_ID
NoIdentifying number of application. If not specified, workspace name and application name is used to query application id, otherwise new application id will be generated.
APEX Application Name
FDAPEX_APPLICATION_NAME
NoThe name of the application to deploy. This is used to derive application id if application id is not provided.
APEX
SQL Files
Application AliasFDAPEX_
SQL_FILES
ALIASNo
Comma 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.
Application alias is set on the application being imported. If not provided, then alias set in exported sql files will be used.
Use APEX Offset
FDAPEX_USE_OFFSET
NoDetermines if the plugin will attempt to set the Offset.
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 Instancecan use any Endpoint where SQLcl is installed and has connectivity to database using JDBC URL. We recommend use of LOCALHOST endpoint if connectivity can be established between FlexDeploy and your APEX database.

Endpoint Execution 

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