Skip to main content

Stop using validations for checking constraints !

 If you run your APEX application - like a Form based on the EMP table - and test if you can change the value of Department to something else then the standard values of 10, 20, 30 or 40, you'll get a nice error message like this:

But it isn't really nice, is it? So what do a lot of developers do? They create a validation (just) in order to show a nicer, better worded, error message like "This is not a valid department".  And what you then just did is writing code twice : Once in the database as a (foreign key) check constraint and once as a sql statement in your validation. And we all know : writing code twice is usually not a good idea - and executing the same query twice is not enhancing your performance!

So how can we transform that ugly error message into something nice? By combining two APEX features: the Error Handling Function and the Text Messages!

Start with copying the example of an Error Handling Function from the APEX documentation. Create this function in your database schema and define this as the Error Handling Function for your application:

When you put this in place, the message gets a bit better - the ORA-02291 is removed - but still not that you would like to show to your customer.
Now lets add a few lines to that Error Handling Function in the part that handles the contraint violations. The original code is this:

if p_error.ora_sqlcode in (-1, -2091, -2290, -2291, -2292) then
  l_constraint_name := apex_error.extract_constraint_name (
                           p_error => p_error );
    select message
    into l_result.message
    from constraint_lookup
    where constraint_name = l_constraint_name;
  exception when no_data_found 
    then null; -- not every constraint has to be in our lookup table
end if;

Now change the select from the constraint_lookup table (which we don't have anyway) into:

if p_error.ora_sqlcode in (-1, -2091, -2290, -2291, -2292) then
  l_constraint_name := apex_error.extract_constraint_name (
                           p_error => p_error );
  l_result.message := apex_lang.message( l_constraint_name );
  if l_result.message = l_constraint_name then
    apex_lang.create_message( p_application_id => v('APP_ID')
                            , p_name           => l_constraint_name
                            , p_language       => apex_util.get_preference
                            , p_message_text   => 'TODO'
  end if;
end if;

So the first step is to "translate" the message using the constraint name ( e.g. EMP_DEPT_FK) as a parameter. If that value is not found the apex_lang.message will simply return the parameter value. So if that happens, the procedure apex_lang.create_message is called to create a Text Message entry with a default text "TODO'.
When we run our test case again, the first time we get an error that is only showing the constraint name as a message.

If we immediately press the Save button again, we get a different message.

Now head over to the APEX Designer, Shared Components, Text Messages and look for the messages you still need to change:
And after adding a meaningful message, run your test again.

So without writing any additional validation code on your pages, you can show a nice, user-friendly error message by just using the power of APEX and the Oracle Database.

Of course this is just a simple example of what you can do with an Error Handling Function: just to name an example or two, you can also send an email from that function or do a REST call from one database to another.


Popular posts from this blog

Using Static Files in APEX has never been easier !

Almost every APEX Developer knows that JavaScript and CSS belongs in separate files and (in 99% of the use cases) not somewhere in your Page properties. If you have this code in separate files it is easier to use them in a Version Control System (SVN or Git) - if the files are outside of APEX. And the code you store in these files can be reused, in contrast to the stuff you store on Page level. In a lot of environments it is harder to use external files, because deployment of these files to the appropriate location on a webserver requires special privileges that not everybody has. In those cases storing these files as Static Application Files or Static Workspace Files might be a better solution. It makes deployment easier, because these files will be exported and imported as part of the application. You can't accidentally forget about them. But working with these files is quite a pain. When you need to edit something you have to download that file, make the changes, upload it again

Filtering in the APEX Interactive Grid

Remember Oracle Forms? One of the nice features of Forms was the use of GLOBAL items. More or less comparable to Application Items in APEX. These GLOBALS where often used to pre-query data. For example you queried Employee 200 in Form A, then opened Form B and on opening that Form the Employee field is filled with that (GLOBAL) value of 200 and the query was executed. So without additional keys strokes or entering data, when switching to another Form a user would immediately see the data in the same context. And they loved that. In APEX you can create a similar experience using Application Items (or an Item on the Global Page) for Classic Reports (by setting a Default Value to a Search Item) and Interactive Reports (using the  APEX_IR.ADD_FILTER  procedure). But what about the Interactive Grid? There is no APEX_IG package ... so the first thing we have to figure out is how can we set a filter programmatically? Start with creating an Interactive Grid based upon the good old Employ

Adding items to your Interactive Grid Toolbar

The APEX Interactive Grid uses the Toolbar widget to create the default Toolbar showing the Search box, Actions menu, Save button etc. And since quite a while there is a nice Plugin " Extend IG Toolbar " by Marko Goricki that makes it very easy to add additional buttons to the Toolbar. But what if you need more than a button?  Inspecting the contents of widget.toolbar.js, you can easily spot there can be added more to the Toolbar than just a button: The type of control, available values: "STATIC", "TEXT", "SELECT", "BUTTON", "MENU", "RADIO_GROUP", "TOGGLE". The first example will show a way to easily switch from one filter to another. Of course we could use the standard functionality and create two different Report views, but using a Radio Group on the Toolbar gives a more "Tab" like user experience. So how can we create a Radio Group that looks like a switch in the Toolbar? In