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 Release 11 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. Arguments (input)

FND_PROGRAM.MESSAGE
Summary
function FND_PROGRAM.MESSAGE return VARCHAR2;

Description Use the message function to return an error message. Messages are set when any validation (program) errors occur.

FND_PROGRAM.EXECUTABLE
Summary
procedure FND_PROGRAM.EXECUTABLE (executable application description execution_method IN IN IN IN VARCHAR2, VARCHAR2, VARCHAR2 DEFAULT NULL, VARCHAR2,

execution_file_name subroutine_name IN icon_name language_code

IN

VARCHAR2 DEFAULT NULL, VARCHAR2 DEFAULT NULL,

IN IN

VARCHAR2 DEFAULT NULL, VARCHAR2 DEFAULT 'US');

Description Use this procedure to define a concurrent program executable. This procedure corresponds to the "Concurrent Program Executable" window accessible from the System Administrator and Application Developer responsibilities. Arguments (input) Name of executable (for example, 'FNDSCRMT'). The short name of the executable's application, for example, 'FND'. Optional description of the executable. The type of program this executable uses. Possible values are 'Host', 'Immediate', 'Oracle Reports', 'PL/SQL Stored Procedure', 'Spawned', 'SQL*Loader', 'SQL*Plus'. execution_ The operating system name of the file. Required for all but Immediate file_name programs. This file name should not include spaces or periods unless the file is a PL/SQL stored procedure. subroutine_name Used only by Immediate programs. Cannot contain spaces or periods. icon_name Reserved for future use by internal developers only. Specify NULL. language_code Language code for the name and description, for example, 'US'. executable application description execution_ method

FND_PROGRAM.DELETE_EXECUTABLE
Summary
procedure FND_PROGRAM.DELETE_EXECUTABLE (executable application IN IN varchar2, varchar2);

Description Use this procedure to delete a concurrent program executable. An executable that is assigned to a concurrent program cannot be deleted. Arguments (input)

executable The short name of the executable to delete. application The short name of the executable's application, for example 'FND'.

FND_PROGRAM.REGISTER
Summary
procedure FND_PROGRAM.REGISTER (program application enabled short_name description executable_name executable_application execution_options priority save_output print cols rows style style_required printer request_type IN VARCHAR2, IN VARCHAR2, IN VARCHAR2, IN VARCHAR2, IN VARCHAR2 DEFAULT NULL, IN VARCHAR2, IN VARCHAR2, IN VARCHAR2 DEFAULT NULL, IN NUMBER DEFAULT NULL,

IN VARCHAR2 DEFAULT 'Y', IN VARCHAR2 DEFAULT 'Y', IN NUMBER IN NUMBER DEFAULT NULL, DEFAULT NULL,

IN VARCHAR2 DEFAULT NULL, IN VARCHAR2 DEFAULT 'N', IN VARCHAR2 DEFAULT NULL, IN VARCHAR2 DEFAULT NULL, IN VARCHAR2 DEFAULT NULL, IN VARCHAR2 DEFAULT 'N', IN VARCHAR2 DEFAULT 'N', IN VARCHAR2 DEFAULT 'N', IN VARCHAR2 DEFAULT 'TEXT',

request_type_application use_in_srs allow_disabled_values run_alone output_type

enable_trace restart nls_compliant icon_name language_code

IN VARCHAR2 DEFAULT 'N', IN VARCHAR2 DEFAULT 'Y', IN VARCHAR2 DEFAULT 'N', IN VARCHAR2 DEFAULT NULL, IN VARCHAR2 DEFAULT 'US' IN VARCHAR2, IN VARCHAR2, IN VARCHAR2);

mls_function_short_name mls_function_application incrementor

Description Use this procedure to define a concurrent program. This procedure corresponds to the "Concurrent Program" window accessible from the System Administrator and Application Developer responsibilities. Arguments (input) program application enabled short_name description executable_name executable_ application execution_ options priority save_output print cols rows style style_required printer request_type The user-visible program name, for example 'Menu Report'. The short name of the application that owns the program. The program application determines the Oracle user name used by the program. Specify either "Y" or "N". The internal developer program name. An optional description of the program. The short name of the registered concurrent program executable. The short name of the application under which the executable is registered. Any special option string, used by certain executables such as Oracle Reports. An optional program level priority. Indicate with "Y" or "N" whether to save the output. Allow printing by specifying "Y", otherwise "N". The page width of report columns. The page length of report rows. The default print style name. Specify whether to allow changing the default print style from the Submit Requests window. Force output to the specified printer. A user-defined request type.

request_type_ application use_in_srs allow_ disabled_values run_alone output_type enable_trace nls_compliant icon_name language_code mls_function_ short_name mls_function_ application incrementor

The short name of the application owning the request type. Specify "Y" to allow users to submit the program from the Submit Requests window, otherwise "N". Specify "Y" to allow parameters based on outdated value sets to validate anyway. Specify "N" to require current values. Program must have the whole system to itself. ("Y" or "N") The type of output generated by the concurrent program. Either "HTML", "PS", "TEXT" or "PDF". Specify "Y" if you want to always enable SQL trace for this program, "N" if not. Reserved for use by internal developers only. Use "N". Reserved for use by internal developers only. Use NULL. Language code for the name and description. The name of the registered MLS function. The short name of the application under which the MLS function is registered. The incrementor PL/SQL function name.

FND_PROGRAM.DELETE_PROGRAM
Summary
procedure FND_PROGRAM.DELETE_PROGRAM (program_short_name application IN IN varchar2, varchar2);

Description Use this procedure to delete a concurrent program. All references to the program are deleted as well. Arguments (input) program_short_ name The short name used as the developer name of the concurrent program. application The application that owns the concurrent program.

FND_PROGRAM.PARAMETER
Summary

procedure FND_PROGRAM.PARAMETER (program_short_name application sequence parameter description enabled value_set default_type default_value required enable_security range display display_size description_size IN VARCHAR2, IN IN IN IN IN IN IN IN IN IN IN IN IN IN VARCHAR2, NUMBER, VARCHAR2, VARCHAR2 DEFAULT NULL, VARCHAR2 DEFAULT 'Y', VARCHAR2, VARCHAR2 DEFAULT NULL, VARCHAR2 DEFAULT NULL, VARCHAR2 DEFAULT 'N', VARCHAR2 DEFAULT 'N', VARCHAR2 DEFAULT NULL, VARCHAR2 DEFAULT 'Y', NUMBER, NUMBER, NUMBER,

concatenated_description_size IN prompt token IN IN

VARCHAR2 DEFAULT NULL, VARCHAR2 DEFAULT NULL);

Description Creates a new parameter for a specified concurrent program. This procedure corresponds to the "Concurrent Program Parameters" window accessible from the System Administrator and Application Developer responsibilities. Attention: 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. Arguments (input) program_short_ name The short name used as the developer name of the concurrent program.

application sequence parameter description enabled value_set default_type default_value required enable_security range display display_size description_size concatenated_ description_size prompt token

The short name of the application that owns the concurrent program. The parameter sequence number that determines the order of the parameters. The parameter name. An optional parameter description. "Y" for enabled parameters; "N" for disabled parameters. The value set to use with this parameter. An optional default type. Possible values are 'Constant', 'Profile', 'SQL Statement', or 'Segment'. Only required if the default_type is not NULL. "Y" for required parameters, "N" for optional ones. "Y" enables value security if the value set permits it. "N" prevents value security from operating on this parameter. Optionally specify "High", "Low", or "Pair". "Y" to display the parameter, "N" to hide it. The length of the item in the parameter window. The length of the item's description in the parameter window. The Length of the description in the concatenated parameters field. The item prompt in the parameter window. The Oracle Reports token (only used with Oracle Reports programs).

FND_PROGRAM.DELETE_PARAMETER
Summary
procedure FND_PROGRAM.DELETE_PARAMETER (program_short_name application parameter IN IN IN varchar2, varchar2 varchar2);

Description Call this procedure to remove a parameter from a concurrent program. Arguments (input) program_short_ name The short name used as the developer name of the concurrent program. application The application that owns the concurrent program.

parameter

The parameter to delete.

FND_PROGRAM.INCOMPATIBILITY
Summary
procedure FND_PROGRAM.INCOMPATIBILITY (program_short_name application inc_prog_short_name inc_prog_application scope IN VARCHAR2, IN IN IN IN VARCHAR2 VARCHAR2, VARCHAR2, VARCHAR2 DEFAULT 'Set');

Description Use this procedure to register an incompatibility for a specified concurrent program. This procedure corresponds to the "Incompatible Programs" window accessible from the System Administrator and Application Developer responsibilities. Arguments (input) program_short_ name The short name used as the developer name of the concurrent program. application The short name of the application that owns the concurrent program inc_prog_ short_name The short name of the incompatible program. inc_prog_ application Application that owns the incompatible program. scope Either "Set" or "Program Only"

FND_PROGRAM.DELETE_INCOMPATIBILITY
Summary
procedure FND_PROGRAM.DELETE_INCOMPATIBILITY (program_short_name application inc_prog_short_name inc_prog_application IN IN IN VARCHAR2, IN VARCHAR2,

VARCHAR2, VARCHAR2);

Description

Use this procedure to delete a concurrent program incompatibility rule. Arguments (input) program_short_ name The short name used as the developer name of the concurrent program. application Application that owns the concurrent program inc_prog_ short_name Short name of the incompatible program to delete. inc_prog_ application Application that owns the incompatible program.

FND_PROGRAM.REQUEST_GROUP
Summary
procedure FND_PROGRAM.REQUEST_GROUP (request_group application code description IN VARCHAR2, IN VARCHAR2, IN VARCHAR2 DEFAULT NULL, IN VARCHAR2 DEFAULT NULL);

Description Use this procedure to create a new request group. This procedure corresponds to the master region of the "Request Groups" window in the System Administration responsibility. Arguments (input) request_group The name of the request group application The application that owns the request group. code An optional code for the request group. description An optional description of the request group.

FND_PROGRAM.DELETE_GROUP
Summary
procedure FND_PROGRAM.DELETE_GROUP (group application IN IN VARCHAR2, VARCHAR2);

Description Use this procedure to delete a request group. Arguments (input) request_group The name of the request group to delete. application The application that owns the request group.

FND_PROGRAM.ADD_TO_GROUP
Summary
procedure FND_PROGRAM.ADD_TO_GROUP (program_short_name program_application request_group group_application IN IN VARCHAR2, IN IN VARCHAR2, VARCHAR2,

VARCHAR2);

Description Use this procedure to add a concurrent program to a request group. This procedure corresponds to the "Requests" region in the "Request Groups" window in System Administration. Arguments (input) program_short_ name The short name used as the developer name of the concurrent program. program_ application The application that owns the concurrent program. request_group The request group to which to add the concurrent program. group_ application The application that owns the request group.

FND_PROGRAM.REMOVE_FROM_GROUP
Summary
procedure FND_PROGRAM.REMOVE_FROM_GROUP (program_short_name IN VARCHAR2,

program_application request_group group_application IN

IN IN

VARCHAR2, VARCHAR2, VARCHAR2);

Description Use this procedure to remove a concurrent program from a request group. Arguments (input) program_short_ name The short name used as the developer name of the concurrent program. program_ application The application that owns the concurrent program. request_group The request group from which to delete the concurrent program. group_ application The application that owns the request group.

FND_PROGRAM.PROGRAM_EXISTS
Summary
function FND_PROGRAM.PROGRAM_EXISTS (program application return boolean; IN IN VARCHAR2, VARCHAR2)

Description Returns TRUE if a concurrent program exists. Arguments (input) program The short name of the program application Application short name of the program.

FND_PROGRAM.PARAMETER_EXISTS
Summary
function FND_PROGRAM.PARAMETER_EXISTS (program_short_name IN VARCHAR2,

application parameter return boolean;

IN IN

VARCHAR2, VARCHAR2)

Description Returns TRUE if a program parameter exists. Arguments (input) program The short name of the program application Application short name of the program. parameter Name of the parameter.

FND_PROGRAM.INCOMPATIBILITY_EXISTS
Summary
function FND_PROGRAM.INCOMPATIBILITY_EXISTS (program_short_name application inc_prog_short_name inc_prog_application return boolean; IN IN IN IN VARCHAR2, VARCHAR2, VARCHAR2, VARCHAR2)

Description Returns TRUE if a program incompatibility exists. Arguments (input) program The short name of the first program application Application short name of the program. inc_prog_short_ name Short name of the incompatible program. inc_prog_ applicatoin Application short name of the incompatible program.

FND_PROGRAM.EXECUTABLE_EXISTS
Summary

function FND_PROGRAM.EXECUTABLE_EXISTS (executable_short_name IN application return boolean; VARCHAR2, IN VARCHAR2)

Description Returns TRUE if program executable exists. Arguments (input) program The name of the executable. application Application short name of the executable.

FND_PROGRAM.REQUEST_GROUP_EXISTS
Summary
function FND_PROGRAM.REQUEST_GROUP_EXISTS (request_group IN application return boolean; IN VARCHAR2, VARCHAR2)

Description Returns TRUE if request group exists. Arguments (input) program The name of the executable. application Application short name of the request group.

FND_PROGRAM.PROGRAM_IN_GROUP
Summary
function FND_PROGRAM.INCOMPATIBILITY_EXISTS (program_short_name IN VARCHAR2,

application request_group group_application return boolean;

IN IN IN

VARCHAR2, VARCHAR2, VARCHAR2)

Description Returns TRUE if a program is in a request group. Arguments (input) program The short name of the first program. application Application short name of the program. request_group Name of the request group. group_ application Application short name of the request group.

FND_PROGRAM.ENABLE_PROGRAM
Syntax:
procedure FND_PROGRAM_ENABLE_PROGRAM (short_name application ENABLED IN IN VARCHAR2,

VARCHAR2, IN VARCHAR2);

Description Use this procedure to enable or disable a concurrent program. Arguments (input) short_name The shortname of the program. application Application short name of the program. enabled Specify 'Y' to enable the program and 'N' to disable the program.