4 Converting an Oracle Forms Application

Converting FormModules, ObjectLibraries, or MenuModules to XML

You can convert Oracle Forms FormModule, MenuModule, and ObjectLibrary files to Extensible Markup Language (XML) using the Oracle Forms to XML conversion tool, Forms2XML.

This section includes these topics:

• About the Forms2XML Conversion Tool

• Using the Forms2XML Conversion Tool From a Command Line

• Using the Forms2XML Conversion Tool in a Java Program

frmf2xml [options] file1 [file2...]
java oracle.forms.util.xmltools.Forms2XML [options] file1 [file2...]

...
 // get the modules in the session
 JdapiIterator mods = Jdapi.getModules(); 
    // ... and iterate round them 
    while(mods.hasNext())
      {
        JdapiModule mod = (JdapiModule)mods.next();
        Forms2XML converter = new Forms2XML(
        XMLDocument doc = converter.dumpModule(false);
              ... 
       }

http://www.oracle.com/webapps/online-help/forms/

Converting a PL/SQL Library

To convert a PL/SQL library, use the File > Convert option in Oracle Forms Builder to convert PL/SQL library .PLL files to .PLD text files.

To learn more about Oracle Forms, see the following hosted Help file:

http://www.oracle.com/webapps/online-help/forms/

Converting an Oracle Report to XML

To convert an Oracle Report, use the File Conversion option in Reports Builder to convert binary (.RDF), ASCII (.REX), and .JSP reports to XML format.

To learn more about Oracle Reports, see the following hosted Help file:

http://www.oracle.com/webapps/online-help/reports

Creating a Workspace Manually

To create an Oracle Application Express workspace manually:

1. Log in to Oracle Application Express Administration Services. Oracle Application Express Administration Services is a separate application for managing an entire Oracle Application Express instance. You log in using the ADMIN account and password created or reset during the installation process.

   1. In a Web browser, navigate to the Oracle Application Express Administration Services application. By default, Oracle Application Express Administration Services installs to the following location:

      • If your setup uses the embedded PL/SQL gateway, go to:

        http://hostname:port/apex/apex_admin
        

        Where:

        hostname is the name of the system where Oracle XML DB HTTP Server is installed.

        port is the port number assigned to Oracle XML DB HTTP Server. In a default installation, this number is 8080.

        apex is the database access descriptor (DAD) defined in the configuration file.

      • If your setup uses Apache and mod_plsql, go to:

        http://hostname:port/pls/apex/apex_admin
        

        Where:

        hostname is the name of the system where Oracle HTTP Server is installed.

        port is the port number assigned to Oracle HTTP Server. In a default installation, this number is 7777.

        pls is the indicator to use the mod_plsql cartridge.

        apex is the database access descriptor (DAD) defined in the mod_plsql configuration file.

   2. On the Login page:

      • In Username, enter admin.

      • In Password, enter the Oracle Application Express administrator account password you specified when you installed Oracle Application Express.

      • Click Login.

   See Also:

   See "Logging in to Oracle Application Express Administration Services" in Oracle Application Express Administration Guide.

   Next, create a workspace.

2. Click Manage Workspaces.

3. Under Manage Workspaces, click Create Workspace.

   The Create Workspace Wizard appears.

4. For Identify Workspace, enter a workspace name and description and click Next.

5. For Identify Schema, select the Oracle Forms application schema.

   1. For Re-use existing schema, select Yes.

   2. Select a schema from the list.

   3. Click Next.

      Tip:

      If the Oracle Forms application schema exists in the current database, select it. If it does not exist in the current database, follow the steps outlined in "Step 3: Upload Database Objects into the Schema Associated with Your Workspace" .

6. For Identify Administrator, enter the Workspace administrator information and click Next.

7. Confirm your selections and click Create.

Creating Oracle Application Express Users

To create an Oracle Application Express user account:

1. Log in to Oracle Application Express Administration Services as described in the previous section. See "Logging in to Oracle Application Express Administration Services" in Oracle Application Express Administration Guide.

2. Click Manage Workspaces.

3. Under Manage Workspaces, click Manage Developers and Users.

   The Manage Developers and Users page appears.

4. Click Create.

   The Create/Edit User page appears.

5. Under User Attributes, enter the appropriate information. Fields marked with an asterisk are required.

   Tip:

   To learn more about a specific attribute, 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.

6. Under Password, type a case-sensitive password for this account.

   If your organization has set up a password policy, be sure the password meets the requirements.

7. Under Developer Privileges, select the appropriate privileges:

   • User is a developer - To add this user as a developer, select Yes. For end users, select No.

     Developers can create and modify applications and database objects and view developer activity, session state, workspace activity, application, and schema reports.

   • User is a workspace administrator - To add this user as a Workspace administrator, select Yes. For developers or end users, select No.

     In addition to having developer privileges, workspace administrators can create and edit user accounts, manage groups, alter passwords of users within the same workspace, and manage development services.

8. Under Account Control, specify the following:

   • Account Availability - Select Unlocked to enable a user to log in to this account.

   • Require Change of Password on First Use - Select Yes to require the user to change the password immediately after logging in with the current, temporary password. Otherwise, select No.

9. Click Create User or Create and Create Another.

Logging in to Your Oracle Application Express Workspace

Once you create a workspace, you must log in to it using your login credentials (that is, the workspace name, user name, and password).

To log in to a workspace:

1. In a Web browser, navigate to the Oracle Application Express Login page. By default, Oracle Application Express installs to the following location:

   • If your setup uses the embedded PL/SQL gateway, go to:

     http://hostname:port/apex
     

     Where:

     • hostname is the name of the system where Oracle XML DB HTTP Server is installed.

     • port is the port number assigned to Oracle XML DB HTTP Server. In a default installation, this number is 8080.

     • apex is the database access descriptor (DAD) defined in the configuration file.

       For users who have upgraded from earlier releases, or who have a custom configuration, this value may be htmldb or something else. Verify your DAD with your Oracle Application Express administrator.

   • If your setup uses Oracle HTTP Server (Apache) and mod_plsql, go to:

     http://hostname:port/pls/apex
     

     Where:

     • hostname is the name of the system where Oracle HTTP Server is installed.

     • port is the port number assigned to Oracle HTTP Server. In a default installation, this number is 7777. You can find information about your Oracle HTTP Server installation's port number from either of the following files:

       ORACLE_BASE\ORACLE_HOME\install\portlist.ini
       ORACLE_BASE\ORACLE_HTTPSERVER_HOME\Apache\Apache\conf\httpd.conf
       

       Be aware that if you change a port number, it is not updated in the portlist.ini file. You can only rely on this file immediately after installation.

     • pls is the indicator to use the mod_plsql cartridge.

     • apex is the database access descriptor (DAD) defined in the mod_plsql configuration file.

       For users who have upgraded from earlier releases, or who have a custom configuration, this value may be htmldb or something else. Verify your DAD with your Oracle Application Express administrator.

   The Login page appears.

2. Under Login, enter the following:

   • Workspace field - Enter the name of your workspace.

   • Username field - Enter your user name.

   • Password field - Enter your case-sensitive password.

3. Click Login.

   Note that, depending on your setup, you might be required to change your password when you log in for the first time.

About the Project Page

The Project page shows a high-level overview of your Oracle Forms conversion project.

This section includes these topics:

• Understanding the Project Page

• Editing Project Details

• Uploading Additional Files

Understanding the Project Page

Description of the illustration project_page.gif

With the exception of the File Name column, most of the information on the Project page only applies to FormModule XML files (for example, Blocks, Triggers, and Program Units columns). If a column does not apply to the uploaded file, a 0 displays.

The Project page lists the following information about uploaded files:

• Type - Identifies the type uploaded by displaying the appropriate file extension (for example, RPT for Report and FMB for FormModule files).

• File Name - Displays the file name and extension (XML or TXT) uploaded into the project.

• Blocks - Displays a count of blocks in FormModule XML file. A single block can be mapped to a region in Oracle Application Express. A region is a area on a page that serves as a container for content. Each page can have any number of regions. You control the appearance of a region through a specific region template.

• DB Blocks - Displays the database data blocks in the uploaded FormModule XML file. These blocks can be based on any of the following block data source types: table; procedure; transactional trigger; or subquery. Blocks included in the DB Blocks count are not control blocks. Note that the associated Database Block property is set to Yes.

• Triggers - Displays a count of all form-level, block-level and item-level triggers associated with the uploaded FormModule XML file.

• Record Groups - Displays a count of Record Groups in the uploaded FormModule XML file.

• Lists of Values - Displays a count of lists of values (LOVs) in the uploaded FormModule XML file.

• Alerts - Displays a count of alerts in the uploaded FormModule XML file.

• Program Units - Displays the number of schema objects that enable you to access and manipulate database information.

• Component Count - Lists the number of components that have been uploaded to the Conversion project.

• Completed Components - Displays a count of components within the conversion process that have been reviewed and have been marked as Complete.

• Percent Complete - Lists percent of components which have been marked as Complete.

You can review Forms attributes and track manual conversion by clicking the links on this page.

About the Search Bar

A Search bar appears at the top of the page. Use this tool to create custom searches and customize and filter the information that appears on the Project page.

Description of the illustration search.gif

The Search bar contains the following controls:

• Finder Drop Down - Enables users to search on a selected column or against all columns.

• Search Field - Displays a text field in the search bar in which to enter search criteria.

• Rows - Displays a select list to select the number of rows to display per page.

• Actions Menu - Enables you to customize the report based on selected Actions menus. To learn more about the Actions menu, select the Help link as shown in the following graphic.

Description of the illustration actions_menu.gif

About the Upload File, Create Application, and Run Application Buttons

Three buttons display to the right of the Search Bar:

• Click Upload File to add files to your conversion project. See "Uploading Additional Files".

• Click Create Application to create an Oracle Application Express application based on the components included in your conversion project. See "Step 6: Generate the Oracle Application Express Application".

• Click Run Application to submit the pages within your Oracle Application Express application to the Oracle Application Express and render viewable HTML. Note this button only appears after you generate an application.

About the Associated Application Box

The Associated Application box only displays after you create an application. This box displays application name, number of application pages, last update date, and the user who performed the updates. Click the application name to link to the Application home page within Application Builder.

Description of the illustration project_ass_app.gif

About the Tasks List

The Tasks box displays on the right side of the page and displays the following links:

• Delete Project deletes the current project.

• Edit Project Details and Applicability links to the Project Details page. See "Editing Project Details".

• About Forms Conversion links to a page that explains how to convert Oracle Forms applications.

• Set Application Defaults links to the Set Application Defaults page. See "Setting Up Application Defaults".

About the Completion Status Box

A Completion Status box displays on the right side of the page listing the total number of components, completed components, and percent complete.

Description of the illustration project_page_status.gif

Editing Project Details

Click the Edit icon on the Project page to access the Project Details page. The Edit icon resembles a small yellow pencil.

Use the Project Details page to edit project details and specify what components to include in your conversion project.

Modifying Component Applicability Defaults

Use the Applicability section to specify whether to include specific components in your conversation project. Select Yes or No adjacent to a component type.

Description of the illustration applicability.gif

See Also:

"Using Annotations to Track the Conversion Process"

Reviewing Forms Modules

From the Project page you can browse the objects included in your uploaded Oracle FormModule XML file (for example, myForm_fmb.xml).

This section includes these topics:

• Viewing an Imported FormModule

• Viewing Object Metadata and Selecting Specific Objects

• Viewing and Selecting Blocks

• Viewing and Selecting Items

Reviewing Oracle Reports

From the Project page you can browse uploaded Oracle Report XML files (for example, myReport.XML).

This section includes these topics:

• Viewing Reports

• Selecting Reports to Include

http://www.oracle.com/webapps/online-help/reports

Reviewing PL/SQL Libraries

From the Project page you can browse uploaded PL/SQL libraries associated with your Oracle Forms application (for example, myLibrary.PLD) and update annotations. Note that PL/SQL libraries are not generated within Oracle Application Express. However, the files are imported to enable you to review and track them.

To view the PL/SQL Library Details page:

1. Go to the Project page:

   1. On the Workspace home page, click the Applications Migrations link on the right side of the page.

   2. Click a project name.

      The Project page appears.

2. Click the PL/SQL library XML file name (for example, myLibrary.PLD).

   The PL/SQL Library Details page appears.

3. To delete the library, click Delete.

4. To download the library, click the Download link.

Reviewing Forms Menus

From the Project page you can browse the objects included in your uploaded MenuModule XML file (for example, myMenu_mmb.XML) and update annotations. Note that Forms Menus are not generated within Oracle Application Express. However, the files are imported to enable you to review and track them.

This section includes these topics:

• Viewing Form Menus

• Viewing a Summary of Forms Menus

• Viewing Form Menu and Program Unit Details

http://www.oracle.com/webapps/online-help/forms/

Reviewing Object Libraries

From the Project page you can browse uploaded Object Libraries associated with your Oracle Forms application (for example, myObjects_olb.XML) and update the annotations. Note that Object Libraries are not generated within Oracle Application Express. However the files are imported to enable you to review and track them.

To view the Forms Object Library page:

1. Go to the Project page:

   1. On the Workspace home page, click the Applications Migrations link on the right side of the page.

   2. Click a project name.

      The Project page appears.

2. Click the Edit icon to the left of the Object Library XML file name (for example, myObjects_olb.XML).

   The Object Library Details page appears.

Using Annotations to Track the Conversion Process

Use Annotations to track the overall status of an object within the conversion process. Most detail pages that describe a specific object include an Annotations section.

Use these fields to determine whether an object should be included in the conversion, assign a priority, track status, assign the object to specific individual, or create notes and tags.

Options include:

• Applicable - Tracks whether the object is applicable within the context of the generated Oracle Application Express application. Select Yes or No.

  The initial value is determined by the applicability default settings for that component or trigger defined on the Project Details page.

• Priority - Assign a numeric priority to the object.

• Complete - Track if the conversion is complete. Select Yes or No.

• Assignee - Assign the object to a specific user.

• Notes - Enter notes regarding the object.

• Tags - Assign tags to the object.

The values defined in Applicable and Complete are used in determining the percentage complete. All the Applicable and Complete values can be changed for a block at one time from the Bulk Changes page.

Setting Up Application Defaults

To set up application defaults (optional):

1. On the right side of the project page, click Set Application Defaults in the Tasks list.

2. Select the options you want to use as defaults.

   For information, click Help or click the item label. Clicking the item label opens a separate window describing the item and its options.

3. Click Apply Changes.

   The project page appears.

Creating an Application

To create an application:

1. On the project page, click Create Application.

2. In Name, specify the following:

   1. Name - Enter a name for this application. The default name is based on the project name.

   2. Create Application - Choose a creation method. Select Based on Migration Project.

      Tip:

      Selecting Based on existing application design model enables you to reuse a model from a previously generated Oracle Application Express application.

   3. Click Next.

3. In the Selected Application Objects section, you can customize specific pages. For example:

   • Rename a page. Click the Page Name link and enter the new name on the New Page Definition page that appears.

   • Select home page navigation. Click the Home link. The Page Definition appears. Under Navigation, select one of the following:

     • Vertical Unordered List with Bullets

     • Vertical Images List

     • Horizontal Images List (default)

   • To display an image on a parent page, click the Page Name link. The Page Definition appears. Scroll down to Page Icon. Select and image from the list list or click the Find icon (flashlight) to view additional options.

     Repeat this step for each parent page. If you do not explicitly select an image for a page, the default image displays for that page.

     Note that for the image to appear in your application, you must have selected either Vertical Images List or Horizontal Images List for the Home page navigation.

4. To add additional pages to the application, scroll down to the Add page section. Select a page type and click Add Page. To learn more about each page type, click item Help.

   Note that the new page appears at the bottom of the list in the Selected Application Objects section.

5. Click Next.

6. Select a theme for the application and click Next.

   A theme is a collection of templates that define the layout and style of an application, including buttons and pages.

7. Confirm your selections and click Create.

8. To preview the application, click Run Application. Then, log in using your Oracle Application Express workspace credentials.

   Your application now appears as a separate application in Oracle Application Express.

9. To customize your application, scroll down to the Developer toolbar and click Edit Application.

   You might want to do the following customizations immediately after you generate your application:

   • Rename the application. Each application has a unique ID, but the conversion project name becomes the application name by default. To more easily identify an application, you might want to change its name to something more meaningful by editing the application attributes.

   • Change the authentication scheme. By default, the authentication scheme is Application Express authentication. You can change this by editing the application attributes.

   See Also:

   For further details on why the model shows the given pages based on your Forms, see "Block to Page Region Mappings". For information on editing application attributes, adding pages, deploying your application see the Oracle Application Express Application Builder User's Guide or online Help.