Skip to main content

Installation

You can install the APEX Office Edit plug-in in two ways:

  • by installing the AOE sample application

  • by running the DDL script and installing the region plug-in in an existing application (manual installation)

Sample Application​

Importing the Sample Application​

  1. Log into your APEX application builder

  2. Click on the Import tile to start the APEX application installation wizard from the installation file

  3. Make sure the schema in which you want to install the sample application has REST enabled

    image

  4. Click on the Drag and Drop region

  5. Select the sample application file

  6. Click the Next button

    image

  7. After successfully uploading the application installation file, you will see a file import confirmation. Click the Next button

    image

Set the application installation settings​

  1. Configure or use the default values in the form

  2. Click the Install Application button

    image

  3. Don’t close the page - wait until APEX finishes installing the application. You will be redirected to the next step when the application installation is complete.

    image

  4. Make sure Install Supporting Objects is checked - to install the sample application, all sample application supporting objects must be installed successfully

  5. Click the Next button

    image

  6. Click the Next button

    image

  7. Click the Install button

    image

  8. Don’t close the page - wait until APEX finishes installing the supporting objects. When the supporting objects are installed, you will be redirected to the next step.

    image

  9. When the installation finishes, you will see a confirmation.

    image

    Note: If an error terminates the installation, it can be verified by clicking the Install Summary button - the summary shows the status of all the installed supporting objects.

    image

  10. After the sample application installation is successful, the last step is to update the plug-in component settings for the RESTful service installed by the sample application.

Configure the plug-in RESTful service​

You must configure the plug-in RESTful service to finish the sample application installation.

  1. Fill in the details as instructed in The plug-in REST service configuration
  2. Test the sample application

Testing the Sample Application​

  1. Run the AOE sample application
  2. Click on the document type tile you wish to create
  3. AOE will create a document of the selected type

image

image

Manual Installation​

Running the DDL Install Script​

  1. From the APEX Application Builder, in the top menu bar, select SQL Workshop and then SQL Scripts

  2. Click the Upload button

    image

  3. In the Upload Script dialog, click on Choose File and select the AOE installation file: .ddl_unitedcodes_apex_office_edit.sql

  4. Click the Upload button

    image

  5. After successfully uploading the script, click the Run button.

    image

  6. Click the Run now button on the confirmation screen.

    image

  7. Examine the installation summary - the script should not raise any errors

  8. Proceed to the next step: Installing the plug-in in an existing example application

    image

Installing the plug-in in an existing application​

  1. Go to the APEX Application Builder home page.

  2. Select the application where you want to use APEX Office Edit

  3. Go to Shared Components \ Plug-ins

  4. Click the Import button

    image

  5. Click on the Drag and Drop region to select the AOE region plug-in installation file: region_type_plugin_unitedcodes_aoe.sql

  6. Click the Next button

    image

  7. On the File Import Confirmation step click the Next button

    image

  8. In the Install Plug-in step click the Install Plug-in button

    image

After successful installation, the plug-in component settings must be updated. Fill in the correct values if you know what you are doing. If not, leave the default values and go to the next step, The plug-in REST service configuration, for instructions on finding the correct values.

To create your first AOE instance, please follow Creating the plug-in instance in an existing application instructions.

Using the plug-in in an existing application​

To create the first instance of AOE, please go to the instructions in the Getting started \ Creating the plug-in instance in an existing application section.

RESTful service configuration​

  1. Go to the applications Shared Components.

  2. Go to Other Components \ Component Settings.

  3. Click on the UC - APEX Office Edit (AOE) region plug-in.

  4. Replace the default values with the correct values for your situation.

    image

  5. From the APEX Application Builder top menubar, select SQL Workshops and then RESTful services.

  6. Select the APEX Office Edit module.

  7. Copy the value of the Full URL module attribute.

    image

  8. Go back to the plug-in component settings.

  9. Fill in the URL to RESTful service module attribute with the value copied in step 8 (the Full URL attribute of the AOE RESTful service module).

  10. In a new browser tab, login to the APEX Office Edit portal (accessible by clicking on the login button on the AOE website.

  11. Copy your API Key, which will be visible next to your current plan under the Your Cloud Subscriptions section

    image

  12. Go back to your APEX application and paste the previously copied API Key from the APEX Office Edit portal in the API Key field.

  13. Click the Apply Changes button.

    image

  14. If you use an on-premises version of AOE, replace the Server-Side Url value with the URL where your server is running. Also, note that an API key is not necessary in this case.