FND_PROGRAM API will be used to
register the concurrent program, executable, concurrent program parameters and
specifying incompatibilities for the concurrent program. It also contains
functions to check for the existence of concurrent programs, executable,
parameters, and incompatibility rules.
The programs/reports which are registered
using API can be run using standard report submission.
FND_PROGRAM API
FND_PROGRAM API is used to
register the concurrent program, executables from the back end i.e., by writing
in the PL/SQL packages. It also contains procedures and functions to check for
the existence of concurrent programs, executables, parameters, and
incompatibility rules and for deletion of the programs and executables.
It contains the following
procedures and functions.
1. EXECUTABLE
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’);
2. EXECUTABLE_EXISTS
This function returns true if
the concurrent program executable exists else returns false. It takes the
following input parameters.
FND_PROGRAM.EXECUTABLE_EXISTS
(executable_short_name IN
VARCHAR2,
application IN VARCHAR2);
3. REGISTER
This procedure is used to
register the concurrent program. It takes the following input parameters
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);
4. PROGRAM_EXISTS
This function returns true if
the concurrent program exists else returns false. It takes the following input
parameters.
FND_PROGRAM.PROGRAM_EXISTS
(program IN VARCHAR2,
application IN VARCHAR2);
5. PROGRAM_IN_GROUP
This function returns true if
the concurrent program is in a given request group. It takes the following
input parameters.
FND_PROGRAM.INCOMPATIBILITY_EXISTS
(program_short_name IN VARCHAR2,
application IN VARCHAR2,
request_group IN VARCHAR2,
group_application IN VARCHAR2);
6. PARAMETER
This procedure creates
parameters for the concurrent program. It takes the following input parameters.
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);
7. PARAMETER_EXISTS
This function returns true if
the concurrent program parameter exists. It takes the following input
parameters.
FND_PROGRAM.PARAMETER_EXISTS
(program_short_name IN VARCHAR2,
application IN VARCHAR2,
parameter IN VARCHAR2);
8. INCOMPATIBILITY
This procedure defines
incompatibilities for the concurrent program. It takes the following input
parameters.
FND_PROGRAM.INCOMPATIBILITY
(program_short_name IN VARCHAR2,
application IN VARCHAR2
inc_prog_short_name IN VARCHAR2,
inc_prog_applicationIN VARCHAR2,
scope IN VARCHAR2 DEFAULT ’Set’);
9. INCOMPATIBILITY_EXISTS
This function returns true if
the incompatibility exists for the concurrent program. It takes the following
input parameters.
FND_PROGRAM.INCOMPATIBILITY_EXISTS
(program_short_name IN VARCHAR2,
application IN VARCHAR2,
inc_prog_short_name IN VARCHAR2,
inc_prog_applicationIN VARCHAR2);
10. ADD_TO_GROUP
This procedure is used to add
the concurrent program to request group so that the concurrent program can
submit from the responsibility for which the request group has assigned.
It takes the following input
parameters.
FND_PROGRAM.ADD_TO_GROUP
(program_short_name IN VARCHAR2,
program_application IN VARCHAR2,
request_group IN VARCHAR2,
group_application IN VARCHAR2);
