FND_CONCURRENT Package

FND_CONCURRENT.AF_COMMIT

function FND_CONCURRENT.AF_COMMIT;

FND_CONCURRENT.AF_COMMIT executes the COMMIT command for the specified rollback segment.

FND_CONCURRENT.AF_COMMIT has no arguments.

FND_CONCURRENT.AF_ROLLBACK

function FND_CONCURRENT.AF_ROLLBACK;

FND_CONCURRENT.GET_REQUEST_STATUS (Client or Server)

function FND_CONCURRENT.GET_REQUEST_STATUS

        (request_id	IN OUT number,
         application	IN varchar2 default NULL,
         program			IN varchar2 default NULL,
         phase			OUT varchar2,
         status			OUT varchar2,
         dev_phase		OUT varchar2,
         dev_status	OUT varchar2,
         message			OUT varchar2) 
return boolean;

Example

 call_status boolean;
        rphase      varchar2(80);
        rstatus     varchar2(80);
        dphase      varchar2(30);
        dstatus     varchar2(30);
        message     varchar2(240);

        call_status :=
                 FND_CONCURRENT.GET_REQUEST_STATUS(<Request_ID>, ‘‘, ‘‘,
                 rphase,rstatus,dphase,dstatus, message);
    end;

In the above example, rphase and rstatus receive the same phase and status values as are displayed on the Concurrent Requests form. The completion text of a completed request returns in a message.

Any developer who wishes to control the flow of a program based on a request‘s outcome should use the following values to compare the request‘s phase and status.

Possible values for dev_phase and dev_status are listed and described in the following table:

FND_CONCURRENT.WAIT_FOR_REQUEST (Client or Server)

function FND_CONCURRENT.WAIT_FOR_REQUEST  

(request_id IN number default NULL,
          interval   IN number default 60,
          max_wait   IN number default 0,
          phase      OUT varchar2,
          status     OUT varchar2,
          dev_phase  OUT varchar2,
          dev_status OUT varchar2,
          message    OUT varchar2) return  boolean;

FND_CONCURRENT.SET_COMPLETION_STATUS (Server)

function FND_CONCURRENT.SET_COMPLETION_STATUS  

(status		IN varchar2,
 message	IN varchar2) return boolean;

FND_FILE: PL/SQL File I/O

The FND_FILE package contains procedures to write text to log and output files. These procedures are supported in all types of concurrent programs.

For testing and debugging, you can use the procedures FND_FILE.PUT_NAMES and FND_FILE.CLOSE. Note that these two procedures should not be called from a concurrent program.

FND_FILE supports a maximum buffer line size of 32K for both log and output files.

Tip: This package is not designed for generic PL/SQL text I/O, but rather only for writing to request log and output files.

See: PL/SQL File I/O Processing

FND_FILE.PUT

procedure FND_FILE.PUT

 (which  IN NUMBER,
  buff	 IN VARCHAR2);

FND_FILE.PUT_LINE

procedure FND_FILE.PUT_LINE
 (which	IN NUMBER,
  buff	IN	VARCHAR2);

Example

Using Message Dictionary to retrieve a message already set up on the server and putting it in the log file (allows the log file to contain a translated message):

 FND_FILE.PUT_LINE( FND_FILE.LOG, fnd_message.get );

Putting a line of text in the log file directly (message cannot be translated because it is hardcoded in English; not recommended):

 fnd_file.put_line(FND_FILE.LOG,‘Warning: Employee ‘||
                     l_log_employee_name||‘ (‘||
                     l_log_employee_num ||
                          ‘) does not have a manager.‘);

FND_FILE.NEW_LINE

procedure FND_FILE.NEW_LINE
  (which	IN NUMBER,
	 LINES 	IN NATURAL := 1);

Example

To write two new line characters:

 fnd_file.new_line(FND_FILE.LOG,2);

FND_FILE.PUT_NAMES

procedure FND_FILE.PUT_NAMES
 	(p_log IN VARCHAR2,
   p_out IN VARCHAR2,
  (p_dir IN VARCHAR2);

Tip: FND_FILE.PUT_NAMES is meant for testing and debugging from SQL*Plus; it does nothing if called from a concurrent program.

BEGIN
	fnd_file.put_names(‘test.log‘, ‘test.out‘,
		‘/local/db/8.0.4/db-temp-dir/‘); 	
	fnd_file.put_line(fnd_file.output,‘Called stored 			
procedure‘); 
	/* Some logic here... */ 
	fnd_file.put_line(fnd_file.output, ‘Reached point A‘); 
	/* More logic, etc... */ 
	fnd_file.close;
END; 

Example

BEGIN
 fnd_file.put_names(‘test.log‘, ‘test.out‘,
  ‘/local/db/8.0.4/db-temp-dir/‘); 
 fnd_file.put_line(fnd_file.output,‘Called stored  
procedure‘); 
 /* Some logic here... */ 
 fnd_file.put_line(fnd_file.output, ‘Reached point A‘); 
 /* More logic, etc... */ 
 fnd_file.close;
END; 

FND_FILE.CLOSE

procedure FND_FILE.CLOSE;

Example

BEGIN
 fnd_file.put_names(‘test.log‘, ‘test.out‘,
  ‘/local/db/8.0.4/db-temp-dir/‘);    fnd_file.put_line(fnd_file.output,‘Called stored 
procedure‘); 
 /* Some logic here... */ 
 fnd_file.put_line(fnd_file.output, ‘Reached point A‘); 
 /* More logic, etc... */ 
 fnd_file.close;
END; 

Error Handling

The FND_FILE package can raise one exception, FND_FILE.UTL_FILE_ERROR, which is raised to indicate an UTL_FILE error condition. Specifically, the procedures FND_FILE.PUT, FND_FILE.PUT_LINE and FND_FILE.NEW_LINE can raise FND_FILE.UTL_FILE_ERROR if there is an error. In addition to this package exception, FND_FILE can also raise predefined PL/SQL exceptions such as NO_DATA_FOUND or VALUE_ERROR.

FND_FILE will raise a UTL_FILE_ERROR if it is not able to open or write to a temporary file. It is up to the concurrent program to error out or complete normally, after the FND_FILE.UTL_FILE_ERROR exception is raised. FND_FILE keeps the translated message in the message stack before raising the UTL_FILE_ERROR exception. Developers can get the message for FND_FILE errors and use it as a Request Completion text. It is up to the caller to get the message from the message stack by using the FND_MESSAGE routine within an exception handler.

The concurrent manager will keep all the temporary file creation errors in the request log file.

FND_PROGRAM: Concurrent Program Loaders

The FND_PROGRAM package includes procedures for creating concurrent program executables, concurrent programs with parameters and incompatibility rules, request sets, and request groups. The FND_PROGRAM package also contains functions you can use to check for the existence of concurrent programs, executables, parameters, and incompatibility rules.

The arguments passed to the procedures correspond to the fields in the Oracle Application Object Library forms, with minor exceptions. In general, first enter the parameters to these procedures into the forms for validation and debugging.

If an error is detected, ORA-06501: PL/SQL: internal error is raised. The error message can be retrieved by a call to the function fnd_program.message().

Some errors are not trapped by the package, notably "duplicate value on index".

Note that an exception is raised if bad foreign key information is provided. For example, delete_program() does not fail if the program does not exist, but does fail if given a bad application name.

FND_PROGRAM.MESSAGE

function FND_PROGRAM.MESSAGE return VARCHAR2;

FND_PROGRAM.EXECUTABLE

procedure FND_PROGRAM.EXECUTABLE

(executable     			IN	VARCHAR2,
	application				IN VARCHAR2,
	description				IN VARCHAR2 DEFAULT NULL,
	execution_method		IN	VARCHAR2,
	execution_file_name	IN	VARCHAR2 DEFAULT NULL,
	subroutine_name		IN VARCHAR2 DEFAULT NULL,
	icon_name				IN	VARCHAR2 DEFAULT NULL,
	language_code			IN VARCHAR2 DEFAULT ‘US‘);

FND_PROGRAM.DELETE_EXECUTABLE

procedure FND_PROGRAM.DELETE_EXECUTABLE

(executable		IN	varchar2,
	application		IN varchar2);

FND_PROGRAM.REGISTER

procedure FND_PROGRAM.REGISTER
 		(program							IN VARCHAR2,
		application  					IN VARCHAR2,
		enabled       					IN VARCHAR2,
		short_name	  					IN VARCHAR2,
		description	 					IN VARCHAR2 DEFAULT NULL,
		executable_name				IN VARCHAR2,
		executable_application 	IN VARCHAR2,
		execution_options				IN VARCHAR2 DEFAULT NULL,
		priority							IN NUMBER   DEFAULT NULL,
		save_output						IN VARCHAR2 DEFAULT ‘Y‘,
		print								IN VARCHAR2 DEFAULT ‘Y‘,
		cols								IN NUMBER   DEFAULT NULL,
		rows								IN NUMBER   DEFAULT NULL,
		style 							IN VARCHAR2 DEFAULT NULL,
		style_required					IN VARCHAR2 DEFAULT ‘N‘,
		printer							IN VARCHAR2 DEFAULT NULL,
		request_type					IN VARCHAR2 DEFAULT NULL,
		request_type_application 	IN VARCHAR2 DEFAULT NULL,
		use_in_srs						IN VARCHAR2 DEFAULT ‘N‘,
		allow_disabled_values		IN VARCHAR2 DEFAULT ‘N‘,
		run_alone						IN VARCHAR2 DEFAULT ‘N‘,
		output_type						IN VARCHAR2 DEFAULT ‘TEXT‘,
		enable_trace					IN VARCHAR2 DEFAULT ‘N‘,
		restart							IN VARCHAR2 DEFAULT ‘Y‘,
		nls_compliant					IN VARCHAR2 DEFAULT ‘N‘,
		icon_name						IN VARCHAR2 DEFAULT NULL,
		language_code					IN VARCHAR2 DEFAULT ‘US‘
		mls_function_short_name	IN VARCHAR2,
		mls_function_application	IN VARCHAR2,
		incrementor						IN VARCHAR2);

FND_PROGRAM.DELETE_PROGRAM

procedure FND_PROGRAM.DELETE_PROGRAM

(program_short_name	IN	varchar2,
    application			IN varchar2);

FND_PROGRAM.PARAMETER

procedure FND_PROGRAM.PARAMETER

(program_short_name 	IN	VARCHAR2,
	application				IN VARCHAR2,
	sequence  				IN NUMBER,
	parameter   			IN VARCHAR2,
	description 			IN VARCHAR2 DEFAULT NULL,
	enabled 					IN VARCHAR2 DEFAULT ‘Y‘,
	value_set 				IN VARCHAR2,
	default_type 			IN VARCHAR2 DEFAULT NULL,
	default_value   		IN VARCHAR2 DEFAULT NULL,
	required 				IN VARCHAR2 DEFAULT ‘N‘,
	enable_security 		IN VARCHAR2 DEFAULT ‘N‘,
	range 					IN VARCHAR2 DEFAULT NULL,
	display 					IN VARCHAR2 DEFAULT ‘Y‘,
	display_size 			IN NUMBER,
	description_size		IN NUMBER,
	concatenated_description_size IN NUMBER,
	prompt 					IN VARCHAR2 DEFAULT NULL,
	token  					IN VARCHAR2 DEFAULT NULL);

Tip: A newly added parameter does not show up in the SRS form until the descriptive flexfields are compiled. The program $FND_TOP/$APPLBIN/fdfcmp compiles the descriptive flexfields.

FND_PROGRAM.DELETE_PARAMETER

procedure FND_PROGRAM.DELETE_PARAMETER

(program_short_name 	IN varchar2,
   	application			IN varchar2
	   parameter	      IN	varchar2);

FND_PROGRAM.INCOMPATIBILITY

procedure FND_PROGRAM.INCOMPATIBILITY

(program_short_name 		IN VARCHAR2,
	application					IN VARCHAR2
	inc_prog_short_name		IN	VARCHAR2,
	inc_prog_application	IN VARCHAR2,
	scope             		IN VARCHAR2 DEFAULT ‘Set‘);

FND_PROGRAM.DELETE_INCOMPATIBILITY

procedure FND_PROGRAM.DELETE_INCOMPATIBILITY

 (program_short_name			IN	VARCHAR2,
		application	 				IN VARCHAR2,
		inc_prog_short_name  	IN VARCHAR2,
		inc_prog_application 	IN VARCHAR2);

FND_PROGRAM.REQUEST_GROUP

procedure FND_PROGRAM.REQUEST_GROUP

(request_group 	IN VARCHAR2,
 application		IN VARCHAR2,
	code 				IN VARCHAR2 DEFAULT NULL,
	description		IN VARCHAR2 DEFAULT NULL);

FND_PROGRAM.DELETE_GROUP

procedure FND_PROGRAM.DELETE_GROUP

(group			IN	VARCHAR2,
 application IN VARCHAR2);

FND_PROGRAM.ADD_TO_GROUP

procedure FND_PROGRAM.ADD_TO_GROUP

(program_short_name		IN	VARCHAR2,
    program_application	IN VARCHAR2,
    request_group			IN VARCHAR2,
    group_application		IN VARCHAR2);

FND_PROGRAM.REMOVE_FROM_GROUP

procedure FND_PROGRAM.REMOVE_FROM_GROUP

(program_short_name		IN	VARCHAR2,
    program_application	IN VARCHAR2,
    request_group			IN VARCHAR2,
    group_application		IN VARCHAR2);

FND_PROGRAM.PROGRAM_EXISTS

function FND_PROGRAM.PROGRAM_EXISTS

(program 		IN VARCHAR2,
 application	IN VARCHAR2)
return boolean;

FND_PROGRAM.PARAMETER_EXISTS

function FND_PROGRAM.PARAMETER_EXISTS

(program_short_name	IN VARCHAR2,
	application				IN	VARCHAR2,
	parameteR				IN	VARCHAR2)
return boolean;

FND_PROGRAM.INCOMPATIBILITY_EXISTS

function FND_PROGRAM.INCOMPATIBILITY_EXISTS

(program_short_name 		IN VARCHAR2,
	application 				IN	VARCHAR2,
	inc_prog_short_name		IN	VARCHAR2,
	inc_prog_application 	IN	VARCHAR2)
return boolean;

FND_PROGRAM.EXECUTABLE_EXISTS

function FND_PROGRAM.EXECUTABLE_EXISTS

(executable_short_name	IN VARCHAR2,
 application 					IN	VARCHAR2)
return boolean;

FND_PROGRAM.REQUEST_GROUP_EXISTS

function FND_PROGRAM.REQUEST_GROUP_EXISTS

(request_group	IN VARCHAR2,
 application		IN	VARCHAR2)
return boolean;

FND_PROGRAM.PROGRAM_IN_GROUP

function FND_PROGRAM.INCOMPATIBILITY_EXISTS

(program_short_name 	IN VARCHAR2,
	application				IN	VARCHAR2,
	request_group			IN	VARCHAR2,
	group_application		IN	VARCHAR2)
return boolean;

FND_PROGRAM.ENABLE_PROGRAM

procedure FND_PROGRAM_ENABLE_PROGRAM

(short_name 	IN VARCHAR2,
 application 	IN	VARCHAR2,
 ENABLED		IN	VARCHAR2);

FND_REQUEST Package

FND_REQUEST.SET_OPTIONS (Client or Server)

function FND_REQUEST.SET_OPTIONS

(implicit  IN varchar2 default ‘NO‘,
          protected IN varchar2 default ‘NO‘,
          language  IN varchar2 default NULL,
          territory IN varchar2 default NULL)
          return boolean;

FND_REQUEST.SET_REPEAT_OPTIONS (Client or Server)

function FND_REQUEST.SET_REPEAT_OPTIONS

(repeat_time 			IN varchar2 default NULL,
repeat_interval  	IN number default NULL,
repeat_unit      	IN varchar2 default ‘DAYS‘,
repeat_type      	IN varchar2 default ‘START‘
repeat_end_time  	IN varchar2 default NULL)
return boolean; 

FND_REQUEST.SET_PRINT_OPTIONS (Client or Server)

function FND_REQUEST.SET_PRINT_OPTIONS

(printer 			IN varchar2 default NULL,
style   		 	IN varchar2 default NULL,
copies  			IN number default NULL,
save_output  		IN boolean default TRUE,
print_together 	IN varchar2 default ‘N‘)
return boolean; 

Tip: Some print options that are set at the program level (i.e., using the Concurrent Programs form) cannot be overridden using this procedure. See the following argument descriptions to determine which print options can be overridden.

FND_REQUEST.SUBMIT_REQUEST (Client or Server)

function FND_REQUEST.SUBMIT_REQUEST

(application 		IN varchar2 default NULL,
program   			IN varchar2 default NULL,
description    	IN varchar2 default NULL,
start_time     	IN varchar2 default NULL,
sub_request    	IN boolean default FALSE
argument1,
argument2, ..., argument99,
argument100) return number; 

Tip: FND_REQUEST must know information about the user and responsibility from which the request is submitted. Therefore, this function only works from concurrent programs or forms within Oracle E-Business Suite.

FND_REQUEST.ADD_NOTIFICATION (Client or Server)

function FND_REQUEST.ADD_NOTIFICATION 
(user IN varchar2) return boolean; 

FND_REQUEST.SET_MODE (Server)

function FND_REQUEST.SET_MODE

 (db_trigger IN boolean) return boolean;

Note that a failure in the database trigger call of FND_REQUEST.SUBMIT_REQUEST does not roll back changes.

Example Request Submissions

/* Example 1 */

/* Submit a request from a form and commit*/
 :parameter.req_id := 
      FND_REQUEST.SUBMIT_REQUEST (
           :blockname.appsname,
           :blockname.program,
           :blockname.description,
           :blockname.start_time,
           :blockname.sub_req = ‘Y‘,
           123, NAME_IN(‘ORDERS.ORDER_ID‘), ‘abc‘, 
           chr(0), ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘,
           ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘,
           ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘,
           ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘,
           ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘,
           ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘,
           ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘,
           ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘,
           ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘,
           ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘, ‘‘);

IF :parameter.req_id = 0 THEN
    FND_MESSAGE.RETRIEVE;
    FND_MESSAGE.ERROR;
ELSE
  IF :SYSTEM.FORM_STATUS != ‘CHANGED‘ THEN
    IF app_form.quietcommit  THEN
      /*form commits without asking user to save changes*/
     fnd_message.set_name(‘SQLGL‘,
           ‘GL_REQUEST_SUBMITTED‘);
     fnd_message.set_TOKEN(‘REQUEST_ID‘,
            TO_CHAR(:PARAMETER.REQ_ID), FALSE);
     fnd_message.show;
    ELSE 
       fnd_message.set_name(‘FND‘, 
            ‘CONC-REQUEST SUBMISSION FAILED‘);
       fnd_message.error;
    END IF;
  ELSE
    DO_KEY(‘COMMIT_FORM‘);
    IF :SYSTEM.FORM_STATUS != ‘CHANGED‘ THEN
        /*commit was successful*/
        fnd_message.set_name(‘SQLGL‘,
           ‘GL_REQUEST_SUBMITTED‘);
        fnd_message.set_TOKEN(‘REQUEST_ID‘,
             TO_CHAR(:PARAMETER.REQ_ID), FALSE);
        fnd_message.show;
    END IF;
  END IF;
END IF;

/* Example 2 */

/* Submit a request where no setup is required */
declare
  req_id number;
begin
  req_id := FND_REQUEST.SUBMIT_REQUEST (‘FND‘,
              ‘FNDMDGEN‘, ‘Message File Generator‘,
              ‘01-NOV-02 00:00:00‘, FALSE, ...arguments...);
  if (req_id = 0) then
    /* Handle submission error */
    FND_MESSAGE.RETRIEVE;
    FND_MESSAGE.ERROR;
  else
    commit;
  end if;
end;

/* Example 3 */ 

/* Submit a request from a database trigger */
result := FND_REQUEST.SET_MODE(TRUE);
req_id := FND_REQUEST.SUBMIT_REQUEST (FND‘,
            ‘FNDMDGEN‘, ‘Message File  Generator‘,
            ‘01-NOV-02 00:00:00‘, FALSE, ...arguments...);
             

/* Example 4 */

/* Submit a request inserting NULL arguments.
   This call inserts 6 arguments with arguments 1, 3,
   4, and 6 being NULL */
req_id := FND_REQUEST.SUBMIT_REQUEST (‘FND‘,
                        ‘FNDPROG‘,
                        ‘Description of FNDPROG‘,
                        ‘01-FEB-01 00:00:00‘, FALSE,
                        ‘‘, ‘arg2‘, ‘‘, NULL, arg5, ‘‘);

/* Example 5 */

/* Submit a repeating request */
result := FND_REQUEST.SET_REPEAT_OPTIONS (‘‘, 4, ‘HOURS‘, ‘END‘);
req_id := FND_REQUEST.SUBMIT_REQUEST (‘CUS‘,
                          ‘CUSPOST‘, ‘Custom Posting‘,
                          ‘01-APR-01 00:00:00‘, FALSE,
                          ...arguments...);

Tip: You may not want to submit a request if FND_REQUEST.SET_REPEAT_OPTIONS returns failure. Thus, you may wish to test the result of FND_REQUEST.SET_REPEAT_OPTIONS before issuing the call to FND_REQUEST.SUBMIT_REQUEST.

/* Example 6 */

/* Submit a request for 5 copies of a menu report */
result := FND_REQUEST.SET_PRINT_OPTIONS (‘hqunx138‘,
                                         ‘Landscape‘,
                                          5,
                                         ‘Yes‘,
                                         FALSE);
req_id := FND_REQUEST.SUBMIT_REQUEST (‘FND‘,
                                ‘FNDMNRMT‘,
                                ‘‘,
                                ‘‘,
                               ‘N‘, 0, 101);

/* Example 7 */

/* Submit a protected request that repeats at noon */
result := FND_REQUEST.SET_OPTIONS (‘YES‘);
result := FND_REQUEST.SET_REPEAT_OPTIONS (‘12:00‘);
req_id := FND_REQUEST.SUBMIT_REQUEST (‘CUS‘,
                            ‘CUSPOST‘, ‘Custom Posting‘,
                            ‘01-APR-01 00:00:00‘, FALSE,
                             ... args ...);

FND_REQUEST_INFO and Multiple Language Support (MLS)

FND_REQUEST_INFO APIs can be used in multi-language support functions (MLS functions) to get information for a request.

A multi-language support function is a function that supports running concurrent programs in multiple languages, as well as territories and numeric character settings (".," for example). A user can submit a single request for a concurrent program and have that program run several times, each time with different values for the parameters for language, territory, and numeric character setting.

To enable this functionality, a developer creates an MLS function as a stored function in the database. When called, the function determines which languages are to be used for the concurrent program‘s data set and returns the list of language codes as a comma-delimited string. The string is then used by the concurrent manager to submit child requests for the concurrent program for each target language. The MLS function can do the same for territory and numeric character setting.

Note: The fnd_concurrent_request should reflect the three values for language, territory, and numeric character setting passed in a string format. This string format consists of a language code, optional territory, and optional numeric character separated by colons and a delimiter of a semicolon as shown in following examples:

“US:US:,.”

“US::.,;JA:JP:;KO:KR:.,”

“US: : ”

The MLS function can use the FND_REQUEST_INFO APIs to retrieve the concurrent program application short name, the concurrent program short name, and the concurrent request parameters if needed.

The developer registers the MLS function in the Concurrent Program Executable form, and then associates the registered MLS function with a concurrent program in the Concurrent Programs form.

FND_REQUEST_INFO.GET_PARAM_NUMBER

function GET_PARAM_NUMBER

(name				IN VARCHAR2,
param_num			OUT NUMBER);

FND_REQUEST_INFO.GET_PARAM_INFO

function GET_PARAM_INFO

(param_num		IN NUMBER,
	 name			OUT VARCHAR2);

FND_REQUEST_INFO.GET_PROGRAM

procedure GET_PROGRAM
(program_name	 		OUT VARCHAR2,
program_app_name		OUT VARCHAR2);

FND_REQUEST_INFO.GET_PARAMETER

function GET_PARAMETER

(param_num	IN NUMBER)
	return varchar2;

Example MLS Function

Suppose you have a concurrent program that will send each employee a report of his or her available vacation days. Assume that the concurrent program will accept a range of employee numbers as parameters. The employees all want to receive the vacation days report in their preferred language. Without an MLS function, the user who submits this concurrent program has to guess at all the preferred languages for the given range of employee numbers and select those languages while submitting the request. Selecting all installed languages might be a waste of resources, because output may not be required in all installed languages.

Assume you have an employees table (emp) with the following columns:

 emp_no number(15), 
     ...
     preferred_lang_code  varchar2(4),
     ...

Your concurrent program has two parameters for the range of employee numbers: parameter 1 is the starting emp_no and parameter 2 is the ending emp_no.

This MLS function could be used for other concurrent programs that have the same parameters for starting and ending employee numbers.

Example

CREATE OR REPLACE FUNCTION EMPLOYEE_LANG_FUNCTION RETURN VARCHAR2 IS
 
  language_string    varchar2(240); 
  start_value        varchar2(240); 
  end_value          varchar2(240); 

  CURSOR language_cursor (starting number, ending number) IS
     SELECT DISTINCT(preferred_lang_code) language_code 
      FROM  emp 
      WHERE emp_no BETWEEN starting AND ending 
      AND   preferred_lang_code IS NOT NULL; 

  BEGIN 

      -- Initialize the language string 
      language_string := null; 
  

      -- Get parameter values for starting and 
      -- ending EMP_NO 
      start_value := FND_REQUEST_INFO.GET_PARAMETER(1); 
      end_value  := FND_REQUEST_INFO.GET_PARAMETER(2); 

      FOR languages IN language_cursor(
                       to_number(start_value), 
                       to_number(end_value)) LOOP 

        IF( language_string IS NULL ) THEN 
           language_string := languages.language_code;
        ELSE 
           language_string := language_string || ‘,‘ ||
                         languages.language_code;
        END IF; 
      END LOOP; 
      RETURN (language_string); 
END EMPLOYEE_LANG_FUNCTION; 

FND_SET: Request Set Loaders

The FND_SET package includes procedures for creating concurrent program request sets, adding programs to a request set, deleting programs from a request set. and defining parameters for request sets.

The arguments passed to the procedures correspond to the fields in the Oracle Application Object Library forms, with minor exceptions. In general, first enter the parameters to these procedures into the forms for validation and debugging.

If an error is detected, ORA-06501: PL/SQL: internal error is raised. The error message can be retrieved by a call to the function fnd_program.message().

Some errors are not trapped by the package, notably "duplicate value on index".

Note that an exception is raised if bad foreign key information is provided. For example, delete_program() does not fail if the program does not exist, but does fail if given a bad application name.

See: Overview of Request Sets

FND_SET.MESSAGE

FND_SET.CREATE_SET

procedure FND_SET.CREATE_SET

 (name	                    	IN VARCHAR2,
	short_name                 	IN VARCHAR2,
	application                	IN VARCHAR2,
	description                	IN VARCHAR2 DEFAULT NULL,
	owner                      	IN VARCHAR2 DEFAULT NULL,
	start_date                 	IN DATE     DEFAULT SYSDATE,
	end_date                   	IN DATE     DEFAULT NULL,
	print_together             	IN VARCHAR2 DEFAULT ‘N‘,
	incompatibilities_allowed  	IN VARCHAR2 DEFAULT ‘N‘,
	language_code              	IN VARCHAR2 DEFAULT ‘US‘);

FND_SET.DELETE_SET

procedure FND_SET.DELETE_SET

(request_set 		IN VARCHAR2,
	application		IN VARCHAR2);

FND_SET.ADD_PROGRAM

procedure FND_SET.ADD_PROGRAM

(program                        IN VARCHAR2,
	program_application           IN VARCHAR2,
	request_set                   IN VARCHAR2,
	set_application               IN VARCHAR2, 
	stage                         IN VARCHAR2,
	program_sequence              IN NUMBER,
  	critical                      IN VARCHAR2 DEFAULT ‘Y‘,
	number_of_copies              IN NUMBER   DEFAULT 0,
	save_output                   IN VARCHAR2 DEFAULT ‘Y‘,
	style                         IN VARCHAR2 DEFAULT NULL,
	printer                       IN VARCHAR2 DEFAULT NULL);

FND_SET.REMOVE_PROGRAM

procedure FND_SET.REMOVE_PROGRAM

(program_short_name             IN VARCHAR2,
	program_application           IN VARCHAR2,
	request_set                   IN VARCHAR2,
	set_application               IN VARCHAR2,
	stage                         IN VARCHAR2,
	program_sequence              IN NUMBER);

FND_SET.PROGRAM_PARAMETER

procedure FND_SET.PROGRAM_PARAMETER

(program 						IN VARCHAR2,
	program_application    IN VARCHAR2,
	request_set           	IN VARCHAR2,
	set_application       	IN VARCHAR2,
	stage                 	IN VARCHAR2.
	program_sequence 			IN NUMBER,
	parameter					IN VARCHAR2,
	display                IN VARCHAR2 DEFAULT ‘Y‘,
	modify     					IN VARCHAR2 DEFAULT ‘Y‘,
 	shared_parameter     	IN VARCHAR2 DEFAULT NULL,
	default_type   			IN VARCHAR2 DEFAULT NULL,
	default_value   			IN VARCHAR2 DEFAULT NULL);

FND_SET.DELETE_PROGRAM_PARAMETER

procedure FND_SET.DELETE_SET_PARAMETER

program		            	IN VARCHAR2,
	program_application 	IN VARCHAR2,
	request_set	  		 		IN VARCHAR2 DEFAULT NULL,
  stage						  	IN VARCHAR2,
	set_application 			IN VARCHAR2,
	program_sequence  		IN NUMBER,
	parameter					IN VARCHAR2);

FND_SET.ADD_STAGE

procedure FND_SET.ADD_STAGE

(name								IN VARCHAR2,
request_set          			IN VARCHAR2,
set_application					IN VARCHAR2,
short_name	 						IN VARCHAR2,
description	       			IN VARCHAR2 DEFAULT NULL, 
display_sequence     			IN NUMBER,
function_short_name  			IN VARCHAR2 DEFAULT ‘FNDRSSTE‘
function_application 			IN VARCHAR2 DEFAULT ‘FND‘,
critical 							IN VARCHAR2 DEFAULT ‘N‘,
incompatibilities_allowed 	IN VARCHAR2 DEFAULT ‘N‘,
start_stage						IN VARCHAR2 DEFAULT ‘N‘,
language_code						IN VARCHAR2 DEFAULT ‘US‘);

FND_SET.REMOVE_STAGE

procedure FND_SET.REMOVE_STAGE

(request_set 			IN VARCHAR2,
	set_application	IN VARCHAR2,
  stage					IN VARCHAR2);

FND_SET.LINK_STAGES

procedure FND_SET.LINK_STAGES

(request_set 			IN VARCHAR2,
	set_application	IN VARCHAR2,
	from_stage			IN VARCHAR2,
	to_stage				IN VARCHAR2 DEFAULT NULL,
	success				IN VARCHAR2 DEFAULT ‘N‘,
	warning				IN VARCHAR2 DEFAULT ‘N‘,
	error					IN VARCHAR2 DEFAULT ‘N‘);

Tip: This procedure updates the specified links. Sets created by FND_SET.CREATE_SET have null links between stages by default.

FND_SET.INCOMPATIBILITY

 procedure FND_SET.INCOMPATIBILITY

(request_set					IN VARCHAR2,
	application					IN VARCHAR2,
	stage							IN VARCHAR2 DEFAULT NULL,
	inc_prog						IN VARCHAR2 DEFAULT NULL
	inc_prog_application	IN VARCHAR2 DEFAULT NULL,
	inc_request_set			IN VARCHAR2 DEFAULT NULL,
	inc_set_application		IN VARCHAR2 DEFAULT NULL,
	inc_stage					IN VARCHAR2 DEFAULT NULL);

Examples

1. Set X is incompatible with program Y:

   fnd_set.incompatibility(request_set=>‘X‘
                           application=>‘APPX‘
                           inc_prog_short_name=>‘Y‘,                                    inc_prog_application=>‘APPY‘); 
   

2. Set X is incompatible with set Y:

   fnd_set.incompatibility(request_set=>‘X‘,
                           application=>‘APPX‘,
                           inc_request_set=>‘Y‘,
                           inc_set_application=>‘APPY‘);
   

3. Set X is incompatible with stage 2 of set Y:

   fnd_set.incompatibility(request_set=>‘X‘,
                           application=>‘APPX‘,
                           inc_request_set=>‘Y‘,
                           inc_set_application=>‘APPY‘,
                           inc_stage_number=>2);
   

4. Stage 3 of set X is incompatible with program Y:

   fnd_set.incompatibility(request_set=>‘X‘,
                           application=>‘APPX‘,
                           stage_number=>3,
                           inc_prog_short_name=>‘Y‘,
                           inc_prog_application=>‘APPY‘);
          

FND_SET.DELETE_INCOMPATIBILITY

procedure FND_SET.DELETE_INCOMPATIBILITY
 (request_set	          	IN VARCHAR2,
	application	 				IN VARCHAR2,
	stage							IN VARCHAR2 DEFAULT NULL,
	inc_prog						IN VARCHAR2 DEFAULT NULL
	inc_prog_application	IN VARCHAR2 DEFAULT NULL,
	inc_request_set			IN VARCHAR2 DEFAULT NULL,
	inc_set_application		IN VARCHAR2 DEFAULT NULL,
	inc_stage					IN VARCHAR2 DEFAULT NULL);

FND_SET.ADD_SET_TO_GROUP

procedure FND_SET.ADD_SET_TO_GROUP
   (request_set		   IN VARCHAR2,
    set_application	IN VARCHAR2,
    request_group		IN VARCHAR2,
    group_application	IN VARCHAR2);

FND_SET.REMOVE_SET_FROM_GROUP

procedure FND_SET.REMOVE_SET_FROM_GROUP
(request_set				IN	VARCHAR2,
 set_application	 		IN VARCHAR2,
 request_group			IN VARCHAR2,
 group_application		IN VARCHAR2);

FND_SUBMIT: Request Set Submission

This document describes the FND_SUBMIT APIs for request set submission. The APIs are described in the order that they would be called. Some of these APIs are optional.

FND_SUBMIT.SET_MODE

function FND_SUBMIT.SET_MODE (db_trigger IN boolean) return boolean;

FND_SUBMIT.SET_REL_CLASS_OPTIONS

function FND_SUBMIT.SET_REL_CLASS_OPTIONS 

(application		IN varchar2 default NULL,
 class_name		IN varchar2 default NULL, 
 cancel_or_hold	IN varchar2 default ‘H‘,
 stale_date		IN varchar2 default NULL)  return boolean;

FND_SUBMIT.SET_REPEAT_OPTIONS

function FND_SUBMIT.SET_REPEAT_OPTIONS 	

(repeat_time			IN varchar2 default NULL,  	 
 repeat_interval		IN number default NULL,  	 
 repeat_unit			IN varchar2 default ‘DAYS‘, 	 
 repeat_type			IN varchar2 default ‘START‘,  	 
 repeat_end_time 	IN varchar2 default NULL)  	return boolean; 

FND_SUBMIT_SET.REQUEST_SET

function FND_SUBMIT.SET_REQUEST_SET 	

(application	IN VARCHAR2,  	 
 request_set	IN VARCHAR2)  return  boolean; 

FND_SUBMIT.SET_PRINT_OPTIONS

function FND_SUBMIT.SET_PRINT_OPTIONS 	

(printer		 	IN varchar2 default NULL,  	
style				IN varchar2 default NULL,  	
copies				IN number default NULL,  	
save_output		IN boolean default 	
print_together	IN varchar2 default ‘N‘)  return boolean;

FND_SUBMIT.ADD_PRINTER

function FND_SUBMIT.SET.ADD_PRINTER 
	
(printer 	IN varchar2 default null, 
 copies  	IN number default null)  return boolean; 

FND_SUBMIT.ADD_NOTIFICATION

function FND_SUBMIT.ADD_NOTIFICATION 	

(user IN varchar2) return boolean;

FND_SUBMIT.SET_NLS_OPTIONS

function FND_SUBMIT.SET_NLS_OPTIONS  	

(language  	IN varchar2 default NULL,  
 territory  	IN varchar2 default NULL) return boolean; 

FND_SUBMIT.SUBMIT_PROGRAM

function FND_SUBMIT.SUBMIT_PROGRAM  

(application	IN varchar2,   
 program		IN varchar2,   
 stage			IN varchar2,   
 argument1,...argument100)  return boolean;

FND_SUBMIT.SUBMIT_SET

function FND_SUBMIT.SUBMIT_SET  	

(start_time	IN varchar2 default null,  	 
 sub_request	IN boolean default FALSE)  return integer;

Examples of Request Set Submission

/* Example 1 */
/* To submit a Request set which is having STAGE1 and
STAGE2. STAGE1 is having ‘FNDSCARU‘ and ‘FNDPRNEV‘
programs. STAGE2 is having ‘FNDSCURS‘. */
/* set the context for the request set FNDRSTEST */
success := fnd_submit.set_request_set(‘FND‘, ‘FNDRSTEST‘);

		if ( success ) then
	
		/* submit program FNDSCARU which is in stage STAGE1 */
		success := fnd_submit.submit_program(‘FND‘,‘FNDSCARU‘,
 		‘STAGE1‘, CHR(0),‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,
							...arguments...);
  	if ( not success ) then
			raise submit_failed;
		end if;

		/* submit program FNDPRNEV which is in stage STAGE1 */
		success := fnd_submit.submit_program(‘FND‘,‘FNDPRNEV‘,
				‘STAGE1‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,
				CHR(0),‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,
				...arguments...);
		if ( not success ) then
			raise submit_failed;
		end if;

		/* submit program FNDSCURS which is in stage STAGE2 */
		success := fnd_submit.submit_program(‘FND‘,‘FNDSCURS‘,
					‘STAGE2‘, CHR(0),‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,
					...arguments...);
		if ( not success ) then
				raise submit_failed;
		end if;

		/* Submit the Request Set */
		req_id := fnd_submit.submit_set(null,FALSE);

end if;

/* Example 2 */
/* To submit a request set FNDRSTEST as a repeating request set.
Request set FNDRSTEST has STAGE1 and STAGE2. 
STAGE1 contains ‘FNDSCARU‘  and ‘FNDPRNEV‘ programs. 
STAGE2 has ‘FNDSCURS‘. */ 

   /* set the repeating options for the request set before
     calling the set_request_set  */ 
   success := fnd_submit.set_repeat_options( ‘‘, 4, ‘HOURS‘,     ‘END‘); 

   /* set the context for the request set FNDRSTEST */ 
   success := fnd_submit.set_request_set(‘FND‘, 
	‘FNDRSTEST‘); 

   if ( success ) then 

   /* submit program FNDSCARU which is in stage STAGE1 */ 
   success := fnd_submit.submit_program(‘FND‘,‘FNDSCARU‘, 
      ‘STAGE1‘, CHR(0),‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘, 
      ...arguments...); 
   if ( not success ) then 
     raise submit_failed; 
   end if; 

   /* submit program FNDPRNEV which is in stage STAGE1 */ 
     success := fnd_submit.submit_program(‘FND‘,‘FNDPRNEV‘,
	‘STAGE1‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,
	CHR(0),‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘, 
	...arguments...); 
      if ( not success ) then 
	raise submit_failed; 
      end if; 

   /* submit program FNDSCURS which is in stage STAGE2  */ 
   success := fnd_submit.submit_program(‘FND‘,‘FNDSCURS‘, 
	‘STAGE2‘, CHR(0),‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘, 
        ...arguments...); 
   if ( not success ) then 
      raise submit_failed; 
   end if; 

   /*  Submit the Request set  */ 
   req_id := fnd_submit.submit_set(null,FALSE); 

end if; 

/* Example 3 */
/* To submit a Request set  FNDRSTEST with 5 copies of the Print environment variables report.  Request set FNDRSTEST has STAGE1 and STAGE2.  STAGE1 has ‘FNDSCARU‘  and ‘FNDPRNEV‘ programs.  STAGE2 has ‘FNDSCURS‘. */ 
  
   /* set the context for the request set FNDRSTEST */ 
   success := fnd_submit.set_request_set(‘FND‘, ‘FNDRSTEST‘); 

   if ( success ) then 

      /* submit program FNDSCARU which is in stage STAGE1 */ 
      success := fnd_submit.submit_program(‘FND‘,‘FNDSCARU‘,
          ‘STAGE1‘, CHR(0),‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘, ...arguments...); 
   if ( not success ) then 
          raise submit_failed; 
   end if; 

   /* set the print options for the program */ 
   success := fnd_submit.set_print_options( ‘hqunx138‘, ‘Landscape‘, 5,
       ‘Yes‘, FALSE); 

   /* submit program FNDPRNEV which is in stage STAGE1 */ 
   success:= fnd_submit.submit_program(‘FND‘,‘FNDPRNEV‘, 
         ‘STAGE1‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,
         CHR(0),‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘, 
          ...arguments...); 
   if ( not success ) then 
       raise submit_failed; 
   end if; 

   /* submit program FNDSCURS which is in stage STAGE2  */ 
   success := fnd_submit.submit_program(‘FND‘,‘FNDSCURS‘,             ‘STAGE2‘, CHR(0),‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘,‘‘, 
         ...arguments...); 
   if ( not success ) then 
      raise submit_failed; 
   end if; 

   /*  Submit the Request set  */ 
   req_id := fnd_submit.submit_set(null,FALSE); 

end if; 

PL/SQL APIs for Concurrent Processing