Skip Headers

Oracle iSetup Developer's Guide
Release 12.1
Part Number E15842-01
Go to Table of Contents
Contents
Go to previous page
Previous
Go to next page
Next

Oracle iSetup Framework Interface Registration

Oracle iSetup Framework Interface Registration

This chapter explains how to register an Oracle iSetup Framework (BC4J) API through iSetup Interface Repository and create an Extract for the registered API. The API registration process is explained with an example using SYSADMIN as the user and the API "Currency". Please note that Currency is an Oracle iSetup framework (BC4J) API which is available as a part of Oracle E-Business Suite. You can find the class files for the Currency API under

$JAVA_TOP/oracle/apps/gl/ispeed/currency/server 

Security Setup for Registering the Oracle iSetup Framework (BC4J) API

Follow these instructions for the security setup of the API.

For more information on managing security, see the manual Oracle E-Business Suite System Administrator's Guide - Security.

To assign the iSetup Super User Role to a User

  1. Log in to Oracle E-Business Suite as a system administrator with the User Management responsibility and the Functional Administrator responsibility.

  2. Go to the User Management responsibility > User.

  3. Search for the username SYSADMIN and click Update.

    the picture is described in the document text

  4. Assign the role to the user. Click on Assign Roles. In the LOV search window, search for iSetup Super User and select it.

    the picture is described in the document text

  5. Provide a justification to add the role and click Apply. Return to the main menu.

    the picture is described in the document text

To Create a Function

  1. Navigate to Functional Administrator.

  2. Navigate to Home > Core Services > Functions > Create Function.

    the picture is described in the document text

  3. Enter the following details:

    the picture is described in the document text

  4. Click Continue.

  5. Add a dummy character in the HTML Call field.

    the picture is described in the document text

  6. Click Submit.

    the picture is described in the document text

    After creating the function, you can add it to a menu. You can directly proceed to that task by clicking on Menu in the subtab.

To Create a Menu

  1. Click on Create Navigation Menu.

    the picture is described in the document text

  2. Enter the following details.

    Click Add Another Row. Add the following:

    Click Apply.

    the picture is described in the document text

To Create a Grant

  1. Navigate to Home > User Management > Role & Role Inheritance.

  2. Search for the iSetup Super User role.

    the picture is described in the document text

  3. Click the Update icon.

    the picture is described in the document text

  4. Click Create Grant.

  5. Enter the following:

    the picture is described in the document text

  6. Click Next.

  7. Add the Menu name to the Set field.

    Set: BC4JREGMENU

    the picture is described in the document text

  8. Click Next.

  9. Click Finish.

    the picture is described in the document text

Registering the iSetup Framework (BC4J) API

To register the interface

The following are descriptions of the fields used in registering an interface.

Details:

The steps to register an interface are:

  1. Navigate to Home > iSetup > Administration.

  2. Click Administration.

    the picture is described in the document text

  3. Navigate to Interface Repository.

    the picture is described in the document text

  4. Click on Create and fill in the following details:

    Click Supports Filter, Commit If Warning, Supports Update, Override Update (Depending on what the API can do).

    Note: The actual file 'CurrSetupAM' should be physically present under $JAVA_TOP in path the oracle.apps.gl.ispeed.currency.server in the instance where the API is registered. The reason for this requirement is that when the API is registered, the system does not validate that the given file physically exists in the path; however, during extraction the system will try to instantiate the file ('CurrSetupAM' in this case) and if the file is not found, the system will return an error.

    the picture is described in the document text

  5. Click Apply.

To Create a Custom Selection Set

  1. Navigate to Migration > Selection Set.

    the picture is described in the document text

  2. Click on Create Custom and enter the following details:

    the picture is described in the document text

  3. Click on Apply. The Selection Set is created successfully.

    the picture is described in the document text

To Create an Extract

  1. Navigate to iSetup > Migrations > Selection Set. Search for iSetup Custom API Demo, select it, and click on Extract.

    the picture is described in the document text

  2. Click on Continue and Finish.

    the picture is described in the document text

  3. Search for iSetup Custom Extract and click on the iSetup Custom Extract link.

    the picture is described in the document text

  4. Wait for the Phase to be marked as Completed. Click on the Refresh button to confirm that it is Completed.

    Note: You need to follow the same steps and register the API on the Central Instance and the Target Instance.

    the picture is described in the document text