updateIntegrations
- Karl Henselin
Updates (activate/deactivate) multiple integration(s) on the OIC server. This operation is useful to activate or deactivate many integrations in a non-deployment scenario. In addition, this operation is REST API based, therefore, will work with localhost endpoints.
During the importIntegration and packageDeploy operations activate is automatically applied, so this is not needed in those two scenarios.
Either FDOIC_CLOUD_ACCOUNT_CODE Target property value or FDOIC_INP_CLOUD_ACCOUNT_CODE plugin input value should exist. When both exist, the plugin input value will take precedence. See Creating/Editing a Cloud Account and Provider for details on how to setup a Cloud Account for OIC.
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 connecting to an OIC Instance. |
Project Properties
Property Name | Property Code | Required | Description |
|---|---|---|---|
Integration Identifier |
| Yes | The identifier (code) of the integration being activated. This may not be the same as the name of the integration. |
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 connecting to an OIC Instance. Typically, this will not be used because the value will come from the property FDOIC_CLOUD_ACCOUNT_CODE instead. |
OIC JSON File Path |
| Yes | JSON File containing zero or more integration objects keyed by integration identifier. |
Stop on Error |
| No | Stop updating(activating/deactivating) integrations, if any error occurs. If false or not specified, updating of other integrations will continue. |
Artifacts
This operation doesn’t consume or produce any artifacts.
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.
Special Considerations
OIC JSON File
FlexDeploy is expecting a JSON file containing data pointing to which integrations to activate or deactivate. The content in the file must comply with JSON Object rules and contain the integrations JSON array. Within the array, each object must have the identifier and status keys at a minimum. If the version is omitted, then FlexDeploy will find the latest version for the given integration identifier. All other keys in each object are optional such as version, oracleRecommendsFlag, stopScheduleForDeactivation, etc... For a full list of optional fields please see the Oracle REST API documentation.
IMPORTANT NOTE
Each object under the integrations JSON array is sent verbatim to the oracle cloud REST API, except for deleteEventSubscriptionFlag, enableAsyncActivationMode, oracleRecommendsFlag. These 3 fields will be removed from the object and added as query parameters of the API request instead. Again please see the Oracle REST API documentation for further clarification.
Example of JSON file deactivating two integrations:
{
"integrations" :
[
{
"identifier" : "HELLO_WORLD",
"version" : "01.02.0000",
"status" : "CONFIGURED",
"stopScheduleForDeactivation" : "true"
},
{
"identifier" : "CONCATMESSAGES",
"version" : "01.00.0001",
"status" : "CONFIGURED",
"stopScheduleForDeactivation" : "true"
}
]
}Example of JSON file activating two integrations:
{
"integrations" :
[
{
"identifier" : "HELLO_WORLD",
"status" : "ACTIVATED",
"oracleRecommendsFlag" : "true",
"enableAsyncActivationMode" : "true"
},
{
"identifier" : "CONCATMESSAGES",
"version" : "01.00.0001",
"status" : "ACTIVATED",
"oracleRecommendsFlag" : "true",
"enableAsyncActivationMode" : "true"
}
]
}- style