applyPatchArchive

Applies to Oracle Data Integrator 12.2.1+ only.

Applies a Patch Deployment Archive file generated from an ODI Repository or Version Control System (VCS) Tag in full deployment projects.

This operation can be used in conjunction with the partialBuild operation in Generic partial deployment type projects to apply patch archives according to Work Repository Type. For partial deployment, the package should contain both development and execution patch archive files.  The appropriate archive file will be deployed based on the Work Repository Type of the target environment.

Sample Build workflow for Generic partial deployments projects can be found here.

Follow the instructions provided here to connect to Oracle Autonomous databases.


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.

ODI Target Archive Type
FDODI_TARGET_ARCHIVE_TYPE
Yes
Set the type of deployment archive to apply. Values are Derive, Design, and Runtime.
Defaults to Derive which determines the type of archive to apply automatically.

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. Ignored in partial deployment projects.

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. Ignored in partial deployment projects.

Deployment Archive Name
FDODI_INP_DEPLOY_ARCHIVE_NAME
NoThe name of the Deployment Archive file.  This value will override the project property, and be used for every project. Ignored in partial deployment projects.
Create Rollback Archive
FDODI_INP_CREATE_ROLLBACK_ARCHIVE
No

If true, a rollback deployment archive will be created before applying the patch.  The rollback deployment archive is created as rollback.zip in full deployment projects and <DEPLOY_ARCHIVE_NAME>-rollback.zip  in partial deployment projects. The path to the rollback archive is returned as an output.

Rollback Archive Storage Path
FDODI_INP_ROLLBACK_ARCHIVE_STORAGE_PATH
No
The absolute path where the generated rollback archive file will be stored. Defaults to reports folder of the endpoint working directory.
Include Physical Topology
FDODI_INP_INCLUDE_PHYS_TOPOLOGY
NoIf true, all Physical Topology Data from the Deployment Archive will be imported into the target repository. 
Export Key
FDODI_EXPORT_KEY
No
Export Key to be used to migrate cipher data in the Deployment Archive during apply.
Apply Without Cipher Data
FDODI_APPLY_WITHOUT_CIPHER_DATA
No
If true, any cipher data present in the Deployment Archive will be made null during apply. If false, the Export Key will be used to migrate the cipher data.

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 is 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.
  • The deployment archive folder and deployment archive name input/property is ignored in partial deployment projects.

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.  In partial deployment projects, If the package contains more than one patch archive, then a list of the fully-qualified paths of the generated rollback deployment archive files will be returned.

Artifacts

This operation consumes the artifacts produced from a build workflow.

Endpoint Selection

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

Endpoint Execution

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

Special Considerations

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