If you have a smartphone, you’re already familiar with push notifications. They’re the timely alerts with some useful info from your favorite apps. In 23.1, your APEX solutions can send them, too, using a page process or
send_push_notification() API. You simply set the message details and APEX securely notifies the user on all their subscribed devices, if any.
In this article, see a sample app in action, how to try it out yourself, and where to download the slides from my recent APEX Alpe Adria conference talk with more in-depth info about push notifications in APEX.
Overview of the Sample App
The sample app uses APEX’s application access control with roles for Customer and Staff. App pages use an appropriate authorization scheme so customers can request reimbursements while staff members approve them. The app declaratively enables Progressive Web App (PWA) installation and push notifications, and the overview video below shows you how the app works on iPhone and Mac desktop PWAs for a customer user
BO and a backoffice user
Regenerating the Signing Key Credentials
After downloading and importing the sample app, the first required setup step is regenerating the public/private key pair credentials. It’a is a one-time step that’s necessary the first time an APEX app using push notifications is imported into a new workspace. This is a new kind of credential used to cryptographically sign the push notifications your app sends.
In practice, it’s a one-click operation. Under Shared Components > Progressive Web App > Push Notifications, click the (Regenerate Credentials) button, and then in the confirmation dialog that appears click (Regenerate Credentials) again to confirm. Ok, you got me. It’s a two-click operation! You can regenerate the credentials any time in the future as well, but be aware that doing so invalidates and removes any existing user push notification subscriptions. Therefore, should you decide later to regenerate the credentials, your users will need to opt-in again to receive your app’s push notifications.
Creating the Two Sample Users
The sample app depends on a backoffice staff user named
PAT who is configured as the approver on the Reimbursement Approval task definition and another user
BO who is a customer. As shown in the demo video above, customer
BO uses the app to request reimbursement of an expense, then backoffice user
PAT approves or rejects the request, which results in sending the requesting user a push notification to alert them of the outcome.
If you have recently tried the Sample Approvals app from the gallery, you might already have workspace users
BO, but if not then you’ll need to create them. Login to your APEX workspace as a workspace admin user and click the Administration (i.e. “person with wrench”) icon in the toolbar and choose the Manage Users and Groups option. Add the missing account(s) on this page using the Create User button.
Assigning Sample Users an Application Role
BO exist, next you need to assign them an appropriate application role so that the staff member user
PAT sees the approval pages and the customer
BO sees the reimbursement request pages. To do this, in the context of the sample application in the App Builder, click Shared Components > Application Access Control. Use the (Add User Role Assignment) button twice on this page to add two user role assignments:
HTTPS & Trusted Certificate Requirement
Keep in mind if you’re trying the sample on your own APEX instance that both on-device PWA installation as well as subscribing to push notifications depend on a secure, trusted connection. This means your desktop or mobile browser needs to access the APEX app over HTTPS and the client device must trust the server’s security certificate. If your APEX is running plain HTTP or it’s using a self-signed certificate that you haven’t configured your client device to trust, exploring the sample won’t work as expected. In that case, I recommend trying it on
apex.oracle.com or your Oracle Cloud always free tier APEX instance instead.
Installing the Sample App as a PWA
The public APEX PWA Reference App’s Push Notifications page documents the compatibility matrix of supported operating systems and devices. If you are an iPhone user, notice that subscribing to push notifications on iOS and iPadOS require version 16.4 or later, as well as your installing the app as a PWA first. Other supported combinations allow push notifications either from the browser or when installed as a PWA. In the video above, I used Chrome on MacOS Ventura to install the PWA for user
BO, Microsoft Edge to install the PWA for user
PAT, and an iPhone 11 Plus running iOS 16.4 to install the mobile PWA for
BO. You can use any of the supported combinations highlighted in the compatibility matrix.
I recorded the demo video on an APEX instance with instance-level settings Allow Persistent Auth set to
Yes and Rejoin Sessions set to
Enabled for All Sessions, so users can stay logged in for a month by default and where tapping on the push notification does not require the user to login again to see the related detail information in the APEX PWA application.
Opting-In to Receive Push Notifications
As shown in the demonstration video above, each user of your app needs to opt-in to receive push notifications from your app. And they need to do this on each device where they want to receive the notifications. When creating a new app with the Push Notification feature enabled in the Create App wizard, APEX generates a user settings modal drawer page containing the link to the Push Notification Settings page. For an existing app, there is a button on the Push Notifications page of the PWA app settings to generate the user settings page with a single click. At runtime, if the settings page shows a “Not Supported” badge, check to make sure you’re using HTTPS and a trusted certificate. If tapping or clicking on the Enable push notifications checkbox produces an error, that’s a signal you probably forgot to regenerate the push notification key pair credentials after importing the app the first time.
Using an App Page as Push Notification Target URL
When sending a push notification, you can configure a target URL that the device uses when the user taps or clicks on the notification. It must be an absolute URL, so for example the
Reimbursement Approval task definition in the sample app contains an action that executes in response to the Complete event. Its action PL/SQL code sends the push notification about the task approval or rejection using the following code:
apex_pwa.send_push_notification( p_user_name => :CREATED_BY, p_title => 'Reimbursement '||initcap(:APEX$TASK_OUTCOME), p_body => 'Your reimbursement of ' || :AMOUNT || ' from ' || :RECEIPT_FROM || ' was ' || lower(:APEX$TASK_OUTCOME)||'.', p_target_url => apex_util.host_url|| apex_page.get_url( p_page => 'reimbursement-notification', p_items => 'p7_id', p_values => :APEX$TASK_PK) );
Notice how the value being passed to the
p_target_url parameter prefixes the result of the
apex_page.get_url() result by the
apex_util.host_url expression. This ensures that the URL is a fully-qualified absolute URL. When using a declarative Send Push Notification page process, the APEX engine handles this for you, so this tip only pertains to the
When the target URL is a page of your APEX app, the page must have the following properties configured:
- Authentication =
- Deep Linking =
- Rejoin Sessions =
Enabled for All Sessions
- Page Protection =
Arguments Must Have Checksum
This public target page will typically use a Before Header branch to redirect to an authenticated page in the app, passing along appropriate parameters to show the user the expected detail information for the notification. When combined with the use of APEX’s persistent authentication “Remember me” functionality, this combination gives the most seamless user experience. Page 7 in the sample app, whose alias
reimbursement-notification appears in the
send_push_notification call above, meets all of these requirements and performs the forwarding to the authenticated page 6, passing along the reimbursement request id to show the end-user the request details.
Granting Outbound Network ACLs for Push Services
The APEX engine sends push notifications by invoking secure notification REST services from Apple, Google, Microsoft, and Mozilla depending on the subscribing user’s device. If you try the sample app on
apex.oracle.com, you won’t have to worry about granting outbound network access for these notification service domains, however it’s a task you must perform when you use push notifications on your own APEX instance. In case you need it, the following PL/SQL block is an example of how to grant the appropriate ACLs to the push notification REST API domains and optional a proxy server if you are behind a corporate firewall. If your APEX applications are already using REST services, you will likely already be familiar with these steps. It’s included here for reference:
-- Run as SYS or DBA user declare l_principal varchar2(20) := 'APEX_230100'; l_proxy varchar2(100) := null; -- e.g. 'proxy.example.org' l_proxy_port number := 80; l_hosts apex_t_varchar2 := apex_t_varchar2( '*.push.apple.com', '*.notify.windows.com', 'updates.push.services.mozilla.com', 'android.googleapis.com', 'fcm.googleapis.com'); procedure add_priv(p_priv varchar2, p_host varchar2, p_port number) is begin dbms_network_acl_admin.append_host_ace ( host => p_host, lower_port => p_port, upper_port => p_port, ace => xs$ace_type(privilege_list => xs$name_list(p_priv), principal_name => l_principal, principal_type => xs_acl.ptype_db)); end; procedure add_priv_resolve(p_host varchar2) is begin dbms_network_acl_admin.append_host_ace ( host => p_host, ace => xs$ace_type(privilege_list => xs$name_list('resolve'), principal_name => l_principal, principal_type => xs_acl.ptype_db)); end; begin if l_proxy is not null then add_priv('connect',l_proxy,l_proxy_port); add_priv_resolve(l_proxy); add_priv('http',l_proxy,l_proxy_port); end if; for j in (select column_value as hostname from table(l_hosts)) loop add_priv('connect',j.hostname,443); add_priv_resolve(j.hostname); add_priv('http',j.hostname,443); end loop; commit; end;
Configuring Wallet to Validate Certificates
On your own APEX instance, in addition to the outbound REST service ACLs required for push notification, you may also need to add certificates into the wallet your instance is using for validating secure HTTP communications. If you are running APEX in the Oracle Cloud, this step should not be necessary. However, on your own instance you may find my colleague Daniel Hochleitner’s open-source Oracle CA Wallet Creator script useful for that purpose.
Downloading the Sample App
You can download the sample app from here.
Downloading My Slides
You can download the slides from my recent talk on this topic at the APEX Alpe Adria 2023 conference from here: APEX 23.1: Native Push Notifications & Easy Background Processing.