Database Specific Data Definition

Database Components are used for making database updates such as table changes using SQL Scripts. Note: An database form (such as an Oracle Form) can be compiled and should be defined as an Application File not Database Component.

Field Description
Base Directory Base, or high level, directory where the file will be deployed. This value will be ignored if the Endpoint has a Base Directory defined. See Formatting Directories on the order of how the deployment directory is formatted.
Pre-Action An Action that is to be run prior to the deployment of this Component. This can be used to perform prerequisite requirements, such as creating directories, creating files from scratch, or moving files between directories.
Post-Action An Action that is to be run after the deployment of this Component. This can be used to execute actions on the target Endpoint after the Component has been deployed.
Roll Forward Target Directory The directory under the Base Directory where the Roll Forward file will be deployed, or final “Target” Directory. See Formatting Directories on the order of how the deployment directory is formatted.
Roll Forward Repository Choose the Repository that contains your Roll Forward SQL. This list box is populated based on the Repositories pre-defined in your initial setup. Based on the Repository you select, you may be provided override or append fields if they were made available. For more information on Repositories see Connecting Your Repositories.
  • Filepath Override: Enter a filepath that will override the default filepath defined at the Repository level.
  • Pattern Override: Enter a pattern that will override the default pattern defined at the Repository level. Patterns are file types you want to pull from the Repository, such as *.exe, *.dll, *.war.
  • Recursive Override: Select the box in order to override the default recursive behavior defined at the Repository level. This will turn recursion on or off depending on the setting at the Repository level.
  • Version Override: Overrides the default template of your versioning pattern defined at the Repository level.
Rollback Target Directory The directory under the Base Directory where the Rollback file will be deployed, or final “Target” Directory. See Formatting Directories on the order of how the deployment directory is formatted.
Rollback Repository Choose the Repository that contains your Roll Forward SQL. This list box is populated based on the Repositories pre-defined in your initial setup. Based on the Repository you select, you may be provided override or append fields if they were made available. For more information on Repositories see Connecting Your Repositories.
  • Filepath Override: Enter a filepath that will override the default filepath defined at the Repository level.
  • Pattern Override: Enter a pattern that will override the default pattern defined at the Repository level. Patterns are file types you want to pull from the Repository, such as *.exe, *.dll, *.war.
  • Recursive Override: Select the box in order to override the default recursive behavior defined at the Repository level. This will turn recursion on or off depending on the setting at the Repository level.
  • Version Override: Overrides the default template of your versioning pattern defined at the Repository level.

Formatting of the Deployment Directory with Base and Target Directories for Database and Application File Deployments

You must define the directory where your Component file is going to be deployed on your Endpoint. This is the purpose of your Component Base and Target Directories. The Base Directory is the high level directory, the Target Directory is the lower level, or final “Target” directory. Endpoints may be managed by a System Administrator who may want to force the use of a particular Base Directory on the Endpoint. If so, this directory can be set at the Endpoint Base Directory and override the Component level Base Directory. When a deployment occurs, the process will check to see if the Endpoint has a Base Directory defined, and will replace the Component Base Directory with the Endpoint Base Directory to create the full path for the deployment.

Below is how the full file deployment path is formatted:

Component Base Directory Value Component Target Directory Value Endpoint Base Directory Value Result
Has Value Null Null The files will be placed in the Component Base Directory.
Null Has Value Null The files will be placed in the Component Target Directory.
Null Null Has Value The files will be placed in the Endpoint Base Directory.
Null Has Value Has Value The files will be placed in the Endpoint Base Directory + Component Target Directory.
Has Value Null Has Value The files will be placed in the Endpoint Base Directory.
Has Value Has Value Null The files will be placed in the Component Base Directory + Component Target Directory.
Has Value Has Value Has Value Endpoint Base Directory + Component Target Directory.
Null Null Null Deployment will fail.

Last modified September 6, 2024: Signed-off-by: tracyragan <[email protected]> (bad55b3)