Build beautiful and interactive API documentation for ORDS

Image
In this blog post, I will show you how to quickly build beautiful and interactive API documentation for your Oracle APEX REST data sources using  swagger hub . Using APEX v23.1. I downloaded the  titanic data set  and loaded them into tables in my APEX instance, created some authorized restful services and published them using swagger hub. You can create a free account on swagger hub.   Check out my titanic swagger hub here ; Press Authorize. Username REST, password Glasgow123! I won't go through creating RESTful services and just show you the four I created that sit on top of the titanic data set; The GET is a very simple SQL query;      select * from TITANIC_DATA_SET_NEW A handy tip is to add comments, as there will appear on swagger hub, making your API self documenting; Once you have created your modules, press the Generate Swagger Doc button; This will generate an open API for you.  Copy the API and paste it into swagger hub This will generate the documentation; As mentioned b
Post a Comment

Add a chatbot to your APEX app using DialogFlow

This post will show you how you can add a free chatbot to your APEX app using the always free Oracle Autonomous database and Google’s natural language processing (NLP) Dialogflow ES.

This Oracle APEX NSS web site allows users to ask the chatbot for the percentage of students who overall, were satisfied with the quality of the courses at the University of Glasgow.  It allows users to query over 1,200 courses.  Give it a try by clicking NSS→Russell Group NSS Course Search


Here is some info about how DialogFlow works on another project I built.

How I built it.

Loaded data into autonomous database

I loaded the National Student Survey CSV data into autonomous database using database actions data load;


Created a REST API for the data

Using the REST action above I created a REST API for the data, it takes a course and aim and retrieves it from the Database


Try it out;

https://kjwvivmv0n5reuj-apexkqor.adb.uk-london-1.oraclecloudapps.com/ords/admin/nss/q27/Mathematics/BSc

This returns the following JSON which has selected the question Q27 overall percentage satisfied with Mathematics BSC course. It also returns the course ID and overall rank for UK universities for that course

"items":[{"q27":77,"kiscourseid":"G100-2208","rank":11}]

Create the chatbot

I used DialogFlow ES to create the chatbot.

Call the REST API from DialogFlow

In webhook fulfilment, I added this function that takes a course and aim and calls the REST API. As it is calling a REST API, I used a promise to make the call and return the result to DialogFlow;

function aim(agent) {
   
    console.log('in AIM intent');    
    var course = agent.contexts[0].parameters.course;
    var aim = agent.contexts[1].parameters.aim;
       
    const promise1 =  new Promise(function (resolve, reject) {
       
    axios.get('https://kjwvivmv0n5reuj-apexkqor.adb.uk-london-1.oraclecloudapps.com/ords/admin/nss/q27/'+course+ '/'+ aim)
        .then(res => {
        resolve(res);
        })
        .catch(error => {
        console.log('Error in fetch ', error);
        });
   });
 
   promise1.then(function (result) {
      console.log("Result is " + JSON.stringify(result.data));
      if (result.data.items && result.data.items[0])
      {
       console.log('Percentage is ', result.data.items[0].q27 );
       console.log('Rank is ', result.data.items[0].rank );
       
        var rank = '';
        if (result.data.items[0].rank == 1)
        {
          rank = 'Good news, the University of Glasgow is the number 1 ranked University in the Russell Group :-).';
        }
        else if (result.data.items[0].rank)
        {
          rank = 'The University of Glasgow is ranked ' + result.data.items[0].rank + ' in the Russell Group.';
        }
       agent.add(course + ' ' + aim + ' overall satisfaction is ' + result.data.items[0].q27 + '%.' + rank + ' Say another course to start again');          
      }
      else
      {
       agent.add(course+ ' does not have an aim of ' + aim + '. Say another course to start again');
      }
    }, function (error) {
                console.log("Error in then ", error);
    });  
    return promise1;  
  }

The DialogFlow aim intent calls the webhook, which passes in the course and aim;


To get the chatbot HTML to add to your APEX app, select DialogFlow Messenger in Integrations;


this created the code to add to our APEX page;

<script src="https://www.gstatic.com/dialogflow-console/fast/messenger/bootstrap.js?v=1"></script>
<df-messenger
  intent="WELCOME"
  chat-title="UofG Overall satisfaction"
  agent-id="XXXXXX"
  language-code="en"
></df-messenger>

we now have the chatbot on our APEX app;




Comments

Post a Comment

Popular posts from this blog

Oracle APEX Interactive Grid colour cells based on a condition using JavaScript and CSS

Image
In this post I will describe how to colour an Interactive Grid based on a column condition using CSS and JavaScript.  Using APEX Version 19.2. I want to colour every column red in my IG when the value is 'No'.   I have several IGs on my page I want to colour, so I set all my IGs that I want to colour with a CSS class of ATTENDEE_SCORE_IG in the Appearance section of the IG; Every column I want to colour in the IG I set the CSS Class to COLOUR_YES_NO (in this example I set this in 5 columns); I then created a Dynamic Action (DA) that contains the JavaScript that has the condition check that will colour the cells.  Because I have several IGs that are details of the master/detail relationship and these are refreshed by the user clicking on the master detail IG I have made my DA a Page Change [Interactive Grid].  If you don't need this you can set the DA on page load. The JS which will colour every column is this; ////////////////////////////////////////////////////////////////
Read more

Oracle APEX pretty checkbox item plugin

Image
Following on from the animated on off button this is now an item plugin.  Pretty up your checkboxes..... You have 16 checkbox types to choose from where you can control the size and colour of the checkbox in item settings; demo Create a page item with type Pretty check box Choose type of checkbox Set checkbox attributes. How it works The item plug in code uses this code to plug the rendered checkbox into APEX. /////////////////////////////////////////////////////////////////////////////////////////// // glasgow_simple_checkbox // // Provides a plug- in specific implementation for a checkbox item. The item on the page // should be a checkbox, i.e. <input type = "checkbox" and name should be your item name // i.e. name = 'P12_NAME' // // Params // // itemName - the item name , i.e. name = 'P12_NAME' // checkboxValues - the check and unchecked values , i.e. Y/N /////////////////////////////////////////////////////////////////////////////////////////// f
Read more

Build beautiful and interactive API documentation for ORDS

Image
In this blog post, I will show you how to quickly build beautiful and interactive API documentation for your Oracle APEX REST data sources using  swagger hub . Using APEX v23.1. I downloaded the  titanic data set  and loaded them into tables in my APEX instance, created some authorized restful services and published them using swagger hub. You can create a free account on swagger hub.   Check out my titanic swagger hub here ; Press Authorize. Username REST, password Glasgow123! I won't go through creating RESTful services and just show you the four I created that sit on top of the titanic data set; The GET is a very simple SQL query;      select * from TITANIC_DATA_SET_NEW A handy tip is to add comments, as there will appear on swagger hub, making your API self documenting; Once you have created your modules, press the Generate Swagger Doc button; This will generate an open API for you.  Copy the API and paste it into swagger hub This will generate the documentation; As mentioned b
Read more