packageDeploy (OIC)
- Karl Henselin
- Chandresh Patel
Deploys Oracle Integration Cloud components to the designated OIC environment. Like other package-based plugin operations, this process only deploys a file if it has changed since the previous deployment to that OIC environment, unless a Force Deploy is requested.
Integrations: The integration object type will be imported to the designated OIC environment. If connections were exported as part of the integration, they will also be imported. Additionally, if the integration utilizes any libraries, the IAR file will include those libraries and they will be imported with the associated metadata.
Connections: The connection object type will be either created or updated. If a connection is not found, it will be created, and all properties will be updated. Any associated attachments will also be uploaded, if present. To use different attachments for each Oracle Integration Cloud (OIC) environment, the Attachment Override Directory input must be specified.
Lookups: The lookup object type will be created or updated. To use different lookup files for each OIC environment, the Lookup Override Directory input must be provided. Property replacement is automatically applied to all lookup files in the artifact. See Property Replacement Support for details.
Either FDOIC_CLOUD_ACCOUNT_CODE Target property value or FDOIC_INP_CLOUD_ACCOUNT_CODE plugin input value should exist. When both exists, plugin input value will take precedence. See Creating/Editing a Cloud Account and Provider for details on how to setup Cloud Account for OIC.
See Oracle Integration Cloud - Object Type Reference for details on supported object types.
Target Properties
Property Name | Property Code | Required | Description |
|---|---|---|---|
OIC Account |
| No | The OIC account with all the required properties like Base URI, Username and Password for running OIC Instance. OIC Account can be created on Integrations - Cloud page. |
Project Properties
Property Name | Property Code | Required | Description |
|---|---|---|---|
Stop On Deployment Error |
| No | Stop deploying package files if any error occurs. If unchecked all files will be deployed even if one or more files fails. This project property only applies to this operation. Defaults to true. |
Overwrite Integrations |
| No | Overwrite integrations with the same name and version when importing. The plugin input defaults to this value, but the workflow can be modified to use a different setting if needed. |
Inputs
Input Name | Input Code | Required | Description |
|---|---|---|---|
OIC Account |
| No | The OIC account with all the required properties like Base URI, Username and Password for running OIC Instance. OIC Account can be created on Integrations - Cloud page. |
Overwrite Integrations |
| No | Overwrite integrations with the same name and version when importing. The plugin input defaults to using the project property Overwrite Integrations, allowing each project to have its own behavior. If needed, the workflow can be adjusted to use a different value, in which case all projects will follow the same behavior. |
OIC Connection Plan File |
| No | Optional connection configuration file to run during import. The default is 'connectionPlan.properties' in the FD_ARTIFACTS_DIR. You can provide absolute path to a file or just name, if name is provided it must exist in artifacts. Allows absolute path or relative to the artifacts directory. This is used for replacing values in the connections.json file. That file must be present in order to have values replaced in it. Will be pre-processed by the plugin to transform any defined replacement properties based on the deployed environment. See Connection Plans section below for more details. |
Deploy Delay between Integrations |
| No | Specify deploy delay in seconds between integrations. Default is 0, which means no delay. Use this delay only if you see issues with Oracle Integration Cloud deployments. |
Update Connections Mode |
| Yes | Input to determine whether connections should be updated after deployment. Defaults to ALL. If value is set to ALL, every applicable connection is updated. If value is set to SPECIFIC, only connections specified in FDOIC_INP_UPDATE_CONNECTION_LIST will be updated. If value is set to NONE, none of the connections are updated after a deployment. |
Update Connection List |
| No | Comma-separated list of connection IDs to update after deployment. This input is only considered when |
Attachment Override Directory |
| No | A directory containing attachments to override, files from this folder will be used in place of the attachments in the artifacts. This is useful when you need to use different attachments for each environment. Example (Groovy) : FD_TEMP_DIR + "/OIC_OVERRIDES/ConnectionAttachmentsOverrides/" + FD_ENVIRONMENT_CODEThe directory structure under override directory should follow this format:<ConnectionId>/<PropertyName>/<Attachment>. You can create You can also use different attachment name per environment. For example, connection plan can indicate If this value is not provided, attachment overrides will not be applied. See the Deployment Overrides section for more details. |
Start Schedules |
| No | If set to true, the file attribute Start Schedules will determine whether any schedules should be initiated after the integration deployment. If set to false, schedules will not be started, regardless of the file attribute value. This feature is useful for starting schedules based on workflow execution variables, such as initiating schedules if environment is "PRODUCTION" Defaults to true. |
Enable Tracing |
| No | If set to true, the file attribute Enable Tracing will determine whether integration activity can be viewed in the Activity Stream. If set to false, tracing will be disabled, regardless of the file attribute value. This feature is useful for enabling tracing based on workflow execution variables, such as initiating schedules if environment is "PRODUCTION". Defaults to true. |
Enable Payload Tracing |
| No | If set to true, the file attribute Enable Payload Tracing will determine whether the payload should be traced. If set to false, payload tracing will be disabled, regardless of the file attribute value. This feature is useful for enabling payload tracing based on workflow execution variables, such as initiating schedules if environment is "PRODUCTION". Defaults to true. |
Integration Retry Count |
| No | The number of times an integration will be retried incase of failures. Default is 5. |
Connection Retry Count |
| No | The number of times an connection will be retried incase of failures due to connection being locked. Default is 10. |
Lookup Override Directory |
| No | A directory containing lookups to override, files from this folder will be used in place of the lookups in the artifacts. This is useful when you need to use different lookups for each environment. Example (Groovy) : FD_TEMP_DIR + "/OIC_OVERRIDES/LookupOverrides/" + FD_ENVIRONMENT_CODELookup CSV files should be placed under override directory. You can create GLOBAL folder at same level as FD_ENVIRONMENT_CODE folder. Files in GLOBAL folder will be applied to all environments unless overridden at individual If this value is not provided, lookup overrides will not be applied. See the Deployment Overrides section for more details. |
Schedule Override Directory |
| No | Specify directory to override integration schedules by environment in place of schedule in artifacts. Example (Groovy) : FD_TEMP_DIR + "/OIC_OVERRIDES/ScheduleOverrides/" + FD_ENVIRONMENT_CODEWithin this override folder, subfolders must be named after the various Integration Ids (which correspond to the IAR file name). The schedule XML file for each integration should be placed in the respective subfolder. The original schedule XML file can be found in the icspackage/schedule folder inside the IAR file. If this value is not provided, schedule overrides will not be applied. |
Artifacts
This operation consumes artifacts from the artifacts repository.
Endpoint Selection
This operation will select all available endpoints associated to the Target.
Endpoint Execution
This operation will execute on any one of the selected endpoints and will be random in the determination of which one.
Connection Plans
If you are using connection plan file(s) (i.e. “connectionPlan.properties”) it is best practice to store these in source control. During packageBuild execution, FlexDeploy will capture all files with the properties extension as artifacts. Such properties files will be stored in root of artifacts. Subsequently, on the deploy side, FlexDeploy will have access to the artifact created during the build which can then be used with the FDOIC_INP_CONNECTION_PLAN input.
The below image is an example of placing the connection plan properties file under the root directory. We are assuming “OIC” is the root directory.
Deployment Overrides
Below is a sample structure for the Overrides folder. You can manage these overrides in a Git repository or any other SCM (Source Control Management) system, or directly on the endpoint filesystem. If using Git or another SCM, make sure to clone or export the root folder before performing the packageDeploy operation and specify appropriate override input values for packageDeploy operation in Workflow.
Here is a simple suggestion for root folder names, though you are free to choose any naming convention that suits your needs:
OIC_OVERRIDES
ConnectionAttachmentsOverrides
LookupOverrides
ScheduleOverrides
- style