Skip to main content
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

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

    Connecting to Oracle Autonomous Database

    You will need client credential zip file (wallet) to connect with Oracle Autonomous Database on Oracle cloud. You can download wallet zip file from Oracle Cloud, you will need admin userid and password to perform this download. See Download Client Credentials (Wallets) for more details on how to download wallet file.

    • Since FlexDeploy 9.0.0.9 with Oracle Wallet Credential Type : Instead of maintaining the wallet zip file under the file system, you can now store the wallet zip as an Oracle Credential Type in FlexDeploy. This allows for secure storage and use of the wallet.

      • Use the URL syntax in the following format: jdbc:oracle:thin:@service_low?TNS_ADMIN={{FDORACLEWALLETFILE}}</code></p></li><li><p>Wemustselectvalidoraclewalletcredentialfor<code>FDORACLEWALLETFILE</code>propertyontargetgroup.</p></li><li><p>Here,<code>\{\{FDORACLE_WALLET_FILE\}\}</code></p></li><li><p>We must select valid oracle wallet credential for <code>FDORACLE_WALLET_FILE</code> property on target group.</p></li><li><p>Here, <code>{{FDORACLE_WALLET_FILE}} is replaced with the temporary wallet folder path during execution. Once execution is completed, the temporary file is cleaned up automatically.

    • Before FlexDeploy 9.0.0.9

      • You must make sure that only authorized users have access to these wallet files. Unzip the client credentials zip file (wallet_databasename.zip) on FlexDeploy server and/or endpoint where it will be used. For example, /home/flexdeploy/.wallets/<wallet_databasename> is folder where specific wallet file was unzipped. Make sure to secure this folder to FlexDeploy and/or Endpoint user, so that it is not readable by all users.

      • We recommend using Oracle Wallet Credential Type for better security and easier management of Wallet usage.

      • Database URL Syntax : jdbc:oracle:thin:@service_high?TNS_ADMIN=/home/flexdeploy/.wallets/<wallet_databasename>

      • Database URL Long Connection String Format Syntax : jdbc:oracle:thin:@(description= (retry_count=20)(retry_delay=3)(address=(protocol=tcps)(port=1522)(host=<hostname>))(connect_data=(service_name=<serice_name>))(security=(ssl_server_cert_dn=“CN=<hostname>,OU=Oracle BMCS US,O=Oracle Corporation,L=Redwood City,ST=California,C=US”)))

        • Examples for the same can be found here.

    If using the Oracle Database Plugin with ADW or ATP databases , use the _low connection. The _medium and _high connections can sometimes throw error ORA-12839: cannot modify an object in parallel after modifying it.

Oracle Wallet File

FDORACLE_WALLET_FILE

No

Since 9.0.0.9 - Provide the Oracle Wallet file, seeCredential Type - Oracle Wallet for more details.

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

User

FDSQLCL_INP_ORA_USER

No

The username that will be used to connect with. This input takes precedence over the target scoped FDORA_USERproperty. This input is required if the FDORA_USERproperty 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.