APEX Plugins: Alles, was Sie darüber wissen müssen. Denes Kubicek

Transkript

1 APEX Plugins: Alles, was Sie darüber wissen müssen Denes Kubicek

2 Denes Kubicek Um es kurz zu halten: Mein Name ist Denes Kubicek geboren 1965 in Kroatien. Ich bin seit acht Jahren selbständig und arbeite ausschließlich an APEX und PL/SQL Projekten. APEX Entwickler des Jahres Oracle ACE Director. Zu meinen Kunden zählen viele Unternehmen (bisher etwa 50) aus dem Inland und Ausland (BASF, Telekom, Bosch, Postbank, Interseroh und viele andere). Ich bin im APEX Forum tätig und habe dort über 6000 Mal gepostet. Ich habe an zwei Büchern mitgearbeitet ein Buch in Deutsch und eins in Englisch. Ich habe auch einen eigenen Blog zum Thema APEX Man kann mich jederzeit erreichen und ich antworte garantiert: 1

3 Denes Kubicek 2

4 APEX Security Über Security Bevor wir anfangen: Ich verwende meistens die englischen Namen für die APEX Komponenten. Ich rede viel und zeige nicht viele Bilder. Alles wovon ich rede ist auch aufgeschrieben. Ich zeige auch einige Beispiele in diesem Vortrag. Wenn die Zeit es erlaubt, können ich am Ende des Vortrags Ihre Fragen beantworten (weniger wahrscheinlich). Sonst bin ich auch nachher erreichbar über meine adresse und beantworte Ihre Fragen gerne: 3

5 APEX Plugins - Agenda APEX Plugins kurze Vorstellung APEX Plugins new Features 5.0 APEX Plugins was fehlt noch? APEX Plugins Erstellung eines Dynamic Action Plugins anhand Beispiel 4

6 APEX Plugins: Kurze Vorstellung

7 APEX Plugins kurze Vorstellung Plugin ist ein neues Feature seit APEX 4.0. Plugins ermöglichen Import und Nutzung von fremden Komponenten in einer Anwendung. Wenn importiert, werden die Plugins wie eigene APEX Komponenten verwaltet. Plugins ermöglichen eine effizientere Gestaltung der Anwendungen. APEX stellt sowohl ein eigenes Interface für die Verwaltung von Plugins als auch die Packages (apex_plugin, apex_plugin_util) für das Programmieren von Plugins: Shared Components > Plugins 6

8 APEX Plugins kurze Vorstellung Plugins können generell in fünf Gruppen aufgeteilt werden Item-Type Plugins, Region-Type Plugins, Process-Type Plugins, Dynamic Action Plugins und Authentication und Authorization Plugins. Die fertigen Plugins können im Internet zur Zeit an zwei Stellen aufgerufen werden Oracle Plugins und apex-plugin.com. Es gibt außerdem viele Blogs, die über das Thema sprechen und eigene Entwicklungen anbieten. 7

9 APEX Plugins kurze Vorstellung Plugins html 8

10 APEX Plugins kurze Vorstellung 9

11 APEX Plugins kurze Vorstellung APEX Packaged Applications sind eine gute Quelle für verschiedene Plugins: 10

12 APEX Plugins kurze Vorstellung Viele Plugins und unterschiedliche Plugin-Typen verfügbar mit konkreten Beispielen: 11

13 APEX Plugins kurze Vorstellung Interessant vor Allem sind die Techniken, die eingesetzt werden: 12

14 APEX Plugins kurze Vorstellung Eine gute Quelle, um den Umgang mit verschiedenen Plugin-Techniken (Best Practices) zu üben: 13

15 APEX Plugins kurze Vorstellung Ergebnis: 14

16 APEX Plugins: New Features 5.0

17 APEX Plugins New Features 5.0 In der Version 5.0 gibt es einige neue Features im Bezug auf Plugins: Plugins als Subscription von einer Master Application erstellen, Directory Support für statische Plugin-Dateien, Deklarative Definition der CSS- und JavaScript-Dateien, die geladen werden, Erweiterungen der Plugin Attribute, Neue Plugin Attributtypen, Set Cursor Focus für Region Type Plugins, Neue API: apex_plugin_util.get_attribute_as_number und Neues Region Type Plugin Columns Plugin. 16

18 APEX Plugins New Features 5.0 Plugins als Subscription von einer Master Application erstellen als Option As a Copy of an Existing Plug-in: Leider nur innerhalb von einem Workspace möglich. 17

19 APEX Plugins New Features 5.0 Directory Support für statische Plugin-Dateien 18

20 APEX Plugins New Features 5.0 Deklarative Definition der CSS- und JavaScript-Dateien, die geladen werden: 19

21 APEX Plugins New Features 5.0 Keine Notwendigkeit mehr für explizite Registrierung der Dateien: apex_javascript.add_library ( p_name => 'bi_cubes_cascading_tabular', p_directory => p_plugin.file_prefix ); Nur die Funktion innerhalb der Skriptdateien wird bekannt gegeben: -- register js function uploaded with -- #PLUGIN_FILES#bi_cubes_cascading_tabular.js under JavaScript v_result.javascript_function := 'get_cascading_list'; Falls FILE_PREFIX Attribute leer, wird die Datei aus dem Plugin File Storage geladen. Wenn gesetzt, wird der Pfad genutzt. 20

22 APEX Plugins New Features 5.0 Erweiterungen der Plugin Attribute: Show in Wizard für Attribute-Settings (für Attribute, die es Erforderlich machen), Common View of Property Editor 21

23 APEX Plugins New Features 5.0 Erweiterungen der Plugin Attribute für LOV s: Hilfetexte für einzelne Optionen einer Auswahlliste: Quick Picks: NULL Value Texte: 22

24 APEX Plugins New Features 5.0 Erweiterungen der Plugin Attribute: Set Text Case (Upper, Lower, Unchanged) Unit (Pixel), Supported for: Desktop, Mobile. 23

25 APEX Plugins New Features 5.0 Neue Plugin Attributtypen: Link to Target Page / URL ruft die Seite für die Erstellung von Links, HTML (Code Editor), Icon (Auswahl der Icons Font Awesome), Javascript Code (Code Editor), PL/SQL Function Body Returning BOOLEAN (Code Editor, Validierung (Warning)), Page Numbers (als Liste). 24

26 APEX Plugins New Features 5.0 apex_plugin_util.get_attribute_as_number (Punkt/Komma Trennzeichenproblem): --============================================================================== -- Returns the value of a plug-in attribute as number, taking into account NLS -- decimal separator effective for the current database session. Use this -- function in plug-in PL/SQL source for custom attributes of type NUMBER -- instead of the built-in to_number() function. --============================================================================== function get_attribute_as_number ( p_value in varchar2, p_attribute_label in varchar2 default null ) return number; Wird in den Packaged Applications in den neuen Plugins eingesetzt. Sollte in den Plugins anstatt TO_NUMBER eingesetzt werden. 25

27 APEX Plugins New Features 5.0 Has Region Columns : 26

28 APEX Plugins New Features 5.0 Has Region Columns : type t_region is record ( id number, static_id varchar2(255), name varchar2(255), type varchar2(255),... region_columns t_region_columns ); type t_region_column is record ( id number, name varchar2(30), is_displayed boolean, heading varchar2(255), heading_alignment varchar2(10), value_alignment varchar2(10), value_css_classes varchar2(255), value_attributes varchar2(255), format_mask varchar2(255), escape_output boolean, -- attribute_01 varchar2(32767),... attribute_25 varchar2(32767) ); 27

29 APEX Plugins New Features 5.0 Has Region Columns : 28

30 APEX Plugins: Was fehlt noch?

31 APEX Plugins Was fehlt noch? Plugins haben eine sehr gute Unterstützung in APEX. Die Möglichkeiten werden ständig ausgebaut und erweitert. Das Referenzieren von Plugin-Dateien wurde stark verbessert. Wenn die Plugins viel machen müssen und viel Code gebraucht wird, wäre eine Möglichkeit PL/SQL Packages mit dem Plugin auszuliefern ganz gut. Möglicherweise könnte ein Plugin-Package genauso referenziert werden, wie Javascript-Dateien und mit dem Plugin initial installiert werden. 30

32 APEX Plugins: Erstellung eines Dynamic Action Plugins

33 APEX Plugins: Erstellung eines Dynamic Action Plugins Problemstellung

34 APEX Plugins Erstellung eines Dynamic Action Plugins Problemstellung Gute Beispiele sind schwer zu finden. Tabular Form Cascading Select List ist immer noch ein Problem. Können wir das Problem mit Board-Mitteln lösen? Es gibt da draußen einige Beispiele aber keiner von denen ist gut genug: Alt: 33

35 APEX Plugins Erstellung eines Dynamic Action Plugins Problemstellung Es gibt da draußen einige Beispiele aber keiner von denen ist gut genug: Neuer: Zu viel Code und zu viele Schritte für die Umsetzung. 34

36 APEX Plugins Erstellung eines Dynamic Action Plugins Problemstellung Wenn wir das Problem in Einzelteile zerlegen, müssen folgende Aufgaben gelöst werden: Beim Ändern einer Auswahlliste, muss die zweite Liste neu aufgebaut werden. Dies gilt für das Ändern eines Elements und für das Laden der Seite (initial). Wir müssen wissen, was gewählt wurde und dann in die Datenbank schauen, was dazu gehört. Aus der Datenbank holen wir die Daten als JSON und bauen daraus die zweite Liste zusammen. Wir brauchen also: Javascript (jquery) für die Ermittlung der Werte und Übergabe an ein PL/SQL Prozess. Ein AJAX Callback-Prozess, der die Daten ermittelt und als JSON zurückgibt. Eine Funktion, die aus dem JSON die zweite Liste aufbaut. 35

37 APEX Plugins Erstellung eines Dynamic Action Plugins Problemstellung Geht das? Ja, das geht: 36

38 APEX Plugins Erstellung eines Dynamic Action Plugins Problemstellung Zusätzlich zu dem On-Change Event, müssen wir auch eine Aktion starten, wenn ein Partial Page Refresh Event stattfindet und die Listen erneuern. Sonst werden die Default-Werte angezeigt. apex.jquery('#emp_tabular_form').bind("apexafterrefresh", function () { 37

39 APEX Plugins: Erstellung eines Dynamic Action Plugins Nachteile

40 APEX Plugins Erstellung eines Dynamic Action Plugins - Nachteile Das Problem wurde gelöst. Wir werden dieses Problem aber nicht nur an einer Stelle haben. Wenn wir es ein zweites Mal einsetzen, dann wird der Code kopiert und erneut hardcodiert eingesetzt. Das ist nicht optimal!!! x 2 oder x? 39

41 APEX Plugins: Erstellung eines Dynamic Action Plugins die Lösung

42 APEX Plugins Erstellung eines Dynamic Action Plugins die Lösung Wir können aus dem Code auch ein Plugin bauen. Wir benötigen dafür folgende Komponenten: Ein Prozess (Funktion), die für das Rendering zuständig ist: 41

43 APEX Plugins Erstellung eines Dynamic Action Plugins die Lösung FUNCTION get_list ( p_dynamic_action IN apex_plugin.t_dynamic_action, p_plugin IN apex_plugin.t_plugin ) RETURN apex_plugin.t_dynamic_action_render_result IS v_event VARCHAR2 (4000) := p_dynamic_action.attribute_01; v_select_list_array VARCHAR2 (4000) := p_dynamic_action.attribute_05; v_cascading_list_array VARCHAR2 (4000) := p_dynamic_action.attribute_06; v_tab_form_static_id VARCHAR2 (4000) := p_dynamic_action.attribute_07; v_triggering_element VARCHAR2 (4000) := p_dynamic_action.attribute_08; v_ajax_identifier VARCHAR2 (500) := apex_plugin.get_ajax_identifier; v_result apex_plugin.t_dynamic_action_render_result; BEGIN -- debug IF apex_application.g_debug THEN apex_plugin_util.debug_dynamic_action (p_plugin => p_plugin, p_dynamic_action => p_dynamic_action END IF; -- register js function uploaded with -- #PLUGIN_FILES#bi_cubes_cascading_tabular.js under JavaScript v_result.javascript_function := 'get_cascading_list'; v_result.attribute_01 RETURN v_result; END get_list; ); := v_event; 42

44 APEX Plugins Erstellung eines Dynamic Action Plugins die Lösung Wir benötigen dafür folgende Komponenten: Eine Funktion, die aus der Datenbank die neue Liste in Form von JSON holt: 43

45 APEX Plugins Erstellung eines Dynamic Action Plugins die Lösung FUNCTION dyn_lov_pr ( p_dynamic_action IN apex_plugin.t_dynamic_action, p_plugin IN apex_plugin.t_plugin ) RETURN apex_plugin.t_dynamic_action_ajax_result IS v_result apex_plugin.t_dynamic_action_ajax_result; TYPE lov_cur_type IS REF CURSOR; TYPE v_display_val IS TABLE OF VARCHAR2 (4000); TYPE v_return_val IS TABLE OF VARCHAR2 (4000); BEGIN FOR i IN 1.. v_rows_fetched LOOP v_list_json := v_list_json '"KEY' v_count '":{"NAME":"' v_d (i) '","VALUE":"' v_r (i) '","SELECTED":"' CASE WHEN v_r (i) = v_selected THEN v_r (i) ELSE NULL END '"},'; v_count := v_count + 1; END LOOP; RETURN v_result; EXCEPTION WHEN OTHERS THEN END dyn_lov_pr; 44

46 APEX Plugins Erstellung eines Dynamic Action Plugins die Lösung Wir benötigen dafür folgende Komponenten: Insgesamt acht (8) Parameter oder Attribute, die bei dem Plugin-Einsatz gesetzt werden müssen: 45

47 APEX Plugins Erstellung eines Dynamic Action Plugins die Lösung Wir benötigen dafür folgende Komponenten: Insgesamt acht (8) Parameter oder Attribute, die bei dem Plugin-Einsatz gesetzt werden müssen: Event (change oder click), LOV SQL wie bei den LOV s für die einzelnen Seitenelemente, Die bestimmende Spalte wie bei den LOV s für die einzelnen Seitenelemente, Null-Werte Beschriftung (- Select Employee -), Tabular Form Array der bestimmenden Spalte (f03), Tabular Form Array der abhängigen Spalte (f04), Static ID der Region. 46

48 APEX Plugins Erstellung eines Dynamic Action Plugins die Lösung Wir benötigen dafür folgende Komponenten: Eine Javascript-Datei, in die wir den Code auslagern: 47

49 APEX Plugins Erstellung eines Dynamic Action Plugins die Lösung function get_cascading_list () { p_triggering_element_id = this.triggeringelement.id; p_event = this.action.attribute01; if (p_event == 'CLICK') {run_on_pagination } else {get_single_change } } 48

50 APEX Plugins Erstellung eines Dynamic Action Plugins die Lösung function get_single_change (p_process, p_triggering_element_id, p_cascading_list_array) { var elem = '#' + p_triggering_element_id; var set_list = '#' + p_cascading_list_array + '_' + p_triggering_element_id.substring(4); apex_server_process (p_process, selected_val, elem_val, key_val, set_list); } function run_on_pagination (p_process, p_tab_form_static_id, p_select_list_array, p_cascading_list_array) { apex.jquery('#'+p_tab_form_static_id ).bind("apexafterrefresh", function () { $('[name='+p_select_list_array+']').each(function(i){ var obj_id = $('[name='+p_select_list_array+']').get(i).id; var elem = '#' + obj_id; apex_server_process (p_process, selected_val, elem_val, key_val, set_list); }); $('#' + p_tab_form_static_id ).trigger('aftercascadingrefresh') }) } 49

51 APEX Plugins Erstellung eines Dynamic Action Plugins die Lösung function apex_server_process (p_process, p_selected_val, p_elem_val, p_key_val, p_set_list) { apex.server.plugin ( p_process, { x01: p_elem_val, x02: p_key_val}, { datatype: 'json', success: function( pdata ) { $(p_set_list).find('option').remove(); $.each(pdata, function(key, innerjson) { $(p_set_list).append($('<option>', { }); } if (p_selected_val!= '') { $('select' + p_set_list + ' option').each(function() {this.selected = (this.value == p_selected_val);}); }}, }); 50

52 APEX Plugins Erstellung eines Dynamic Action Plugins die Lösung Wir können innerhalb von der Plugin-Definition auch noch optional Events definieren, um nachfolgenden Prozesse zu triggern. Durch diese Definition, kann eine weitere Dynamic Action auf der Seite gestartet werden: 51

53 APEX Plugins Erstellung eines Dynamic Action Plugins die Lösung Falls wir eine Aktion definieren, benutzt diese unser Event und führt eine oder mehrere andere Aktionen durch: 52