Oracle plugin

The Oracle database is an object-relational database management system produced and marketed by Oracle Corporation. Oracle has these features:

Transaction support
Stability
Scalability
Multiplatform support
Security

The EC-Oracle plugin calls the Oracle SQL*Plus command-line tool that you use to execute SQL files against the database.

Plugin Version 2.0.10.2022041506 Revised on April 14, 2022

For all parameter descriptions in this document, required parameters are shown in bold italics.
In the CloudBees CD/RO UI, open the main menu and select Admin Plugins to open the Plugin Manager.

Integrated version

This plugin was developed and tested against Oracle 10g.

Setting up the plugin configuration

Plugin configurations are sets of parameters that apply across some or all of the plugin procedures. They reduce repetition of common values, create predefined sets of parameters for end users, and securely store credentials. Each configuration has a unique name that is automatically entered in designated parameters in the procedures.

Input

In the main menu, select Admin Plugins to open the plugin manager.
Find the EC-Oracle row.
Click Configure to open the Oracle Configurations page.
Click Create Configuration.
To create an Oracle configuration, enter the following information and click OK.

Remember that you may need to create additional configurations later.

Output

The Oracle configurations page now shows the new configuration.

You can also manage your Oracle configurations in this page. Click Edit to modify an existing configuration or Delete to remove an existing configuration.

Plugin procedures

ExecuteSQL

This procedure creates and executes an SQL file against an Oracle database.

Input

In the Main Menu, click Admin > Plugins to open the Plugin Manager.
Go to the ExecuteSQL procedure.
Enter the following parameters:

Parameter	Description
Configuration name	The name of the configuration that contains the user and password used to connect to the database server. (Required)
Query	A query to run against the database.
Sqlplus path	Absolute path to the SQP*Plus command-line tool. (Required)
Server	The name or IP address of the server to which you want to connect. (Required)
Output file	Name of a file where output is stored (without extension).
SQL file path	Absolute path to an SQL file that you want to run.
Additional commands	Additional commands, such as -S to activate the SQL*Plus silent mode. For more commands, go to this website.
Working directory	The directory where the commands are executed.
Result (output property path)	Property name used to store the query results.

Parameter

Description

Configuration name

The name of the configuration that contains the user and password used to connect to the database server. (Required)

Query

A query to run against the database.

Sqlplus path

Absolute path to the SQP*Plus command-line tool. (Required)

Server

The name or IP address of the server to which you want to connect. (Required)

Output file

Name of a file where output is stored (without extension).

SQL file path

Absolute path to an SQL file that you want to run.

Additional commands

Additional commands, such as -S to activate the SQL*Plus silent mode.

For more commands, go to this website.

Working directory

The directory where the commands are executed.

Result (output property path)

Property name used to store the query results.

Output

After the job runs, you can view the results on the Job Details page in CloudBees CD. The SQL file was successfully executed.

In the ExecuteSQL step, click the Log button to see the diagnostic information.

Examples and use cases

How to create a configuration

Stored configurations are available on the oracle configurations page

ExecuteSQL parameter form

Expected output

Release notes

EC-Oracle 2.0.10

Added session validation

EC-Oracle 2.0.9

The documentation has been migrated to the main documentation site.

EC-Oracle 2.0.8

Renaming to "CloudBees CD".

EC-Oracle 2.0.8

Renaming to "CloudBees"

EC-Oracle 2.0.7

Configurations can be created by users with "@" sign in a name.

EC-Oracle 2.0.6

The plugin icon has been updated.

EC-Oracle 2.0.5

Fixed issue with configurations being cached for IE.

EC-Oracle 2.0.4

Improved form validation.
Improved error handling.
Fixed minor issues.

EC-Oracle 2.0.3

Restricted usage of both Query and SQL file path parameters.
Fixed a bug when plugin could not open runCommandLine log file.
Fixed a bug with temp.sql file which was not found in some cases.

EC-Oracle 2.0.2

Removed the requirement for the agent/lib directory.

EC-Oracle 2.0.1

Fixed a bug where the clear text password appeared in the commandLine property created by the ExecuteSQL procedure. The clear text password also appeared in the ElectricFlow log file if the user ran the ExecuteSQL procedure.

EC-Oracle 2.0.0

The Result (output property path) parameter was added.

EC-Oracle 1.0.2

Procedure names were changed in the step picker section.

EC-Oracle 1.0.1

Updated the XML parameter panels.

EC-Oracle 1.0.0

Added the ExecuteSQL procedure.