Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Deploys integration components to the specified OIC target instances. This operation checks each file for changes and only deploys a file if it has changed or is set to forced.

  • Integrations - Object type of integration will be imported to the target instance. If connections were exported as part of an integration, they will be imported. If the integration uses any library then the iar file includes libraries and it imports the associated metadata of the library as well.

  • Connections - Object type of connection will be created or updated. If a connection is not found, it will be created as well as all of the properties updated. It also uploads any associated attachment if one exists. Attachment Override Directory input must be used to use different attachments for each OIC instance/environment. @since 7.0.0.3

  • Lookups - Object type of lookup will be created or updated. Lookup Override Directory input must be used to use different lookup file for each OIC instance/environment. Property replacement is automatically applied to all Lookup files in the artifact. See Property Replacement Support for details. @since 7.0.0.3

Info

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.

Target Properties

Property Name

Property Code

Required

Description

OIC Account

FDOIC_CLOUD_ACCOUNT_CODE

No

The OIC account with all the required properties like Base URI, Username and Password for running OIC Instance.

...

Input Name

Input Code

Required

Description

OIC Account

FDOIC_INP_CLOUD_ACCOUNT_CODE

No

The OIC account with all the required properties like Base URI, Username and Password for running OIC Instance.

Overwrite Integrations

FDOIC_INP_REPLACE_INTEGRATION

No

Overwrite integrations with the same name and version when importing.
The default value of this property allows using a project property to control this on a per-project basis.

OIC Connection Plan File


FDOIC_INP_CONNECTION_PLAN

No

Optional connection configuration file to run during import.  The default is 'connectionPlan.properties' in the FD_ARTIFACTS_DIR

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.

Deploy Delay between Integrations

FDOIC_INP_PARTIAL_DEPLOY_DELAY

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

FDOIC_INP_UPDATE_CONNECTION_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

FDOIC_INP_UPDATE_CONNECTION_LIST

No

Comma-separated list of connection IDs to update after deployment. This input is only considered when FDOIC_INP_UPDATE_CONNECTION_MODE is set to SPECIFIC.

Attachment Override Directory

FDOIC_INP_ATTACHMENT_OVERRIDE_DIRECTORY

No

A directory which contains attachments to override. Any attachments contained in this directory will be copied over the existing attachments. Useful if you want to have different attachments per environment, you can use FD_ENVIRONMENT_CODE to achieve this. See the attachment overrides section for an example of this. Directory should be in the following format <Connectionid>/<PropertyName>/<attachment>.

Example : The folder structure should be <Root>/<Environment Code>/<Connection Id>/<Property Name>/<Attachment File>

@since 7.0.0.2

There are situations where you may use same attachment for all environments, rather than copying the attachment file structure to each environment folder, you can place them in the following folder structure <Root>/GLOBAL/<Connection Id>/<Property Name>/<Attachment File>.

Attachments for connections placed under GLOBAL will be copied along with the files inside environment folder where the plugin execution runs, all files are then copied to the artifacts connection attachment folder. Files inside GLOBAL will be copied first and then files from environment folder will be copied.

@since 7.0.0.4

connectionPlan.properties now supports to use attachment override file for each instance for a connection.

Ex, FLEX_ATP_DB is the connection id, uses wallet. In the connectionPlan.properties, you can define a workflow property and configure as below. The execution will search for the name in the override folder.

FLEX_ATP_DB.secure.Wallet=${{FLEX_ATP_DB_WALLET_FILE_NAME}}

Start Schedules

FDOIC_INP_START_SCHEDULES

No

If true, the file attribute Start Schedules is used to determine if any schedules should be initiated after integration deployment. If false, schedules will not be started regardless of the file attribute value.

This is useful to start schedules based on workflow execution variables. I.E. Starting schedules if FD_ENVIRONMENT_CODE is Production.

Enable Tracing

FDOIC_INP_ENABLE_TRACING

No

If true, the file attribute Enable Tracing is used to determine if integration activity can be viewed in the Activity Stream. If false, tracing will be disabled regardless of the file attribute value.

This is useful to enable tracing based on workflow execution variables. I.E. Enable tracing if FD_ENVIRONMENT_CODE is Production.

Enable Payload Tracing

FDOIC_INP_ENABLE_PAYLOAD_TRACING

No

If true, the file attribute Enable Payload is used to determine if the payload should be traced. If false, payload tracing will be disabled regardless of the file attribute value.

This is useful to enable payload tracing based on workflow execution variables. I.E. Starting schedules if FD_ENVIRONMENT_CODE is Production.

Integration Retry Count

FDOIC_INTEGRATION_RETRY_COUNT

No

@since 7.0.0.3

The number of times an integration will be retried incase of failures. Default is 5.

Connection Retry Count

FDOIC_INP_CONNECTION_RETRY_COUNT

No

@since 7.0.0.3

The number of times an connection will be retried incase of failures due to connection being locked. Default is 10.

Lookup Override Directory

FDOIC_INP_LOOKUP_OVERRIDE_DIRECTORY

No

@since 7.0.0.3

A directory which contains lookups to override. Any lookup contained in this directory will be used for lookup during execution. Useful if you want to have different values for lookups per environment, you can use FD_ENVIRONMENT_CODE to achieve this.

Example : The folder structure should be <Root>/<Environment Code>/<Lookup csv file>.

There are situations where you may use same lookup for all environments, rather copying the lookup file to each environment folder, you can place them in the following folder structure <Root>/GLOBAL/<Lookup csv file>.

Lookup placed under GLOBAL will be copied along with the files inside environment folder where the plugin execution runs. Files inside GLOBAL will be copied first and then files from environment folder will be copied.

Schedule Override Directory

FDOIC_INP_SCHEDULE_OVERRIDE_DIRECTORY

No

@since 7.0.0.3

Specify directory to override integration schedules by environment. Use FD_ENVIRONMENT_CODE to indicate folder for current environment. The subfolder of this folder must be various Integration Ids(Use iar file name as Integration Id). Integration iar archive file has schedules stored as xml file in icspackage/schedule folder which can be copied to prepare override files.

...