7 Creating Applications

This section describes how to use Application Builder to build an application and application components. It includes instructions for creating an application and adding pages as well as adding components (reports, charts, or forms), page controls (buttons, items, list of values), and shared components (breadcrumbs, lists, or tabs).

Topics:

About Creating Applications

An application is a collection of pages that enable you to manage and display data in an Oracle database. You create two different types of applications in Application Builder: Database Applications or Websheet applications.

Topics:

Understanding the Difference Between Database and Websheet Applications

You create both database applications and Websheet applications using the Create Application Wizard. The main difference between these two types of applications is the intended audience. While database applications are geared toward application developers, Websheet applications are designed for end users with no development experience.

About Database Applications

To create a database application, an application developers use wizards to declaratively assemble content into pages. Individual pages are organized using containers called regions. Regions can contain text, custom PL/SQL, reports, charts, maps, calendars, web service references, or forms. Forms are made up of fields (called items) which can be selected from the multitude of built-in types (such as text fields, text areas, radio groups, select lists, check boxes, date pickers, and popup list of values). Developers can also create their own types using plug-ins. In many instances, update functionality is built-in and PL/SQL can be used to process data. Session state (or application context) is transparently managed and the user interface presentation is separated from the application logic enabling developers to manage the look and feel of an application by simply by selecting a different theme. See "About Creating a Database Application".

About Websheet Applications

By creating Websheet applications, end users can manage structured and unstructured data without developer assistance. Page sections contain unstructured data which can edited using a WYSIWYG editor. Data Grids enable users to manage structured data without the need for writing SQL. Using runtime dialog boxes, users can add columns, rename columns, and validations. Each page and row of data grid data can be annotated with files, tags, notes, and links. Pages can contain sections as well as reports and data grids and everything can be linked together using navigation. All information is searchable and completely controlled by the end-user. See "About Creating a Websheet".

About the Create Application Wizard

By using the Create Application Wizard, you can create a complete Oracle Application Express application containing multiple pages. To run the Create Application Wizard, click the Create button on the Application Builder home page.

Key Decision Points in the Create Application Wizard

When you run the Create Application Wizard, the wizard prompts you to choose the type of application you wish to create. Available options include:

  • Database. Database applications enable developers to have full control over all aspects of development process and final application functionality. With database applications, developers can directly leverage their SQL and PL/SQL programming skills. Database applications use declarative control over flow control and support full user interface controls through the use of templates and themes. See "About Database Applications" and "About Creating a Database Application".

  • Websheet. Websheet applications enable users to build data centric applications without any SQL programming knowledge. Websheet applications are simplified and support pages, data grids, and reports. These applications are easy to build and support community contributions. For more information on websheet applications, click the Learn more... button on the Application Express home page. See "About Database Applications" and "About Creating a Websheet".

  • Sample Applications. Oracle Application Express installs with a number of sample applications. Use these applications to learn more about the different types of functionality you can include in your applications. See "Understanding the Sample Application".

About Creating a Database Application

By using the Create Application Wizard, you can create a complete Oracle Application Express application containing multiple pages including reports, interactive reports, forms, tabular forms, and master detail forms. The Create Application Wizard is designed to easily and quickly create basic Oracle Application Express application. After you create an application using this wizard, you can modify pages and add additional pages Create Page Wizard. See "About Creating Pages in a Database Application".

You can use the Create Application Wizard to create blank pages, or pages based on SQL queries or existing database tables. Applications based on tables can consist of a simple report, a form and report, or a tabular form. To learn more, see "Creating Reports" and "Creating Forms". You can create SQL queries by manually typing SQL, or by using the graphical user interface of Query Builder.

At the workspace level, you have the option of setting defaults that are used for applications built in that workspace. Setting these defaults enables you to exit the wizard without paging through each step. When you exit the wizard, the application you create uses the values you specified as defaults.

See Also:

"Building Queries with Query Builder"in Oracle Application Express SQL Workshop Guide and "Leveraging Application Builder Defaults" in Oracle Application Express Administration Guide

Topics:

Creating an Application From Scratch

You can create an application based on a table, query, or drill-down query by selecting Create Application in the Create Application Wizard.

To create an application based on a table, query, or drill-down query:

  1. On the Workspace home page, click the Application Builder icon.

  2. Click the Create button.

  3. For Application Type, select Database.

  4. For Method, select From Scratch.

  5. For Name, enter the following and click Next:

    1. Name - Enter a name to identify the application.

    2. Application - Enter a unique integer value to identify the application. Note that Application IDs between 3000 to 9000 are reserved for internal use.

    3. Create Application - Select a creation method:

      • Select From scratch to manually add all pages

      • Select Based on existing application design model to copy page definitions from a previous application model.

        Note that you will still have to define all other application attributes, or you can choose to copy some attributes by choosing to copy shared components from another application (See step 7 and "About Application Models and User Interface Defaults").

    4. Schema - Your application will obtain its privileges by parsing all SQL as a specific database schema. Identify the database schema owner.

    Next, add pages to your application.

  6. For Pages:

    1. Select the type of page you want to add:

      • Blank creates a page with no built-in functionality.

      • Report creates a page that contains the formatted result of a SQL query. You can choose to build a report based on a table you select, or based on a custom SQL SELECT statement or a PL/SQL function returning a SQL SELECT statement that you provide.

      • Form creates a form to update a single row in a database table.

      • Report and Form builds a two page report and form combination. On the first page, users select a row to update. On the second page, users can add a record or update or delete an existing record.

      • Tabular Form creates a form to perform update, insert, and delete operations on multiple rows in a database table.

      • Master Detail creates a form that displays a master row and multiple detail rows within a single HTML form. With this form, users can query, insert, update, and delete values from two tables or views.

      • Chart creates a page with a flash chart to represent the result of a SQL query.

      Action displays the currently selected page type. For each selection, the wizard prompts you for different types of information, such as selecting a table name or report implementation.

    2. Click Add Page.

      The page (or pages) appear at the top of the page. To delete a page, click the Delete icon.

    3. Repeat the previous steps until all pages have been added.

    4. Click Next.

      Tip:

      To exit this wizard early and utilize Application Builder Defaults, click the Create button. To configure Application Builder Defaults, see "Leveraging Application Builder Defaults" in Oracle Application Express Administration Guide.
  7. For Tabs, determine whether to include tabs in your application and click Next.

  8. For Shared Components, determine whether to import shared components from another application. Shared components are common elements that can display or be applied on any page within an application.

    To include shared components, select the following:

    1. Copy Shared Components from Another Application - Select Yes.

    2. Copy from Application - Select the application from which you want to import shared components.

    3. Select Components to Import - Select the components to import.

    4. Click Next.

    Next, select a default authentication scheme. Authentication is the process of establishing a user's identity before they can access an application. See "Establishing User Identity Through Authentication".

  9. For Authentication Scheme, select one of the following:

    • Application Express - Uses the user account credentials created and maintained with the Application Express Service Administration application. These are the accounts you use to log in to the Application Express development environment. You can also create accounts in this user account repository for end users of your applications.

    • No Authentication - Also known as database authentication, this option enables users to access your application using the account credentials stored in the modplsql DAD definition. In most cases this results in users not having to login when accessing your application. This is the quickest way to create a "public" application.

    • Database Account - Requires users logging into your application to enter a database schema name (or user name) and a password in order to authenticate. This account information is managed entirely within the Oracle database.

  10. Next, select the following globalization preferences:

    1. Language - Select the primary language for this application.

      This attribute identifies the language in which an application is developed. This language is the base language from which all translations are made.

    2. User Language Preference Derived From - Specifies how the engine determines the application language. The application primary language can be static (that is, derived from the Web browser language) or determined from a user preference or item. The database language setting determines date display and sorting characteristics.

      You can alter the Language and User Language Preference Derived From attributes later on the Edit Globalization attributes page. See "Configuring Globalization Attributes".

    3. Date Format - Specifies the date format to be used in the application.

      This date format is used to alter the NLS_DATE_FORMAT database session setting before showing or submitting any page within the application. This value can be a literal string containing a valid Oracle date format mask or an item reference via substitution syntax. If no value is specified, the default date format is derived from the database session at runtime. If supplied, this is also used as the date format for any items resulting from columns of type DATE.

    4. Click Next.

  11. For User Interface, select a theme and click Next.

    Themes are collections of templates that can be used to define the layout and style of an entire application. See "Managing Themes".

  12. Confirm your selections and click Create.

Creating an Application from a Spreadsheet

You can create an application based on spreadsheet data by selecting Create from Spreadsheet in the Create Application Wizard.

To create an application from spreadsheet data:

  1. On the Workspace home page, click the Application Builder icon.

  2. Click the Create button.

  3. For Application Type, select Database.

  4. Select From Spreadsheet.

  5. For Load Method, specify how spreadsheet data will be uploaded. Select one of the following and click Next:

    1. Upload file, comma separated (*.csv) or tab delimited. Specify the following and click Next:

      • Text File - Click Browse to locate the file to be uploaded.

      • Separator - Specify the column separator character. Use \t for tab separators.

      • Optionally Enclosed By - Enter a delimiter character. You can use this character to deliminate the starting and ending boundary of a data value. If you specify a delimiter character, the wizard ignores white space occurring before the starting and ending boundary of a data value. You can also use this option to enclose a data value with the specified delimiter character.

      • File Character Set - Choose the character set in which the text file is encoded.

    2. Copy and paste. Copy and paste the tab delimited data you want to import.

  6. For Table Properties, review how your table will display and click Next. Specify the table name and column names, or modify the data types. To specify whether to include a column, make a selection from the Upload list.

  7. For User Interface Defaults:

    1. Review the displayed Singular Name and enter a Plural Name.

    2. (Optional) Under Column User Interface Defaults, review the displayed column labels.

    3. Click Next.

  8. For Application Options, specify the following:

    1. Application Name - Enter an alphanumeric name for this application.

    2. Create Mode:

      • Read and Write includes insert and update pages.

      • Read Only does not include insert and update pages.

    3. Report Implementation:

      • Classic creates a SQL report.

      • Interactive creates an interactive report.

    4. Click Next.

  9. For User Interface Theme, select a theme and click Next.

    Themes are collections of templates that can be used to define the layout and style of an entire application. See "Managing Themes".

  10. Confirm your selections and click Create.

See Also:

"Building Queries with Query Builder" in Oracle Application Express SQL Workshop Guide

Copying a Database Application

To copy an application:

  1. On the Workspace home page, click the Application Builder icon.

  2. Select an application.

    The Application home page appears.

  3. From the Tasks list, click Copy this Application.

  4. On Copy Application:

    1. Enter a new application ID.

    2. Enter a new application name.

    3. Specify whether to copy supporting object definitions.

    4. Click Next.

  5. Click Copy Application.

Deleting a Database Application

You can delete an application from within Application Builder, or while editing application attributes. If you delete an application you also delete all defined components (reports, charts, or forms), page controls (buttons, items, list of values), and shared components (breadcrumbs, lists, and tabs, but not user interface defaults).

Topics:

Deleting an Application from the Application Builder Home Page

To delete an application from Application Builder:

  1. On the Workspace home page, click the Application Builder icon.

  2. Select an application.

  3. When Application Builder appears, verify the application ID and name at the top of the page.

  4. On the Tasks list, click Delete this Application.

  5. When prompted, click Permanently Delete Now.

Deleting an Application from the Edit Application Page

To delete an application from the Edit Application page:

  1. On the Workspace home page, click the Application Builder icon.

  2. Select an application.

  3. Click the Edit Application Properties button to the right of the application name.

    The Edit Application page appears.

  4. Verify the application ID and name.

  5. Click Delete at the top of the page.

  6. When prompted, click Permanently Delete Now.

About Application Models and User Interface Defaults

The Create Application Wizard is designed with the assumption that the developer may run it multiple times. To facilitate this iterative approach to application development, every time you run the wizard it saves the page definitions to an application model.

Consider the following example. You create an application by running the Create Application Wizard. After viewing the application, you realize it is not quite what you wanted. Instead of altering it, you can run the wizard again and select an application model. By selecting an existing application model when you rerun the wizard, you can quickly improve your application with minimal time and effort.

See Also:

"Managing Application Models" in Oracle Application Express Administration Guide

Another way to increase your productivity when creating an application is to specify user interface defaults. User interface defaults are metadata that enable you to assign default user interface properties to a table, column, or view within a specified schema.

See Also:

"Managing User Interface Defaults" in Oracle Application Express SQL Workshop Guide

Leveraging Application Models and User Interface Defaults

You can increase your productivity when creating applications by leveraging application models and user interface defaults. Consider the following scenario:

  1. Create an application based on tables or views by running the Create Application Wizard.

  2. Run the generated application. Note any functional deficiencies.

  3. Evaluate whether to create or edit user interface defaults.

    For example, you can use user interface defaults to control how form field or report labels display. You can also utilize user interface defaults to display specific columns or have columns display in an alternate order.

  4. Navigate to the Application home page and create an application by clicking Create.

  5. Select Create Application.

  6. When prompted to enter application details, specify the following:

    1. Name - Enter a name to identify the application.

    2. Application - Enter a unique integer value to identify the application, or accept the default.

    3. Create Application - Select Based on existing application design model.

  7. Select an application model.

    Note the pages you previously created already appear.

  8. Add pages, edit pages, or remove pages.

  9. Complete the wizard.

  10. Repeat steps 2 through 9 until the application meets your functional requirements.

About Creating a Websheet

Websheet applications enable end users to manage structured and unstructured data without developer assistance. This section offers an overview of Websheet functionality.

Topics:

About Websheets

Websheets enable end users to easily share content using a Web browser. Users can organize pages into a hierarchical structure and cross link pages using a simple page name syntax.

Users can display and manage tabular data Data Grids. They can create interactive reports using SQL or by utilizing existing structures within your database. Users can annotate pages using files, tags, and notes and upload inline images. All Websheet pages feature built-in search capability. Using built-in Access Control functionality, you can manage read and write privileges based on three predefined user types: reader, contributor, or administrator.

To learn more about Websheets, click the Help link within a running Websheet.

Creating a Websheet

To create a Websheet application:

  1. On the Workspace home page, click the Application Builder icon.

  2. Click the Create button.

  3. For Application Type, select Websheet.

  4. For Define Application, enter the following and click Next:

    1. Name - Enter a name to identify the application.

    2. Application - Enter a unique integer value to identify the application. Note that Application IDs between 3000 to 9000 are reserved for internal use.

    3. Create Application:

      • Name - Enter a name to identify the application.

      • Application - Enter a unique integer value to identify the application. Note that Application IDs between 3000 to 9000 are reserved for internal use.

      • Description - Enter a description.

    4. Home Page Section:

      • Title - Enter a page section title.

      • Content - Enter initial page section content. Note this can be easily edited at a later time.

  5. Confirm your selections and click Create.

    To view a rendered version of your application, you run or submit it to the Application Express engine.

  6. To view a rendered version of your application:

    1. Click Run.

    2. Enter your Websheet credentials (that is, username and password). By default, your Websheet credentials are the same as you workspace login credentials.

    3. Click Login.

  7. To edit Websheet properties, click Edit Properties.

Running a Websheet from Application Builder

As with database applications, to view a rendered version of a Websheet, you run it.

Topics:

Running a Websheet from the Application Builder Home Page

To run an entire application from the Application Builder home page:

  1. On the Workspace home page, click the Application Builder icon.

  2. From the View list, select Report and click Go.

  3. Locate the application in the Applications list.

  4. Click the Run icon in the far right column.

  5. Enter your Websheet credentials (that is, username and password). By default, your Websheet credentials are the same as you workspace login credentials.

  6. Click Login.

Running a Websheet from the Application Home Page

To run an entire application from the Application home page:

  1. On the Workspace home page, click the Application Builder icon.

    The Application Builder home page appears.

  2. Select a Websheet application.

  3. Click the Run icon.

  4. Enter your Websheet credentials (that is, username and password). By default, your Websheet credentials are the same as you workspace login credentials.

  5. Click Login.

Returning to the Oracle Application Express Development Environment

To return to Oracle Application Express after running a Websheet:

  • Within a running Websheet, click the Return to Oracle Application Express Development Environment to the left of the Help link.

    Description of dev_return_ico.gif follows
    Description of the illustration dev_return_ico.gif

    If you were previously logged in to Oracle Application Express with developer privileges, the Application Builder home page appears

Tip:

You can also click the Logout link. When the Login page appears, click the Oracle Application Express Development link and then e-enter your workspace credentials.

About Adding Websheet Content

Websheets may contain three different types of content:

  • Page - Displays text, navigation, data, or chart sections. Text sections are managed using a built-in WYSIWIG editor.

  • Data Grid - Set of tabular data displayed as editable and managed through APEX$ tables.

  • Report - Queries against database objects you have access to.

Tip:

To learn more about adding Websheet content, click the Help link within a running Websheet.

Creating a Data Grid

A data grid is a contributor defined set of tabular data. In other words, a data grid is a Web-based spreadsheet. You can create a data grid by defining the structure (that is, the column names, data types, and basic validations) or by pasting in spreadsheet data.

To create a data grid:

  1. Log in to and run the Websheet.

  2. Under Page, click New Data Grid.

  3. For Creation Method, select one of the following and click Next.

    • From Scratch - Enables you to specify column names, data types, and basic validation.

    • Copy and Paste - Enables you to copy and paste spreadsheet data.

  4. Follow the on-screen instructions.

Managing Pages in a Database Application

A page is the basic building block of an application. When you build an application in Application Builder, you create pages that contain user interface elements, such as tabs, lists, buttons, items, and regions.

Topics:

About Creating Pages in a Database Application

You add a page or add a component to an existing page by running the Create Page Wizard. You can access this wizard by:

Note:

You can also use the Create Page Wizard to add a component (that is, a report, chart, form, wizard, a calendar, or tree) to an existing page. When prompted, specify an existing page number.

Creating a Page from the Application Home Page

To create a page from the Application home page:

  1. On the Workspace home page, click Application Builder.

  2. Select an application.

    The Application home page appears.

  3. Click the Create Page button.

  4. Select the type of page you want to create as described in the following table.

    Page Type Description
    Blank Page Creates a blank page.
    Multiple Blank Pages Creates multiple blank pages.
    Report Formatted result of a SQL query. Available options:
    • Classic Report - Creates a report based on a custom SQL SELECT statement or a PL/SQL function returning a SQL SELECT statement that you provide.

    • Interactive Report - Creates an interactive report based on a custom SQL SELECT statement you provide. Users can alter the layout of report data by selecting specific columns, applying filters, highlighting, and sorting. They can also define breaks, aggregations, different charts, and their own computations.

    • Report on Web Service Result - Creates a report on a Web Service result.

    • Wizard Report - Creates a report without requiring any SQL knowledge. Select the appropriate schema, table, columns, and result set display.

    See Also: "Creating Reports" and "Implementing Web Services"

    Chart Enables you to create HTML and Flash graphical charts.

    See Also: "Creating Charts"

    Form Creates a form interface with which users can update a single row or multiple rows within a table.

    See Also: "Creating Forms"

    Wizard Create a wizard.
    Calendar Generates a calendar with monthly, weekly, and daily views.

    See Also: "Creating Calendars"

    Tree Creates a a tree to graphically communicate hierarchical or multiple level data.

    See Also: "Creating Trees"

    Login Page Creates a login page.

    See Also: "Building a Login Page"

    Access Control Creates a page containing a access control list, enabling developers to control access to an application, individual pages, or page components.

    See Also: "Controlling Access to Applications, Pages, and Page Components"

    Map Creates a Flash map based on the AnyChart AnyMap Interactive Maps Component.

    See Also: "Creating Maps"

    Feedback Page Adds a feedback page. Feedback is the process of gathering real-time comments, enhancement requests, and bugs from your application users.

    See Also: "Managing Feedback"


  5. Follow the on-screen instructions.

Creating a Page from the Developer Toolbar

To view a rendered version of your application, you run or submit it to the Application Express engine by clicking the Run or Run Application icon.

When you run an application, the Developer toolbar appears at the bottom of the page. The Developer toolbar offers a quick way to edit the current page, create a page, region, or page control, view session state, or turn edit links on and off. You can control whether the Developer toolbar displays by changing the Status attribute on the Edit Application page.

See Also:

"Editing the Application Definition" for information on the Status list

To create a page from the Developer toolbar:

  1. Run the application. See "Running a Page or Application".

  2. On the Developer toolbar, click Create.

    The New Component Wizard appears.

  3. Select the type of component you want to create and click Next. Available options include:

  4. Follow the on-screen instructions.

About Create Page Types

When you run the Create Page Wizard, you select a page type. Table 7-1 describes available create page options based on the type of page you select.

Table 7-1 Create Page Options

Create Page Options Available Selections

New Page

Available page types:

Region on this page

Regions function as containers for content. Available region types:

  • HTML

  • Multiple HTML

  • Report

  • Form

  • Chart

  • List

  • Breadcrumb

  • PL/SQL Dynamic Content

  • Tree

  • URL

  • Calendar

  • Plug-ins (displays if region type plug-in exists)

  • Help Text

  • Map

  • Region Display Selector

See Also: "Understanding Regions" and "About Region Types"

Page control on this page

Page controls:

Shared control

Shared component options:


Copying a Page

You can copy a page from the current application or from another application. During the copy process, you can also copy shared components or change mappings to shared components in the target application.

To copy a page:

  1. Navigate to the application you want to copy to:

    1. Navigate to the Workspace home page.

    2. Click the Application Builder icon.

    3. Select an application.

    4. Select a page.

      The Page Definition appears.

  2. In Tree view:

    1. Under Page Rending, select the page name.

    2. Right-click and select copy.

  3. In Component view:

    1. Under Page, click the Copy icon.

    2. For Copy Page Option, select one of the following:

      • Page in this application

      • Page in another application

  4. Follow the on-screen instructions.

Running a Page or Application

The Application Express engine dynamically renders and processes pages based on data stored in database tables. To view a rendered version of your application, you run or submit it to the Application Express engine. As you create new pages, you can run them individually, or run an entire application. You can run an application by clicking the Run Application icon.

Topics:

About the Run Application and Run Page Icons

The Run Application icon resembles a large traffic light and displays on the Application home page. Clicking the Run Application icon runs an entire application.

Description of run_ico_sm.gif follows
Description of the illustration run_ico_sm.gif

The Run Page icon resembles a small, light gray traffic light and displays in the upper right corner of many pages within Application Builder. Clicking the Run Page icon runs the current page.

Description of run_ico_green.gif follows
Description of the illustration run_ico_green.gif

Running an Application from the Application Builder Home Page

To run an entire application from the Application Builder home page:

  1. On the Workspace home page, click the Application Builder icon.

  2. From the View list, select Report and click Go.

  3. Locate the application in the Applications list.

  4. Click the Run icon in the far right column.

Running an Application from the Application Home Page

To run an entire application from the Application home page:

  1. On the Workspace home page, click the Application Builder icon.

    The Application Builder home page appears.

  2. Select on application.

  3. Click the Run Application icon at the top of the page.

Running a Page on the Application Home Page

You can control how the Application home page displays by making a selection from the View list on the navigation bar at the top of the page. Selecting Details displays each page as a line in a report. Each line includes the page number, the page name, when the page was last updated, who last updated the page, a lock icon, and a Run icon.

To run a page from the Pages list:

  1. On the Workspace home page, click the Application Builder icon.

  2. Select an application.

  3. From the View list, select Report and click Go.

  4. From the Pages list, locate the page you want to run and click the Run icon in the far right column.

Running a Page from the Page Definition

To run a specific page from the Page Definition:

  1. On the Workspace home page, click the Application Builder icon.

  2. Select an application.

  3. Select a page.

    The Page Definition appears.

  4. Click the Run button at the top of the page.

Grouping Pages

You can make the pages within your application easier to access by organizing them into page groups. To use page groups, you create a group and then assign pages to the group.

Page groups do not have any function other than to help developers organize their application pages.

Topics:

Viewing Page Groups

The section describes different ways to view page groups.

To access the Page Groups page:

  1. On the Workspace home page, click the Application Builder icon.

  2. Select the application.

  3. Click the Utilities icon.

  4. From Page Specific Utilities, click Cross Page Utilities.

  5. Click Page Groups.

    The Page Groups page appears.

    A Search bar at the top of the page. Available controls include:

    • Search columns icon - Resembles a magnifying glass. Click this icon to narrow your search. To search all columns, select All Columns.

    • Text area - Enter case insensitive search criteria (wild card characters are implied) to search for a page group by name and then click Go.

    • Go button - Executes a search or applies a filter.

    • View. Use this control to toggle between icon and report views. To change the view, click these icons:

      • View Icons (the default) displays each group as a large icon. To edit a group, click the appropriate icon.

      • View Report displays each group as a line in a report. To edit a group, click the name.

    • Actions menu - Displays the Actions menu. Use this menu to customize the report view. See "Using the Actions Menu".

  6. To view the pages associated with a group, click Pages by Page Group.

Creating a Page Group

To create a page group:

  1. On the Workspace home page, click the Application Builder icon.

  2. Select the application.

  3. Click the Utilities icon.

  4. From Page Specific Utilities, click Cross Page Utilities.

  5. Click Page Groups.

  6. On the Page Groups page, click Create.

  7. Enter a name, a description (optional), and click Create.

Editing a Page Group Definition

When you create page group you specify a name and description.

To edit the Page Group definition:

  1. On the Workspace home page, click the Application Builder icon.

  2. Select the application.

  3. Click the Utilities icon.

  4. From Page Specific Utilities, click Cross Page Utilities.

  5. Click Page Groups.

  6. Select a page group.

  7. On the Page Group page, edit the name or description and click Apply Changes.

  8. To move to the next Page Group definition, click the Previous (<) and Next (>) buttons and repeat the previous step.

Assigning a Page to a Page Group

To assign pages to a group:

  1. On the Workspace home page, click the Application Builder icon.

  2. Select the application.

  3. Click the Utilities icon.

  4. From Page Specific Utilities, click Cross Page Utilities.

  5. Click Page Groups.

  6. Click the Page Assignments tab.

    The Page Assignments page appears. Clicking a page number takes you to the Page Attributes page. Clicking the page Name links to the Page Definition.

  7. From the New Group list, select a group to which you want to assign pages and click Go.

  8. Select the pages to be assigned and click Assigned Checked.

Reassigning a Page to a Another Page Group

To reassign a page to a page group:

  1. On the Workspace home page, click the Application Builder icon.

  2. Select the application.

  3. Click the Utilities icon.

  4. From Page Specific Utilities, click Cross Page Utilities.

  5. Click Page Groups.

  6. Click the Page Assignments tab.

    The Page Assignments page appears. Clicking a page number takes you to the Page Attributes page. Clicking the page Name links to the Page Definition.

  7. Select a page.

  8. From New Group, select a group to which you want to assign pages.

  9. Select the pages to be reassigned and click Assigned Checked.

Viewing Pages by Page Group

To view pages by page group:

  1. On the Workspace home page, click the Application Builder icon.

  2. Select the application.

  3. Click the Utilities icon.

  4. From Page Specific Utilities, click Cross Page Utilities.

  5. Click Page Groups.

  6. Click the Pages by Page Group tab.

    The Pages by Page Group page appears. Clicking a page number takes you to the Page Attributes page. Clicking the page Name links to the Page Definition.

  7. To create a new group, click Create and follow the on-screen instructions.

Deleting a Page Group

To remove a page group:

  1. Remove all pages from the group to be deleted. See "Viewing Pages by Page Group".

  2. Access the Page Group page:

    1. On the Workspace home page, click the Application Builder icon.

    2. Select the application.

    3. Click the Utilities icon.

    4. From Page Specific Utilities, click Cross Page Utilities.

    5. Click Page Groups.

    6. Select a page group.

  3. Click Delete.

    A confirmation page appears.

  4. Confirm your request.

Locking and Unlocking a Page

You can prevent conflicts during application development by locking pages in your application. By locking a page, you prevent other developers from editing it.

Topics:

Determining If a Page Is Locked

A lock icon indicates whether a page is currently locked. If a page is unlocked, the icon appears as an open padlock. If the page is locked, the icon appears as a locked padlock. A lock icon appears on the Application home page and on the Page Definition.

To view the lock icon on the Application home page, click the View Detail icon. A detail view appears. The lock icon appears on the right side of the page.

Description of lock_ico.gif follows
Description of the illustration lock_ico.gif

The lock icon also appears on the Action Bar on the Page Definition. See "About the Developer Action Bar".

Locking a Page

You can lock pages from the Page Locks page, the Pages list, and from a Page Definition.

Locking a Page from the Page Locks Page

To lock a page from the Page Locks Page:

  1. On the Workspace home page, click the Application Builder icon.

  2. Select an application.

  3. Click the Utilities icon.

  4. On the Page Specific Utilities list, click Cross Page Utilities.

  5. Click Page Locks.

  6. Select the appropriate pages and click Lock Checked.

  7. Enter a comment in the Comment field.

  8. Click Lock Page(s).

Locking a Page from the Detail View

To lock a page from the Detail view:

  1. On the Workspace home page, click the Application Builder icon.

  2. Select an application.

  3. On the search bar, click the View Detail icon.

  4. Locate the page you want to lock and click the Lock icon.

  5. Enter a comment in the Comment field.

  6. Click Lock Page(s).

Locking a Page from the Page Definition

To lock a page from the Page Definition:

  1. Navigate to the appropriate Page Definition. See "Accessing the Page Definition".

  2. Click the Lock icon in the Developer Action bar. See "About the Developer Action Bar".

  3. Select the selected page and click Lock Checked.

  4. Enter a comment in the Comment field.

  5. Click Lock Page(s).

Tip:

You can also lock a page on the Page Definition, by clicking the Utilities button and then Lock.

Unlocking Pages

Only the developer who locked a page can unlock it. However, a developer with administrative privileges can unlock pages locked by other developers.

Unlocking Pages from the Page Locks Page

To unlock a page from the Page Locks page:

  1. On the Workspace home page, click the Application Builder icon.

  2. Select an application.

  3. Click the Utilities icon.

  4. On the Page Specific Utilities list, click Cross Page Utilities.

  5. Click Page Locks.

  6. Select the appropriate pages.

  7. Click UnLock Checked.

Unlocking Pages from the from the Detail View

To unlock a page from the Detail view:

  1. On the Workspace home page, click the Application Builder icon.

  2. Select an application.

  3. On the search bar, click the View Detail icon.

  4. In the Pages list, locate the page you want to unlock and click the Lock icon.

    The Edit Lock Comment page appears.

  5. Click UnLock.

Unlocking Pages from the Page Definition

To unlock pages from the Page Definition:

  1. Navigate to the appropriate Page Definition. See "Accessing the Page Definition".

  2. Click the Lock icon in the upper right corner above Shared Components.

    The Page Locks page appears.

  3. Select the page you want to unlock and click Unlock.

    Tip:

    You can also unlock a page on the Page Definition, by clicking the Utilities button and then Unlock.
Unlocking Pages As a Workspace Administrator

To unlock pages as a Workspace Administrator:

  1. On the Workspace home page, click the Application Builder icon.

  2. Select an application.

  3. Click the Utilities icon.

  4. On the Page Specific Utilities list, click Cross Page Utilities.

  5. Click Page Locks.

  6. Click Lock Administration.

  7. Select the appropriate pages.

  8. Click UnLock Page(s).

Deleting a Page

You can delete a page from the Page Definition or while editing page attributes.

Topics:

Deleting a Page from the Page Definition

To delete a page from the Page Definition:

  1. Navigate to the appropriate Page Definition. See "Accessing the Page Definition".

  2. Verify the page number.

  3. Click the Utilities button and then click Delete.

  4. Click Permanently Delete Page.

See Also:

"Editing a Page in Component View" for information about editing page attributes

Deleting a Page While Editing Page Attributes

To delete a page while editing page attributes:

  1. Navigate to the Page Definition. See "Accessing the Page Definition".

  2. To access the Edit Page:

    • Tree view - Under Page Rendering, double-click the page title at the top of the tree.

    • Component view - Under Page, click the Edit All icon.

    The Page Attributes page appears. Required values are marked with a red asterisk (*).

  3. Verify the page number and page name.

  4. Click Delete.

  5. Follow the on-screen instructions.

Deleting Multiple Pages

To delete multiple pages:

  1. On the Workspace home page, click the Application Builder icon.

  2. Select an application.

  3. Click Utilities.

  4. From Page Specific Utilities, click Cross Page Utilities.

  5. Click Delete Multiple Pages.

  6. Select the pages to be deleted and click Delete Pages.

Tip:

To delete a range of pages, click the Delete Pages by Range tab. Enter a range of pages and click Delete Pages.

Adding Application Comments

You can add comments concerning an entire database application on the Application Comments page. You could add a description of the application or track the developers involved in working on the application.

Topics:

Creating and Editing Application Comments

To create an application comment:

  1. Navigate to the Workspace home page.

  2. Click the Application Builder icon.

  3. Select an application.

  4. On the Application home page, click Shared Components.

    The Shared Components page appears.

  5. Under Application, click Edit Comments.

    The Application Comments page appears.

  6. Enter comments in the Comments field and click Apply Changes.

Adding Developer Comments

You can add developer comments to an application, a page, or a group of pages using the Developer Comment icon. The Developer Comment icon resembles a small balloon. This icon displays on the Developer Action bar.

Description of comment_ico.gif follows
Description of the illustration comment_ico.gif

You can use developer comments to communicate application changes, report issues, or record developer suggestions.

Topics:

Adding Developer Comments to an Application or Page

The Developer Comment icon displays on any page in Application Builder that is related to a specific application or application page. You can add developer comments to an application, a page, or a group of pages.

To add a developer comment:

  1. On the Workspace home page, click the Application Builder icon.

  2. Select an application.

  3. Click the Developer Comment icon.

    The Create Comment page displays in a separate window.

  4. In Relevant Page(s), specify the pages to which the comment applies. To enter a comment that:

    • Applies to a specific page, enter the page number.

    • Applies to multiple pages, enter a comma-delimited list of pages. For example:

      1, 2, 3 
      
    • Does not apply to a page or group of pages, leave this field blank.

  5. In Comment, enter up to 4000 characters of text.

  6. Click Create or Create and Create Another.

Viewing and Editing Developer Comments

To edit a developer comment:

  1. On the Workspace home page, click the Application Builder icon.

  2. Select an application.

  3. Click the Developer Comment icon.

    The Create Comment page displays in a separate window.

  4. Click View Comments.

    The View Comments page appears. See "About the Navigation Bar on the View Comments Page".

  5. To edit a comment, click the Edit icon.

    The Edit Comment page appears.

    1. In Relevant Page(s), specify the pages to which the comment applies. To enter a comment that:

      • Applies to a specific page, enter the page number.

      • Applies to multiple pages, enter a comma-delimited list of pages. For example:

        1, 2, 3 
        
      • Does not apply to a page or group of pages, leave this field blank.

    2. In Comment, enter up to 4000 characters of text.

  6. Click Apply Changes.

Tip:

You can also view and edit Developer comments on the Shared Components page. Navigate to the Shared Components page and click Developer Comments on the Tasks list. See "Accessing the Shared Components Page".

About the Navigation Bar on the View Comments Page

A navigation bar appears at the top of the View Comments page and contains the following controls:

  • Page. Search for a page number. Enter a page number and click Go. To view all pages, leave the field blank and click Go.

  • Comment. Search for comments. Enter a case insensitive query for comment text and click Go. To view all comments, leave the field blank and click Go.

  • Developer. Limit the display to a specific developer. Select a developer to display and click Go.

  • Display. Determines how comments display. To increase or decrease the number of comments that appear, make a selection from the Display list and click Go.

Deleting Developer Comments

You can delete developer comments on the Edit Comment page or on the Manage Comments page.

Topics:

Deleting a Specific Developer Comment

To delete a developer comment:

  1. On the Workspace home page, click the Application Builder icon.

  2. Select an application.

  3. Click the Developer Comment icon.

    The Create Comment page displays in a separate window.

  4. Click View Comments.

  5. Locate the comment to be deleted. See "About the Navigation Bar on the View Comments Page".

  6. Click the Edit icon.

    The Edit Comment page appears.

  7. Click Delete.

Deleting Multiple Developer Comments

To delete multiple developer comments:

  1. On the Workspace home page, click the Application Builder icon.

  2. Select an application.

  3. Click the Developer Comment icon.

    The Create Comment page displays in a separate window.

  4. Click Manage Comments.

  5. Select one of the following actions:

    • Delete all comments

    • Delete comments created by a developer

    • Delete comments by date

  6. Follow the on-screen instructions.

About the Developer Comments Report

You can also view, edit, and manage developer comments from the Developer Comments report.

Topics:

Accessing the Developer Comments Report

To access the Developer Comments report:

  1. On the Workspace home page, click the Application Builder icon.

  2. Select an application.

  3. Click Shared Components

  4. Under Tasks, click Developer Comments.

    The Developer Comments report appears.

A navigation bar appears at the top of the page and contains the following controls:

  • Search icon - Resembles a magnifying glass. Click this icon to narrow your search to only specific columns. To search all columns, select All Columns.

  • Text area - Enter case insensitive search criteria (wild card characters are implied) and then click Go.

  • Go button - Executes a search.

  • Actions menu - Displays the Actions menu. Use this menu to customize an interactive report. See "Using the Actions Menu".

Editing or Deleting Comments from the Developer Comments Report

To edit a comment from the Developer Comments report:

  1. Navigate to the Developer Comments report. See "Deleting Multiple Developer Comments".

    The Developer Comments report appears.

  2. Locate the comment to be edited.

  3. Click the Edit icon.

    The Edit Comment page displays in a separate window.

    1. In Relevant Page(s), specify the pages to which the comment applies. To enter a comment that:

      • Applies to a specific page, enter the page number.

      • Applies to multiple pages, enter a comma-delimited list of pages, for example:

        1, 2, 3 
        
      • Does not apply to a page or group of pages, leave this field blank.

    2. In Comment, enter up to 4000 characters of text.

  4. Click Apply Changes.

Deleting a Comment from the Developer Comments Report

To delete a comment from the Developer Comments report:

  1. Navigate to the Developer Comments report. See "Accessing the Developer Comments Report".

    The Developer Comments report appears.

  2. Locate the comment to be deleted.

  3. Click the Edit icon.

    The Edit Comment page displays in a separate window.

  4. Click Delete.

Deleting Multiple Comments from the Developer Comments Report

To delete multiple comments from the Developer Comments report:

  1. Navigate to the Developer Comments report. See "Deleting Multiple Developer Comments".

    The Developer Comments report appears.

  2. Locate the comment to be deleted.

  3. Click the Edit icon.

    The Edit Comment page displays in a separate window.

  4. Click Manage Comments.

  5. Select one of the following actions:

    • Delete all comments

    • Delete comments created by a developer

    • Delete comments by date

  6. Follow the on-screen instructions.

  7. Click Apply Changes.

Viewing the Developer Comments Calendar

To access the Developer Comments report:

  1. On the Workspace home page, click the Application Builder icon.

  2. Select an application.

  3. Click Shared Components

  4. Under Tasks, click Developer Comments Calendar.

    The Developer Comments Calendar page appears.

  5. Use the Previous, Today and Next buttons to navigate.

Creating Application Groups

You can organize your applications by assigning them to application groups. To use application groups, create a group by clicking the Create button and then assign applications to it.

Topics:

Viewing Application Groups

The section describes different ways to view application groups.

Accessing the Application Group Page

To access the Application Group page:

  1. On the Workspace home page, click the Application Builder icon.

  2. On the Tasks List on the right side of the page, click Application Groups.

    The Application Group page appears.

    Use the Navigation bar at the top of the page to search for a page group by name or change the page display. You can change the default display by making a selection from View list. Available options include:

    • Icons (the default) displays each group as a large icon. To edit a group, click the appropriate icon.

    • Details displays each group as a line in a report. To edit a group, click the name.

  3. To view the applications associated with a group, you click the group name.

    Note:

    The Tasks list only appears if groups currently exist.

Creating an Application Group

To create an application group:

  1. On the Workspace home page, click the Application Builder icon

  2. On the Tasks List on the right side of the page, click Application Groups.

  3. On the Application Group page, click Create.

  4. Enter a name, a description (optional), and click Create.

Editing an Application Group Definition

When you create page group you specify a name and description.

To edit an application group definition:

  1. On the Workspace home page, click the Application Builder icon

  2. On the Tasks List on the right side of the page, click Application Groups.

    Application Group page appears.

  3. Select an application group.

  4. On the Application Group page, edit the name or description and click Apply Changes.

Assigning an Application to an Application Group

To assign applications to a group:

  1. On the Workspace home page, click the Application Builder icon.

  2. On the Tasks List on the right side of the page, click Application Groups.

  3. On the Tasks list, click Manage Unassigned.

    The Manage Application Group Assignments page appears.

  4. From the New Group list, select a group.

  5. Select the applications to be assigned and click Assigned Checked.

Tip:

You can also assign an application to an application group by editing the application definition. Select the group from the Application Group list. See "Editing the Application Definition".

Removing an Application from an Application Group

To remove an application from an application group:

  1. On the Workspace home page, click the Application Builder icon.

  2. On the Tasks List on the right side of the page, click Application Groups.

  3. On the Tasks list, click Manage Unassigned.

    The Manage Application Group Assignments page appears.

  4. From the New Group list, select Unassign.

  5. Select the pages to be unassigned and click Assigned Checked.

Tip:

You can also remove an application from an application group by editing the application definition. Select Unassigned from the Application Group list. See "Editing the Application Definition".

Deleting an Application Group

To remove an application group:

  1. On the Workspace home page, click the Application Builder icon.

  2. On the Tasks List on the right side of the page, click Application Groups.

  3. Assign all applications in the group to Unassign. See "Removing an Application from an Application Group".

  4. Return to the Application Groups page.

  5. Select the application group to be deleted.

  6. On the Application Group page, click Delete.

    A confirmation page appears.

  7. Confirm your request.

Understanding Page-Level Items

An item is part of an HTML form. An item can be a text field, text area, password, select list, check box, and so on. Item attributes affect the display of items on a page. For example, these attributes can impact where a label displays, how large an item is, and if the item will display next to or below the previous item.

Topics:

Differences Between Page Items and Application Items

There are two types of items: page items and application items. Page items are placed on a page and have associated user interface properties, such as Display Only, Label and Label Template. Examples of page-level items include a check box, date picker, display as text, file browse field, popup list of values, select list, or a text area. Application items are not associated with a page and therefore have no user interface properties. You can use an application item as a global variable.

Viewing Items on the Page Definition

You create and edit page-level items on the Page Definition. In both Component and Tree view, items section appears in the Page Rendering section. See "Switching Between Tree and Component View".

Topics:

Viewing Items in Tree View

In Tree view, items display within a tree under the region which contains them.

Description of pg_def_items_tree.gif follows
Description of the illustration pg_def_items_tree.gif

To edit or add an item, right-click to display a context menu. Then, make a selection from the context menu.

Tip:

You can also edit an item by double-clicking the item name or selecting the name and pressing ENTER. See "Editing a Page in Tree View".
Description of pg_def_item_menu.gif follows
Description of the illustration pg_def_item_menu.gif

To edit multiple items at once, right-click Items and select Edit All. The Items page appears. See "Editing Multiple Items Simultaneously".

You can interactively reorder items within a given region or move them to another region by dragging and dropping them.

Viewing Items in Component View

Description of pg_def_items.gif follows
Description of the illustration pg_def_items.gif

In Component view, items display under the Items. You can temporarily hide all other subsections by clicking the Items icon. To restore the view, click Show All. The Show All icon resembles an inverted triangle.

The following icons display next to the section title:

  • Edit All. The Edit All icon resembles a small grid with a pencil on top of it. Use this icon to edit all items at once. See "Editing Multiple Items Simultaneously".

  • Copy. The Copy icon resembles two small overlapping pages. Use this icon to make a copy of an existing item.

  • Create. The Create icon resembles a plus (+) sign overlapping a small page. Click this icon to create an item.

Items are organized by region. To edit an item, click the item name.

About the Drag and Drop Icon

You can quickly change the appearance of a page by clicking the Drag and drop icon to access the Drag and Drop Layout page. The Drag and drop icon resembles a rectangle and displays to the right of the Reorder Region Items icon.

Description of drag_drap_ico.gif follows
Description of the illustration drag_drap_ico.gif

You can use the Drag and Drop Layout page to interactively reorder items within a given region, change select item attributes, create items, or delete existing items. See "Using the Drag and Drop Layout Page".

About the Reorder Items Icon

You can quickly edit the label and position of items in a region by clicking the Reorder Region Items icon on the Page Definition. This icon resembles a light green down or up arrow.

Description of reorder_items.gif follows
Description of the illustration reorder_items.gif

Creating Page-Level Items

You can create page-level items by running the Create Item Wizard.

Topics:

About Item Naming Conventions

When specifying an item name, remember the following rules. Item names must:

  • Be unique within an application.

  • Not include quotation marks.

  • Begin with a letter or a number, and subsequent characters can be letters, numbers, or underscore characters.

  • Be case-insensitive.

  • Should not exceed 30 characters. Items longer than 30 characters cannot be referenced using bind variable syntax. See "About Bind Variable Syntax".

  • Cannot contain letters outside the base ASCII character set

As a best practice Oracle recommends including the page number when naming items. By default, wizards prefix page item names with P<page no>_ (for example, P1_NAME.

Creating a Page-Level Item on the Page Definition

You create a page-level item by running the Create Item Wizard from the Page Definition.

To create a page-level item:

  1. Navigate to the appropriate Page Definition. See "Accessing the Page Definition".

  2. If necessary, create an HTML region. See "Understanding Regions".

  3. To access the Create Item Wizard:

    • Tree view - Under Page Rending, right-click the region to contain the item and select Create Page Item.

    • Component view - Under Items, click the Create icon.

    The Create Item Wizard appears.

  4. Select an item type. See "About Item Types".

    When creating a Popup LOV, Color Picker, or Text Field with Calculator Popup, select Popup List of Values and then the specific popup list of values type.

  5. For Display Position and Name:

    1. Item Name - Enter a name used to retrieve the value of the item. See "About Item Naming Conventions".

    2. Sequence - Specify the sequence for this component. The sequence determines the order of evaluation.

    3. Region - Select a region to contain this item.

    4. Click Next.

  6. Follow the on-screen instructions.

  7. To learn more about a specific field, click the field label.

    When help is available, the item label changes to red when you pass your cursor over it, and the cursor changes to an arrow and question mark. See "About Field-Level Help".

Creating a Static List of Values

One way to create a static list of values is to edit an item's List of Values definition. Note that this type of list of values is not reusable. As a best practice, create a list of values as a shared component whenever possible.

To create a static list of values:

  1. Navigate to the appropriate Page Definition. See "Accessing the Page Definition".

  2. Access the attributes page for the item:

    • Tree view - Right-click on the item and select Edit.

    • Component view -Under Items, select the item name.

    The Edit Page Item page appears.

  3. Under Name, specify how the item will be rendered. From Display As, select Select List.

  4. Scroll down to List of Values.

  5. Under List of Values, create a static list of values:

    1. From Named LOV, select Select Named LOV.

    2. In List of values definition, enter a definition using the following syntax:

      STATIC[2]:Display Value[;Return Value],Display Value[;Return Value]
      

      Where:

      • The first keyword may be STATIC or STATIC2.

        STATIC results in the values being sorted alphabetically by display value. STATIC2 results in the values being displayed in the order they are entered in the list.

      • A semicolon separates the display value from the return value in each entry.

      • Return Value is optional. If a Return Value is not included, the return value is the same as the display value.

  6. To learn more, see item Help. To view help for a specific item on a page, click the item label.

    When help is available, the item label changes to red when you pass your cursor over it and the cursor changes to an arrow and question mark. See "About Field-Level Help".

  7. Click Apply Changes.

    The examples that follow demonstrate syntax for three different static LOVs.

Example 1: Four Values Displayed in Alphabetical Order

In this example, the list of values has four values (Cow, Dog, Cat, and Lion) that display in alphabetical order. The return value of each entry equals the display value.

STATIC:Cow,Dog,Cat,Lion
Example 2: Ten Values Displayed in the Order Listed

In this example, the list of values has ten values that display in the order listed in the definition. The return value of each entry equals the display value.

STATIC2:10,15,20,25,50,100,200,500,1000,10000
Example 3: A List of Values with Having Both a Return and Display Value

In this example, the list of values has two values: Yes and No (the display value Yes and its return value Y, and the display value No and its return value N).

STATIC:Yes;Y,No;N

Creating a Cascading List of Values

By creating a cascading list of values (LOV), one item on a page determines the list of values for another item. Application Builder includes cascading LOV support for the following item types: Select List, Shuttle, Checkbox, Radio Group, Popup LOV, and List Manager. To learn more about item types, see Appendix A, "About Item Types".

You create a cascading LOV by creating two items. To populate the second item, you specify a Cascading LOV Parent Item when running the Create Item Wizard or by editing the item's attributes.

The following example demonstrates how to create two related select lists where the value of the first list populates the second.

To a cascading list of values:

  1. Create the first item and name it P1_DEPTNO:

    1. Create a select list item. See "Creating a Page-Level Item on the Page Definition".

    2. For Item Type, select Select List.

    3. For Display Position and Name:

      • Item Name - Enter:

        P1_DEPTNO
        
      • Accept the remaining defaults and click Next.

    4. For Item Attributes:

      • Label - Enter Department

      • Accept the remaining defaults and click Next.

    5. For Settings, accept the defaults and click Next.

    6. For List of Values:

      • Display Null Value - Accept the default, Yes.

      • Null Display Value - Enter - Select Department -

        - Select Department -
        
      • In List of values definition, enter:

        SELECT dname as d,
               deptno as r
          FROM dept
         ORDER BY dname
        
      • Click Next.

    7. Accept the remaining defaults.

    8. Click Create Item.

  2. Create the second item named P1_EMPNO:

    1. Create a second item. See "Creating a Page-Level Item on the Page Definition".

    2. For Item Type, select Select List.

    3. For Display Position and Name:

      • Item Name - Enter:

        P1_EMPNO
        
      • Accept the remaining defaults and click Next.

    4. For Item Attributes:

      • Label - Enter Employee.

      • Accept the remaining defaults and click Next.

    5. For Settings, accept the defaults and click Next.

    6. For List of Values:

      • Display Null Value - Accept the default, Yes.

      • Null Display Value - Enter - Select Department -

        - Select Employee -
        
      • From Cascading LOV Parent Item(s) - Select P1_DEPTNO.

      • In List of values definition, enter:

        SELECT ename as d,
               empno as r
          FROM emp
         WHERE deptno = :P1_DEPTNO
         ORDER BY ename
        
      • Click Next.

    7. Accept the remaining defaults.

    8. Click Create Item.

Two select lists appear. Making a selection in the Department select list, determines which individuals display in the Employees select list.

Description of cascading_lov.gif follows
Description of the illustration cascading_lov.gif

Creating Multiple Items Using a Tabular Form

To create multiple items simultaneously:

  1. Navigate to the appropriate Page Definition. See "Accessing the Page Definition".

  2. If necessary, create an HTML region. See "Understanding Regions".

  3. To access the Create Item Wizard:

    • Tree view - Under Page Rending, right-click the region to contain the item and select Create Page Item.

    • Component view - Under Items, click the Create icon.

    The Create Item Wizard appears.

  4. Click the Create multiple items using tabular form link at the bottom of the page.

  5. On the Create Multiple Items page, specify the following:

    1. Create Item(s) in Region - Select the region to contain the items.

    2. Item Template - Select an item template.

    3. For each item, enter the Sequence, Name, Label, Type and specify whether the item should be cached.

  6. Click Create Multiple Items.

Creating Multiple Items Using Drag and Drop

To create multiple items using the Drag and Drop Layout page:

  1. Navigate to the appropriate Page Definition. See "Accessing the Page Definition".

  2. If necessary, create an HTML region. See "Understanding Regions".

  3. To access the Drag and Drop Layout page:

    • Tree view - Under Page Rending, right-click on the region and select Drag and Drop Layout.

    • Component view - Under Items, click the Drag and Drop Layout icon.

    The Drag and Drop Layout page appears.

  4. Select an item from the palette on the left side of the page and drag it to the appropriate position on the page.

  5. Edit the item attributes at the of the page.

    1. Item Name - Enter a name used to retrieve the value of the item. See "About Item Naming Conventions".

    2. Label - Enter the label for this item. You may include HTML, JavaScript, and shortcuts. You can also use the substitution string #CURRENT_ITEM_NAME# to obtain the name of the item associated with this label.

    3. Display Type - Select a display type (if applicable). See "About Item Types".

  6. To edit an existing item, select the item and then edit the Item Name and Label fields, or select a new Display Type at the top of the page.

  7. Click Next.

  8. Optionally, edit the each item's Name and Label.

  9. Click Apply Changes.

Editing Page-Level Items

You can edit page-level items by editing page item attributes or using the Edit All or Reorder Items icons.

Topics:

Editing Page Item Attributes

Once you create a page item, you can edit it on the Edit Page Item page.

To edit page item attributes:

  1. Navigate to the appropriate Page Definition. See "Accessing the Page Definition".

  2. Access the attributes page for the item:

    • Tree view - Right-click on the item and select Edit.

    • Component view -Under Items, select the item name.

    Tip:

    You can also edit an item by double-clicking the item name or selecting the name and pressing ENTER. See "Editing a Page in Tree View".

    The Edit Page Item page appears.

  3. To learn more about a specific attribute on a page, click the attribute label.

    When help is available, the item label changes to red when you pass your cursor over it, and the cursor changes to an arrow and question mark. See "About Field-Level Help".

  4. Click Apply Changes.

About Navigation Alternatives

The Edit Page Item page is divided into sections. The sections that display depend upon the Display As attribute.

You can access these sections by scrolling down the page, or by clicking a navigation button at the top of the page. When you select a button at the top of the page, the selected section appears and all other sections are temporarily hidden. To view all sections of the page, click Show All.

Defining Default Values

You define default values for an item using the attributes under Default on the Edit Page Item page. The default value is used when the item's value is not derived from session state and when the source value is NULL.

To define a default value for an item:

  1. Create the item. See "Creating Page-Level Items".

  2. Navigate to the appropriate Page Definition. See "Accessing the Page Definition".

  3. Access the attributes page for the item:

    • Tree view - Right-click on the item and select Edit.

    • Component view -Under Items, select the item name.

    The Edit Page Item page appears.

  4. Scroll down to Default.

  5. In Default Value, enter a value.

  6. From Default Value Type, select one of the following:

    • Static Text with Session State Substitutions

    • PL/SQL Function Body

    • PL/SQL Expression

  7. Click Apply Changes.

Creating a Quick Pick Selection

If the item type supports quick pick selection, use the Quick Picks attributes to define up to ten selections that display under a give item. Clicking on a quick pick sets the value of item. The following example shows quick picks for 5%, 10%, 15%, and 20%.

Description of quick_pick.gif follows
Description of the illustration quick_pick.gif

To create a quick pick:

  1. Create the item. See "Creating Page-Level Items".

  2. Navigate to the appropriate Page Definition. See "Accessing the Page Definition".

  3. Access the attributes page for the item:

    • Tree view - Right-click on the item and select Edit.

    • Component view -Under Items, select the item name.

    The Edit Page Item page appears.

  4. Scroll down to Quick Picks.

  5. From Show Quick Picks, select Yes.

  6. Define the Label and Value for each quick pick:

    1. Under Label, enter the label to display for each selection.

    2. Under Value, enter the corresponding value.

  7. In Link Attributes, enter additional attributes for the quick picks.

  8. Click Apply Changes.

Editing Multiple Items Simultaneously

Item attributes control how items display on a page. You can use the Page Items page to edit the sequence, field label, template, region, and overall position for all items on a page. The sections that follow describe how to edit items using these pages.

Topics:

Items

To edit multiple items simultaneously:

  1. Navigate to the appropriate Page Definition. See "Accessing the Page Definition".

  2. Access the Page Items page:

    The Items tab appears.

    A Navigation bar displays at the top of the page. Use the Page field to navigate to another page. To limit the display to just items in a specific region, make a selection from Regions list.

    The Page Items page displays items in an editable report. Table 7-2 describes each editable attribute.

    Table 7-2 Editable Attributes on Page Items

    Attribute Description

    Sequence

    Specify the display sequence for this component. The sequence determines the order of evaluation.

    Prompt

    Enter the label for this HTML form element. You may include HTML, JavaScript, and shortcuts. You can also use the substitution string #CURRENT_ITEM_NAME# to obtain the name of the item associated with this label.

    Field Template

    Determines the label template. Label templates enable you to define the user interface attributes in a central place and share that definition among many labels.

    Region

    Defines the region in which the item displays. All items must be in a region.

    New Line

    Determines whether this item displays on the same line as the previous item or whether it displays on the next line. Items are laid out in an HTML table. Select Yes to have an item display as the first field in a new row in the table.

    New Field

    If set to Yes, this item will be rendered into it's own HTML table cell which is the default. If set to No, the item will be rendered into the same HTML table cell as the previous page item.

    Note that rendering into the same table cell will look more attached to the previous page item.

    Width

    Specifies the length (in characters) of the form element that displays for this item.

    Height

    Specifies the height (in lines) for text areas and multi select lists.

    Column Span

    Items are laid out in HTML tables. This property defines the value to be used for the COLSPAN attribute in the table cell.

    Row Span

    Items are laid out in HTML tables. The attribute determines the value to be used for the ROWSPAN attribute in the table cell that the item displays in.

    Post Element

    Text or HTML code will be rendered immediately after the page item element.


Reassign Region Items

Use the Reassign Region Items page to assign items to a new region.

To Reassign Region Items page:

  1. Navigate to the appropriate Page Definition. See "Accessing the Page Definition".

  2. Access the Page Item page:

    • Tree view - Right-click Items and select Edit All.

    • Component view - Under Items, click the Edit All icon. The Edit All icon resembles a small grid with a pencil on top of it.

    The Page Item page appears.

  3. Click Reassign Region Items.

    The Reassign Region Items page appears.

    Use the Navigation bar at the top of the page to narrow or broaden the display. Available options include:

    • Page - Select or enter a new number and click Go.

    • Show Region(s) - Select a region to display and click Go.

  4. To reassign an item to another region:

    1. Select the items to reassign.

    2. From Assign to Region, select a new region.

    3. Click Reassign.

Tip:

In Tree view, you can also reassign region items by simply dragging and dropping to a new location.
Delete Multiple Items

Use the Delete Multiple Items page to delete multiple items at once.

To delete multiple items:

  1. Navigate to the appropriate Page Definition. See "Accessing the Page Definition".

  2. Access the Page Item page:

    • Tree view - Right-click on Items and select Edit All.

    • Component view - Under Items, click the Edit All icon. The Edit All icon resembles a small grid with a pencil on top of it.

    The Page Item page appears.

  3. Click Delete Multiple Items.

    The Delete Multiple Items page appears.

    Use the Navigation bar at the top of the page to narrow or broaden the display. Use the Page field to navigate to a new page. Select or enter a new number and click Go.

  4. To delete an item:

    1. Select the items.

    2. Click Remove Items.

Viewing Item Utilities

The Utilities page includes Grid Edit pages and reports Utilities that enable you to edit multiple pages within a selected application.

To access the Utilities page:

  1. Navigate to the appropriate Page Definition. See "Accessing the Page Definition".

  2. Access the Page Item page:

    • Tree view - Right-click on Items and select Edit All.

    • Component view - Under Items, click the Edit All icon. The Edit All icon resembles a small grid with a pencil on top of it.

    The Page Item page appears.

  3. Select one of the following reports:

    • Grid Edit of all Item Labels

    • Grid Edit of all Item Help Text

    • Item Help Subscriptions

    • All Page Items

    • Conditional Items

History

Use the History page to view a summary of recent edits to page-level items.

Using the Drag and Drop Layout Page

You can use the Drag and Drop Layout page to interactively reorder items within a given region, change select item attributes, create items, or delete existing items.

Topics:

Accessing the Drag and Drop Layout Page

You access the Drag and Drop Layout page by either:

  • Tree view - Under Page Rending, right-click on the region and select Drag and Drop Layout.

  • Component view - Under Items, click the Drag and Drop Layout icon.

About the Drag and Drop Layout Page

The Drag and Drop Layout page is divided into two sections: Item palette and Layout region.

Description of drag_drap_pg.gif follows
Description of the illustration drag_drap_pg.gif

The Item palette displays on the left side of the page. You add items by clicking an item type on the palette and dragging it to the correct position in the Layout region. Note that when you position the cursor over an item type, a tooltip appears.

Use the right side of the page (or Layout region) to position items. To move an item vertically, click the Add Row button to insert an empty row. Then drag and drop the item into the empty row.

See Also:

"Deleting Items"
Creating a New Item

To create a new item on the Drag and Drop Layout page:

  1. Navigate to the Drag and Drop Layout page. See "Accessing the Drag and Drop Layout Page".

  2. Click an item type in the Item palette on the left side of the page and drag it to the appropriate location in the Layout region.

    Note that when you position the cursor over an item type, a tooltip appears.

  3. You can reposition the item:

    • To move an item horizontally, select the item and drag it to the appropriate position on the page.

    • To insert an existing or new item between two existing rows, click the Add Row button and drag it between the existing rows. This creates an empty row where you can then move the item.

  4. Edit the item attributes at the of the page.

    1. Display Name - Enter an item name. Use this name to retrieve the value of the item. Item names longer than 30 characters cannot be referenced using bind variable syntax.

    2. Label - Enter the label for this item. You may include HTML, JavaScript, and shortcuts. You can also use the substitution string #CURRENT_ITEM_NAME# to obtain the name of the item associated with this label.

    3. Display Type - Select a display type (if applicable). Note that the select list is restricted to options corresponding to the type of item you are creating. See "About Item Types".

  5. Click Next.

  6. Optionally, edit the each item's Name and Label.

  7. Click Apply Changes.

About List of Values

If you create an item that requires a list of values (LOV), the Drag and Drop Layout Wizard creates a static inline LOV for you. Note you must edit and fix this LOV once you complete the layout process.

Editing Existing Items

To edit an existing item on the Drag and Drop Layout page:

  1. Navigate to the Drag and Drop Layout page. See "Accessing the Drag and Drop Layout Page".

  2. To reposition the item:

    • To move an item horizontally, select the item and drag it to the appropriate position on the page.

    • To insert an existing or new item between two existing rows, click the Add Row button and drag it between the existing rows. This creates an empty row where you can then move the item.

  3. If required, select an item and edit its attributes at the of the page.

    1. Display Name - Enter an item name. Use this name retrieve the value of the item. Item names longer than 30 characters cannot be referenced using bind variable syntax.

    2. Label - Enter the label for this item. You may include HTML, JavaScript, and shortcuts. You can also use the substitution string #CURRENT_ITEM_NAME# to obtain the name of the item associated with this label.

    3. Display Type - Select a display type (if applicable). Note that the select list is restricted to options corresponding to the type of item you are creating. See "About Item Types".

  4. Click Next.

  5. Optionally, edit the each item's Name and Label.

  6. Click Apply Changes.

Note:

To change the region in which an item resides, you must edit the item attributes. See "Editing Page Item Attributes".
Deleting Items

To delete an item, click it and drag it to the Recycle box at the bottom of the page. If you delete an existing item, it appears in the Recycle box and can be retrieved until you click Apply Changes on the next page. Note that if you drop a new item you have just created in the Recycle box, it instantly disappears and cannot be retrieved.

Using the Reorder Region Items Icon in Component View

You can quickly edit the label and position of items in a region by clicking the Reorder Region Items icon on the Page Definition. This icon resembles a gray down and up arrow.

To use the Reorder Region Items icon:

  1. Navigate to the appropriate Page Definition. See "Accessing the Page Definition".

  2. Under Items, click the Reorder Region Items icon.

    The Reorder Region Items page appears with items laid out in tables. You can edit the position of an item by selecting values for New Line, New Field, Column Span, and Label Alignment attributes.

  3. To edit an item label, enter a new title in the Label field.

  4. To change the position of an item, edit the following attributes:

    • New Line. Determines if the item displays on the same line as the previous item, or displays on the next line. Select Yes to have an item display as the first field in a new row in the table.

    • New Field. Determines if the item displays in the next column or in the same column as the previous item. Select Yes to have the label and value for the item display in a new HTML table cell. Use this attribute in combination with the New Line and Span attributes to control layout.

    • Column Span. Defines the value to be used for the COLSPAN attribute in the table cell. The COLSPAN attribute defines the number of columns that it spans across the table.

  5. To change label alignment, make a selection from the Label Alignment list.

  6. To change the order in which items display, click the up and down arrows in the far right column. Clicking the arrow moves the item one row up or down.

    Note that the order you specify here translates to sequence number in the Sequence attribute on the Edit Page Item page. See "Editing Page Item Attributes".

  7. Click Apply Changes.

Tip:

You can also use the Drag and Drop Layout feature to reorder items. See "Using the Drag and Drop Layout Page".

Note:

To change the region in which an item resides, you must edit the item attributes. See "Editing Page Item Attributes".

Referencing Item Values

You can reference item values stored in session state in regions, computations, processes, validation, and branches. Table 7-3 describes the supported syntax for referencing item values.

Table 7-3 Syntax for Referencing Item Values

Type Syntax Description

SQL

:MY_ITEM

Standard bind variable syntax for items whose names are no longer than 30 bytes. Use this syntax for references within a SQL query and within PL/SQL code.

PL/SQL

V('MY_ITEM')

PL/SQL syntax referencing the item value using the V function. Use this syntax in PL/SQL code of packages or stored procedures and functions.

Avoid this syntax in SQL statements. It may result in performance problems.

See Also: Oracle Application Express API Reference

PL/SQL

NV('MY_NUMERIC_ITEM')

Standard PL/SQL syntax referencing the numeric item value using the NV function. Use this syntax in PL/SQL code of packages or stored procedures and functions.

Avoid this syntax in SQL statements.It may result in performance problems.

See Also: Oracle Application Express API Reference

Static Text (exact)

&MY_ITEM.

Static text. Exact Substitution.

Note: Exact substitution syntax should be avoided in SQL or PL/SQL code because it can result in SQL Injection vulnerabilities.


You can set the value of an item in your application using any of the following methods:

  • For page-level items, use the Source Attribute to set the item value.

    From the Page Definition, select the item name to view the Edit Page Item page. Scroll down to Source and edit the appropriate fields.

    You can also set the value of an item in any region based on PL/SQL or a process using the following syntax:

    BEGIN
     :MY_ITEM :=  'new value';
    END;
    
  • Pass the value on a URL reference using f?p syntax. For example:

    f?p=100:101:10636547268728380919::NO::MY_ITEM:ABC
    
  • Set the value using a computation. Computations are designed to set item values. For example:

    TO_CHAR(SYSDATE,'Day DD Month, YYYY');
    
  • Use the PL/SQL API to set an item value within a PL/SQL context. For example:

    APEX_UTIL.SET_SESSION_STATE('MY_ITEM',SYSDATE);
    

Displaying Conditional or Read-Only Page Items

You can choose to have an item display conditionally or as read-only by editing attributes on the Edit Pages Item page.

Topics:

Displaying Conditional Page Items

To display a conditional or read-only item:

  1. Create the item. See "Creating Page-Level Items".

  2. Navigate to the appropriate Page Definition. See "Accessing the Page Definition".

  3. Access the attributes page for the item:

    • Tree view - Right-click on the item and select Edit.

    • Component view -Under Items, select the item name.

    The Edit Page Item page appears.

  4. To display an item conditionally:

    1. Scroll down to Conditions.

    2. Make a selection from the Condition Type list.

    3. Enter an expression in the fields provided.

  5. To make an item read-only:

    1. Scroll down to Read Only Display Settings.

    2. Make a selection from the Read Only Condition Type list.

    3. Enter an expression in the fields provided.

  6. Click Apply Changes.

Displaying Read Only Page Items

To display a read-only item:

  1. Create the item. See "Creating Page-Level Items".

  2. Navigate to the appropriate Page Definition. See "Accessing the Page Definition".

  3. Access the attributes page for the item:

    • Tree view - Right-click on the item and select Edit.

    • Component view -Under Items, select the item name.

    The Edit Page Item page appears.

  4. To display an item conditionally:

    1. Scroll down to Read Only.

    2. Make a selection from the Condition Type list.

    3. Enter an expression in the fields provided.

  5. To make an item read-only:

    1. Scroll down to Read Only Display Settings.

    2. Make a selection from the Read Only Condition Type list.

    3. Enter an expression in the fields provided.

  6. In Read Only Element Table Cell(s) Attributes, enter attributes to be included in the HTML table cell tag, <td>, that contains the item when displayed in read only mode. For example:

    bgcolor="#FF0000"
    
  7. Click Apply Changes.

Working with Multiple Select List Item

A multiple select item renders as a multiple select list form element which can be either a Multiselect List or Shuttle item type. When submitted, selected values are returned in a single colon-delimited string. You can handle values in this format in three ways:

  • Using the INSTR function

  • Using the APEX_UTIL.STRING_TO_TABLE function

  • Creating a shuttle

Topics:

Using APEX_UTIL.STRING_TO_TABLE to Convert Selected Values

Suppose you had a report on the EMP and DEPT tables that is limited by the departments selected from a Department multiple select list. First, you create the multiple select item, P1_DEPTNO, using the following query:

SELECT dname, deptno
FROM dept

Second, you return only those employees within the selected departments as follows:

SELECT ename, job, sal, comm, dname
FROM emp e, dept d
WHERE d.deptno = e.deptno
AND instr(':'||:P1_DEPTNO||':',':'||e.deptno||':') > 0

Next, assume you want to programmatically step through the values selected in the multiple select item, P1_DEPTNO. To accomplish this, you would convert the colon-delimited string into a PL/SQL array using the APEX_UTIL.STRING_TO_TABLE function. The following example demonstrates how to insert the selected departments into an audit table containing the date of the query.

DECLARE
    l_selected APEX_APPLICATION_GLOBAL.VC_ARR2;
BEGIN
  --
  -- Convert the colon separated string of values into
  -- a PL/SQL array 

  l_selected := APEX_UTIL.STRING_TO_TABLE(:P1_DEPTNO);

  --
  -- Loop over array to insert department numbers and sysdate
  --

  FOR i IN 1..l_selected.count 
  LOOP
    INSERT INTO report_audit_table (report_date, selected_department)
        VALUES (sysdate, l_selected(i));
  END LOOP;
END;

See Also:

"STRING_TO_TABLE Function" in Oracle Application Express API Reference

Creating a Shuttle Item Type

Suppose you have a form on the DEPT table that shows which employees are assigned to a given department. To made assigning employees to a department easier, you can create a shuttle item that lists employees alphabetically.

To create a shuttle item:

  1. Create a new Form page on DEPT using Form on a Table with Report:

    1. On the Workspace home page, click the Application Builder icon.

    2. Select an application.

    3. Click Create Page.

    4. For Page Type, select Form.

    5. Under Forms, select Form on a Table with Report.

    6. Select the appropriate schema.

    7. For Table/View Name, select DEPT.

    8. Accept the remaining defaults and follow the on-screen instructions. To learn more about a specific field, click the item label.

  2. Create a shuttle named P2_EMP_LIST and the form page.

    1. Go the Page Definition for the form page.

    2. Right-click the region containing the form and select Create Page Item.

    3. For Item Type, select Shuttle.

    4. For Item Name, enter P2_EMP_LIST and click Next.

      Tip:

      In this example, "P2" in the item name P2_EMP_LIST indicates the item resides on page 2.
    5. For Item Attributes, accept the defaults and click Next.

    6. For Setting, accept the defaults and click Next.

    7. For List of Values:

      • List of Values Query - Enter:

        SELECT ename, empno FROM emp ORDER BY 1
        
      • Click Next.

    8. For Source:

      • Source Type - Select SQL Query (return color separated value)

      • Item Source Value - Enter:

        SELECT empno FROM emp WHERE deptno = :P2_DEPTNO ORDER BY ename
        
      • Click Create Item.

    9. Run the page by clicking the Run Page icon.

      Description of shuttle_example.gif follows
      Description of the illustration shuttle_example.gif

Understanding Application-Level Items

Application-level items do not display, but are used as global variables to the application. You can use an application item as a global variable.

Topics:

Creating an Application-level Item

To create an application-level item:

  1. Navigate to the Workspace home page.

  2. Click the Application Builder icon.

  3. Select an application.

  4. When Application home page appears, click Shared Components.

  5. Under Logic, select Application Items.

    The Application Items page appears.

  6. To create an application item, click Create.

  7. Follow the on-screen instructions.

About the Application Items Page

Once you create a application item, it appears on the Application Items page. You can customize the appearance of page using the Search bar at the top of the page. Available controls include:

  • Search icon - Resembles a magnifying glass. Click this icon to narrow your search. To search all columns, select All Columns.

  • Text area - Enter case insensitive search criteria (wild card characters are implied) to search for a page group by name and then click Go.

  • Go button - Executes a search.

  • View. Use this control to toggle between icon and report views. To change the view, click these icons:

    • View Icons (the default) displays each application item as a large icon. To edit an item, click the appropriate icon.

    • View Report displays each item as a line in a report. To edit an item, click the item name.

  • Actions menu - Displays the Actions menu. Use this menu to customize the report view. See "Using the Actions Menu".

Viewing Application Item Usage

You can a listing of where application items are used by clicking Utilization at the top of the Application Items page.

Editing Application-level Item Attributes

Once you create an application-level item, you can edit it on the Create/Edit Application Item page.

To edit application-level item attributes:

  1. Navigate to the Workspace home page.

  2. Click the Application Builder icon.

  3. Select an application.

  4. When Application home page appears, click Shared Components.

  5. Under Logic, select Application Items.

    The Application Items page appears.

  6. Select an application item.

    The Create/Edit Application Item page appears.

  7. To learn more about a specific item on a page, click the item label.

    When Help is available, the item label changes to red when you pass your cursor over it and the cursor changes to an arrow and question mark. See "About Field-Level Help".

  8. Click Apply Changes.

About Navigation Alternatives

The Create/Edit Application Item page is divided into the following sections: Name, Security, Configuration, and Comments.

You can access these sections by scrolling down the page, or by clicking a navigation button at the top of the page. When you select a button at the top of the page, the selected section appears and all other sections are temporarily hidden. To view all sections of the page, click Show All.

Viewing Utilities and Reports

Oracle Application Express includes a comprehensive number of reports that enable you to view of your application from various perspectives. You can use these reports to view statistics and access reports of page and application components, templates, plug-ins, and conditions. For example, you can view details about buttons used on all pages within your application. Additionally, many reports are updatable so you can standardize components, such as item and region labels, without navigating to a specific page.

Topics:

Using Application Builder Utilities

The Application Builder Utilities page includes tools and reports that summarize information across an application.

Topics:

About the Application Builder Utilities Page

Description of bldr_utilities.gif follows
Description of the illustration bldr_utilities.gif

The center of Application Builder Utilities contains icons that link to the following tools and reports:

Page Specific Utilities

Description of page_util.gif follows
Description of the illustration page_util.gif

The Page Specific Utilities display on the right side of the Utilities page. Use these utilities to view component reports across pages in an application and by component type (for example, region, button, item, validation, process, dynamic action, or branch). To learn more, see "About Page Specific Utilities" and "About Cross Page Utilities".

Viewing the Application Dashboard

The Application Dashboard details application components and attributes.

To view reports specific to an application:

  1. Navigate to the Workspace home page.

  2. Click the Application Builder icon.

  3. Select an application.

    The Application home page appears.

  4. Click Utilities.

  5. Click Application Dashboard.

    The Application Dashboard appears and contains the following sections:

    • Application Overview lists detailed information and statistics about the current application, including the ID, name, alias, parsing schema, associated group, number of pages, and associated theme.

    • Security lists the current authentication scheme, number of public and non public pages, and the number of authorization schemes used within the current application.

    • Templates contains links to reports of templates used within the current application.

    • Pages by Type lists counts of components, including types of reports and forms and dynamic HTML

    • Application Components contains links to reports of application-level controls and logic, including lists of values, tabs, lists, application items, application processes, and application computations.

    • Page Components contains links to reports of page-level controls and logic, including items, buttons, processes, regions, branches, validations, and dynamic actions.

  6. To view a specific report, click the number to the right of the component type or template.

Viewing the Change History Report

The Change History report displays a summary report of edits to the current applications by developer, component type, and page number.

To view the Change History report:

  1. Navigate to the Workspace home page.

  2. Click the Application Builder icon.

  3. Select an application.

    The Application home page appears.

  4. Click Utilities.

  5. Click the Change History.

    A Search bar at the top of the page. Available controls include:

    • Search columns icon - Resembles a magnifying glass. Click this icon to narrow your search. To search all columns, select All Columns.

    • Text area - Enter case insensitive search criteria (wild card characters are implied) to search for a page group by name and then click Go.

    • Go button - Executes a search.

    • Actions menu - Displays the Actions menu. Use this menu to customize the report. See "Using the Actions Menu".

Viewing the Recently Updated Pages Report

The Recently Updated Pages report displays a report of pages recently updated by the current user.

To view the Recently Updated Pages report:

  1. Navigate to the Workspace home page.

  2. Click the Application Builder icon.

  3. Select an application.

    The Application home page appears.

  4. Click Utilities.

  5. Click Recently Updated Pages.

    A Search bar at the top of the page. Available controls include:

    • Search columns icon - Resembles a magnifying glass. Click this icon to narrow your search. To search all columns, select All Columns.

    • Text area - Enter case insensitive search criteria (wild card characters are implied) to search for a page group by name and then click Go.

    • Go button - Executes a search.

    • Actions menu - Displays the Actions menu. Use this menu to customize the report. See "Using the Actions Menu".

Upgrading an Existing Application

Use the Upgrade Application icon on the Utilities page to upgrade an existing application to include new components available in the current release. This feature upgrades the following components:

  • Update Text Field items to Number Field items when there is a IS NUMERIC validation.

  • Update the Value Required item attribute to Yes when there is a NOT NULL validation.

  • Upgrade Date Picker (Classic) to the new Date Picker.

  • Remove %null% in LOV Null Return Value of page items.

  • Upgrade FCKEditor 2 to CKEditor 3.

  • Upgrade SVG Charts to Flash Chart 5.

  • Upgrade Flash Charts to Flash Chart 5.

  • For interactive reports:

    • Enable Group By for interactive reports.

    • Enable Save Public Report for interactive reports.

    • Enable Subscription for interactive reports.

    • Enable Rows Per Page Selector for interactive reports.

  • Numeric, Required, and Date Picker Item updates based upon conditional validations.

    A wizard displays all relevant validations per page and enables you to select the ones you want to replace with item settings. Then, you may select any buttons that you want to change to not execute validations (such as Cancel). Lastly, you can select any validations that should always execute (for example, checking privileges before deletion).

To upgrade an existing application:

  1. Navigate to the Workspace home page.

  2. Click the Application Builder icon.

  3. Select an application.

    The Application home page appears.

  4. Click Utilities.

  5. Click Upgrade Application.

  6. Follow the on-screen instructions.

Using the Database Object Dependencies Report

The Database Object Dependencies report identifies database objects referenced by the current application. Review this report to determine what objects to move when deploying an application.

To view the Database Object Dependencies report:

  1. Navigate to the Workspace home page.

  2. Click the Application Builder icon.

  3. Select an application.

    The Application home page appears.

  4. Click Utilities.

  5. Click Database Object Dependencies.

    The Database Object Dependencies page appears.

  6. Click Compute Dependencies.

    Tip:

    Display of the report may take a moment depending on the size and complexity of your application.

    The Database Object Dependencies report appears.

About Application Express Views

Application Express Views are data dictionary views that expose the metadata for applications. In Application Express Views, you can not only see the view, but you can also see the data they contain.

To view the data within a view, select the columns from the Select Column tab and click the Results button. On the Results tab, expand the Query region to view the query that was executed. You can copy this query for reuse with SQL Commands or SQL Developer.

Description of apex_views.gif follows
Description of the illustration apex_views.gif

About Page Specific Utilities

The Page Specific Utilities display on the right side of the Utilities page. Use these utilities to view component reports across pages in an application and by component type (for example, region, button, item, validation, process, dynamic action, or branch).

Description of page_util.gif follows
Description of the illustration page_util.gif

To access Page Specific Utilities page:

  1. Log in to Oracle Application Express.

    The Workspace home page appears.

  2. Click the Application Builder icon.

    The Application Builder home page appears.

  3. Click Utilities.

  4. Under Page Specific Utilities, select one of the following:

    • Cross Page Utilities. See "About Cross Page Utilities".

    • Region Utilities

    • Button Utilities

    • Item Utilities

    • Computations Utilities

    • Process Utilities

    • Dynamic Action Utilities

    • Branch Utilities

About Cross Page Utilities

The Cross Page Utilities page provides access to the following tools and reports:

Accessing Cross Page Utilities

To access the Page Utilities page:

  1. On the Workspace home page, click the Application Builder icon.

  2. Select an application.

  3. Click Utilities.

  4. From Page Specific Utilities, click Cross Page Utilities.

About Recently Updated Pages

The Recent Pages report displays a report of recently accessed pages within the current application. To link to a page, click the page number. To customize the report, use the Search Bar at the top of the page. See "Customizing Interactive Reports".

About Grid Edit of all Pages

Use the Grid Edit Pages report to edit the page name, alias, title, page template, and security options. To link to a specific page, click the Edit icon adjacent to the page number. To save your changes, click Apply Changes.

About Delete Multiple Pages

Use Delete Multiple Pages to delete multiple pages at once. See "Deleting Multiple Pages".

About the Page Attributes

The Page Attributes report details attributes, components, controls, and application logic for each page in the current application. To link to a specific page, click the page number. To customize the report, use the Search Bar at the top of the page. See "Customizing Interactive Reports".

About Page Groups

Use Page Groups to better organize the pages within an application. See "Grouping Pages".

About Page Locks

Use Page Locks to prevent conflicts during application development. By locking a page, you prevent other developers from editing it. See "Locking and Unlocking a Page".

About Cross Application Reports

Use the links on the Cross Application Reports page to view and edit information across multiple applications in the current workspace. You access cross application reports from Application Builder home page.

To access cross application reports:

  1. Log in to Oracle Application Express.

    The Workspace home page appears.

  2. Click the Application Builder icon.

    The Application Builder home page appears.

  3. From Tasks, click Cross Application Reports.

    The Cross Application Reports page is divided into the following sections:

    • Application Attributes

    • Application Comparison Reports

    • Security

    • User Interface

  4. Select a report to review.