Skip Navigation Links | |
Exit Print View | |
Designing with Oracle Java CAPS Application Adapters Java CAPS Documentation |
Designing with Application Adapters
Building an Oracle Applications Custom Pre-Validation Package
Oracle Applications Adapter Pre-Validation Scripts
Oracle Application Adapter Pre-Validation Procedures
To Build a Custom Pre-Validation Package for a Non-Supported Open Interface
Oracle Application Adapter Concurrent Manager Request Function
Oracle Applications Adapter Template DTD
Oracle Applications Manufacturing Modules
Oracle Applications Inventory Module
Customer Items Cross-Reference
Oracle Applications Purchase Order Import Module
Oracle Applications Order Entry Module
Oracle Applications Financial Module
Oracle Applications Accounts Payable Module
Oracle Applications Accounts Receivable Module
Oracle Applications Cash Management Module
Oracle Applications Fixed Assets Module
Oracle Applications General Ledger Module
Oracle Applications Validation Error Codes
Oracle Applications Manufacturing Error Codes
Oracle Applications Financial Budget-GL Error Codes
Accounts Receivable Error Codes
Configuring the PeopleSoft Server for the PeopleSoft Adapter Projects
Configuring PeopleSoft for Enterprise Service Bus Posting
Additional HTTP Configurations
Starting and Stopping the JMS Listening Connector
Verifying PeopleSoft Server Logs
Notes on PeopleSoft Server Disconnections for JMS
To Create PeopleSoft Nodes to Receive Enterprise Service Bus HTTP Posts
To Activate the Message Definition to Receive Enterprise Service Bus Posts
Defining Message Channel Routing Rules
Adding the PeopleSoft Subscription Handler
Creating an HTTP Adapter Message Node
Activating the Message Definition for Subscription
Defining the Message Channel Routing Rules
Adding the HTTP Publication Handler
Accessing Non-Local Queue Managers and Non-Local Queues
To Connect to a Remote WebSphere MQ Queue.
Creating the WebSphere MQ Queue
To Create the WebSphere MQ Queue
IBM WebSphere MQ Server and Queue Manager Limits and Settings
The Java CAPS Oracle Application scripts provided are intended to be used as a template or skeleton. You may need to modify these scripts to satisfy your own environment or requirements. These scripts have been tested successfully in the Java CAPS environment.
This section covers the following information for building a custom Pre-Validation Package:
To view corresponding tables and scripts used for the Pre-Validation packages, refer to the following modules:
For Open Interfaces for which pre-validation scripts have been supplied, the SQL files shipped with the Adapter are sufficient for you to create a working Project. For Open Interfaces for which pre-validation scripts are not currently available, a template XML file (templateXml.xml) is supplied. Use this file to build your own pre-validation package. The procedure for you to follow is given in To Build a Custom Pre-Validation Package for a Non-Supported Open Interface.
The pre-validation scripts packaged with the Adapter for the supported modules are rudimentary and do not cover all possible scenarios. Since the requirements from Oracle occasionally change and evolve, you may be required to provide additional data and/or parameters to ensure that the Concurrent Manager request completes successfully and without errors. Pre-validation scripts have been tested in 11.5.3 only.
All pre-validation script packages (*_pkg.sql) contain the following procedures.
Table 1 Common Procedures
|
<CAPS_Dir>/appserver/userdir/modules/ext/oracleappsadapter/ wizard/configs/Applications.xml
When adding a new business function, assign the business section a new name and entry for the new open interface. Spaces are acceptable when creating a module name.
<Module Name=”Module_Name”Definition=”moduleDefinition.xml”> </Module>
Notice that the name attribute is an English description which appears in the OTD wizard where the definition attribute locates the open interface XML definition file (this attribute cannot have spaces).
where business_function_name is the name attribute value (for example, either Manufacturing or Financial).
While the template XML file does not have an error package or error table entries, you can look at any existing module to create these entries. If you choose to modify the common sb_install.sql file to append more errors for the new module, the SB_ERRORS table needs to be removed from the database so the wizard can recreate it with new error values the next time the wizard is run.
<%%ORACLE_INTERFACE_NAME%%>
Do not use spaces when creating an ORACLE_INTERFACE_NAME.
<%%ORACLE_APPLICATION_SUITE NAME%%>
<%%MODULE_NAME%%>
Do not use spaces when creating a MODULE_NAME.
Note - Do not change either the Initialize_Profile stored procedure name, nor its location as the entry point for the initialization packages.
The validation package file name must be sql/business_function_name/module_name/Oracle_interface_name/sb_validate_interfaceNameAbbreviation_pkg.sql.
This path is relative from JavaCAPS_Home/.netbeans/caps/modules/ext/oracleappsadapter/wizard/.
This package contains the VALIDATE procedure which eventually invokes all the VALIDATE procedures for all the tables.
The utility package file name must be sql/business_function_name/module_name/Oracle_interface_name/sb_interfaceNameAbbreviation_utils_pkg.sql.
This path is relative from JavaCAPS_Home/.netbeans/caps/modules/ext/oracleappsadapter/wizard/.
This package contains the procedures to move, delete, and function count all interface tables and the OTD level.
This concurrent manager file name must be sql/business_function_name/module_name/Oracle_interface_name/fn_request_ORACLE_INTERFACE_NAME.sql relative from JavaCAPS_Home/.netbeans/caps/modules/ext/oracleappsadapter/wizard/.
This function eventually invokes the concurrent manager.
For example, in manufacturing, order import has two interface tables with child-parent relationships, whereas item import has two interface tables with sibling relationships.
This validation package file name must be sql/business_function_name/module_name/Oracle_interface_name/sb_validate_interface_TablenameAbbreviation_pkg.sql
This path is relative from JavaCAPS_Home/.netbeans/caps/modules/ext/oracleappsadapter/wizard/.
This package has the VALIDATE procedure for these interface tables.
Note - The new Applications.xml, moduleDefinition.xml, and SQL scripts are stored only in the Java CAPS IDE directory. It is recommended to back them up periodically.
The default SQL script template for Concurrent Manager Request has 100 identical input parameters for FND_REQUEST.SUBMIT_REQUEST. If you need to customize the input parameters for your generated script, the following tags can be used to specify the input parameters.
<Concurrent_Manager>path/file_name.sql</Concurrent_Manager> <Request_Param>parameter1</Request_Param> <Request_Param>parameter2</Request_Param> <Request_Param>parameter3</Request_Param>
The Data Type Definition (DTD) associated with the template XML file is shown:
<!ELEMENT OPEN_INTERFACE (Initialize_Script?, Validation_Script?, Utility_Script, Concurrent_Manager, Request_Param*, Concurrent_Manager_Status?, Interface_Table+, Error_Handle?, Pre_Required_Script*)> <!-- Open interface name --> <!ATTLIST OPEN_INTERFACE Name CDATA #REQUIRED > <!-- Oracle Manufacturing Version --> <!ATTLIST OPEN_INTERFACE Version CDATA #REQUIRED > <!-- Application Suite --> <!ATTLIST OPEN_INTERFACE Application-Suite CDATA #REQUIRED > <!-- Module Name --> <!ATTLIST OPEN_INTERFACE Module CDATA #REQUIRED > <!-- utiltiy store procedure name at root level, this attribute is optional if this attribute is specified, it overrides the default name convention, which is derived from Name attribute of OPEN_INTERFACE --> <!ATTLIST OPEN_INTERFACE Util_Name CDATA #IMPLIED > <!-- relative path to the sql script file for initialize package--> <!ELEMENT Initialize_Script (#PCDATA)> <!-- relative path to the sql script file for validation package --> <!ELEMENT Validation_Script (#PCDATA)> <!-- relative path to the sql script file for Utility package --> <!ELEMENT Utility_Script (#PCDATA)> <!-- relative path to the sql script file for concurrent manager request function --> <!ELEMENT Concurrent_Manager (#PCDATA)> <!-- parameter description for concurrent manager request function --> <!ELEMENT Request_Param (#PCDATA)> <!-- relative path to the sql script file for function to retrieve concurrent manager request status --> <!ELEMENT Concurrent_Manager_Status (#PCDATA)> <!-- Oracle Open Interface table definition --> <!ELEMENT Interface_Table (Validation_Script?, Interface_Table*)> <!-- name for the oracle open interface table --> <!ATTLIST Interface_Table Name CDATA #REQUIRED > <!-- name for SB staging table, this attribute is optional if this attribute is set, the program directly uses its value as the SB staging table for this specific interface --> <!ATTLIST Interface_Table SB_Name CDATA #IMPLIED > <!-- utility store procedure name at specific interface level, this attribute is optional if this attribute is specified, it overrides the default name convention, which is derived from the specific interface name --> <!ATTLIST Interface_Table Util_Name CDATA #IMPLIED > <!-- Error handling definition --> <!ELEMENT Error_Handle (Error_Table?, Error_PKG?)> <!-- relative path to the sql script for creating error table --> <!ELEMENT Error_Table (#PCDATA)> <!-- relative path to the sql script for error handling --> <!ELEMENT Error_PKG (#PCDATA)> <!-- relative path to the sql script that needs to be compiled in order for other stored procedure to be compiled successfully -->
The following topics provide information about naming conventions for various interface components:
This is the name used for the generated utility stored procedures, for each interface table. It is derived from the corresponding Oracle Interface Table name. If the Oracle Interface Table name is longer than 23 characters, INTERFACE or IFACE_ALL is replaced with INT to form the short table name. Since there is a limitation of 30 characters placed on the function/stored procedure name in Oracle, the Open Interface name specified in the XML file can be no more than 23 characters.
The utility stored procedure names are derived from the Short Table name, according to the following convention:
Sb_XXX_<SHORT_TABLE_NAME>
The name of the staging table node is derived from the corresponding Oracle Interface Table name by adding the prefix SB_ and truncating it to 30 characters, if necessary.
If the SQL file is used to create a packaged stored procedure, the file name must be the same as the package name. The file name is case sensitive and must be less than or equal to 30 character due to the rules of Oracle procedure/function name.
The function name is derived from the Open Interface name specified in the XML, and has the form: FN_REQUEST_<ORACLE_INTERFACE_NAME>.