Manage Integrations

These are the steps you'll need to use to import and export Integration artifacts via build jobs in VB Studio:

Step	Description	See this topic
Configure a build job to export Integration artifacts from an Oracle Integration instance.	Creates and executes a job to Export an Integration archive (IAR file) from a source Oracle Integration instance and store it in a VB Studio repository. Allow export integrations with asserter recordings. Oracle's asserter testing framework is used to record tests of integration instances and replay them to reproduce potential issues. See Test Integration Instances for more information.	Configure a Job to Export an Integration
Configure a build job to import Integration artifacts to an Oracle Integration instance.	Creates and executes a job to: Reference a previously exported Integration archive (IAR file) and import it to another Oracle Integration instance. Optionally, activate the Integration, after which you can also contribute integration mappings to Oracle Recommends, enable asserter recordings, and enable tracing. If you enable tracing, you can also include the payload. Optionally, include asserter recordings, if there are any.	Configure a Job to Import an Integration
Configure a standalone build job to activate a new integration or reactivate an existing one on the target instance after importing artifacts.	Creates and executes a job to:	Configure a Job to Activate an Integration
Optional: Configure a build job to delete an Integration artifact that's no longer needed or one that causes a conflict.	Creates and executes a job to delete an Integration archive (IAR file) that exists on a particular Oracle Integration instance.	Configure a Job to Delete an Integration

Configure a Job to Export an Integration

You can create and execute a job that exports an Integration archive (IAR file) from a source Oracle Integration instance and stores it. You'll need to copy the artifact (IAR) from your export job into your import build job. Optionally, you can set up the job to add recordings to the exported artifact.

To configure a build job that exports an Integration artifact from an Oracle Integration instance:

1. In the left navigator, click Builds .
2. In the Jobs tab, click + Create Job.
3. In the New Job dialog box, in Name, enter a unique name.
4. In Description, enter the job's description.
5. In Template, select the System Default OL7 for Visual Builder template.
6. Click Create.

   The job configuration page is displayed.

7. Click the Steps tab.
8. From Add Step, select Oracle Integration, and then select Export Integration.
9. In Export from Source Instance , select the Oracle Integration instance from which you’ll be performing the export operation.
10. In Username and Password, provide credentials for a user who has permissions to perform Oracle Integration operations.
11. In Identifier, provide the identifier for the integration as defined in the Oracle Integration service instance.

    You can also click Search and open the Search Integrations window. In it you can specify the credentials (username/password) and get a list of integrations in your instance, or narrow your search by entering a prefix in the Search field. For example, if you enter "COUNTRYINFO", a list of Integrations that contain "COUNTRYINFO" will be displayed.

12. In Version, provide the version for the integration as defined in the Oracle Integration service instance.

    If you selected an integration by using the Search Integrations dialog, the Version and Identifier information will be filled in automatically.

    Tip:

    Alternatively, you could specify a parameter, such as $version, here which, when combined with the example identifier in the previous step, would result in an output filename of COUNTRYINFO_${version}.iar. You'll need to copy the generated filename or enter COUNTRYINFO_${version}.iar when you import the Integration archive.

    See Use Build Parameters for information about adding build parameters.

13. (Optional) The Include asserter recordings in exported file checkbox isn't selected by default. If you want to include recordings in the archive, select it.
14. Select the After Build tab and add Artifact Archiver as an After Build Action.
15. In Files to archive, ensure that the IAR file in the Export Integration build step's Archive filename is shown.
16. Click Save.

Configure a Job to Import an Integration

You can create and execute a job that references a previously exported Integration archive (IAR file) and import it to another Oracle Integration instance. Optionally, you can set up the job to activate the Integration after importing it.

To configure a build job that imports a previously exported Integration artifact from an Oracle Integration instance:

1. In the left navigator, click Builds .
2. In the Jobs tab, click + Create Job.
3. In the New Job dialog box, in Name, enter a unique name.
4. In Description, enter the job's description.
5. In Template, select the System Default OL7 for Visual Builder template.
6. Click Create.

   The job configuration page is displayed.

7. From the Before Build tab select Before Build Action and then select Copy Artifacts.
   1. In From job, enter the previous Integration Export job you want to import.
   2. In Which build, select Last successful build.
8. Click the Steps tab.
9. From Add Step, select Oracle Integration, and then select Import Integration.
10. In Import to Target Instance , select the environment that points to the Oracle Integration instance to which the archive will be imported.
11. In Username and Password, provide credentials for a user who has permissions to perform Oracle Integration operations.
12. In Import Archive Filename, enter the name and version number of the archive file (with .iar extension) that contains the integration to import.

    You could enter the name of the same file that was created in the export. Or, if you specified the identifier, such as COUNTRYINFO, and used a parameter, such as $version, for the version to generate the COUNTRYINFO_${version}.iar output filename in the export operation, you'd enter the identifier and ${version} for the version here, as in COUNTRYINFO_${version}.iar. You could also copy and use the generated archive name from the import operation.

    See Use Build Parameters for information about adding build parameters.

13. In the Import Method section:
    • Select the Add checkbox to import an integration with a new ID/version.
    • Select the Replace checkbox to import a previously imported integration.
    • Select the Automatic checkbox to either add or replace, depending on whether this integration already exists in the target instance.
14. If you chose Replace or Automatic in the previous step, in the Deactivation section select the Deactivate existing integration when replacing it checkbox to deactivate the current integration on the target instance before replacing it.
    If the integration to be replaced has been activated, the import will fail unless you choose this option.
15. (Optional) In the Activation section, check the Activate new integration on the target instance after importing checkbox to activate the imported integration in the Oracle Integration service instance.

    If you select Activate new integration on the target instance after importing, you can optionally contribute integration mappings to Oracle Recommends, enable asserter recording, and enable tracing. If Enable tracing is selected, you also select the Include payload option.

16. (Optional) In the Recordings section, the Include asserter recordings (if any) checkbox is selected by default. Leave it selected to import any recordings that were written to the exported Integration archive. To ignore the exported recordings, deselect the checkbox.
17. Click Save.

Configure a Job to Activate an Integration

You might want to configure a standalone build job to deactivate and reactivate an OIC Integration. You might want to add this step after performing an Update Connection step to configure connection endpoints and credentials after importing an integration. The modified integration needs to be activated (or reactivated) after the connections(s) have been configured.

1. Builds .
2. In the Jobs tab, click + Create Job.
3. In the New Job dialog box, in Name, enter a unique name.
4. In Description, enter the job's description.
5. In Template, select the System Default OL7 for Visual Builder template.
6. Click Create.

   The job configuration page is displayed.

7. Click the Steps tab.
8. From Add Step, select Oracle Integration, and then select Activate Integration.
9. In Target Instance , select the environment that points to the Oracle Integration instance with the Integration artifact(s) you want to deactivate and activate.
10. In Username and Password, provide credentials for a user with the Oracle Integration role to perform Oracle Integration operations.
11. In Identifier, provide the identifier for the integration as defined in the Oracle Integration service instance.

    You can also click Search and open the Search Integrations window. In it you can specify the credentials (username/password) and get a list of integrations in your instance, or narrow your search by entering a prefix in the Search field. For example, if you enter "Hello", a list of Integrations that contain "Hello" will be displayed.

    If you selected an integration by using the Search Integrations dialog, the Version and Identifier information will be filled in automatically.

12. In Version, provide the version for the integration as defined in the Oracle Integration service instance.
13. In the Deactivation section, select the Deactivate then activate integration checkbox to deactivate the current integration on the target instance before activating it.

    Note:

    If the integration has already been activated, the activation will fail unless you choose this option.

    If you select Deactivate then activate integration on the target instance after importing, you can optionally contribute integration mappings to Oracle Recommends.

14. In the Oracle Asserter section, select the Enable asserter recording checkbox to allow Oracle's asserter testing framework to test the integration instance and records it, so you can replay it to reproduce any potential issues.
15. In the Tracing section, select the Enable tracing checkbox to display tracing Integration activity in the Oracle Integration Activity Stream.
16. Click Save.

Configure a Job to Delete an Integration

You might want to configure a build job to delete Integration artifacts from an Oracle Integration instance, especially when an existing artifact could cause a conflict.

To configure a build job that deletes Integration artifacts from an Oracle Integration instance:

1. In the left navigator, click Builds .
2. In the Jobs tab, click + Create Job.
3. In the New Job dialog box, in Name, enter a unique name.
4. In Description, enter the job's description.
5. In Template, select the System Default OL7 for Visual Builder template.
6. Click Create.

   The job configuration page is displayed.

7. Click the Steps tab.
8. From Add Step, select Oracle Integration, and then select Delete Integration.
9. In Delete from Target Instance , select the environment that points to the Oracle Integration instance from which you want the Integration artifact(s) removed.
10. In Username and Password, provide credentials for a user with the Oracle Integration role to perform Oracle Integration operations.
11. In Identifier, provide the identifier for the integration as defined in the Oracle Integration service instance.

    You can also click Search and open the Search Integrations window. In it you can specify the credentials (username/password) and get a list of integrations in your instance, or narrow your search by entering a prefix in the Search field. For example, if you enter "Hello", a list of Integrations that contain "Hello" will be displayed.

    If you selected an integration by using the Search Integrations dialog, the Version and Identifier information will be filled in automatically.

12. In Version, provide the version for the integration as defined in the Oracle Integration service instance.
13. Click Save.