Document 380457.1

Skip to content
<#>
My Oracle Support Logo
pvText <#>
pvText <#>
PowerView is Off
<#>
Turn PowerView On
Edit
New
Recent PowerViews
Named PowerViews
Manage PowerViews
Learn more about PowerView...
chandrasekhar (Available)
<#>
Available (for My Oracle Support initiated chat)
Not Available
Learn about Chat...
My Account
Sign Out
<#>
Last Refreshed: May 5, 2015 6:44 PM IST(0) <#>
a <#>
Contact Us
<#>
Help
<#>
Viewing Documents
-----------------------------------------------------------------------Getting Started
Troubleshooting
Contact Oracle Global Customer Support
Table of Contents
<#>
Dashboard <#>
Knowledge <#>
Service Requests <#>
Patches & Updates <#>
Community <#>
Certifications <#>
Systems <#>
Collector <#>
Advanced Customer Services <#>
Settings <#>
Advanced Customer Services <#>
Settings <#>
Favorites
Recent Searches
Selected Source
Global Search
Global Search <#>
Give Feedback... <javascript:var newWin =

window.open('https%3A%2F%2Fora-gcp1.custhelp.com%2Fci%2Fdocuments%2Fdetail%2F5%2
F1046%2F12%2F742014625729a6c0d41118e1a8a926dbebf67a0c%3Fuser%3DCHANDRASEKHAR.KAD
ALI%40HITACHICONSULTING.COM%26uID%3D0E8059E4619E3EAAE050E60AD07F4C79%26fID%3D6wn
26abwu5d1zfe%26cua%3Dfalse%26page%3DDocumentDisplay','feedbackWindow','width=630
,
height=600,
location=no,resizable=yes,scrollbars=yes,status=no,left='+getLeftOffset(630)+',t
op='+getTopOffset(600)+'','true');>
You have been directed to this document based on an ID match.
Alternatively, click here to search on this phrase. <#> Hide <#>
Customize Page... <#>
9876
Doc ID
Click to add to Favorites <#>

Getting GME APIs to Work Using Vision Database Examples From Ora
cle
Support (Doc ID 380457.1)
To BottomTo Bottom <#>
-----------------------------------------------------------------------Getting GME APIs to Work Using Vision Database Examples
/*** Checked for relevance on 11-JAN-2013 ***/
*Product:* Process Execution (GME) APIs *Minimum Version:*11.5.10 CU 2
An Oracle White Paper
Abstract
This paper shows several simple test scripts that execute many of
the public GME APIs. The basis of all of these scripts has been the
Vision database. All of the scripts detailed below have been proven
to run successfully using our own internal Vision install using
Applications Version 11.5.10 CU 2.

You will notice that the scripts are quite simple and have been
written principally to test whether or not the APIs function as
designed. Most of them have been written by Oracle Applications
Support when questions have been raised as to whether the APIs are
indeed working as they should
You should be able to take the examples listed below and with the
necessary changes (that is, changing constants such as Item Id, UOM,
document or transaction id) get the scripts to work on your own
systems. Remarks are added after each script as what changes should
be made in order to get the API(s) called by the script to work for
your own circumstances.
If you are having problems getting the correct results from an API,
you should first of all try using the on-line application to
recreate what you are trying to achieve in the API. For example, if
you are using the application to create a Batch using a particular
Recipe, then you should be able to achieve the same result when
using the API. This is because the underlying code used by both the
application and the API is essentially the same.
It is worthwhile commenting here as to the limits of support that
Oracle Support Services can provide regarding the use of the
publicly provided APIs.
Oracle Support Services will support APIs in that they will ensure
that they function as designed and that the data inserted by the
APIs into the database is correct. It is NOT the function of support
to provide help to the user on writing their own custom wrapper
files but they may be able to give you the advice on this. An
example wrapper file is provided in the User Guide (see below).
As a general comment, when a user is setting out to write procedures
and functions using these APIs, it is advisable first to write
simple scripts like the ones detailed in this paper (that is to say,
with a single row of data embedded in the script as constants) to
become confident of the working of the API itself before moving on
to a wrapper which reads and processes a batch of input rows.
It should also be noted that Oracle will support the use of the
Public APIs *ONLY*. You should not directly call the private APIs.
For example, the use of 'gme_api_pub.create_batch' is supported,
however, 'gme_api_main.create_batch' is not supported.
An additional point to is that GME Debugging works when using the
APIs in the exactly the same way that it works when using the
application in the normal way.
This can provide useful additional information if the results of an
API run are not as expected.
In order to generate a GME debug file, do the following:
1.
Set Profile Option 'FND: Debug Log Enabled' at User level to
'Yes' and Profile Option 'FND: Debug Log Level' at User level to
'Statement' and run the API in the normal way.
2.
The GME Debug log files are to be found in the 'utl_file_dir'
directory. This query
select nvl(substr(value, 1, instr(value, ',')-1),value)
from v$parameter
where name = 'utl_file_dir'
/
will show the user the directory where the log file will be
generated. GME debug Log file names start with the Applications User
Name, and the format of the file name is 'USERNAMEEvent'; for
example ORAUSRCreateBatch or ORAUSRAllocateLine.
For a detailed description of available public APIs, refer to the
Process Execution API Users Guide Release 11/i - /Part No.
A97388-04. When attempting to use an API, it is recommended to read
the manual thoroughly, especially the sections that outline the
parameters required by the relevant API.
All of the scripts provided in this document should be executed
using the APPS SQL*Plus user.
Document History
*Create Date :* 25-JUL-2006*
Last Update Date : *01-AUG-2006
-----------------------------------------------------------------------*Table of Contents*
*
*
*
*
*
*
*
*
*
*
Example 1: Creation of batch using the RECIPE creation mode <#head1>

Example 2: Creation of batch by Product <#head2>
Example 3: Creation using Output Quantity <#head3>
Example 4: Create, Release and Save Batch <#head4>
Example 5: Create a batch and insert an additional material line
<#head5>
Example 6: Insert_line_allocation API <#head6>
Example 7: Close (Complete) Batch <#head7>
Example 8: Release, Record Usage and Complete Step <#head8>
Related Documents <#Related>
*
-----------------------------------------------------------------------Example 1: Creation of batch using the RECIPE creation mode
alter session set nls_language=american;
set serveroutput on size 1000000;
DECLARE
p_api_version NUMBER DEFAULT gme_api_pub.api_version;

p_validation_level NUMBER DEFAULT gme_api_pub.max_errors;
p_init_msg_list BOOLEAN DEFAULT FALSE;
P_batch_type NUMBER DEFAULT 0;
p_orgn_code VARCHAR2(4) DEFAULT PR1 ;
x_batch_header gme_batch_header%ROWTYPE;
x_unallocated_material gme_api_pub.unallocated_materials_tab;
x_message_count NUMBER;
x_message_list VARCHAR2(100);
x_return_status VARCHAR2(1);
l_batch_header GME_BATCH_HEADER%ROWTYPE;
l_msg_index_out NUMBER;
BEGIN
l_batch_header.plant_code := PR1 ;
l_batch_header.batch_type :=p_batch_type;
l_batch_header.batch_no:= ;
l_batch_header.plan_start_date := ;
l_batch_header.plan_cmplt_date := ;
l_batch_header.due_date :=TO_DATE( 10-AUG-2006
12:00:00 , DD-MON-YYYY HH24:MI:SS );
l_batch_header.update_inventory_ind := Y ;
l_batch_header.recipe_validity_rule_id :=1239;
l_batch_header.wip_whse_code:= PR1 ;
fnd_global.apps_initialize(user_id =>1003637,
resp_id => null,
resp_appl_id => null);
gme_api_pub.create_batch(
p_api_version => p_api_version
,p_validation_level => p_validation_level
,p_init_msg_list => p_init_msg_list
,p_commit => true
,x_message_count => x_message_count
,x_message_list => x_message_list
,x_return_status => x_return_status
,p_batch_header => l_batch_header
,x_batch_header => x_batch_header
,p_batch_size => 10
,p_batch_size_uom => KG
,p_creation_mode => RECIPE
,p_recipe_id => null
,p_recipe_no => JGC_1
,p_recipe_version => 301
,p_product_no => null
,p_product_id => null
,p_ignore_qty_below_cap => true
,p_ignore_shortages => true
,x_unallocated_material =>x_unallocated_material );
gme_debug.display_messages(x_message_count);
dbms_output.put_line( x_message_count = ||TO_CHAR(x_message_count));
dbms_output.put_line( x_message_list =
||length(x_message_list)||SubStr(x_message_list,length(x_message_list)-20,2
0));
dbms_output.put_line( x_message_list = ||x_message_list);
dbms_output.put_line( x_return_status = ||x_return_status);
dbms_output.put_line( x_batch_header.batch_id=
||TO_CHAR(x_batch_header.batch_id));
dbms_output.put_line(SubStr( x_batch_header.plant_code
= ||x_batch_header.plant_code,1,255));
dbms_output.put_line(SubStr( x_batch_header.batch_no
= ||x_batch_header.batch_no,1,255));
END;
/
To find the Validity Rule Id, run this script
select r.recipe_no
,r.recipe_version
,r.recipe_id
,v.RECIPE_VALIDITY_RULE_ID
,v.orgn_code
,RECIPE_USE
,PREFERENCe
,START_DATe
,END_DATE
,MIN_QTY
,MAX_QTY
,STD_QTY
,ITEM_UM
from gmd_recipes r
,gmd_recipe_validity_rules v
where r.recipe_no= &recipe_no
and r.recipe_version= &version
and r.recipe_id=v.recipe_id
order by
v.preference
Remarks on Example 1
1. Notice the alter session set nls_language=american; command. This
command is used to ensure that the language in the current SQL*Plus
session matches one of the installed languages within the
Application. It is always safe to set this to american.
2. The set serveroutput on size 1000000 command is there to ensure
that the dbms_out.put_line messages can be seen on the screen. In
real life examples, the user will probably use the
utl_file.put_line command in order to write these messages to a
text log file.
3. Note the combination of the Recipe Number and Version and the
Validity Rule Id. The Validity Rule Id must be attached to the
relevant Recipe, and both must be Approved for General Use. The
Validity Rule must be effective on the relevant batch dates (in this
case, the batch due date). To find the appropriate value of Validity
Rule Id, run the script shown above.
4. Note the Batch Size and UOM. These must be valid within the limits
set by the Validity Rule being used.
5. The fnd_global.apps_initialize is used to set the application
context. In the above example, the context is set according to the
applications user whose id is 1003637. The relevant id can found for
the required user by using this command: select user_id from
fnd_user where user_name= &user_name ; and entering the required
username. The user selected should have a responsibility attached
which allows creation of batches via the application.
6. A full description of the Create Batch API and its parameters can be
found in the User Guide pages 4-16 to 4-19.
Example 2: Creation of batch by Product

set serveroutput on size 1000000
DECLARE
p_batch_header GME_BATCH_HEADER%rowtype;
x_batch_header GME_BATCH_HEADER%rowtype;
x_unallocated_material GME_API_PUB.UNALLOCATED_MATERIALS_TAB;
BEGIN
dbms_output.enable(100000);
fnd_global.apps_initialize( USER_ID =>1007882,
resp_id =>NULL,
resp_appl_id =>NULL);
p_batch_header.plant_code := PR1
p_batch_header.batch_no := ;
p_batch_header.batch_type := 0;
p_batch_header.plan_start_date :=
12:00:00 , DD-MON-YYYY HH24:MI:SS
p_batch_header.wip_whse_code :=
p_api_version
,p_validation_level
,p_init_msg_list
,p_commit
,x_message_count
,x_message_list
,x_return_status
,p_batch_header
,x_batch_header
,p_batch_size
,p_batch_size_uom
,p_creation_mode
,p_recipe_id
,p_recipe_no
,p_recipe_version
,p_product_no
,p_product_id
,p_ignore_qty_below_cap
,p_ignore_shortages
,x_unallocated_material
);
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
;
TO_DATE( 16-JULY-2006
);
;
100
TRUE
FALSE
x_message_count
x_message_list
x_return_status
p_batch_header
x_batch_header
100
KG
PRODUCT
null
null
null
JGC_1
NULL
TRUE
TRUE
x_unallocated_material
gme_debug.display_messages(x_message_count);
dbms_output.put_line( x_message_list = ||x_message_list);
dbms_output.put_line( x_batch_header.batch_id =
dbms_output.put_line(SubStr( x_batch_header.plant_code =
||x_batch_header.plant_code,1,255));
dbms_output.put_line(SubStr( x_batch_header.batch_no =
||x_batch_header.batch_no,1,255));
dbms_output.put_line( x_batch_header.batch_type =
||TO_CHAR(x_batch_header.batch_type));
dbms_output.put_line( x_batch_header.recipe_validity_rule_id
= ||TO_CHAR(x_batch_header.recipe_validity_rule_id));
dbms_output.put_line( x_batch_header.formula_id =
||TO_CHAR(x_batch_header.formula_id));
dbms_output.put_line( x_batch_header.routing_id =
||TO_CHAR(x_batch_header.routing_id));
dbms_output.put_line( x_batch_header.plan_start_date =
||TO_CHAR(x_batch_header.plan_start_date, DD-MON-YYYY HH24:MI:SS ));
dbms_output.put_line( x_batch_header.due_date =
||TO_CHAR(x_batch_header.due_date, DD-MON-YYYY HH24:MI:SS ));
dbms_output.put_line( x_batch_header.plan_cmplt_date =
||TO_CHAR(x_batch_header.plan_cmplt_date, DD-MON-YYYY HH24:MI:SS ));
dbms_output.put_line( x_batch_header.batch_status =
||TO_CHAR(x_batch_header.batch_status));
dbms_output.put_line(SubStr( x_batch_header.wip_whse_code
= ||x_batch_header.wip_whse_code,1,255));
dbms_output.put_line(SubStr( x_batch_header.poc_ind =
||x_batch_header.poc_ind,1,255));
dbms_output.put_line(SubStr( x_batch_header.update_inventory_ind =
||x_batch_header.update_inventory_ind,1,255));
dbms_output.put_line( x_batch_header.last_update_date= ||TO_CHAR(x_batch_hea
der.last_update_date,
DD-MON-YYYY HH24:MI:SS ));
dbms_output.put_line( x_batch_header.last_updated_by =
||TO_CHAR(x_batch_header.last_updated_by));
dbms_output.put_line( x_batch_header.creation_date =
||TO_CHAR(x_batch_header.creation_date, DD-MON-YYYY HH24:MI:SS ));
dbms_output.put_line( x_batch_header.created_by =
||TO_CHAR(x_batch_header.created_by));
dbms_output.put_line( x_batch_header.last_update_login
= ||TO_CHAR(x_batch_header.last_update_login));
dbms_output.put_line( x_batch_header.delete_mark =
||TO_CHAR(x_batch_header.delete_mark));
dbms_output.put_line( x_batch_header.text_code =
||TO_CHAR(x_batch_header.text_code));
dbms_output.put_line( x_batch_header.automatic_step_calculation
= ||TO_CHAR(x_batch_header.automatic_step_calculation));
IF x_unallocated_material.count > 0 THEN
FOR i IN
x_unallocated_material.first..x_unallocated_material.last LOOP
IF x_unallocated_material.exists(i) THEN
dbms_output.put_line( x_unallocated_material( ||to_char(i)|| ).batc
h_id
= ||TO_CHAR(x_unallocated_material(i).batch_id));
dbms_output.put_line(SubStr( x_unallocated_material( ||to_char(i)||
).batch_no
= ||x_unallocated_material(i).batch_no,1,255));
dbms_output.put_line( x_unallocated_material( ||to_char(i)|| ).mate
rial_detail_id= ||TO_CHAR(x_unallocated_material(i).material_detail_id));
dbms_output.put_line( x_unallocated_material( ||to_char(i)|| ).line
_type= ||TO_CHAR(x_unallocated_material(i).line_type));
_no= ||TO_CHAR(x_unallocated_material(i).line_no));
dbms_output.put_line( x_unallocated_material( ||to_char(i)|| ).item
_id= ||TO_CHAR(x_unallocated_material(i).item_id));
).item_no
= ||x_unallocated_material(i).item_no,1,255));
dbms_output.put_line( x_unallocated_material( ||to_char(i)|| ).allo
c_qty= ||TO_CHAR(x_unallocated_material(i).alloc_qty));
dbms_output.put_line( x_unallocated_material( ||to_char(i)|| ).unal
loc_qty
= ||TO_CHAR(x_unallocated_material(i).unalloc_qty));
).alloc_uom= ||x_unallocated_material(i).alloc_uom,1,255));
END IF;
END LOOP;
END IF;
gme_api_pub.save_batch(
p_batch_header
X_return_status
p_commit
=> p_batch_header,
=> x_return_status,
=>TRUE);
EXCEPTION
WHEN OTHERS THEN
dbms_output.put_line( Error ||TO_CHAR(SQLCODE)|| : ||SQLERRM);
RAISE;
END;
/
1. The remarks made against Example 1 remain valid for Example 2.
In addition please note the following.
2. In this example, the product to be output is specified and the
quantity to be output is likewise specified. Once again,
however, there must be a valid Recipe Validity Rule that can
used to create the batch. See remark 3 on example 1 for more
details.
3. Notice that when the API creating the batch
(gme_api_pub.create_batch) is run, the transaction is not
committed. Instead this is done at a later stage using the
gme_api_pub.save_batch API. The user may care to use this
technique when, for example, creating and releasing a batch in a
single transaction.
Example 3: Creation using Output Quantity
set serveroutput on
DECLARE
p_batch_header GME_BATCH_HEADER%rowtype;
x_batch_header GME_BATCH_HEADER%rowtype;
x_unallocated_material GME_API_PUB.UNALLOCATED_MATERIALS_TAB;
BEGIN
-- Following line is set the output buffer
dbms_output.enable(100000);
/***************************************************************************
***********
* Enter your user id below
* NOTE: To retrieve user_id Log on to the application.
* Select to Production Supervisor responsibility
* Navigate Others->Session parameters
* You will see your USER ID and Username on the screen.
* fnd_profile.initialize(user_id);
****************************************************************************
**********/
-- set the applications context
resp_id =>NULL,
resp_appl_id =>NULL
);
/***************************************************************************
***********
* (R) = Required, (O) = Optional
* enter your own plant_code (R), recipe_validity_Rule_Id(O),
batch_type (R)
* specify batch_no (R if testing manual doc ordering)
* dates are optional;format of the dates is
* TO_DATE( 10-OCT-2001 12:00:00 , DD-MON-YYYY HH24:MI:SS );
* In esence you supply the date and appropriate format.
* wip_whse_code is optional.
* update_inventory_ind is optional and should only be used if the
plant is a Lab.
* Y =Transactions to be created, N =transactions should not be
created.
****************************************************************************
**********/
p_batch_header.plant_code := PR1 ; p_batch_header.batch_no := ;
-- batch_type .. 10=fpo, 0=batch
p_batch_header.batch_type := 0;
p_batch_header.recipe_validity_rule_id := null;
p_batch_header.plan_start_date := ; --TO_DATE( 30-JUL-2006
12:00:00 , DD-MON-YYYY HH24:MI:SS );
p_batch_header.due_date := ; ---TO_DATE( );
p_batch_header.plan_cmplt_date := ; --TO_DATE( );
p_batch_header.wip_whse_code := ;
-- -- you have the option to set the below param to N when testing
Lab batch creation
p_batch_header.update_inventory_ind := Y ;
/***************************************************************************
***********
* Now call the stored program
* Leave first 4 parameters as they are
* enter p_batch_size and p_batch_size_uom are required
* if p_creation_mode is PRODUCT , OUTPUT , INPUT )
* enter p_creation_mode = RECIPE, PRODUCT,OUTPUT,INPUT
* p_batch_header_validity_rule_id OR p_recipe_id OR (p_recipe_no and

p_recipe_version)
* are required if p_creation_mode = RECIPE , INPUT , OUTPUT
* p_batch_header_validity_rule_id OR p_product_id OR p_product_no
* are required if p_creation_mode = PRODUCT
* If p_ignore_shortages id passed as FALSE then in case of shortages
* and profile option GMI:Allow negative inventory is set to Warning
or Error
* Batch will not be created and the x_unallocated procedure will be
populated
* with the material lines causing shortages.
* p_ignore_qty_below_cap: If set to FALSE, then if the process
quantity of any of
* the resources in the batch is less than the minimum capacity for
that resource
* batch will not be created.
****************************************************************************
**********/
,p_api_version => 1
,p_validation_level => 100
,p_init_msg_list => TRUE
,p_commit => TRUE
,p_batch_header => p_batch_header
,p_batch_size => 1000
,p_creation_mode => OUTPUT
,p_recipe_id => NULL
,p_product_no => JGC_1
,p_product_id => NULL
,p_ignore_qty_below_cap => TRUE
,p_ignore_shortages => TRUE
,x_unallocated_material => x_unallocated_material
);
/***************************************************************************
************
* Following line can be uncommented, if there are multiple messages
return by the
* API, and you want to see all those messages. These will be written
to the Log file
* If generated by the API.
****************************************************************************
***********/
-- gme_debug.display_messages(x_message_count);
/***************************************************************************
************
* Output the results
* One of the following will be the outcome of the API call(
x_return_status)
* S - Success
* E - Error
* U - Unexpected Error
* N - Items failed auto allocation
* V - Inventory shortage exists
****************************************************************************
***********/
IF x_return_status <> FND_API.g_ret_sts_success THEN
IF X_message_count = 1 THEN
DBMS_OUTPUT.PUT_LINE( Error: ||X_message_list);
ELSE
FOR i IN 1..x_message_count LOOP
FND_MSG_PUB.get (p_msg_index => i
,p_data => X_message_list
,p_msg_index_out => l_msg_index_out);
END LOOP;
END IF;
ELSE
||length(x_message_list)||SubStr(x_message_list,length(x_message_list)-20,2
0));
dbms_output.put_line( x_batch_header.recipe_validity_rule_id =
||TO_CHAR(x_batch_header.recipe_validity_rule_id));
||TO_CHAR(x_batch_header.plan_cmplt_date, DD-MON-YYYY HH24:MI:SS ));
dbms_output.put_line(SubStr( x_batch_header.wip_whse_code =
||x_batch_header.wip_whse_code,1,255));
dbms_output.put_line(SubStr( x_batch_header.poc_ind =
||x_batch_header.poc_ind,1,255));
dbms_output.put_line(SubStr( x_batch_header.update_inventory_ind =
||x_batch_header.update_inventory_ind,1,255));
dbms_output.put_line( x_batch_header.last_update_date =
||TO_CHAR(x_batch_header.last_update_date, DD-MON-YYYY HH24:MI:SS ));
dbms_output.put_line( x_batch_header.last_updated_by =
||TO_CHAR(x_batch_header.last_updated_by));
dbms_output.put_line( x_batch_header.creation_date =
||TO_CHAR(x_batch_header.creation_date, DD-MON-YYYY HH24:MI:SS ));
dbms_output.put_line( x_batch_header.created_by =
||TO_CHAR(x_batch_header.created_by));
dbms_output.put_line( x_batch_header.last_update_login =
||TO_CHAR(x_batch_header.last_update_login));
dbms_output.put_line( x_batch_header.delete_mark =
||TO_CHAR(x_batch_header.delete_mark));
dbms_output.put_line( x_batch_header.text_code =
||TO_CHAR(x_batch_header.text_code));
dbms_output.put_line( x_batch_header.automatic_step_calculation =
||TO_CHAR(x_batch_header.automatic_step_calculation));
IF x_unallocated_material.count > 0 THEN
FOR i IN
x_unallocated_material.first..x_unallocated_material.last LOOP
IF x_unallocated_material.exists(i) THEN
dbms_output.put_line( x_unallocated_material( ||to_char(i)|| ).batc
h_id
= ||TO_CHAR(x_unallocated_material(i).batch_id));
).batch_no
= ||x_unallocated_material(i).batch_no,1,255));
dbms_output.put_line( x_unallocated_material( ||to_char(i)|| ).mate
rial_detail_id
= ||TO_CHAR(x_unallocated_material(i).material_detail_id));
_type
= ||TO_CHAR(x_unallocated_material(i).line_type));
_no
= ||TO_CHAR(x_unallocated_material(i).line_no));
dbms_output.put_line( x_unallocated_material( ||to_char(i)|| ).item
_id
= ||TO_CHAR(x_unallocated_material(i).item_id));
).item_no
= ||x_unallocated_material(i).item_no,1,255));
dbms_output.put_line( x_unallocated_material( ||to_char(i)|| ).allo
c_qty
= ||TO_CHAR(x_unallocated_material(i).alloc_qty));
dbms_output.put_line( x_unallocated_material( ||to_char(i)|| ).unal
loc_qty
= ||TO_CHAR(x_unallocated_material(i).unalloc_qty));
).alloc_uom
= ||x_unallocated_material(i).alloc_uom,1,255));
END IF;
END LOOP;
END IF;
END IF;
EXCEPTION
WHEN OTHERS THEN
RAISE;
END;
/
Remarks on example 3
1. See Remarks for both Example 1 and Example 2. As in Example 1,
the Recipe and Version numbers are specified and like Example 2,
the Product is specified. This example differs from the others
in that it allows the user to control both the recipe used and
the output quantity. It basically provides the same
functionality as using the Total Output tab when creating a
batch in the application.
Example 4: Create, Release and Save Batch

set serveroutput on size 100000;
DECLARE
l_batch_header
gme_batch_header%ROWTYPE;
x_batch_header
p_batch_header
x_message_count
NUMBER;
x_message_list
VARCHAR2(2000);
x_unallocated_material
gme_api_pub.unallocated_materials_tab;
x_return_status
VARCHAR2(1);
l_material_detail
gme_material_details%ROWTYPE;
x_material_detail
gme_material_details%ROWTYPE;
p_values_tab
gme_api_pub.field_values_tab;
l_field
gme_api_pub.p_field;
l_unallocated_material
gme_api_pub.unallocated_materials_tab;
BEGIN
-- Set the applications context
resp_id =>NULL,
l_batch_header.plant_code
:= PR1 ;
l_batch_header.batch_type
:= 0;
l_batch_header.plan_start_date
:= SYSDATE;
l_batch_header.plan_cmplt_date
:= SYSDATE;
l_batch_header.due_date
:= SYSDATE;
l_batch_header.update_inventory_ind
:= Y ;
l_batch_header.wip_whse_code
:= PR1 ;
l_batch_header.recipe_validity_rule_id := 1239;
--- CREATE THE BATCH
-gme_api_pub.create_batch (p_api_version
=> 1
,p_validation_level
=> 1000
,p_init_msg_list
=> TRUE
,p_commit
=> FALSE
,x_message_count
=> x_message_count
,x_message_list
=> x_message_list
,x_return_status
=> x_return_status
,p_batch_header
=> l_batch_header
,x_batch_header
=> x_batch_header
,p_batch_size
=> 10
,p_batch_size_uom
,p_creation_mode
,p_recipe_id
=> KG
=> RECIPE
=>
NULL
,p_recipe_no
=> JGC_1
,p_recipe_version
=> 301
,p_product_no
=> NULL
,p_product_id
=> NULL
,p_ignore_qty_below_cap
=> TRUE
,p_ignore_shortages
=> TRUE
=> x_unallocated_material);
ELSE
END LOOP;
END IF;
ELSE
dbms_output.put_line( x_message_count =
||TO_CHAR(x_message_count));
length ||length(x_message_list)|| Contents
||substr(x_message_list,1,200));
||TO_CHAR(x_batch_header.plan_cmplt_date, DD-MON-YYYY HH24:MI:SS );
l_batch_header.batch_type
l_batch_header.batch_id
x_batch_header.batch_id;
l_batch_header.plan_start_date
l_batch_header.plan_cmplt_date
l_batch_header.due_date
:= 0;
:=
:= SYSDATE;
:= SYSDATE;
:= SYSDATE;
l_batch_header.update_inventory_ind
l_batch_header.actual_start_date
:= Y ;
:= SYSDATE;
----- RELEASE IT
--gme_api_pub.release_batch (p_api_version
=> 1
,p_validation_level
=> 1000
,p_init_msg_list
=> TRUE
,p_commit
=> FALSE
,x_message_count
=> x_message_count
,x_message_list
=> x_message_list
,x_return_status
=> x_return_status
,p_batch_header
=> l_batch_header
,x_batch_header
=> x_batch_header
,p_ignore_shortages
=> TRUE
=> l_unallocated_material
,p_ignore_unalloc
=> TRUE);
IF x_return_status = FND_API.g_ret_sts_success THEN
dbms_output.put_line( Batch Released );
p_batch_header.batch_id
:=
x_batch_header.batch_id;
--- SAVE THE CHANGES
-gme_api_pub.save_batch(
p_batch_header
=> p_batch_header,
X_return_status
=> x_return_status,
p_commit
=>TRUE);
else
dbms_output.put_line( Batch Release failed );
ELSE
END LOOP;
end if;
end if;
end if;
EXCEPTION
WHEN OTHERS THEN
dbms_output.put_line( Error ||TO_CHAR(SQLCODE)|| :
||SQLERRM);
RAISE;
END;
/
This script creates, releases and saves a batch. Note that when
the batch is created and released, these changes are not

committed (that is to say, p_commit is set to False). This
enables the user to treat both batch creation and release as
part of the same transaction and commit the changes if both
operations succeed.
Example 5: Create a batch and insert an additional material line
DECLARE
l_batch_header gme_batch_header%ROWTYPE;
p_batch_header gme_batch_header%ROWTYPE;
x_unallocated_material gme_api_pub.unallocated_materials_tab;
l_material_detail gme_material_details%ROWTYPE;
x_material_detail gme_material_details%ROWTYPE;
p_values_tab gme_api_pub.field_values_tab;
l_field gme_api_pub.p_field;
l_unallocated_material gme_api_pub.unallocated_materials_tab;
BEGIN
-- Set the applications context
resp_id =>NULL,
l_batch_header.plant_code := PR1 ;
l_batch_header.batch_type := 0;
l_batch_header.plan_start_date := SYSDATE;
l_batch_header.plan_cmplt_date := SYSDATE;
l_batch_header.due_date := SYSDATE;
l_batch_header.update_inventory_ind := Y ;
l_batch_header.wip_whse_code := PR1 ;
l_batch_header.recipe_validity_rule_id := 1239;
--- CREATE THE BATCH
-gme_api_pub.create_batch (p_api_version => 1
,p_validation_level => 1000
,p_commit => FALSE
,p_batch_header => l_batch_header
,p_batch_size => 10
,p_creation_mode => RECIPE
,p_recipe_id => NULL

,p_product_no => NULL
,p_product_id => NULL
,p_ignore_qty_below_cap => TRUE
,x_unallocated_material => x_unallocated_material);
ELSE
dbms_output.put_line( x_message_count =
||TO_CHAR(x_message_count));
dbms_output.put_line( x_message_list = lenght
||length(x_message_list)|| Contents ||substr(x_message_list,1,200));
||TO_CHAR(x_batch_header.plan_cmplt_date, DD-MON-YYYY HH24:MI:SS );
l_material_detail.batch_id :=x_batch_header.batch_id;
l_material_detail.line_no :=2;
l_material_detail.item_id :=712;
l_material_detail.plan_qty :=100;
l_material_detail.scale_type :=1;
l_material_detail.alloc_ind :=0;
l_material_detail.item_um := LB ;
l_material_detail.line_type :=-1;
l_material_detail.cost_alloc :=0;
l_material_detail.contribute_yield_ind := Y ;
l_material_detail.scrap_factor :=0;
l_material_detail.phantom_type :=0;
p_batch_header := x_batch_header;
--- INSERT INGREDIENT LINE
-gme_api_pub.insert_material_line (p_api_version =>1
,p_validation_level =>100
,p_init_msg_list =>FALSE
,p_commit =>FALSE
,x_message_count =>x_message_count
,x_message_list =>x_message_list
,x_return_status =>x_return_status
,p_material_detail =>l_material_detail
,p_batchstep_no =>NULL
,x_material_detail =>x_material_detail);
dbms_output.put_line( Material line inserted for item id
||x_material_detail.item_id);
--- SAVE THE CHANGES
-gme_api_pub.save_batch(
p_batch_header => p_batch_header,
X_return_status => x_return_status,
p_commit =>TRUE);
else
dbms_output.put_line( Material line insertion failed );
end if;
end if;
EXCEPTION
WHEN OTHERS THEN
||SQLERRM);
RAISE;
END;
/
This is similar to Example 4 except that this time, once the
batch is created, a new ingredient line is added. The changes
are then saved via the save batch API.
Example 6: Insert_line_allocation API

set serverout on size 100000
DECLARE
-x_message_count NUMBER;
p_material_details gme_material_details%ROWTYPE;
x_material_details gme_material_details%ROWTYPE;
p_batch_header gme_batch_header%ROWTYPE;
x_def_tran_row gme_inventory_txns_gtmp%ROWTYPE;
x_tran_row gme_inventory_txns_gtmp%ROWTYPE;
x_unallocated_materials gme_api_pub.unallocated_materials_tab;
x_unallocated_items gme_unallocated_items_gtmp%rowtype;
p_tran_row gme_inventory_txns_gtmp%ROWTYPE;
-x_msg_index number;
x_msg_data varchar2(200);
l_message_count NUMBER;
l_message_list VARCHAR2(200);
BEGIN
-- Following line is set the output buffer
DBMS_OUTPUT.enable(20000);
-- Line below required if formula security is used. It sets the
security context.
resp_id =>NULL,
resp_appl_id =>NULL
);
-p_material_details.material_detail_id := 22188;
p_batch_header.batch_id := 4354;
-/**/
p_tran_row.doc_id := 4354;
p_tran_row.material_detail_id := 22188;
p_tran_row.whse_code := PR1 ;
p_tran_row.location := 1 ;
p_tran_row.lot_id := 7571;
p_tran_row.alloc_qty := 100;
p_tran_row.trans_qty := 100;
p_tran_row.completed_ind := 0;
p_tran_row.trans_date := sysdate;
p_tran_row.reason_code := null;
/***************************************************************************
***********
* Now call the stored program *
* Leave first 4 parameters as they are *
****************************************************************************
**********/
gme_api_pub.insert_line_allocation(p_api_version => 1
p_validation_level => 1000
,p_commit => TRUE
,p_tran_row => p_tran_row
,p_lot_no => null
,p_sublot_no => null
,p_create_lot => TRUE
,p_ignore_shortage => FALSE
,p_scale_phantom => FALSE
,x_material_detail => p_material_details
,x_tran_row => x_tran_row
,x_def_tran_row => x_def_tran_row
,x_message_count => l_message_count
,x_message_list => l_message_list
,x_return_status => x_return_status);
DBMS_OUTPUT.put_line( doc_id = ||x_tran_row.doc_id);
DBMS_OUTPUT.put_line( material_detail_id =
||x_tran_row.material_detail_id);
DBMS_OUTPUT.put_line( trans_id = ||x_tran_row.trans_id);
DBMS_OUTPUT.put_line( line_type = ||x_tran_row.line_type);
DBMS_OUTPUT.put_line( whse_code = ||x_tran_row.whse_code);
DBMS_OUTPUT.put_line( location = ||x_tran_row.location);
DBMS_OUTPUT.put_line( alloc_qty = ||x_tran_row.alloc_qty);
DBMS_OUTPUT.put_line( trans_qty = ||x_tran_row.trans_qty);
DBMS_OUTPUT.put_line( trans_qty2 = ||x_tran_row.trans_qty2);
DBMS_OUTPUT.put_line( completed_ind = ||x_tran_row.completed_ind);
DBMS_OUTPUT.put_line( trans_date = ||x_tran_row.trans_date);
else
DBMS_OUTPUT.put_line( x_message_count =
||TO_CHAR(L_message_count));
DBMS_OUTPUT.put_line(SubStr( x_message_list =
||l_message_list,1,255));
DBMS_OUTPUT.put_line(SubStr( x_return_status =
||x_return_status,1,255));
end if;
EXCEPTION
WHEN OTHERS THEN
DBMS_OUTPUT.put_line( Error ||TO_CHAR(SQLCODE)|| :
||SQLERRM);
RAISE;
END;
/
This will create a line allocation for either an ingredient or
product line. Note this API can be used in conjunction with the
gme_api_pub.insert_material_line API to both add and allocate a
new material line. Once again the gme_api_pub.save_batch
procedure can be used to save both transactions once the user is
sure there are no errors.
Example 7: Close (Complete) Batch
DECLARE
v_batch_header apps.gme_batch_header%ROWTYPE;
x_batch_header apps.gme_batch_header%ROWTYPE;
v_message_count number;
v_message_list VARCHAR2(1024);
v_unallocated_material apps.gme_api_pub.unallocated_materials_tab;
v_return_status VARCHAR2(1);
BEGIN
resp_id =>NULL,
v_batch_header.batch_id := 4355;
v_batch_header.ACTUAL_CMPLT_DATE := sysdate;
gme_api_pub.certify_batch (
p_init_msg_list => TRUE
,p_commit => false
,x_message_count => v_message_count
,x_message_list => v_message_list
,x_return_status => v_return_status
,p_del_incomplete_manual => TRUE
,p_batch_header => v_batch_header
,x_unallocated_material => v_unallocated_material);
IF v_return_status = S THEN
dbms_output.put_line( Certify succeeded );
gme_api_pub.save_batch(x_batch_header, v_return_status);
dbms_output.put_line( save_batch: status= || v_return_status);
commit;
else
dbms_output.put_line( Certify failed status= || v_return_status);
DBMS_OUTPUT.PUT_LINE( Error: ||v_message_list);
rollback;
end if;
EXCEPTION
WHEN OTHERS THEN
||SQLERRM);
RAISE;
END;
/
Bear in mind the state the batch must be in before it can
completed - that is, the quantity of the output product should
have been recorded and the ingredients allocated. If the user
has any doubts about this, it is suggested that they create,
release, allocate and attempt to complete a batch in the
Application. If this can be done in the application then a batch
in the same state should be able to be completed using the API.
Notice also in this example the commit is done at the end of the
script i.e. after the save batch.
Example 8: Release, Record Usage and Complete step
DECLARE
v_message_count number;
v_message_list VARCHAR2(1024);
v_return_status VARCHAR2(1);
v_batch_header gme_batch_header%ROWTYPE;
v_batch_step gme_batch_steps%ROWTYPE;
x_batch_step gme_batch_steps%ROWTYPE;
l_release boolean :=false;
l_usage boolean :=false;
l_certify boolean :=false;
v_unallocated_material gme_api_pub.unallocated_materials_tab;
l_batchstep_id number;
l_batch_id number;
x_poc_trans_id number;
BEGIN
resp_id =>NULL,
----- Get batch details
---select * into v_batch_header
from gme_batch_header
where batch_id=4362;
----- release step 10
--v_batch_step.batchstep_no := 10;
v_batch_step.batch_id := v_batch_header.batch_id;
v_batch_step.actual_start_date := v_batch_header.actual_start_date;
gme_api_pub.release_step (
,p_commit => FALSE
,p_batch_step => v_batch_step
,x_batch_step => x_batch_step
,x_unallocated_material => v_unallocated_material
,p_ignore_unalloc => TRUE);
if v_return_status = S then
l_release := true;
l_batch_id :=x_batch_step.batch_id;
l_batchstep_id := x_batch_step.batchstep_id;
dbms_output.put_line( Release step succeeded );
else
dbms_output.put_line( release_step: status= ||
v_return_status|| , message= ||v_message_list);
rollback;
end if;
----- Record resource usage
--if l_release = true then
for c1 in (select batchstep_resource_id
, resources
,activity
from
gme_batch_step_resources r
,gme_batch_step_activities a
where
r.batchstep_id=x_batch_step.batchstep_id
and a.batchstep_id=r.batchstep_id
and a.batch_id=x_batch_step.batch_id
and r.batchstep_activity_id=a.batchstep_activity_id)
loop
gme_api_pub.update_actual_rsrc_usage(
,p_commit => FALSE
,p_batchstep_rsrc_id => c1.batchstep_resource_id
,p_plant_code => v_batch_header.plant_code
,p_batch_no => v_batch_header.batch_no
,p_batchstep_no => x_batch_step.batchstep_no
,p_activity => c1.activity
,p_resource => c1.resources
,p_trans_date => v_batch_header.actual_start_date
,p_start_date => v_batch_header.actual_start_date
,p_end_date => sysdate
,p_usage => 1.0
,p_reason_code =>
,x_poc_trans_id => x_poc_trans_id);
dbms_output.put_line( update_actual_rsrc_usage:
status= || v_return_status|| ,
message= ||v_message_list);
end loop;
end if;
l_usage := true;
else
rollback;
end if;
----- Complete step
--IF l_usage = true then
gme_api_pub.certify_step(
,p_commit => FALSE
,p_batch_step => v_batch_step
,x_batch_step => x_batch_step
,x_unallocated_material => v_unallocated_material
,p_del_incomplete_manual => FALSE
,p_ignore_shortages => TRUE);
l_certify := true;
----- Save the changes
--gme_api_pub.save_batch(x_batch_header, v_return_status);
dbms_output.put_line( save_batch: status= ||
v_return_status);
commit;
else
rollback;
end if;
else
dbms_output.put_line( Certify step: status= ||
v_return_status|| , message= ||v_message_list);
rollback;
end if;
end if;
EXCEPTION
WHEN OTHERS THEN
RAISE;
END;
/
This example releases a batch step, records actual resource
usage and then completes the step. Assuming all operations are
successful, the changes are then saved using the save batch API
and the changes are committed.
Related Documents
Oracle Process Manufacturing Process Execution API User s Guide
<http://download-west.oracle.com/docs/cd/B25516_08/current/acrobat/115gmepea
piug.pdf>
-----------------------------------------------------------------------*Copyright 2003 Oracle. All rights reserved. Oracle is a registered
trademark of Oracle. Various product and service names referenced herein
may be trademarks of Oracle. All other product and service names
mentioned may be trademarks of their respective owners.*
*Disclaimer: This document is provided for information purposes only and
the contents hereof are subject to change without notice. Oracle does
not warrant that this document is error-free, nor does it provide any
other warranties or conditions, whether expressed orally or implied in
law, including implied warranties and conditions of merchantability or
fitness for a particular purpose. Oracle specifically disclaims any
liability with respect to this document and no contractual obligations
are formed either directly or indirectly by this document. This document
may not be reproduced or transmitted in any form or by any means,
electronic or mechanical, for any purpose, without the prior written
permission of Oracle.*
<#>
Was this article helpful?
Yes
No
<#>
<#>
Document Details
Email link to this document <#>Open document in new window

</epmos/faces/DocContentDisplay?id=380457.1>Printable Page <#>
Type:
Status:
Last Major Update:
Last Update:
WHITE PAPER
PUBLISHED
Jan 21, 2014
Jan 21, 2014
Currency Check Required.
Current Out of Date
<#>
Related Products
Oracle Process Manufacturing Process Execution

<#>
<#>
Information Centers
Loading Information Center

No Information Center available for this
document.
Information Center: Oracle Process Manufacturing [1393312.2]
</epmos/faces/DocumentDisplay?id=1393312.2&parent=WIDGET_INFORMATION_CENTER&sour
ceId=380457.1>
<#>
<#>
Document References
Loading Information Center
No References available for this documen
t.
<#>
<#>
Recently Viewed
Getting GME APIs to Work Using Vision Database Examples From Oracle
Support [380457.1]
</epmos/faces/DocumentDisplay?id=380457.1&parent=WIDGET_RECENTLY_VIEWED&sourceId
=>
FAQ: Inventory Standard Datafixes [568012.1]
=>
Transactions For Lot Controlled Items Missing Lot Transaction Records
[302026.1]
=>
MTL_MATERIAL_TRANSACTIONS_TEMP Error Messages, Meanings and Solutions
[1070343.1]
</epmos/faces/DocumentDisplay?id=1070343.1&parent=WIDGET_RECENTLY_VIEWED&sourceI
d=>
Import WIp Lot Transaction Fails With Error Msg "For This Transaction
Row Either the Lot Records are Missing..." [462822.1]
=>
Show More <#>
<#>
Didn t find what you are looking for?Ask in Community...
<#>
Related
Products
* Oracle E-Business Suite

</epmos/main/kmservlet?operation=doSearch&task=SearchProduct&type=line&id=LI
_3_F8H7JI&name=Oracle%20E-Business%20Suite&source=>
> Manufacturing
</epmos/main/kmservlet?operation=doSearch&task=SearchProduct&type=family&id=
FI_3_F8H7V6&name=Manufacturing&source=>
> Process Manufacturing
</epmos/main/kmservlet?operation=doSearch&task=SearchProduct&type=area&id=AI
_3_F8H7FQ&name=Process%20Manufacturing&source=>
> Oracle Process Manufacturing Process Execution
</epmos/main/kmservlet?operation=doSearch&task=SearchProduct&type=product&id
=PI_1_97JSZ&name=Oracle%20Process%20Manufacturing%20Process%20Execution&source=>
> API Issues
</epmos/main/kmservlet?operation=doSearch&task=SearchProduct&type=component&
id=CI_3_2OYN_7358&prodid=PI_1_97JSZ&name=API%20Issues&source=>
Back to TopBack to Top <#>
<#>
Copyright (c) 2015, Oracle. All rights reserved.
Legal Notices and Terms of Use
<http://www.oracle.com/pls/topic/lookup?ctx=mos_en&id=MOSHP983>
Privacy Statement
<http://www.oracle.com/us/legal/privacy/index.html>
<#>
OK
InformationRestore PaneWarningCritical ErrorCollapse

PaneInformationCritical ErrorWarningConfirmationErrorErrorConfirmation
OKCancel

Document 380457.1

Încărcat de

Informații document

Drepturi de autor

Formate disponibile

Partajați acest document

Partajați sau inserați document

Opțiuni de partajare

Vi se pare util acest document?

Este necorespunzător acest conținut?

Drepturi de autor:

Formate disponibile

Document 380457.1

Încărcat de

Drepturi de autor:

Formate disponibile

Skip to content

Global Search <#>

Give Feedback... <javascript:var newWin =

Customize Page... <#>

Click to add to Favorites <#>

Applications Version 11.5.10 CU 2.

Example 1: Creation of batch using the RECIPE creation mode <#head1>

p_api_version NUMBER DEFAULT gme_api_pub.api_version;

Example 2: Creation of batch by Product

* p_batch_header_validity_rule_id OR p_recipe_id OR (p_recipe_no and

Example 4: Create, Release and Save Batch

the batch is created and released, these changes are not

,p_recipe_no => JGC_1

Example 6: Insert_line_allocation API

Was this article helpful?

Email link to this document <#>Open document in new window

Oracle Process Manufacturing Process Execution

Loading Information Center

Loading Information Center

No References available for this documen

* Oracle E-Business Suite

InformationRestore PaneWarningCritical ErrorCollapse

S-ar putea să vă placă și