Set up the Oracle EBS spoke

Integrate the ServiceNow instance and your Oracle EBS instance using a basic authentication to authenticate the ServiceNow requests.

Before you begin

• Request an Integration Hub subscription.
• Activate the Oracle EBS spoke.
• Admin access to the Oracle EBS account.
• Role required: admin.

Set up for Oracle Database 12C and later versions

Configure Oracle Database 12C and later versions to work with the Oracle E-Business Suite spoke by deploying REST APIs and setting up ServiceNow connections.

Before you begin

Role required: admin

Procedure

1. From the ServiceNow® Store Oracle E-Business Suite Spoke Dependencies for Oracle Database 12c and 18c download the project file, Oracle_e-business_suite spoke_dependencies.zip and save it in the required local folder.

2. Unzip the contents of the Oracle_e-business_suite spoke_dependencies.zip file.

3. In SQL Developer or an SQL client, compile all the PKB and PLS files in the APPS schema.

1. In Oracle EBS server, deploy the Oracle EBS REST API.

   For the steps to enable the REST API per extension, see Deploying REST Web Services.

   You must perform these steps for every PLS file. While deploying each PLS file, you must provide the relevant values. Here, the procedure is outlined using XXSN_CREATE_PO_PKG.pls as an example.

   1. Copy and upload the compiled package .pls files to these respective directories:

      • $PO_TOP/patch/115/sql/tmp/
      • $PO_TOP/patch/115/sql/ Note: Ensure that you replace the $PO_TOP with the module the package belongs to such as, $AP_TOP, $PO_TOP, and so on.

   2. Log in to PuTTY of your Oracle EBS server and execute the Integration Repository Parser.

      1. To generate an iLDT (*.ildt) file, execute the Integration Repository Parser using this syntax:

         $IAS_ORACLE_HOME/perl/bin/perl $FND_TOP/bin/irep_parser.pl -g -v -username=sysadmin po:patch/115/sql:XXSN_CREATE_PO_PKG.pls:12.0=$PO_TOP/patch/115/sql/tmp/XXSN_CREATE_PO_PKG.pls
         

      2. If you aren't generating .ildt file for the XXSN_CREATE_PO_PKG.pls file, replace po and $PO_TOP with required Top.

      3. If you aren't generating .ildt file for the XXSN_CREATE_PO_PKG.pls file, replace XXSN_CREATE_PO_PKG.pls with the required package name.

3.  Upload the generated iLDT file to Integration repository by executing this command:

    ```
    $FND_TOP/bin/FNDLOAD apps/apps 0 Y UPLOAD $FND_TOP/patch/115/import/wfirep.lct XXSN_CREATE_PO_PKG_pls.ildt

    ```

    **Note:** Replace `XXSN_CREATE_PO_PKG_` with the required package name.

4.  Log in to your Oracle E-Business Suite instance as system administrator.

5.  Switch to the **Integrated SOA Gateway** responsibility and select **Integration Repository**.

6.  Search for the web service with the internal name, `XXSN_CREATE_PO_PKG`.

7.  Click the link in the search result to access the list of available metods in the interface package.

    **Note:** In the PL/SQL interface type, both SOAP and REST web services are available. However, this procedure focuses on the REST web service.

8.  Click the **REST Web Service** tab.

    1.  Set an alias for this service. For exmaple, `hr`.
    2.  Click **Deploy**.
9.  View the Create PO method by clicking the **REST Web Service** tab.

10. Enter the unique service alias name, select the **Create PO** method, and click **Deploy**.

    A confirmation message is displayed that the service is successfully deployed.

11. Click **View WADL** to access the physical location of the service endpoint where the service is hosted.

12. Open the **Grants** tab, select **Create PO**, and click **Create Grant**.

    A confirmation message is displayed mentioning that the grant has been successfully created.

    **Note:** To revoke grant, click **Revoke Grants** in the **Grants** tab and select the required users.

14. Perform the above steps for all the required actions and ensure that you use the same names \(associated with the respective action\) as mentioned in the Resource Path column of the following table:

15. Restart the server and using PuTTY, perform these steps up on logging in to the Oracle EBS server.

    1.  Execute the commands: `cd $ADMIN_SCRIPTS_HOME` and `./adadminsrvctl.sh stop`.
    2.  Enter the WebLogic password and EBS password.
    3.  Execute the command, `./adadminsrvctl.sh start`.
    4.  Enter the WebLogic password and EBS password.
    5.  To check the status, execute the command, `./adadminsrvctl.sh status`.

1. Create a credential record for the Oracle EBS spoke.

   1. Navigate to Connections & Credentials > Credentials.

   2. Click New.

      The system displays the message What type of Credentials would you like to create?.

   3. Select Basic Auth Credentials.

   4. On the form, fill these values.

      Field	Description
      Name	Name to uniquely identify the credential record. For example, OEBS Cred.
      User name	User name to log in to the Oracle EBS instance.
      Password	Password to log in to the Oracle EBS instance.
      Active	Option to actively use the credential record.

   5. Click Submit.

2. Create a connection record for the Oracle EBS spoke.

   1. Navigate to Connections & Credentials > Connection & Credential Aliases.

   2. Open the record for the Oracle EBS spoke.

   3. From the Connections tab, click New.

   4. On the form, fill these values.

      Field	Description
      Name	Name to uniquely identify the connection record. For example, OEBS Conn.
      Credential	Credential record you created for the Oracle EBS spoke.
      Connection URL	Connection URL to connect to your Oracle EBS instance.

   5. Click Submit.

Set up for Oracle Database 19C and later versions

Configure Oracle Database 19C and later versions to work with the Oracle E-Business Suite spoke by deploying REST APIs and setting up ServiceNow connections.

Before you begin

Role required: admin

Procedure

1. From the ServiceNow® Store Oracle EBS Spoke Dependencies for Oracle Database 19c or later download the project file, Oracle_e-business_suite spoke_dependencies.zip and save it in the required local folder.

2. Unzip the contents of the Oracle_e-business_suite spoke_dependencies.zip file.

3. In SQL Developer or an SQL client, compile all the PKB and PLS files in the APPS schema.

4. Review the module package reference to identify the correct values for your deployment.

   The following table lists the .pls filename, $TOP variable, product short-code, and service alias required for each Oracle EBS module. Use the values in this table wherever the steps below reference a module-specific path, product code, or alias.

   Module	Package (.pls filename)	$TOP variable	Product code	Service alias
   General Ledger	xxsn_gl_integration_pkg.pls	$GL_TOP	gl	xxsn_gl_integration_pkg
   AP — Supplier	xxsn_supplier_integration_pkg.pls	$AP_TOP	ap	xxsn_supplier_integration_pkg
   Purchasing	xxsn_po_integration_pkg.pls	$PO_TOP	po	xxsn_po_integration_pkg
   Accounts Payable	xxsn_ap_integration_pkg.pls	$AP_TOP	ap	xxsn_ap_integration_pkg
   Fixed Assets	xxsn_fa_integration_pkg.pls	$FA_TOP	fa	xxsn_fa_integration_pkg
   Sourcing	xxsn_pon_integration_pkg.pls	$PON_TOP	pon	xxsn_pon_integration_pkg
   Inventory	xxsn_inv_integration_pkg.pls	$INV_TOP	inv	xxsn_inv_integration_pkg
   Common	xxsn_common_integration_pkg.pls	$FND_TOP	fnd	xxsn_common_integration_pkg
   Receivables	xxsn_ar_integrations_pkg.pls	$AR_TOP	ap	xxsn_ar_integrations_pkg
   Order Management	xxsn_om_integration_pkg.pls	$ONT_TOP	ont	xxsn_om_integration_pkg

5. In Oracle EBS server, deploy the Oracle EBS REST API.

   For the steps to enable the REST API per extension, see Deploying REST Web Services.

   You must perform these steps for every PLS file. While deploying each PLS file, you must provide the relevant values. Here, the procedure is outlined using xxsn_gl_integration_pkg.pls as an example.

   1. Copy and upload the compiled package .pls files to these respective directories:

      • $GL_TOP/patch/115/sql/tmp/
      • $GL_TOP/patch/115/sql/ Note: Ensure that you replace the $GL_TOP with the $TOP variable for the module the package belongs to. For the correct $TOP variable per module, see the module package reference table in the previous step.

2.  Grant `777` permissions to the uploaded `.pls` file.

    In your SFTP client, right-click the `.pls` file, click **Properties**, and set the **Octal** permission value to `0777`.

    **Note:** 777 permissions are required for the Integration Repository parser to process the file. Without this step, the command in the next substep fails.

3.  Log in to PuTTY of your Oracle EBS server and execute the Integration Repository Parser.

    1.  To generate an iLDT \(\*.ildt\) file, execute the Integration Repository Parser using this syntax:

        ```
        $IAS_ORACLE_HOME/perl/bin/perl $FND_TOP/bin/irep_parser.pl -g -v -username=sysadmin gl:patch/115/sql:xxsn_gl_integration_pkg.pls:12.0=$GL_TOP/patch/115/sql/xxsn_gl_integration_pkg.pls

        ```

    2.  If you aren't generating the .ildt file for the `xxsn_gl_integration_pkg.pls` file, replace `gl` and `$GL_TOP` with the product code and `$TOP` variable for the required module. For the correct values per module, see the module package reference table in the previous step.
    3.  If you aren't generating the .ildt file for the `xxsn_gl_integration_pkg.pls` file, replace `xxsn_gl_integration_pkg.pls` with the required package name.

4.  Upload the generated iLDT file to Integration repository by executing this command:

    ```
    $FND_TOP/bin/FNDLOAD apps/apps 0 Y UPLOAD $FND_TOP/patch/115/import/wfirep.lct xxsn_gl_integration_pkg_pls.ildt

    ```

    **Note:** Replace `xxsn_gl_integration_pkg_` with the required package name.

5.  Log in to your Oracle E-Business Suite instance as system administrator.

6.  Switch to the **Integrated SOA Gateway** responsibility and select **Integration Repository**.

7.  Search for the web service with the internal name, `xxsn_gl_integration_pkg`.

8.  Click the link in the search result to access the list of available methods in the interface package.

    **Note:** In the PL/SQL interface type, both SOAP and REST web services are available. However, this procedure focuses on the REST web service.

9.  Click the **REST Web Service** tab.

    1.  In the **Service Alias** field, enter the service alias for your module. For the correct alias value per module, see the module package reference table in the previous step.

        **Note:** The service alias must exactly match the value in the **Service Alias** column of the module package reference table. Aliases are case-sensitive.

    2.  Click **Deploy**.
10. View the General Ledger Integration service method by clicking the **REST Web Service** tab.

11. Enter the unique service alias name, select the required method, and click **Deploy**.

    A confirmation message is displayed that the service is successfully deployed.

12. Click **View WADL** to access the physical location of the service endpoint where the service is hosted.

13. Open the **Grants** tab, select the required method, and click **Create Grant**.

14. Select a grantee type, enter the user name to whom you want to give the grant access to use the web service, and click **Create Grant**.

    A confirmation message is displayed mentioning that the grant has been successfully created.

    **Note:** To revoke grant, click **Revoke Grants** in the **Grants** tab and select the required users.

15. Perform the above steps for all the required actions and ensure that you use the same names \(associated with the respective action\) as mentioned in the Resource Path column of the following table:

16. Restart the server and using PuTTY, perform these steps up on logging in to the Oracle EBS server.

    1.  Execute the commands: `cd $ADMIN_SCRIPTS_HOME` and `./adadminsrvctl.sh stop`.
    2.  Enter the WebLogic password and EBS password.
    3.  Execute the command, `./adadminsrvctl.sh start`.
    4.  Enter the WebLogic password and EBS password.
    5.  To check the status, execute the command, `./adadminsrvctl.sh status`.

1. Create a credential record for the Oracle EBS spoke.

   1. Navigate to Connections & Credentials > Credentials.

   2. Click New.

      The system displays the message What type of Credentials would you like to create?.

   3. Select Basic Auth Credentials.

   4. On the form, fill these values.

      Field	Description
      Name	Name to uniquely identify the credential record. For example, OEBS Cred.
      User name	User name to log in to the Oracle EBS instance.
      Password	Password to log in to the Oracle EBS instance.
      Active	Option to actively use the credential record.

   5. Click Submit.

2. Create a connection record for the Oracle EBS spoke.

   1. Navigate to Connections & Credentials > Connection & Credential Aliases.

   2. Open the record for the Oracle EBS spoke.

   3. From the Connections tab, click New.

   4. On the form, fill these values.

      Field	Description
      Name	Name to uniquely identify the connection record. For example, OEBS Conn.
      Credential	Credential record you created for the Oracle EBS spoke.
      Connection URL	Connection URL to connect to your Oracle EBS instance.

   5. Click Submit.