Manage Oracle APEX in Autonomous Database

Learn about functionality only available in Oracle APEX in Autonomous Database.

Note:

To learn more about Autonomous Database instance lifecycle operations, see Lifecycle Operations in Using Oracle Autonomous Database Serverless.
  • About Document Generator
    Learn about privileges required to configure Document Generator and how to configure Document Generator for an APEX instance.

Parent topic: Manage Oracle APEX

About Document Generator

Learn about privileges required to configure Document Generator and how to configure Document Generator for an APEX instance.

The Document Generator Function pre-built function enables you to generate documents based on Office templates and JSON data. You can configure the Document Generator Function for APEX from the OCI Console.

For more information about the pre-built function, see Document Generator Function.

Parent topic: Manage Oracle APEX in Autonomous Database

IAM Policies and Oracle Database Privileges

Learn more about OCI permissions the OCI user requires in order to configure Document Generator.

Required IAM Policies

To configure Document Generator against an APEX instance, an OCI user requires the following policies:
Policy Statement Justification
allow group '<identity_domain_name>'/'<group_name>' to read autonomous-database-family in compartment <compartment> Required to navigate to the APEX Instance Details page
allow group '<identity_domain_name>'/'<group_name>' to manage virtual-network-family in compartment <compartment> Required to create a Database Tools Private Endpoint
allow group '<identity_domain_name>'/'<group_name>' to manage vaults in compartment <compartment> Required to create a Vault
allow group '<identity_domain_name>'/'<group_name>' to manage keys in compartment <compartment> Required to create a Key
allow group '<identity_domain_name>'/'<group_name>' to manage secret-family in compartment <compartment> Required to create Vault Secrets
allow group '<identity_domain_name>'/'<group_name>' to manage database-tools-family in compartment <compartment> Required to create Database Tools Connection and Private Endpoint and make use of them
allow group '<identity_domain_name>'/'<group_name>' to read function-family in compartment <compartment> Required to select Application, Function, and PbfListing
allow group '<identity_domain_name>'/'<group_name>' to read object-family in compartment <compartment> Required to get the Object Storage namespace
allow group '<identity_domain_name>'/'<group_name>' to manage policies in compartment <compartment> Required to manage Policies

Oracle Database Privileges

To configure Document Generator against an APEX instance, the user specified in the Database Tools Connection requires the grants in the table below. Note that the ADMIN user of an APEX Instance (Autonomous Database Serverless) already has these grants:
Grant Statement Justification
GRANT CREATE SESSION TO <user> Required to create a session (log in to the database)

GRANT EXECUTE ON DBMS_CLOUD_ADMIN TO <user>

EXEC DBMS_CLOUD_ADMIN.ENABLE_RESOURCE_PRINCIPAL(username => '<user>', grant_option => TRUE)

Required to enable/disable the ADB-S Resource Principal
GRANT APEX_ADMINISTRATOR_ROLE TO <user> Required to execute APEX_INSTANCE_ADMIN.{GET,SET}_PARAMETER

GRANT SELECT ON SYS.DBA_CREDENTIALS TO <user>

GRANT SELECT ON SYS.DBA_TAB_PRIVS TO <user>

 Required to obtain the enabled status of the ADB-S Resource Principal

Parent topic: About Document Generator

Configure Document Generator

Learn how to configure Document Generator.

An APEX Instance Administrator can configure the Oracle Document Generator pre-built function for Oracle Autonomous Database from the OCI Console.
The workload type must be Data Warehouse, Transactional Processing, or JSON Database. The Document Generator integration is not supported for the APEX workload type.
In order to configure Document Generator, you must have a Database Tools connection to an Oracle Autonomous Database. For more information on the Database Tools connection, see Using the Oracle Cloud Infrastructure Console. For more information on OCI permissions, see IAM Policies and Oracle Database Privileges.

To configure Document Generator:

  1. Navigate to the OCI Console Sign-In Page and sign in as described in Access Oracle Cloud Infrastructure.
  2. Next to the Oracle Cloud logo, click the Navigation menu (Navigation menu) and select Developer Services and then APEX Instances.
    The APEX Instances page appears.
  3. From the Row menu, click View Details.

    The APEX Instance Details page appears.

  4. Click the Actions menu and select Configure Document Generator.

    Note:

    The Configure Document Generator option is only displayed for APEX instances where the workload type is Data Warehouse, Transactional Processing, or JSON Database.

In the Configure Document Generator page:

  1. Select the Compartment.
  2. Select the Connection.
    If you do not have a connection, you must create one manually. For more information on creating a connection, see Using the Oracle Cloud Infrastructure Console in Oracle Cloud Infrastructure Documentation. For more information on database privileges required, see IAM Policies and Oracle Database Privileges.
  3. Select Enable Document Generator for the APEX instance to enable Document Generator for the selected connection.
    By default, Enable Autonomous Database resource principal for the APEX instance is selected and cannot be disabled until you disable Enable Document Generator.
  4. In the Document generator function field, select the function you want.
    If the function is not available, you must create one manually. See Configuring the Document Generator Function in Oracle Cloud Infrastructure Documentation for more details.
  5. Select the Object storage bucket compartment for document templates and reports. By default, this is the current compartment.
  6. In the IAM policy creation section, create a policy group by entering a name in the Policy name field.

    Tip:

    If you do not want to automatically create the policy, select Do not create an IAM policy.
  7. (Optional) Change the Policy compartment.
  8. Click Configure.
    If the Document Generator is enabled and the IAM policy created successfully, a green Done label appears when configuration is complete. If configuration does not complete, an error label appears.
  9. Click Close to close the screen.

Parent topic: About Document Generator