2.9 Using the App Gallery

Use the App Gallery to install Sample Apps, Starter Apps, Custom Apps, and Utility Apps.

• About Sample Apps, Starter Apps, Custom Apps, and Utility Apps
  Sample Apps and Starter Apps are available with every Oracle APEX workspace. Custom Apps are only available if your instance administrator has enabled them. Utility Apps are ready-to-use apps that simplify common APEX application development tasks.
• About the Oracle APEX GitHub Repository
  The Oracle APEX GitHub repository contains Starter Apps, Sample Apps, sample code, and plug-ins you can use in your workspace.
• Installing Apps from the Gallery
  Install Sample and Starter Apps directly from the Gallery by clicking Install.
• Uninstalling Apps from the Gallery
  Uninstall Sample and Starter Apps directly from the Gallery.

See Also:

Configuring the Application Gallery in Oracle APEX Administration Guide

2.9.1 About Sample Apps, Starter Apps, Custom Apps, and Utility Apps

Sample Apps and Starter Apps are available with every Oracle APEX workspace. Custom Apps are only available if your instance administrator has enabled them. Utility Apps are ready-to-use apps that simplify common APEX application development tasks.

You can access the Gallery from the top menu or by typing Gallery in the Global Search field (also known as Spotlight Search). The Gallery includes four types of applications:

• Sample Apps - Built with sample data that highlight specific functionality. You can use them as a developer guide for how particular features work.
• Starter Apps - Fully functional apps that provide standalone solutions for simple requirements. You can use them as is or extend them with custom functionality.
• Custom Apps - Specific to your workspace. Custom Apps are only available if your instance administrator has enabled them.
• Utility Apps - Ready-to-use applications that simplify common APEX application development tasks. The Utility Apps heading only displays in APEX if at least one utility application is available.

You can install Sample Apps, Starter Apps, Custom Apps, and Utility Apps directly from the Gallery. You can also download Sample Apps and Starter Apps from GitHub to import into your workspace.

See Also:

• Importing an Application or Page Export
• Configuring the Gallery in Oracle APEX Administration Guide

2.9.2 About the Oracle APEX GitHub Repository

The Oracle APEX GitHub repository contains Starter Apps, Sample Apps, sample code, and plug-ins you can use in your workspace.

• Navigating the GitHub Repository
  Use the GitHub repository to access documentation, license information (if applicable), and installation files for Sample and Starter Apps.

2.9.2.1 Navigating the GitHub Repository

Use the GitHub repository to access documentation, license information (if applicable), and installation files for Sample and Starter Apps.

The Oracle APEX GitHub repository can be accessed at https://github.com/oracle/apex. Under Oracle APEX on GitHub, click a branch to view. The repository contains information you can use to customize apps:

• docs contains the installation source file.
• plugins contains examples for APEX plug-ins.
• sample-apps contains the sample apps found in the Gallery.
• sample-code contains code examples for APEX functionality.
• starter-apps contains the starter apps found in the Gallery.

To access GitHub from an APEX workspace:

1. Navigate to the Workspace home page.
2. Click the Gallery icon.
   The Gallery page opens, displaying cards for Sample Apps. Starter Apps, and Custom Apps.
3. Choose either Sample Apps or Starter Apps.

   Each app displays as a card with a description.

4. To access GitHub:
   1. Click the More Info button () which resembles a vertical ellipses.
   2. From the menu, select More Info again.
   The GitHub directory for the app opens.
5. All files associated with the app including the README, licenses (if applicable), and installation files are available for viewing.
   The README contains instructions for installing the app.
6. Download the files you need.

You can now install the app.

2.9.3 Installing Apps from the Gallery

Install Sample and Starter Apps directly from the Gallery by clicking Install.

Sample and Starter Apps can be installed from the Gallery. Custom Apps can be installed from the Gallery if they have been enabled by your instance administrator. Utility Apps can be installed from the Gallery if available.

To install apps from the Gallery:

1. Navigate to the Workspace home page.
2. Click the Gallery icon.

   The Gallery page opens displaying cards. Each card displays a description and buttons. The buttons that display differ depending upon whether the app is installed.

3. The card for an uninstalled app resembles the following example:
   
   

   
   Description of the illustration gallery_uninstalled_app.png

   
   

   Availlable controls include:

   • More Info - More Info () features an image of a vertical ellipses. Options include:
     • Application Details - Displays a dialog with additional information about the app. Expand Advanced Settings to install the app but configure the application ID and parsing schema.

       For Install As Application, specify whether the Application ID will be assigned automatically (default) or manually. For Parsing Schema, select the parsing schema. Click Install Application to complete the installation

     • More Info - Click More Info to open the GitHub repository in a new browser tab. See About the Oracle APEX GitHub Repository.
   • Install - Click Install to perform a quick install of the app.
4. The card for an installed app resembles the following example:
   
   

   
   Description of the illustration gallery_installed_app.png

   
   

   Available controls include:

   • More Info - More Info () features an image of a vertical ellipses. Options include:
     • Application Details - Displays a dialog with additional information about the app. Click Remove Application to remove the application.
     • Remove - Removes the application.
     • More Info - Click More Info to open the GitHub repository in a new browser tab. See About the Oracle APEX GitHub Repository.
   • Edit - Click Edit to view the application on the Application home page.
   • Run - Click Run to view a rendered version of the application.

See Also:

• Understanding the Application Home Page
• Running an Application or Page
• Importing an Application or Page Export
• Editing Pages in Page Designer

2.9.4 Uninstalling Apps from the Gallery

Uninstall Sample and Starter Apps directly from the Gallery.

To uninstall Sample and Starter Apps directly from the Gallery, click More Info () and select Remove.

Only apps that were installed from the Gallery can be uninstalled using the procedure described in this topic. Apps downloaded and imported from GitHub will not display a Remove icon and must be deleted manually as described in Deleting an Application.

Note:

Any customizations that were made to an app will be lost if the app is uninstalled. These customizations will not be restored if the app is reinstalled. To preserve customizations, export the application and then import the export file back into your workspace. See Exporting and Importing from App Builder.

To uninstall apps from the Gallery:

1. Navigate to the Workspace home page.
2. Click the Gallery icon.

   The Gallery page opens.

3. Find the card for the app to be removed.
4. Click More Info () and select Remove.
5. On the confirmation screen, click Remove again.

The app is uninstalled. It can be reinstalled if needed.

See Also:

Deleting an Application