Executes a SQL script file. Property replacement is performed on the files before they are executed.

Delimiting SQL files

Please note that the statements in the SQL files must be delimited properly.

Use ; to delimit individual statements.
Use / on new line to delimit program blocks.
Use /* or -- (two dashes) for comments.

Target Properties

Property Name	Property Code	Required	Description

Property Name	Property Code	Required	Description
Oracle Database User	`FDORA_USER`	Yes	The username that will be used to connect to the target Oracle Database.
Oracle Database Password	`FDORA_PASSWORD`	Yes	The password for Oracle Database User.
Oracle Database URL	`FDORA_URL`	Yes	JDBC URL for Oracle database. For example: jdbc:oracle:thin:@HOSTNAME:PORT:SID or jdbc:oracle:thin:@//HOSTNAME:PORT/SERVICENAME
Oracle SQLcl Home	`FD_SQLCL_HOME`	Yes	Folder where SQLcl is installed. ( Ex: `/u01/install/sqlcl`) Make sure that the endpoint Java Home is a high enough version for your SQLcl version.

Inputs

Input Name	Input Code	Required	Description

Input Name	Input Code	Required	Description
User	`FDSQLCL_INP_ORA_USER`	No	The username that will be used to connect with. This input takes precedence over the target scoped `FDORA_USER`property. This input is required if the `FDORA_USER`property is not specified.
Password	`FDSQLCL_INP_ORA_PASSWORD`	No	The password for `FDSQLCL_INP_ORA_PASSWORD`. This input takes precedence over the target scoped `FDORA_PASSWORD` property. This input is required if the `FDORA_PASSWORD` property is not specified.
Script File	`FDSQLCL_INP_FILE_PATH`	Yes	Fully qualified or relative path to script file. If relative path is given, it will be assumed to be in the `FD_ARTIFACTS_DIR`.
User Profile (login.sql)	`FDSQLCL_INP_LOGIN_SQL_FILE`	No	User Profile (login.sql) is intended to allow users to specifically customize their session. (see the Special Considerations section for examples)
Generate SQL Spool File	`FDSQLCL_INP_GENERATE_SPOOL_FILE`	No	Check to generate report (Spool file) of SQL statement executions.
Show DBMS Output	`FDSQLCL_INP_SHOW_DBMS_OUT`	No	Print DBMS output in the log.
Fix SQL Syntax	`FDSQLCL_INP_FIX_SQL_SYNTAX`	No	Check to fix common SQL syntax issues.
Ignore Compilation Warnings	`FDSQLCL_INP_IGNORE_WARNING`	No	If checked, SQL compilation warnings will be ignored. Otherwise, they will cause the execution to be marked as fail.

Artifacts

This operation consumes one SQL file from the artifacts repository.

Endpoint Selection

This operation delegates the selection to the workflow developer to determine.

Endpoint Execution

This operation will randomly execute on one of the endpoint identified during selection.

Special Considerations

login.sql

The script provided in the input FDSQLCL_INP_LOGIN_SQL_FILE will be created as the login.sql file in the current working directory and will be deleted after execution. The login.sql script in SQLcl is automatically executed whenever you start SQLcl. It can be used to set up your SQLcl environment, including formatting options, environment variables, and other session settings.

Below is an example script that can be customized based on requirements.

-- Set the SQLcl environment settings
SET ECHO OFF
SET FEEDBACK ON
SET HEADING ON
SET LINESIZE 200
SET PAGESIZE 9999
SET SERVEROUTPUT ON
SET TERMOUT ON
SET TIMING ON
SET VERIFY OFF

-- Set default schema
ALTER SESSION SET CURRENT_SCHEMA=YOUR_SCHEMA_NAME;

-- Define common substitution variables
DEFINE my_variable = 'default_value'

-- Custom SQL*Plus prompt
SET SQLPROMPT "SQL> "

-- Display a welcome message
PROMPT Welcome to SQL*Plus

FlexDeploy 8.0

runScript(SQLcl)