Running a Submit Request

In this section:

How to:

iWay Application Adapter for Oracle E-Business Suite supports running what was formerly known as the Oracle Applications concurrent program function using the adapter concurrent programs agent. Currently, this function is called the Submit Request.

The Submit Request submits a request that runs a concurrent program. Concurrent programs perform several functions, including moving data. For example, if you wish to move data to a base table:

  1. First, write the data to an interface table.

    Each interface table has a Submit Request associated with it.

  2. When the data is ready, run a Submit Request.

    The Submit Request moves the data from the interface table to the base table.

The Submit Request can call a concurrent program synchronously or asynchronously. It submits the concurrent program to a concurrent manager that controls background processing in Oracle E-Business Suite.


Top of page

x
Procedure: How to Run the Submit Request

To run the Submit Request:

  1. Use iWay Explorer to generate a pair of request and response schemas for the Submit Request, as described in Generating a Schema for the Submit Request.

    You do this only once for a Submit Request. This covers all Submit Requests to be run from a given Oracle E-Business Suite connection.

  2. Add a service for the Submit Request, as described in Generating a Web Service for the Submit Request.

    You do this only once for a Submit Request. This covers all Submit Requests to be run from one Oracle E-Business Suite connection.

  3. Create and test the request document, as described in Creating a Request Document.

Top of page

x
Installing the Submit Request and Running the Concurrent.ora Script

To install the Submit Request, you must perform the following additional steps when installing the adapter:

  1. Extract the Concurrent.ora script from the ibspsql.zip archive, which is located in the following directory:
    <iway_home>\etc\setup
  2. Run the Concurrent.ora script against the Oracle database server using SQL*PLUS.

    Note: Contact Information Builders Customer Support Services to obtain the Concurrent.ora script.

    Note: As part of the installation process, you must run the Concurrent.ora script. You can run it at any time before creating the service for the Submit Request. For information on how to run the Concurrent.ora script, see How to Run the Concurrent.ora Script.

  3. Adjust the system path on the Oracle database server.
  4. Verify the presence of the CONCSUB executable on the Oracle database server.

As part of the installation process, you must run the Concurrent.ora script. You can run it at any time before creating the service for the Submit Request. The computer on which you run the script must have:



x
Procedure: How to Run the Concurrent.ora Script

To run the Concurrent.ora script:

  1. Extract Concurrent.ora using WinZip or a similar extraction product.

    You can also use the iWay package facility to install the Oracle Applications package, which contains the script file. For more information, see the iWay Service Manager User's Guide.

  2. After the Concurrent.ora script is extracted, move it to the computer where SQL*Plus resides, if it is not already located there.
  3. Edit the Concurrent.ora script as follows:

    For Windows Platforms Only:

    In the CREATE OR REPLACE AND RESOLVE JAVA SOURCE NAMED IwayConc... section, the path to the cmd.exe file must be set correctly at finalCommand[0]. For example:

    finalCommand[0] = "C:\\WINDOWS\\system32\\cmd.exe";

    For Windows and UNIX Platforms:

    In the CREATE OR REPLACE AND RESOLVE JAVA SOURCE NAMED IwayConc... section, the path to the ConcSub.exe file must be appended before concCommand at finalCommand[3]. For example:

    finalCommand[3] = "D:\\oracle\visappl\\fnd\\11.5.0\\bin" + concCommand;
  4. Open a command prompt or Telnet session.
  5. In the directory in which Concurrent.ora resides, issue the following command using the APPS user ID:
    SQLPLUS APPS/password@database @Concurrent.ora

    where:

    password

    Is the password associated with the APPS user ID.

    database

    Is a value of the tnsnames entry (in the tnsnames.ora file) that points to the Oracle E-Business Suite database instance.



x
Procedure: How to Adjust the System Path and Verify CONCSUB

To adjust the system path and verify CONCSUB:

  1. On the server where the Oracle E-Business Suite database instance resides, add the following to the system path:
    $FND_TOP\bin

    You can add it at any time before creating the service for the Submit Request.

  2. Verify that the CONCSUB executable is present in $FND_TOP\bin.

    If CONCSUB is missing, contact your Oracle E-Business Suite administrator.

    $FND_TOP is the location of the Oracle E-Business Suite foundation directory. Its value is set in the vis.env (or prod.env) file located under the oraclehome\visappl directory.


Top of page

x
Generating a Schema for the Submit Request

You must create a pair of request and response service schemas for the Submit Request. You need only do this once for each Oracle E-Business Suite connection from which you run these programs. This satisfies the requirement for all Submit Requests that are accessed using that connection.



x
Procedure: How to Generate a Schema for the Submit Request

To generate the request and response schemas:

  1. If you have not already done so, connect to an Oracle E-Business Suite database instance.
  2. In the left pane of iWay Explorer under the Oracle Applications target, expand the Services node and the submit_request node.
  3. Select submit_request.
  4. In the right pane, move the pointer over Operations and select Generate Schema.

    A table appears on the right.

  5. To review a schema, click the ellipsis (...) in the Schemas column for the appropriate row.

You have finished generating the service schemas.


Top of page

x
Generating a Web Service for the Submit Request

Generating a web service for the submit request is identical to configuring other Oracle E-Business Suite services, except that some of the configuration parameters differ.

The following table lists and describes the service parameters for the submit request.

Parameter

Description

Select

Submit Request.

Userid

User ID for the Oracle E-Business Suite database.

Password

Password associated with the user ID.

Host

Name of the server where the Oracle E-Business Suite database instance resides.

Port

Port number on which the database is listening.

ServiceId

Unique name, comprised of the database name and domain name, that identifies the database.

TnsName

Logical name of the Oracle E-Business Suite database instance.



x
Procedure: How to Generate a Web Service for Submit Request

To create a web service:

  1. In the left pane of iWay Explorer, expand the submit_request node.

    The following image shows the expanded submit_request service node on the left and a property table for the submit request service that opens on the right.

  2. Select submit_request.

    The Operations menu becomes available on the right.

  3. Move the pointer over Operations and select Create iWay Business Services.

    The Create Web Service for submit_request pane opens on the right and provides the option to create a new service or use an existing service as shown in the following image.

  4. Select the Create a new service option button.
  5. Click Next.

    The right pane prompts you for descriptive information about the service, as shown in the following image.

    1. In the Service Name field, type a name for the web service.
    2. In the Description field, type a brief description of the web service.
    3. From the License list, select the license, for example, test.
  6. Click Next.

    The right pane then prompts you to identify a method for the service, as shown in the following image.

    1. In the Method Name field, type a name for your method.
    2. In the Description field, type a brief description of the method.
  7. Click Finish.

Top of page

x
Creating a Request Document

You can use an XML editor to create the service request document. For a sample submit request document, see How to Test the Submit Request.

After you create a web service and a request document, you can verify that you correctly configured the service for the Submit Request. After you create a service, the test pane appears on the right.



x
Procedure: How to Test the Submit Request

To test the Submit Request service:

  1. Ensure the Test pane appears on the right after you create the service. If it does not appear:
    1. Click the iWay Business Services tab.
    2. Click the Browse button.
    3. Use the tree in the left pane to browse to your service and method.
  2. Copy the XML input from the request document and paste it in the input xml field of the test pane. For a sample XML input document, see Sample Input XML.
  3. To test the Submit Request, click Invoke.

    The response document appears on the right.

    The submit_response_id returned in the reply is the request id returned from the concsub command. This request id can be used through Oracle E-Business Suite to monitor the status of the concurrent manager program instance that was invoked.

You have completed the testing of the Submit Request service.



x
Reference: Sample Input XML
The following is a sample input XML document that can be used to test an iWay Business Service for an Oracle concurrent program:
<?xml version="1.0" encoding="UTF-8"?>
<ORACLE>
  <submit_request>
    <resp_appl_shrtnm>SYSADMIN</resp_appl_shrtnm>
    <responsibility>System Administrator</responsibility>
    <username>SYSADMIN</username>
    <wait>N</wait>
    <prog_appl_shrtnm>WIP</prog_appl_shrtnm>
    <program>WICTMS</program>
<parm>3993</parm>
<parm>0</parm>
<parm>1</parm>
  </submit_request>
</ORACLE>

iWay Software