Form Functions Window

Used to define new functions. A function is a part of an application's functionality that is registered under a unique name for the purpose of assigning it to, or excluding it from, a responsibility.

Description

Fields include:

Function

Users do not see this unique function name. However, you may use this name when calling your function programmatically. You should follow the naming conventions for functions.

User Function Name

Enter a unique name that describes your function. You see this name when assigning functions to menus. This name appears in the Top Ten List of the Navigator window.

Properties

Fields include:

Type

A function's type describes its use. A function's type is passed back when a developer tests the availability of a function. The developer can write code that takes an action based on the function's type.

Standard function types include the following:

ADFX External ADF Application. Used for linking an external Application Developer Framework (ADF) 11g application deployed on an Oracle Application Server 11g container from the Oracle E-Business Suite home page.
DBPORTLET Database provider portlet.
FORM Oracle E-Business Suite form functions are registered with a type of FORM.
JSP Functions used for some products in the Oracle Self-Service Web Applications. These are typically JSP functions.
REST REST service.
SERVLET Servlet functions used for some products in the Oracle Self-Service Web Applications.
SUBFUNCTION Subfunctions are added to menus (without prompts) to provide security functionality for forms or other functions.
WEBPORTLET Web provider portlet.
WWK Functions used for some products in the Oracle Self-Service Web Applications. These are typically PL/SQL functions that open a new window.
WWR or WWL Functions used for some products in the Oracle Self-Service Web Applications.
WWJ OA Framework JSP portlet.
WWW Functions used for some products in the Oracle Self-Service Web Applications. These are typically PL/SQL functions.

For information on functions used by Oracle Application Framework, see the Oracle Application Framework Developer's Guide, available from My Oracle Support Knowledge Document 1315485.1.

Maintenance Mode Support

This field should not be used. Maintenance Mode is disabled in an online patching-enabled environment.

Context Dependence

In general, the context dependence determines the required context for the function to work properly. The context dependence controls whether the user must choose a specified context (if not already in that context) before executing the function.

For example, some functions are controlled by profile options that affect what the user can perform within the current context. Types of context dependence are:

Form

Fields include the following:

Form/Application

If you are defining a form function, select the name and application of your form.

Parameters

Enter the parameters you wish to pass to your function. Separate parameters with a space.

For an executable (form) function:

For a concurrent program submitted through the Standard Request Submission form, the following syntax may be used:

TITLE="appl_short_name:message_name"

where appl_shortname:message_name is the name of a Message Dictionary message. See: Customizing the Submit Requests Window using Codes.

Warning: In general, system administrators should not modify parameters passed to predefined functions for Oracle E-Business Suite products. The few exceptions are documented in the relevant manuals or product notes.

Web HTML

The fields in the Web HTML and Web Host are only required if your function will be accessed from Oracle Application Framework. You do not need to enter any of these fields for functions based on Oracle Developer forms.

HTML Call

The last section of your function URL is the HTML Call. The HTML Call is used to activate your function. The function may be either a static web page or a procedure.

The syntax for this field depends on the function type.

For functions used with Mobile Application Server, enter the full name of your java class file, including <package name>.<class name>. The class name and package name are case sensitive. Mobile Application Server will try to load this class from the classpath as it is. For example, 'oracle.apps.mwa.demo.hello.HelloWorld'.

Web Host

The fields in the Web HTML and Web Host are optional and only enabled for some types of functions. These fields apply only to Oracle Application Framework functions.

Host Name

The URL (universal resource locator) or address required for your function consists of three sections: the Host Name, Agent Name, and the HTML Call. The Host name is the IP address or alias of the machine where the Web server is running.

Agent Name

The second section of your function URL is the Oracle Web Agent. The Oracle Web Agent determines which database is used when running your function. Defaults to the last agent used.

Icon

Enter the name of the icon used for this function. If the function will be in the "Level 1" menu, provide the name of a seeded icon to assign to the function. The icon file must reside in the $OA_MEDIA directory. This icon displays when the profile FND: Top-Level Menu Display Mode is set to display the "Level 1" menu as icons and links, when the function appears in the global header, or when the function is a favorite on the simplified home page.

Secured

Secured is only required when your function is accessed by Oracle Workflow. Checking Secured enables recipients of a workflow email notification to respond using email.

Encrypt Parameters

Checking Encrypt Parameters adds a layer of security to your function to ensure that a user cannot access your function by altering the URL in their browser window. You must define Encrypt Parameters when you define your function to take advantage of this feature.

Region

The fields on this page are for future use.