1. Using Visual Builder Studio
  2. Common Tasks
  3. Build Your Applications
  4. Configure and Run Project Jobs and Builds
  5. Configure a Job
  6. Move Oracle Integration Projects, Artifacts, Packages, and Lookups Between Instances
  7. Manage Integration Lookups

Manage Integration Lookups

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

Step Description See this topic
Configure a build job to export Integration lookups from an Oracle Integration instance. Creates and executes a job to
  • Export an OIC lookup from a source Oracle Integration instance and store it in a VB Studio repository.
  • In the source Integration instance, identify the name of the lookup you want to export.
  • See the archive that contains the exported lookup.
 Configure a Job to Export an Integration Lookup
Configure a job (or build step) to import an Oracle Integration lookup to a target Oracle Integration instance. Creates and executes a job to:
  • Reference a previously exported archive containing the Oracle Integration lookup to import.
  • Choose how to import the lookup: import with a new name, replace a previously imported lookup, or automatically add or replace the lookup, depending on whether it already exists on the target instance.
Configure a Job to Import an Integration Lookup
Optional: Configure a job (or build step) to delete an Integration lookup that's no longer needed or one that causes a conflict. Creates and executes a job to delete an OIC lookup on a particular Oracle Integration instance. Configure a Job to Delete an Integration Lookup

Configure a Job to Export an Integration Lookup

You can create and use a build step to export an Integration lookup and use an After Build step to archive the exported file(s) to Object Storage. Later, you can import the archive containing the exported lookup(s) to a different target 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 Export Lookup.
  9. In Source Instance , select the environment that points to the Oracle Integration instance from which you want to export the lookup(s).
  10. In the Authorization section, select Use OAuth (or Use Basic) to specify the type of authorization used to run this build step. OAuth is the only authentication method supported for Oracle Integration 3 instances.

    • If you selected Use OAuth, the Authorization is required message indicates that this build step needs to be authorized. Click Authorize and provide the credentials of a user who has permissions to perform Oracle Integration operations; you can also run the job manually and enter the credentials when prompted. Once authorized, the Authorization has been provided message displays.

      If the OAuth token used to authorize the connection expires during extended periods of inactivity (say, when you're away on vacation), you can click Renew Authorization to renew the token (or you can run the job manually, so you're prompted to authorize any expired OAuth tokens).

    • If you selected Use Basic, in Username and Password, provide the credentials of a user who has permissions to perform Oracle Integration operations.
  11. In Lookup Name, enter or search for the name of the lookup you want to export from the source Oracle Integration instance.

    To search for the lookup name, click Search. The Search Lookups dialog is displayed. Press Enter in the Search field to see the list of all lookups on your target instance (if you used Basic authentication, you'll need to specify credentials to see this list). Select the lookup from the list. Instead of selecting the lookup from a list, you can type in a lookup name for the specific lookup, typing in either the full name, or part of it, then selecting it from the narrowed list of choices. The drop-down list initially shows all the instance's lookups available to you.

    The Archive Filename shows the archive file that'll contain the exported lookup(s). Copy the filename (DivisionLookup.csv , for example). You'll use it in the next step.

  12. In the After Build tab, click Add After Build Action and select Artifact Archiver.
  13. Paste the filename you copied in step 11 into the Files to archive field.
  14. Click Save.

Configure a Job to Import an Integration Lookup

You can create and use a build step to import an Integration lookup exported from another 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. In the Before Build tab, click Add Before Build Action , and select Copy Artifacts.
  8. In the From job field, select your Import Lookup build job or enter its name.
  9. Click the Steps tab.
  10. From Add Step, select Oracle Integration, and then select Import Lookup.
  11. In Target Instance , select the environment that points to the Oracle Integration instance into which you want to import the lookup(s).
  12. In the Authorization section, select Use OAuth (or Use Basic) to specify the type of authorization used to run this build step. OAuth is the only authentication method supported for Oracle Integration 3 instances.

    • If you selected Use OAuth, the Authorization is required message indicates that this build step needs to be authorized. Click Authorize and provide the credentials of a user who has permissions to perform Oracle Integration operations; you can also run the job manually and enter the credentials when prompted. Once authorized, the Authorization has been provided message displays.

      If the OAuth token used to authorize the connection expires during extended periods of inactivity (say, when you're away on vacation), you can click Renew Authorization to renew the token (or you can run the job manually, so you're prompted to authorize any expired OAuth tokens).

    • If you selected Use Basic, in Username and Password, provide the credentials of a user who has permissions to perform Oracle Integration operations.
  13. In Import Archive Filename, enter the name of the archive file (with .csv extension) containing the lookup to import.
  14. In Import method, select how to import the lookup:
    • Choose Add to import a lookup with a new name.
    • Choose Replace to import a previously imported lookup.
    • Choose Automatic to either add or replace the lookup, depending on whether it already exists on the target instance.
  15. Click Save.

Configure a Job to Delete an Integration Lookup

You can create and use a build step to delete an Integration lookup from an Oracle Integration instance.

To configure a build job that deletes an Integration lookup 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 Lookup.
  9. In Target Instance , select the environment that points to the Oracle Integration instance from which you want to remove the lookup(s).
  10. In the Authorization section, select Use OAuth (or Use Basic) to specify the type of authorization used to run this build step. OAuth is the only authentication method supported for Oracle Integration 3 instances.

    • If you selected Use OAuth, the Authorization is required message indicates that this build step needs to be authorized. Click Authorize and provide the credentials of a user who has permissions to perform Oracle Integration operations; you can also run the job manually and enter the credentials when prompted. Once authorized, the Authorization has been provided message displays.

      If the OAuth token used to authorize the connection expires during extended periods of inactivity (say, when you're away on vacation), you can click Renew Authorization to renew the token (or you can run the job manually, so you're prompted to authorize any expired OAuth tokens).

    • If you selected Use Basic, in Username and Password, provide the credentials of a user who has permissions to perform Oracle Integration operations.
  11. In Lookup Name, enter or search for the name of the lookup you want to delete from the target Oracle Integration instance.

    To search for the lookup name, click Search. The Search Lookups dialog is displayed. Press Enter in the Search field to see the list of all lookups on your target instance (if you used Basic authentication, you'll need to specify credentials to see this list). Select the lookup from the list. Instead of selecting the lookup from a list, you can type in a lookup name for the specific lookup, typing in either the full name, or part of it, then selecting it from the narrowed list of choices. The drop-down list initially shows all the instance's lookups available to you.

  12. Click Save.