importIntegration
- Copy Page Tree
- Joel Wenzel
- Dan Reynebeau
Imports an integration as a .iar artifact into the Oracle Integration Cloud. The operation will activate the newly deployed integration after deployment is finished. Any connections will also be imported. They will be processed by the updateConnections operation as part of this operation, so it isn't necessary to have additional steps in your workflow. Lookups included in the integration export will also be imported.
Either FDOIC_CLOUD_ACCOUNT_CODE environment instance 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.
Environment/Instance 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. |
Project Properties
Property Name | Property Code | Required | Description |
|---|---|---|---|
Integration Identifier | FDOIC_INTEGRATION_IDENTIFIER | Yes | The identifier (code) of the integration being deployed |
| Overwrite Integrations | FDOIC_REPLACE_INTEGRATION | No | Overwrite integrations with the same name and version when importing. Note that if you modify the |
Cloud Account Properties
Property Name | Property Code | Required | Description |
|---|---|---|---|
OIC User | FDOICACCT_USERNAME | Yes | Username for the registered OIC account |
OIC Password | FDOICACCT_PASSWORD | Yes | Password for the registered OIC account |
OIC Base URI | FDOICACCT_BASE_URI | Yes | The REST Base URI of a running OIC Instance |
OIC Identity Base URI | FDOICACCT_IDENTITY_BASE_URI | No | The Oracle Identity Cloud Service URL (IDCS). E.G. https://idcs-1a2bc3de.identity.oraclecloud.com. Only required when using OAuth. For more information on configuring OAuth see here. |
OIC Client Id | FDOICACCT_CLIENT_ID | No | The Oracle Identity Client Id. Only required when using OAuth. For more information on configuring OAuth see here. |
OIC Client Secret | FDOICACCT_CLIENT_SECRET | No | The Oracle Identity Client Secret. Only required when using OAuth. For more information on configuring OAuth see here. |
OIC Client Scope | FDOICACCT_CLIENT_SCOPE | No | The Oracle Identity Client Scope. Only required when using OAuth. For more information on configuring OAuth see here. |
Inputs
| Input Name | Input Code | Required | Description |
|---|---|---|---|
| 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. |
| 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. | |
| Enable Tracing | FDOIC_INP_ENABLE_TRACING | No | When tracing is enabled, integration activity can be viewed in the Activity Stream. Will only apply if instance is also being activated |
| Enable Payload Tracing | FDOIC_INP_ENABLE_PAYLOAD_TRACING | No | Should the payload be traced. Will only apply if instance is also being activated |
Send to Oracle Recommends | FDOIC_INP_SEND_TO_ORACLE_RECOMMENDS | No | Contribute integration mappings to Oracle Recommends. Will only apply if instance is also being activated |
Artifacts
This operation consumes artifacts from the artifacts repository.
Endpoint Selection
This operation will select all available endpoints associated to the environment/instance.
Endpoint Execution
This operation will execute on any one of the selected endpoints and will be random in the determination of which one.
Special Considerations
Retrying
- If any connection the integration uses is locked, the plugin will retry up to 10 times with 30 seconds of quiet time in between attempts. If after 10 attempts it is still unable to update the connection then an error will be thrown. This is a common case when multiple integrations are deploying at the same time that share the connection.
- @since 5.4.0.1 The entire import operation will be retried up to 5 times with a 30 second delay. These retries are independent of the connection retries mentioned above.
- style