Manage Oracle Integration Packages

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

Step Description See this topic
Configure a build job to export a package of Integration artifacts from an Oracle Integration instance. Creates and executes a job to
  • Export a package (PAR file) of integrations from a source Oracle Integration instance and store it in a VB Studio repository.
  • Allow exported packages with integrations that have asserter recordings.
Configure a Job to Export an Integration Package
Configure a build job to import a package of Integration artifacts to an Oracle Integration instance. Creates and executes a job to:
  • Reference a previously exported package (PAR file) of integrations and import it to another Oracle Integration instance.
  • Choose an import method (add a new package; replace an existing package; or automatically add or replace the package, depending on whether it already exists on the target instance or not).
  • Deactivate any current integrations on the target instance before importing and reactivate after the import.
  • Include asserter recordings, if any were exported.
Configure a Job to Import an Oracle Integration Package
Optional: Configure a build job to delete a package of Integration artifacts that's no longer needed. Creates and executes a job to delete a package (PAR file) of integrations on a particular Oracle Integration instance. By default, these integrations will be automatically deactivated before they are deleted. Configure a Job to Delete an Integration Package

Configure a Job to Export an Integration Package

You can create and execute a job that exports an Integration package (PAR file) of integrations from a source Oracle Integration instance and stores it in a VB Studio repository. Optionally, you can set up the job so the export operation adds artifacts with asserter recordings to the artifact.

To configure a build job that exports an Integration package from an Oracle Integration instance:
  1. In the left navigator, click Builds 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. Optionally, click the Parameters tab and define any parameters, like $Username (using a string parameter) and $Password (using a password parameter), for example, that you'll use in this build step.
  8. Click the Steps tab.
  9. From Add Step, select Oracle Integration, and then select Export Package.
  10. In Export from Source Instance , select the Oracle Integration instance from which you’ll be performing the export operation.
  11. In Username and Password, provide credentials for a user who has permissions to perform Oracle Integration operations.
    If you defined parameters for these fields, enter the parameter names here, such as $Username and $Password. You'll be prompted to supply their values when the build runs.
  12. In Package Name, provide the name for the package as defined in the Oracle Integration service instance.

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

  13. (Optional) Select the Include asserter recordings in exported file checkbox if you want to include integrations with asserter recordings in the package.
  14. Click Copy the Copy icon to copy the PAR file name, You'll use it in other steps.
  15. Select the After Build tab and add Artifact Archiver as an After Build Action.
  16. In Files to archive, paste the PAR file in the Export Package build step's Archive filename.
  17. Click Save.

Configure a Job to Import an Oracle Integration Package

You can create and execute a job that references a previously exported Integration package (PAR file) and import it to another Oracle Integration instance. Optionally, you can set up the job to include integrations with asserter recordings, if any were written to the exported package.

To configure a build job that imports a previously exported package from an Oracle Integration instance:
  1. In the left navigator, click Builds 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 Package 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 Package.
  10. In Import to Target Instance , select the environment that points to the Oracle Integration instance to which the package 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 of the file (with .par extension) that contains the package of integrations to import.

    You could enter the name of the archive file that was created in the export package job or the name of a previously exported archive.

  13. In the Import Method section, select one of the following:
    • Choose Add to import a package with a new name.
    • Choose Replace to import a previously imported package.
    • Choose Automatic to either add or replace the package, depending on whether it already exists on the target instance.
  14. If you've chosen Replace or Automatic in the previous step, select the Deactivate existing integrations when replacing the package checkbox in the Deactivate section to deactivate any current integrations on the target instance before replacing the package.

    Note:

    If any integration to be replaced has been activated, the import will fail unless you choose this option.
  15. After replacing the package on the target instance, select the Reactivate existing integrations after replacing the package checkbox in the Reactivate section to reactivate any integrations that were deactivated for the import.
  16. (Optional) Include asserter recordings, if any were written to the exported package.
    Oracle's asserter testing framework tests integration instances and records them, which you can replay to reproduce any potential issues.
  17. Click Save.

Configure a Job to Delete an Integration Package

You might want to configure a build job to delete an Integration package from an Oracle Integration instance. This action will delete the package and all integrations included in that package.

To configure a build job that deletes an Integration package (or packages) from an Oracle Integration instance:
  1. In the left navigator, click Builds 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 Package.
  9. In Delete from Target Instance , select the environment that points to the Oracle Integration instance from which you want the package removed.
  10. In Username and Password, provide credentials for a user with the Oracle Integration role to perform Oracle Integration operations.
  11. In Package Name, enter the name for the package as defined in the Oracle Integration service instance. If you copied the PAR file name in the Export Package build step, you can paste that name here, but you'll need to remove the .par file extension.

    You can also click Search Search icon and open the Search Packages window. In it you can specify the credentials (username/password) and get a list of packages 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 a package by using the Search Packages dialog, the Package Name will be filled in automatically.

  12. Optionally, in Deactivation, select the Automatically deactivate integrations in the package checkbox.
    You won't be able to delete the package if any integrations in it are active.
  13. Click Save.