Installing Version 25.1
Flows for APEX v25.1 Installation Guide
You have a choice of two installation approaches for a new installation of Flows for APEX..
- The simplest, for most new installations, is to install Flows for APEX as a packaged APEX installation. Download the packaged application and import it into APEX. instructions
- Alternatively, you can install from source code using SQLcl if you have SQL*Net access to the database server hosting APEX. instructions
If Flows for APEX is currently installed, you need to follow the instructions for migration instead.
Prerequisites
Before installing, ensure that your database schema has been granted the following system privileges:
- CREATE TABLE
- CREATE VIEW
- CREATE PROCEDURE
- CREATE SEQUENCE
- CREATE TYPE
- CREATE JOB
In addition, users of the Flows for APEX Enterprise Edition require
- AQ_ADMINISTRATOR role
- AQ_USER role
- execute privilege on SYS.DBMS_AQ package
New Installation with the packaged application
Note: These instructions are only for a fresh installation into an APEX workspace. If you are upgrading an existing Flows for APEX installation, see the migration page
-
Download the latest version of the packaged app here.
The release area contains two versions of the packaged app.
- English Only. Contains only the English language support. Use this version on oracleapex.com.
- All Languages. Contains all translated languages.
-
Log in into your Oracle APEX workspace and click on the “Import” cards.
-
On the import page, choose the previously downloaded SQL file, make sure that the option “Database Application, Page or Component Export” is selected and click on the “Next” button. A new page should confirm that the file have been correctly imported. Click on the “Next” button.
-
The next wizard page is a summary of the installation that will be done. Make sure the selected options are correct and click on “Install Application”.
-
After installation, the installer is likely to report that it installed a credential and a remote server for AI. The installation creates a remote server for the Flows for APEX AI Service. If the AI service does not exist, these are placeholder services that can be edited later in APEX through the Application Builder Workspace Utilities. The Credential that is created is also a placeholder than can be edited later if you want to use the AI service. Click Next.
-
you will be asked if you want to install the Supporting Objects. Enable the switch and click on “Next”. A confirmation page will be loaded, confirm the installation by clicking on the “Next” button.
-
Installation of Supporting Objects starts by checking that your schema has all of the required privileges. Click on Install to proceed.
-
After installation, you can click on the “Run Application” button to log into the Flows for APEX application and start building flows.
Installation with SQLcl
For Windows users, please make sure to set NLS_LANG value correctly by running set NLS_LANG=AMERICAN_AMERICA.UTF8
before using SQLcl.
- Get the full distribution content downloading the release source code: zip or tar.gz.
- Connect to you Oracle schema with SQLcl, make sure you are located into the distribution folder.
- Run the installation script, it will create the database objects and import the application.
SQL> @src/install_all_scratch.sql
- Provide the Workspace Name, Parsing Schema, Application Alias and Application Name.
>> Please enter needed Variables
Enter Workspace Name: [FLOWS4APEX] FLOWS4APEX
Enter Parsing Schema: [FLOWS4APEX] FLOWS4APEX
Enter Application Alias: [FLOWS4APEX] FLOWS4APEX
Enter Application Name: [Flows for APEX] Flows for APEX
- At the end of the installation, you should see the confirmation that the product have been correctly installed. You can connect to your Oracle APEX builder and run the Flows for APEX application. You will also see the following (or similar) warnings from APEX that it has installed a credential and a remote server for the AI service. These are installed as placeholders and do not contain any security relevant information. If you are going to use the Flows for APEX AI features, you should set up both the remote service and the credential using relevant information. These are set in the APEX Application Builder » Workspace Utilities.
--------------------------------------------------------------------------------
WARNING for credential "credentials_for_flows_for_apex_ai_service" (Static ID):
- Oracle APEX export files do not contain credential information.
- Use the APEX_CREDENTIAL.SET_PERSISTENT_CREDENTIAL procedure to set the
- credentials after the application has been imported. The credential is being
- referenced with its static ID "credentials_for_flows_for_apex_ai_service"
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
WARNING for remote server "F4A_AI_SERVICE" (Static ID).
- The PROMPT_ON_INSTALL attribute is set to YES.
- No attributes have been provided with APEX_APPLICATION_INSTALL.
Thus, workspace remote server settings remain unchanged.
- Base URL: https://api.openai.com/v1
- HTTPS Host:
- ORDS Timezone:
Use APEX_APPLICATION_INSTALL.SET_REMOTE_SERVER to change attributes.
--------------------------------------------------------------------------------
... elapsed: 124.15 sec
...done
>> Publish Translated Applications
PL/SQL procedure successfully completed.
>> Finished Installation of Flows4APEX
>> ====================================
Post Installation Tasks
Post Installation Task 1: Flows for APEX Configuration
Set Workspace and Default App and User Info
- Start the Flows for APEX Application.
- Open the Configuration page from the menu bar on the right hand side of the top of the screen.
- Select the Engine configurations.
- Set the default Workspace Name
- Set a default application ID, Page ID and default username. The App ID, Page ID, and Username must exist in the specified workspace. These parameters are used to create an APEX session when a Flows for APEX task is started from outside of APEX, for example in a process following a timer event. You can adjust these parameters or remove them before your application goes production if you want.
Note: Without default workspace, app, and user information, some background tasks - such as scripts run by timers and message flow events will not operate correctly after installation.
Post Installation Task 2: Additional step to install REST-API
Register schema with ORDS
You schema needs to be registered with ORDS by using the “RESTful Services” page in APEX or using the API-package “ORDS” (ORDS.ENABLE_SCHEMA)
Install API module
We provide a SQL script to install the API module, roles and privileges. It can be downloaded from our Github-Release-Page (Filename “REST_v1.sql”): https://github.com/flowsforapex/apex-flowsforapex/releases/latest/
Attention: Do not use “Import” Function on the APEX RESTful Services-Page.
Set Base-URL and Log-Status (Optional)
- Start the Flows for APEX Application.
- Open the Configuration page from the menu bar on the right hand side of the top of the screen.
- Open REST-Configuration subpage
- Enter the Base-URL path to your REST-Module (excluding the module “v1”). If no value is provided links populated in the response of the service will be relative paths. Example: https://domain.com/ords/flows4apex/v1 -> Base-URL: https://domain.com/ords/flows4apex
- Choose if incoming REST Calls should be logged in table “flow_rest_event_log”