24.6 Exporting an Application and Application Components

This section describes how to export and application and related files to another Oracle Application Express instance.

• About the Export Process

• About The Export Page

• Exporting an Application

• Exporting Application Components

• Exporting a Workspace

• Exporting a Page in an Application

• Exporting a Websheet

• About Exporting Static Files

• Exporting Themes

• Exporting Plug-ins

• Exporting User Interface Defaults

• Exporting Team Development Feedback

• Exporting Script Files from the Script Repository

Tip:

 You can also export workspaces, applications, and related files from a command-line using the APEXExport program located in the Utilities folder in the downloaded installation zip file. To learn more, see the Readme.txt file in the Utilities folder.

24.6.1 About the Export Process

Exporting an application from Oracle Application Express is very straightforward process and produces a readable script file with a .SQL extension. You can run this SQL script in any Oracle Application Express environment which is the same release or later than the environment from which you are exporting. For example, an application exported from Oracle Application Express release 4.0 can be imported into an environment running Oracle Application Express release 4.0, 4.1, or 4.2. However, an application exported from Oracle Application Express release 4.2 cannot be imported into an environment running Application Express 4.1 or earlier.

An application export includes the application definition, supporting objects, and shared components (including plug-ins, images, CSS files, JavaScript files and other files which must be managed independently). Instead of exporting complete applications you can also choose to export specific components, such as a page. This also creates a SQL script file. There are limitations when importing components into a different environments. As a best practice, it is better to export complete applications rather than individual components.If you wish to export an application and there are components, such as pages, that are not yet ready for testing then you can utilize Build Options to include or exclude various application components.

See Also:

Exporting an Application, Exporting Application Components, and Using Build Options to Control Configuration

24.6.2 About The Export Page

You export an application definition and all associated files using the following tabs at the top of the Export page: Export, Workspace, Application, Websheet, Themes, Plug-ins, Defaults, and Feedback.

Description of the illustration ''export_tabs.png''

You do not need to export an entire workspace unless you want to migrate workspace users or replicate shared component subscriptions in the target instance.

Once you export an application and any related files, you must import them into the target Oracle Application Express instance and then install them. As a general rule, always import the application first and then the related files.

Tip:

You can simplify the steps needed to deploy an application by creating a custom packaged application. See "How to Create a Custom Packaged Application."

See Also:

"How to Move an Application to Another Instance"

24.6.3 Exporting an Application

When you export an application, Oracle Application Express generates a text file containing PL/SQL API calls. An application export includes the application definition, supporting objects, and shared components (including plug-ins, images, CSS files, JavaScript files, and other files which must be managed independently).

See Also:

"Exporting Application Components" and "Installing Exported Applications into a Runtime Environment" in Oracle Application Express Administration Guide

To export an application:

1. Navigate to the Export page:

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

   2. On the Application Builder home page, click Workspace Utilities.

   3. Click Export.

2. Click the Applications tab.

3. Under Choose Application, select the application to export.

4. Under Export Application:

   1. File Format - Select how rows in the export file are formatted. Options include:

      • UNIX - The resulting file contains rows delimited by line feeds.

      • DOS - The resulting file contains rows delimited by carriage returns and line feeds.

      • Database - Exports the application to the file repository instead of producing a file to download.

   2. Owner Override - Optionally select another owner. By default, the application is owned by the owner identified in the application attribute owner.

   3. Build Status Override - Select one of the following:

      • Run Application Only - Developers can only run an application.

      • Run and Build Application - Developers can both run and edit an application.

      Selecting Run Application Only is an effective way to protect an application from modifications from other developers.

      Tip:

      If you select Run Application Only, you cannot set the argument p_trace to Yes. See "Using Build Options to Control Configuration". Also, the only way to change this setting after you import the application, is to log in to Oracle Application Express Administration Services. See "Changing Application Build Status Set During Deployment" in Oracle Application Express Administration Guide.

   4. Debugging - Select one of the following:

      • Yes - Exports the application with debugging enabled.

      • No - Exports the application with debugging disabled.

   5. As of - Enables you to go back in time and export a previous version of your application. For example, you can use this option to export a version of your application that contain an object that is currently deleted. Specify the number of minutes in the field provided.

      This utility uses the DBMS_FLASHBACK package. Because the timestamp to System Change Number (SCN) mapping is refreshed approximately every five minutes, you may have to wait that amount of time to locate the version for which you are looking. The time undo information is retained and influenced by the startup parameter UNDO_RETENTION (the default is three hours). However, this only influences the size of the undo tablespace. While two databases can have the same UNDO_RETENTION parameter, you are able to go back further in time on a database with fewer transactions because it is not filling the undo tablespace, forcing older data to be archived.

5. Under Export Preferences, select Yes or No to include or exclude the following:

   • Export Supporting Object Definitions

   • Export Public Interactive Reports

   • Export Private Interactive Reports

   • Export Interactive Report Subscriptions

   • Export Developer Comments

   • Export Translations

   • Export with Original IDs

   To learn more about an attribute, see field-level Help. See "Viewing Field-Level Help."

6. Click Export Application.

In addition to exporting the actual application file, you may also need to export other related files such as cascading style sheets, images, and script files.

See Also:

"Enabling SQL Tracing and Using TKPROF" and "Importing an Application, Page or Component Export"

24.6.4 Exporting Application Components

You can export shared components or components of a page on the Component Export page. You can use this wizard to:

• Export shared components or page components to another application or workspace.

• Back up a component before editing it.

• Create an export to function as a patch to another Oracle Application Express instance.

To export shared components or page components:

1. Navigate to the Component Export page:

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

   2. Select an application.

   3. Click Shared Components.

   4. From the Tasks list, click Export Application Components.

      The Component Export page appears.

2. Click the following tabs and select the components to export:

   • Components displays shared application components and entire pages. Use the navigation bar at the top of the page to search for components. See "Working with Shared Components."

   • Components by Page lists components of the selected page. Navigate to a specific page by making a selection from the Page. Click Check All to select all components.

   • Build Option Status displays available build options. Use this page to turn build options on and off. See "Exporting Build Options or Build Option Status."

   For each tab, select the appropriate components and click Add to Export.

3. Click Next.

4. For Component Export:

   1. File Format - Select how rows in the export file are formatted:

      • UNIX - The resulting file contains rows delimited by line feeds.

      • DOS - The resulting file contains rows delimited by carriage returns and line feeds.

   2. As of - Specify a time in minutes to go to back to for your export. This option enables you to go back in time in your application, perhaps to get back a deleted object.

      This utility uses the DBMS_FLASHBACK package. Because the timestamp to System Change Number (SCN) mapping is refreshed approximately every five minutes, you may have to wait that amount of time to locate the version for which you are looking. The time undo information is retained and influenced by the startup parameter UNDO_RETENTION (the default is three hours). However, this only influences the size of the undo tablespace. While two databases may have the same UNDO_RETENTION parameter, you are able to go back further in time on a database with fewer transactions because it is not filling the undo tablespace, forcing older data to be archived.

   3. Click Export Components.

Tip:

For translated applications, the Export Translations field displays. To export the selected shared components for the primary language application and all translated applications, from Export Translations field, select Yes. To ensure text strings and markup are up-to-date, remember to synchronize the translated applications prior to exporting the translated components.

See Also:

"Exporting an Application", "Exporting a Page in an Application", "Importing an Application, Page or Component Export", and "Exporting Build Options or Build Option Status"

24.6.5 Exporting a Workspace

You can move or copy a workspace to another Oracle Application Express instance by exporting a workspace. When you export a workspace, Oracle Application Express creates and ASCII text SQL script of users, any defined user groups, SQL Workshop artifacts like saved SQL, history, and SQL Scripts, and optionally Team Development data.

To export a workspace:

1. Navigate to the Export page:

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

   2. On the Application Builder home page, click Workspace Utilities.

   3. Click Export.

2. On the Export page, click the Workspace tab.

3. Under Export Workspace:

   • Include Team Development - Select Yes to include Team Development data such as Features, Milestones, To Do, Bugs, Feedback, Links and News. Only select Yes if the target instance for this workspace is not a runtime only instance. Otherwise, select No.

   • File Format - Select how rows in the export file are formatted:

     • UNIX - The resulting file contains rows delimited by line feeds.

     • DOS - The resulting file contains rows delimited by carriage returns and line feeds.

4. Click Export.

See Also:

"Managing Application Express Users" in Oracle Application Express Administration Guide

24.6.6 Exporting a Page in an Application

This section describes how to export a page in an application. When exporting a page, remember that exported pages can only be imported successfully if they have the same application ID and workspace ID.

To export a page in an application:

1. Navigate to the appropriate page:

   1. Page Designer:

      • Navigate to the appropriate page. See "Viewing a Page in Page Designer."

      • Click the Utilities menu and select Export.

   2. Component View:

      • Navigate to the appropriate page. See "Viewing a Page in Component View."

      • Click the Utilities menu and select Export.

   The Export Page Wizard appears.

2. From Page, select the page to export.

3. From File Format, select how rows in the export file are formatted. Options include:

   • UNIX - The resulting file contains rows delimited by line feeds.

   • DOS - The resulting file contains rows delimited by carriage returns and line feeds.

4. For As of, specify a time in minutes to go to back to for your export. This option enables you to go back in time in your application, perhaps to get back a deleted object.

   This utility uses the DBMS_FLASHBACK package. Because the timestamp to System Change Number (SCN) mapping is refreshed approximately every five minutes, you may have to wait that amount of time to locate the version for which you are looking. The time undo information is retained and influenced by the startup parameter UNDO_RETENTION (the default is three hours). However, this only influences the size of the undo tablespace. While two databases may have the same UNDO_RETENTION parameter, you are able to go back further in time on a database with fewer transactions because it is not filling the undo tablespace, forcing older data to be archived.

5. Click Export Page.

See Also:

"Exporting Application Components," "Exporting an Application," and "Importing an Application, Page or Component Export"

24.6.7 Exporting a Websheet

Use the Export Websheet utility to make a Websheet application available to other users.

To export a Websheet application:

1. Navigate to the Export page:

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

   2. On the Application Builder home page, click Workspace Utilities.

   3. Click Export.

2. On the Export page, click the Websheet tab.

3. On the Websheets page:

   1. Websheet Application - Select the Websheet to export.

   2. File Format - Select how rows in the export file are formatted. Options include:

      • UNIX - The resulting file contains rows delimited by line feeds.

      • DOS - The resulting file contains rows delimited by carriage returns and line feeds.

   3. Export Preferences - Select the appropriate options.

   4. Click Export.

See Also:

"Creating Websheet Applications" and "Importing a Websheet"

24.6.8 About Exporting Static Files

You can export static application files and static workspace files by creating a ZIP file. To learn more, see "Downloading All Static Application Files in a Zip" and "Downloading All Static Workspace Files in a Zip."

24.6.9 Exporting Themes

Use the Export Theme utility to export themes from one Oracle Application Express development instance to a file.

To export an application theme:

1. Navigate to the Export page:

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

   2. On the Application Builder home page, click Workspace Utilities.

   3. Click Export.

2. Click the Themes tab.

3. On the Themes page:

   1. Application - Select an application and click Set Application.

   2. Export Theme - Select the theme to export.

   3. File Format - Select how rows in the export file are formatted. Options include:

      • UNIX - The resulting file contains rows delimited by line feeds.

      • DOS - The resulting file contains rows delimited by carriage returns and line feeds.

   4. Click Export Theme.

See Also:

"Importing Themes" and "Using Themes"

24.6.10 Exporting Plug-ins

Use the Export Plug-in utility to export plug-ins from one Oracle Application Express development instance to a file.

To export a Plug-in from the Export page:

1. Navigate to the Export page:

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

   2. On the Application Builder home page, click Workspace Utilities.

   3. Click Export.

2. Click the Plug-ins tab.

3. On the Plug-ins page:

   1. Application - Select an application and click Set Application.

   2. Plug-in - Select the plug-in to export.

   3. File Format - Select how rows in the export file are formatted. Options include:

      • UNIX - The resulting file contains rows delimited by line feeds.

      • DOS - The resulting file contains rows delimited by carriage returns and line feeds.

   4. Click Export.

See Also:

"Importing Plug-ins"

24.6.11 Exporting User Interface Defaults

This section describes how to export User Interface Defaults.

• About Exporting User Interface Defaults

• Exporting User Interface Defaults from the Export Page

• Exporting User Interface Defaults from the User Interface Defaults Page

24.6.11.1 About Exporting User Interface Defaults

Exporting User Interface Defaults is useful when you plan to develop on a target system. User Interface Defaults are divided into two categories, the Table Dictionary, and the Attribute Dictionary.

• The Table Dictionary consists is specific to tables and columns within a selected schema. These defaults are used over those defined in the Attribute Dictionary.

• The Attribute Dictionary contains a set of attributes about a column that is used in creating forms and reports. The definitions are matched by column name and a particular definition can be shared among several columns by using synonyms.

When you export User Interface Defaults, all User Interface Defaults for the selected dictionary and schema are exported to a single SQL Command script. When prompted, save this file to your hard drive. The file contains an API call to create table hints by making calls to the application PL/SQL API. You can use this file to import User Interface Defaults to another database and Oracle Application Express instance.

See Also:

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

24.6.11.2 Exporting User Interface Defaults from the Export Page

To export User Interface Defaults from the Export page:

1. Navigate to the Export page:

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

   2. On the Application Builder home page, click Workspace Utilities.

   3. Click Export.

2. Click the User Interface Defaults tab.

3. On the Table Dictionary page:

   1. Schema - Select the schema that owns the table associated with the User Interface Defaults.

   2. File Format - Select how rows in the export file are formatted. Options include:

      • UNIX - The resulting file contains rows delimited by line feeds.

      • DOS - The resulting file contains rows delimited by carriage returns and line feeds.

   3. Click Export.

4. To export Attribute Dictionary, click Attribute Dictionary tab.

5. On the Attribute Dictionary page:

   1. File Format - Select how rows in the export file are formatted. Options include:

      • UNIX - The resulting file contains rows delimited by line feeds.

      • DOS - The resulting file contains rows delimited by carriage returns and line feeds.

   2. Click Export.

24.6.11.3 Exporting User Interface Defaults from the User Interface Defaults Page

To export User Interface Defaults from the User Interface Defaults page:

1. On the Workspace home page, click the SQL Workshop icon.

2. Click Utilities.

3. Click User Interface Defaults.

   The User Interface Defaults page appears.

4. Select the dictionary

   • Manage Table Dictionary - Select this button to export specific tables and columns within a selected schema.

   • Manage Attribute Dictionary - Select this button to export a set of column attributes used to create forms and reports.

5. Under Tasks, click Export.

6. For File format, select an option:

   • UNIX - The resulting file contains rows delimited by line feeds.

   • DOS - The resulting file contains rows delimited by carriage returns and line feeds.

   • Database - Exports to the file repository instead of producing a file to download.

7. Click Export.

24.6.12 Exporting Team Development Feedback

Use the Export Feedback utility to synchronize feedback from a production or test system to the development system. The development system is identified by using the workspace setting Feedback Synchronization Source Identifier which is set on the Edit Workspace Information page. If exporting from a development system, the export process has an additional attribute called Deployment System where you specify to which deployment system, production or test, you want to synchronize the updated feedback to.

To export Team Development Feedback:

1. Navigate to the Export page:

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

   2. On the Application Builder home page, click Workspace Utilities.

   3. Click Export.

2. Click the Feedback tab.

3. On the Feedback page:

   1. Changes Since - Select the date of the oldest feedback to export. All feedback from this selected date until the current date is exported.

   2. File Format - Select how rows in the export file are formatted. Options include:

      • UNIX - The resulting file contains rows delimited by line feeds.

      • DOS - The resulting file contains rows delimited by carriage returns and line feeds.

   3. Click Export.

See Also:

"Importing Team Development Feedback"

24.6.13 Exporting Script Files from the Script Repository

You can transfer selected scripts from your current Script Repository to a Script Repository in a different Workspace by using the Export and Import tasks.

To export script files:

1. On the Workspace home page, click the SQL Workshop icon.

2. Click SQL Scripts.

3. On the Tasks list, click Export.

4. Select the appropriate script files and click Add to Export.

5. Review the file name and click Export All.

   Select the Remove check box to remove the script.

See Also:

"Using SQL Scripts" in Oracle Application Express SQL Workshop Guide