HowTo Install

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 apexlib@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 Builder Plugin. I'm curious how many are actively using it and how much effort I should put into the Plugin. 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 apexlib@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

The Oracle APEX Builder Plugin is currently only supported for Firefox 2.x/3.x (with the Greasemonkey add-on) and Internet Explorer 6/7 (with the IE7Pro add-on).

It works with Oracle APEX 2.2 and higher. Some features also work with Oracle APEX 2.0 and 2.1, but not all, because the layout structure of the Builder is different in those versions.

New Installation for Firefox

Firefox Logo

If you are using Firefox as your favourite browser, you have to download and install the Greasemonkey add-on. This add-on is required for the Oracle APEX Builder Plugin to work properly.

After the installation you will see a little monkey icon () in the statusbar at the bottom right of your browser window.

Install the Oracle APEX Builder Plugin

  • Extract the zip file
  • Drag and drop apex_builder_plugin_for_FF.user.js into your browser window.
  • Confirm the installation dialog.

Verify that the Plugin is correctly running

  • Load one of your Oracle APEX applications into the APEX development environment.
  • Open the definition page of one of your page items.
  • You should notice that the "Display As" select list is split into two select lists and at the top of the page, you should see a new "Set" select list which contains several entries.
  • Go, try it out and select one of the predefined entries!

You have already done the basic installation!

To tweak the settings of the Plugin, follow the steps in the Advanced Configuration section.

Update Installation for Firefox

Firefox Logo

You have an existing installation of the Plugin and want to upgrade to the most current version?

Uninstall the existing version

  • Open the Firefox menu Tools/Greasemonkey/Manage User Scripts...
  • Select the APEX Builder Plugin entry.
  • Remember which version you had installed.
  • Check the Also uninstall associated preferences checkbox.
  • Press the Uninstall button.

Install the new version

  • Drag and drop apex_builder_plugin_for_FF.user.js into your browser window.
  • Confirm the installation dialog.

Verify that the Plugin is correctly running

  • Load one of your Oracle APEX applications into the APEX development environment.
  • Open the definition page of one of your page items.
  • You should notice that the "Display As" select list is split into two select lists and at the top of the page, you should see a new "Set" select list which contains several entries.

You are already done with the basic upgrade!

If you have used the apex_builder_plugin*.js config files, see the Advanced Configuration section for more details on how to merge your changes into the current version of the files.

Uninstall for Firefox

Firefox Logo

Are you sure you want to do this? Did it not work as expected or did you have problems during installation? Let me know! I want your feedback so that I can improve the Plugin. If you still want to uninstall it, follow the following steps.

  • Open the Firefox menu Tools/Greasemonkey/Manage User Scripts...
  • Select the APEX Builder Plugin entry.
  • Press the Uninstall button.

The Plugin is gone!

New Installation for Internet Explorer

Internet Explorer Logo

If you are using Internet Explorer (6/7) as your favourite browser, you have to download and install the IE7Pro add-on. This add-on also works for IE 6 and is required for the Oracle APEX Builder Plugin to work properly.

You have to check the "Enable Userscripts" checkbox during installation.

After the installation you will see a little blue icon () in the statusbar at the bottom right of your browser window.

Install the Oracle APEX Builder Plugin

  • Extract the zip file
  • Drag and drop apex_builder_plugin_for_IE.ieuser.js into your browser window.
  • Confirm the installation dialog.

Verify that the Plugin is correctly running

  • Load one of your Oracle APEX applications into the APEX development environment.
  • Open the definition page of one of your page items.
  • You should notice that the "Display As" select list is split into two select lists and at the top of the page, you should see a new "Set" select list which contains several entries.
  • Go, try it out and select one of the predefined entries!

You have already done the basic installation!

To tweak the settings of the Plugin, follow the steps in the Advanced Configuration section.

Update Installation for Internet Explorer

Internet Explorer Logo

You have an existing installation of the Plugin and want to upgrade to the most current version?

Uninstall the existing version

  • Open the Internet Explorer menu Tools/IE7Pro Preferences
  • Select the User Scripts entry.
  • Select the APEX Builder Plugin script.
  • Remember which version you had installed.
  • Press the Uninstall button.

Install the new version

  • Drag and drop apex_builder_plugin_for_IE.ieuser.js into your browser window.
  • Confirm the installation dialog.

Verify that the Plugin is correctly running

  • Load one of your Oracle APEX applications into the APEX development environment.
  • Open the definition page of one of your page items.
  • You should notice that the "Display As" select list is split into two select lists and at the top of the page, you should see a new "Set" select list which contains several entries.

You are already done with the basic upgrade!

If you have used the apex_builder_plugin*.js config files, see the Advanced Configuration section for more details on how to merge your changes into the current version of the files.

Uninstall for Internet Explorer

Internet Explorer Logo

Are you sure you want to do this? Did it not work as expected or did you have problems during installation? Let me know! I want your feedback so that I can improve the Plugin. If you still want to uninstall it, follow the following steps.

  • Open the Internet Explorer menu Tools/IE7Pro Preferences
  • Select the User Scripts entry.
  • Select the APEX Builder Plugin script.
  • Press the Uninstall button.

The Plugin is gone!

Advanced Configuration

After you are done with the basic configuration you should have a working APEX Builder Plugin with all the features enabled. If you want to enable/disable features, for example the Seamless Integration of ApexLib Framework is disabled by default, you can do that in the APEX Builder Plugin Settings.

Go on a page which belongs to application 4000 (URL has to contain f?p=4000). For example the page "Page Definition".

  • Firefox:
    • Select Tools\Greasemonkey\User Script Commands...\APEX Builder Plugin Settings...
  • Internet Explorer:
    • Open the context menu by right mouse click onto the little blue icon () in the statusbar at the bottom right of your browser window.
    • Select User Script Commands\APEX Builder Plugin Settings...

For your convenience the Plugin is setup to load the dynamic configuration files for the "Set" feature, the keyboard shortcuts, the ApexLib Integration, ... from

http://builderplugin.oracleapex.info/config/1.9/

For a description what this dynamic configuration files can do for you, see the documentation.

The next section will explain where you have to install them if you want to change them to your needs. If you have done an upgrade from a previous version of the Plugin, see the Upgrade existing Config Files section.

Use your own Config Files

If you want to modify these files to meet your own needs, you have to take the files from the config directory and copy them somewhere where the Plugin has access to. The config files for ApexLib are not included in the distribution, you have to download them separately from the ApexLib Homepage.

But where can you put this files? You have at least 4 options.

Apache Web Server

You can copy the files into a new directory on the Apache Web Server where your mod_plsql is running.

  • On the Apache Web Server go into the images directory where all the other Oracle APEX related images are located. See the Oracle APEX Installation Guide where this directory can be found.
  • Create a new directory apex_builder_plugin
  • Copy the files from the config directory into this new directory.
  • Try and see if you are able to access one of the files from your browser. Enter
    http://yourdomain:port/i/apex_builder_plugin/test.html
    into your browser.
  • Set the URL Prefix in the APEX Builder Plugin Settings to
    /i/apex_builder_plugin/

XMLDB for Oracle XE/11g

If you use Oracle XE or 11g with the built in Web Server you can use XMLDB to store the files.

  • See Dietmar Aust's blog posting about file storage on XE/11g.
  • After you have mapped http://yourdomain:port/i/ with WebDAV, create a new directory apex_builder_plugin
  • Copy the files from the config directory into this new directory.
  • Try and see if you are able to access one of the files from your browser. Enter
    http://yourdomain:port/i/apex_builder_plugin/test.html
    into your browser.
  • Set the URL Prefix in the APEX Builder Plugin Settings to
    /i/apex_builder_plugin/

Static Files in Oracle APEX Workspace

You can upload them as Static File into your Oracle APEX Workspace.

  • Go to Shared Components\Static Files
  • Upload the files from the config directory into this new directory. Note: Don't assign them to an application!
  • Set the "View" select list to "Details" mode and click the "Go" button.
  • Right mouse click on one of the download icons to open the context menu.
  • Select the menu entry Copy Link Location. You should get something like
    /pls/apex/wwv_flow_file_mgr.get_file?p_security_group_id=2647143312916903283&p_fname=
    when you remove the host name and the filename at the end.
  • Set the URL Prefix in the APEX Builder Plugin Settings to the URL you got.

On any Web Space

But you can put them onto any web space you have access to.

  • Create a new directory apex_builder_plugin
  • Copy the files from the config directory into this new directory.
  • Try and see if you are able to access one of the files from your browser. Enter
    http://yourdomain:port/your_directory/apex_builder_plugin/test.html
    into your browser.
  • Set the URL Prefix in the APEX Builder Plugin Settings to
    http://yourdomain:port/your_directory/apex_builder_plugin/

Have fun hacking the Oracle APEX Builder!

If you have problems, check out the FAQ section.

Upgrade existing Config Files

See the Change Log to get a list of changed and new configuration files between your previous version and the new Plugin version. You can use the diff link to find out what has changed, so that you can merge it into your modified configuration files.

Version 1.7 and newer is using the new jQuery 1.2.1. Unfortunately jQuery has removed some of the selectors, so check the configuration files in case you have modified them. See jQuery 1.2.1 Removed Functionality for details.

If you use the ApexLib Framework Integration, get the newest config files from the ApexLib Homepage and copy them over the existing files.

That's it, you are up an running!

FAQ

The "User Script Commands" menu entry is disabled.

Make sure that you are on a page of application 4000. For example the page "Page Definition".

I have modified a config file, but the change doesn't show up.

Depending where you put your config files, the files are maybe cached by our browser. You can check that by adding a
alert('file loaded');

into your code. If it doesn't show up, try to clear your browser cache.

  • Firefox: Go to Tools\Options...\Advanced\Network and click the Clear Now button.
  • Internet Explorer: Tools\Internet Options\Browser History\Delete\Temporary Internet Files and click the Delete Files... button.

The file is loaded, but there is still something wrong.

Check if a Javascript error was raised, while your file was parsed by the browser.
  • Firefox: Open Tools\Error Consoles...
  • Internet Explorer: Check the error indicator icon in the statusbar of your browser.

Still can't find what is wrong!

Send me the config file which doesn't work, maybe I see what's wrong. My e-mail address is apexlib@oracleapex.info You can also post your problem in the Support Forum.