PeopleSoft Object Types - Database

Database type objects model sql files that are stored in SCM. They are used to copy sql files from an SCM to a filesystem on an endpoint where they are executed by JDBC. DB type objects can be sourced only from an SCM. They cannot be created manually. No attributes are required.

Subfolders to the final target location of the sql files are created by the plugin as long as the endpoint user has sufficient privileges.

Attributes

Name

Code

Description

Default Value

Name

Code

Description

Default Value

Source

SOURCE

Object Source Location Type

SCM (**populating from SCM)

JDBC User Property

FDPSOFT_JDBC_USER

The property that will be used to set the username used to log into the database.

FDPSOFT_JDBC_USER- Set this value on the Target, or override it on a project. Alternatively, create a new property on the workflow, and then set its value in one of those locations.

JDBC Password Property

FDPSOFT_JDBC_PASSWORD

The property that will be used to set the password used to log into the database.

FDPSOFT_JDBC_PASSWORD- Set this value on the Target or override it on a project. Alternatively, create a new property on the workflow, and then set its value in one of those locations.

JDBC URL Property

FDPSOFT_JDBC_URL

The property that will be used to set the JDBC URL used to log into the database.

FDPSOFT_JDBC_URL- Set this value on the Target or override it on a project. Alternatively, create a new property on the workflow, and then set its value in one of those locations.

Retry Count

RETRY_COUNT

How many times should the file be retried before marking it as a failure. It may be useful to set it to a larger value if deploying many files together if the selected order may not be correct.

FDPSOFT_JDBC_RETRY_COUNT_DEFAULT is the project property that fills in the default value at evaluate or populate time.

Ignore Failure

IGNORE_FAILURE

If checked, the file and the execution will be marked successful even if it fails to be processed in any way. The failure will be logged, but there will be no other indication.

FDPSOFT_JDBC_IGNORE_FAILURE_EXT_DEF is the project property that takes a list of extensions. Any files that end with those extensions will have their ignore failures checkbox checked at populate or evaluate time.

Ignore Compilation Warnings

IGNORE_COMPILATION_WARNING

If checked, the file and the execution will be marked successful even if it encounters a compilation warning. The warning will be logged, but there will be no other indication.

FDPSOFT_JDBC_IGNORE_COM_ERR_EXT_DEF is the project property that takes a list of extensions. Any files that end with those extensions will have their ignore compilation warnings checkbox checked at populate or evaluate time.

Property Replacement

PROPERTY_REPLACEMENT

If checked, property replacement will be run on the file, unless it appears to be a binary file, and then it will be skipped for property replacement.

FDPSOFT_JDBC_PROPERTY_REPLACEMENT_DEFAULTis the project property to control the default.

Target Location

TARGET_LOCATION

This is the location where the file will be placed. Property replacement will be performed on the value.

If blank, the file will be copied into FD_TEMP_DIR. If the default is used, but the Database SQL Files Target Folder project property is left blank, then the file will be copied into FD_TEMP_DIR.

${{FDPSOFT_SQL_TARGET_FOLDER}}

Run As User

RUN_AS_USER

If set, a SQL statement will be executed before the file to switch schema (user). Property replacement will be performed on the value. This is a convenient attribute when many files must switch schema before execution. For example you can use ${{MYSCHEMA}}, where MYSCHEMA is Project or Target property.

This attribute is only supported for Oracle, PostgreSQL, and SQL Server databases.

I.E. If Run As User is set to “TestUser”, then the following would be executed before the file depending on database type:

// Oracle ALTER SESSION SET current_schema=TestUser // PostgreSQL SET SEARCH_PATH TO TestUser // SQL Server EXECUTE AS USER=TestUser

 

Rollback Source Type

ROLLBACK_SOURCE_TYPE

Where to retrieve file when initiating a rollback deployment.

Options are Project Version, SCM Revision, Backup Repository, and Rollback File

SCM Revision and Rollback File options are only available when the project has SCM details configured, and Backup Repository should only be used if the FlexDeploy server and project are configured to take backups.

Project Version

 

Rollback File

ROLLBACK_FILE

The associated file to deploy which will roll back this file. Only applicable when Rollback Source Type is Rollback File

 

The following macros are not currently supported in the footer:
  • style