...

Applies to Oracle Data Integrator 12.2.1+ only.

Applies a Patch Deployment Archive file generated from an ODI Repostory or Version Control System (VCS) Tag.

Note

title	Limitations

The implementation currently does not support the following:

Export Key for importing secure Cipher data. Patches will be imported, but will exclude any encrypted data contained in the patch.
Creating a Rollback Deployment Archive prior to application
Deploying full/initial patches

Environment/Instance Properties

Property Name	Property Code	Required	Description
ODI Home	`FDODI_ODI_HOME`	Yes	Fully qualified path to the ODI installation directory.
ODI JDBC Driver Path	`FDODI_JDBC_DRIVER_PATH`	Yes	Classpath for locating the JDBC Driver.
ODI JDBC URL	`FDODI_JDBC_URL`	Yes	JDBC Connect String for the ODI Master/Work repositories.
ODI JDBC Driver	`FDODI_JDBC_DRIVER`	Yes	JDBC Driver to use for connecting to the ODI Master/Work repositories.
ODI Master User	`FDODI_MASTER_USER`	Yes	Database schema owner of the ODI Master repository.
ODI Master Password	`FDODI_MASTER_PASSWORD`	Yes	Database password for ODI Master User.
ODI User	`FDODI_ODI_USER`	Yes	User to connect to ODI instance with (must have `SUPERVISOR` privileges).
ODI Password	`FDODI_ODI_PASSWORD`	Yes	Password for `ODI User`.
ODI Work Repository	`FDODI_WORK_REPOSITORY`	Yes	The name of the target ODI work repository.

Project Properties

Property Name	Property Code	Required	Description
Deployment Archive Name	FDODI_DEPLOY_ARCHIVE_NAME	No	The name of the Deployment Archive file. The plugin input will take precedence if provided.

Inputs

Input Name	Input Code	Required	Description
Deployment Archive Folder	FDODI_INP_DEPLOY_ARCHIVE_FOLDER	No	The folder from which to source the archive file. Defaults to the artifacts directory if not provided.
Deployment Archive Name	FDODI_INP_DEPLOY_ARCHIVE_NAME	No	The name of the Deployment Archive file. This value will override the project property, and be used for every project.
Create Rollback Archive	FDODI_INP_CREATE_ROLLBACK_ARCHIVE	No	If true, rollback deployment archive will be created before applying the patch. The rollback deployment archive is created as <FD_TEMP_DIR>/rollback.zip, and is returned as an output from this operation. @since 5.2.0.1
Include Physical Topology	FDODI_INP_INCLUDE_PHYS_TOPOLOGY	No	If true, all Physical Topology Data from the Deployment Archive will be imported into the target repository. @since 5.2.0.1

Tip

title	Properties & Inputs

The properties and inputs for this operation are used according to the following rules:

The deployment archive name input takes precedence over the project property.
The deployment archive name can take the following forms:
- Empty - The zip file will be searched for in the Deployment Archive Folder. An error will result if zero or more than one zip file are found within the folder or its sub-folders.
- Extension or no Extension - May be specified with .zip extension or without extension (extension will be added implicitly if not provided).
- Relative Path - The filename and its relative path will be appended to the Deployment Archive Folder to locate the file.
- Absolute Path - The absolute path will be used, and the Deployment Archive Folder will be ignored.
The deployment archive folder defaults to the Artifacts directory if not specified.
The deployment archive folder and deployment archive name input/property may use Groovy expressions to calculate the values at execution time, and make use of variables like FD_ARTIFACTS_DIR, FD_TEMP_DIR, etc.

Outputs

Output Name	Required	Description
FDODI_OUT_ROLLBACK_ARCHIVE	No	If Create Rollback Archive is true, then the fully-qualified path of the generated rollback deployment archive file will be returned. @since 5.2.0.1

Artifacts

This operation consumes the artifacts produced from a build workflow.

This operation will select all available endpoints associated to the environment/instance.

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

This operation is available for Oracle Data Integrator 12.2.1+ only.