Legal Information

The program(s) and/or file(s) are supplied as is. The author disclaims all warranties, expressed or implied, including, without limitation, the warranties of merchantability and of fitness for any purpose. The author assumes no liability for damages, direct or consequential, which may result from the use of these program(s) and/or file(s).

If you have further questions, please contact me at patrick.wolf@oracleapex.info

Overview
Before you begin

Because nobody reads post-installation instructions, the important information at the beginning! :-)

I would really appreciate it if you would inform me if you are using the Oracle APEX Essentials. I'm curious how many are actively using it and how much effort I should put into the tool. If you like it, donate a small amount to support my development efforts. Thanks a lot!

If you have suggestions or problems

Just drop a note to patrick.wolf@oracleapex.info, create a feature/bug report on Sourceforge - Tracker or write a message in the Support Forum.

Thanks for your attention and have fun using the Plugin!

Stay informed by subscribing to the RSS feed. If you prefer, you can also be
notified by e-mail.
Installation Requirements

Oracle APEX Essentials currently supports Oracle APEX versions 3.1.x, 3.2 on Oracle XE, 10gR2 and 11i.

Note: Oracle 10gR1 (10.1.x) works to some extend, but it doesn't support all the regular expression commands, so some checks do not find the patterns or return wrong check results. Eg. all report queries are detected as wrong.

Simple Installation

All your applications have the same "Parsing Schema" (see Shared Components\Application Definition) or you want to install Oracle APEX Essentials into each of this Parsing Schemas.

  1. Login into the Oracle APEX Builder.
  2. Import the apex_essentials.sql application definition file (Application Builder\Import).
  3. When prompted if you want to install the supporting objects, select Yes and continue.
You are done! Have fun checking your applications.

Install into its own APEX Essentials schema

If you have multiple parsing schemas referenced in your Oracle APEX applications, you can install Oracle APEX Essentials into each of this schemas, or you just install it once into its own schema.

  1. Open a command box.
    Eg on Windows Start/Execute => cmd
  2. Change into the Scripts directory.
    cd Scripts
  3. Connect with SYS to create the APEX_ESSENTIALS schema. See ae_create_ae_schema.sql, why SYS and not an user with DBA privileges is required.
    sqlplus "sys/password@database as sysdba"
  4. Execute the following script to create the schema APEX_ESSENTIALS and all the necessary privileges
    @ae_create_ae_schema.sql
  5. Execute the following installation scripts: (connected as AE, APEX_ESSENTIALS, ...)
    1. @ae_install_into_ae_schema.sql
    2. Grant the APEX Essentials objects to the schema where you are going to install the Oracle APEX Essentials application. (Note: That's NOT the AE, APEX_ESSENTIALS, ... schema!!!)
      You can also grant to PUBLIC, but a specific schema is always better than public grants/synonyms.
      @ae_grant_and_create_synonyms.sql
  6. Lock the AE, APEX_ESSENTIALS, ... schema with a DBA user or with SYS.
    ALTER USER APEX_ESSENTIALS ACCOUNT LOCK;
  7. Login into the Oracle APEX Builder.
  8. Import the apex_essentials.sql application definition file (Application Builder\Import).
  9. When prompted for the Parse As Schema select any schema of your workspace.
  10. When prompted if you want to install the supporting objects, select No and continue.
You are done! Have fun checking your applications.