Quick Install Guide

This guide will install the PL/SQL packages and the Oracle APEX plug-ins for AOP

  1. Unzip the file you downloaded from https://www.apexofficeprint.com

  2. Install the PL/SQL API.

  3. Go in APEX to SQL Workshop > SQL Scripts > Upload

  4. Select file /apex_version_\<version>/db directory/aop_db_pkg.sql

  5. Give it a name and click the Upload button.

  6. Click the run icon for the script you just uploaded, confirm that the schema in the upper right-hand corner of the screen is correct and click Run Now.

  7. All statements should be successful.

Repeat the above for /apex_version_\<version>/db directory/aop_modal_pkg.sql

  1. Import new versions of the plug-ins.

  2. Go in APEX to App Builder > Your application > Shared Components > Plug-ins > Import

  3. Be sure to select the directory that corresponds to the version of Oracle APEX you are using - NOT the version of AOP.

  4. Select file apex_version_\<version>/plugin/process_type_plugin_be_apexrnd_aop.sql (for the AOP Process type plug-in)

  5. Select file apex_version_\<version>/plugin/dynamic_action_plugin_be_apexrnd_aop_da.sql (for the AOP Dynamic Action type plug-in)

  6. Select file apex_version_\<version>/plugin/dynamic_action_plugin_be_apexrnd_aop_convert_da.sql (for the Convert Dynamic Action type plug-in)

  7. Select file apex_version_\<version>/plugin/dynamic_action_plugin_be_apexrnd_aop_modal.sql (for the Modal Dynamic Action type plug-in)

  8. Enter the details of the AOP Server or in case the AOP Cloud is used the API key. If using the cloud version of AOP, make sure the API Key is set for each plug-in. An API Key is not necessary for on-premises installations.

That is it! On the page you want to use AOP, add the "APEX Office Print" Dynamic Action or Process.

Optional you can also install the sample code

  1. Install the Sample PL/SQL Scripts.

  2. Go in APEX to SQL Workshop > SQL Scripts > Upload

  3. Select file /apex_version_\<version>/db/aop_db_sample_pkg.sql

  4. Give it a name and click the Upload button.

  5. Click the run icon for the script you just uploaded, confirm that the schema in the upper right-hand corner of the screen is correct and click Run Now.

  6. All statements should be successful.

  7. Install the AOP Sample Applications.

  8. Import the AOP Sample Apps you find in /apex_version_\<version>/app

Possible issues you might encounter

Connection issues to the AOP Server or AOP Cloud: TNS, ACL, Wallet

You want to check your connecion by running the following in SQL Workshop > SQL Commands:

-- HTTP
begin 
  -- in case of an on-premises AOP Server, change the URL
  aop_api_pkg.send_aop_sample(
    p_url            => 'http://api.apexofficeprint.com',
    p_proxy_override => null,
    p_wallet_path    => null,
    p_wallet_pwd     => null);
end; 

begin 
  -- in case of an on-premises AOP Server, change the URL
  aop_api_pkg.is_aop_accessible(
    p_url            => 'http://api.apexofficeprint.com',
    p_proxy_override => null,
    p_wallet_path    => null,
    p_wallet_pwd     => null);
end;    

-- HTTPS
begin 
  -- in case of an on-premises AOP Server, change the URL
  aop_api_pkg.send_aop_sample(
    p_url            => 'https://api.apexofficeprint.com',
    p_proxy_override => null,
    p_wallet_path    => null,
    p_wallet_pwd     => null);
end; 

begin 
  -- in case of an on-premises AOP Server, change the URL
  aop_api_pkg.is_aop_accessible(
    p_url            => 'https://api.apexofficeprint.com',
    p_proxy_override => null,
    p_wallet_path    => null,
    p_wallet_pwd     => null);
end;    

ORA-20000: The AOP Server can not process your request. RequestID: xxxx-xxxxx Error while generating file. Please contact AOP for further inquiry

This error means the AOP Server has difficulties full-filling your request. In this case it's best to debug the request to the AOP Server or AOP Cloud. You can get the debug JSON by inserting the following PL/SQL code in the Init PL/SQL section of the Dynamic Action or before you call the AOP PL/SQL API:

aop_api_pkg.g_debug := 'Local';

The next time you print, you should get a JSON. Once you have the local JSON file, please send it to support@apexofficeprint.com

APEX Debugging

When you run Oracle APEX in debug mode you can see how long a request took. In case you want to see more detailed debug information, run in LEVEL6 (=Application Trace) debug mode. See this video how to set LEVEL6 debug on.