buildAPEX
- Karl Henselin
- Ben Hoffman
Builds an APEX application artifact, sourcing from an SCM or Oracle APEX Application Builder in a development environment. This operation can be used in conjunction with FlexDeploy's Full and Package-Based deployment models.
Full Deployment
Entire application gets exported.
Source from SCM
Set desired SCM type.
Add SCM export or checkout operation before buildAPEX operation in workflow.
Source from App Builder
Set SCM type to None.Â
You only need to add buildAPEX operation in workflow.
Package-based Deployment
Only selected page/components are exported. You can also export All Files, which means entire application gets exported.
Source from SCM
Set desired SCM type.
You only need to add buildAPEX operation in workflow.
SCM export or checkout operation is not required at all as FlexDeploy will implicitly perform extract of files from SCM based on project configurations.
Source from App Builder
Set SCM type to None.
You only need to add buildAPEX operation in workflow.
Oracle JDBC driver must on the FlexDeploy server's classpath. If the FlexDeploy is setup to use Oracle Database, the driver will be already available. However, if the FlexDeploy is using PostgreSQL or MySQL, then you will need to place the Oracle JDBC Driver on the FlexDeploy server, add it to the server's classpath, and restart it.
Artifact generated by this operation is zip file containing split application sql files. For APEX versions 4.x, no split is done hence artifact will be entire application sql file.
Target Properties
Property Name | Property Code | Required | Description |
|---|---|---|---|
Oracle SQLcl Home |
| Yes | Folder where SQLcl is installed. Only required if sourcing from App Builder. Make sure that the endpoint Java Home is a high enough version for your SQLcl version. |
APEX User |
| Yes | Provide database user APEX_xxxxx (APEX user requires INHERIT Privilege) or owner (parsing schema) of the application for export and import operations. You can use system user as well. Only required if sourcing from App Builder. |
APEX Password |
| Yes | Password for APEX User. Only required if sourcing from App Builder. |
Oracle Database URL |
| Yes | JDBC URL for Oracle database. For example:
Only required if sourcing from App Builder. |
1 - Required only if sourcing from App Builder.
Project Properties
Property Name | Property Code | Required | Description |
|---|---|---|---|
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. |
Parsing Schema |
| No | Used to set the parsing (owner) schema of the APEX application. Provide uppercase schema name. |
Application ID |
| No | APEX Application ID |
Application Name |
| No | APEX Application Name |
Application Alias |
| No | APEX alphanumeric identifier unique within a workspace and page. |
Export Supporting Object Definitions |
| No | Specify whether to export supporting object definitions with your application. |
Export Public Reports |
| No | Specify whether to include public reports with your application. |
Export Report Subscriptions |
| No | Specify whether to include interactive report or interactive grid subscription settings with your application. |
Export Developer Comments |
| No | Specify whether to include Developer Comments in your application export. |
Export Translations |
| No | Check to include Translations with your application export. |
Use Offset |
| No | Determines if the plugin will attempt to set the Offset. |
Offset value |
| No | APEX Offset value |
Use Original Ids |
| No | Determines if the plugin will use original ids when exporting. @Since 8.0.0.9 |
FlexDeploy needs to identify the application id. This can be provided by either entering the application id directly or by entering the associated application name. If the application name is not unique across workspaces, you must provide the workspace name in addition to the application name.
Artifacts
Artifact generated by this operation is zip file containing split application sql files. For APEX versions 4.x, no split is done hence artifact will be entire application sql file.
Endpoint Selection
This operation will select all available endpoints associated to the Target.
If sourcing from App Builder, you can 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.
If sourcing from SCM, then you can use any Endpoint. We recommend using LOCALHOST endpoint in this case.
Endpoint Execution
This operation will execute on any one of the selected endpoints and will be random in the determination of which one.
- style