WEBADI - Create Custom Integrator

WEBADI - Steps to create custom Integrator

Login to Oracle applications responsibility Desktop Integration Manager as below-

STEP 1  - Click on the Create Integrator to create a new custom integrator.

this opens the following page in which we enter the details.

Enter the Integrator name , Integrator code  - they can be same for convenience.

Select Application like i have selected xxc custom top as this is R12.2.7 enviroment. if its R12.1 then Application can be Order Management Custom also.

tick the checkbox  - Display in Create document page  , this is very important as then only we will be able to create an excel template for the integrator.

After this click on Next Button.

STEP 2 -  The next step is define the interfaces. Enter a custom name for the interface , which i prefer to give the integrator name appended with _IFACE for convenience as below-

Interface Type - API- Procedure , then enter the package name and the Procedure name to be called. this package will hold the Code to insert into the stage table and then call the procedure to insert into interface tables of Sales Order.

Code snippet Screenshot -  Important note here - we need to give all the columns of the staging table in the insert_stage as parameters to the procedure. The same parameters are used to insert into the stage table.

click on Apply button.

the interface is created as below-

select the Radio button and it displays the Interface attributes which are nothing but the parameters of the insert stage procedure.

STEP 3- Contents Tab 

we do not define anything here, NONE is also Ok. so we just click on next.

STEP 4 - Uploader Tab

This defines the way data will be loaded. Select "from Template" here to be able to load data using an excel file.

Like below-

Click on Create button, this automatically creates a Uploader.

The Uploader has some parameters as below-

Meaning of each of the parameters are as below-

• bne:rows - 
• This has two options in the form of Radio button - 
• All rows and Flagged rows.
• It enables us to upload all rows or only the rows which we want to.
• bne:validation - 
• This is checkbox parameter, we can choose to validate the rows before upload, which will validate if there is a text in the number field and throw error if failed there.
• bne: import - 
• This is checkbox parameter. This decides if we need to automatically submit the import program which can be defined in the next step -IMPORTER.
• bne: commit rows - 
• This has two options in the form of Radio button - All rows and Each row.
• It enables us to commit data according to the selection.
• All rows means- even if one row fails validation, all will not be uploaded.
• Each row means - only the failed rows are not loaded, others are loaded into the stage table.

STEP 5- Importer

The importer is a program which will be used to submit a concurrent program into the oracle application .

here, we are not defining any importer as of now but will create a new post which will show the importer options and its working.

Click on submit to create the custom Integrator.

This brings us to the end of the CUSTOM integrator definitions.

STEP 6 - Creation of layout.

Switch the responsibility to Desktop Integrator and select define layout as below:

• An OAF page opens as below - Select the custom integrator that we have created using the first 5 steps.

• Click on create button to create new layout. A new page opens which asks for the layout name and Headers as below-

• Give the layout name as SALES_ORDER_UPLOAD_LAYOUT.
• no of headers will be 1.
• Click on Next.

• The next page shows the fields which are to be populated as columns in the excel for data gathering from user.
• The placement as highlighted should be changed to Line.
• Click on Next button.
• The next page shows the properties of the Excel file which will be downloaded. 
• The Excel will be opened in Protect Mode
• The excel will have filters by default when downloaded.
• Screen as below-

• Click on Apply which will save the Layout and display message.

STEP 7 - Create Document

• Now in the same responsibility - Desktop integrator click on the Create document as show in below screenshot

• An OAF page opens which asks to select the Integrator name , in our case it will be SALES_ORDER_UPLOAD as below. 

• After the selection of the integrator, click anywhere on the page and it starts the process to display the related layout.
• It automatically displays the layout name related to the integrator which we created in STEP6.

• Click on create, this creates the document and starts the template download.
• It shows the below message window

• After around 5-7 mins , the template is downloaded and ready for inserting data and uploading the same.
• The Excel template after download is saved with the name of the integrator itself as below -
• The Oracle Tab is used to upload data into the Oracle applications.

• Upload button when clicked opens  the upload parameter form as below (STEP 4 details).

• When we click on Upload from this form it inserts data into the Oracle applications.

This ends with the creation and loading data with WEB-ADI Custom Integrator.
To be able to define function for this custom integrator and assign to responsibility , please refer to
webadi-steps-to-create-function-for.html