Manage Service Access and Security

Give Users Permissions to Manage Analytics Cloud Instances

About Permissions to Manage Oracle Analytics Cloud Instances

You use authorization policies to control access to resources in your tenancy. For example, you can create a policy that authorizes users to create and manage Oracle Analytics Cloud instances.

You create policies using the Oracle Cloud Infrastructure Console. For detailed information, see Managing Policies.

Resource Types for Oracle Analytics Cloud
Resource Types Description

analytics-instance

A single Oracle Analytics Cloud instance.

analytics-instances

One or more Oracle Analytics Cloud instances.

analytics-instance-work-request

A single work request for Oracle Analytics Cloud.

Each operation you perform on an Oracle Analytics Cloud instance, creates a work request. For example, operations such as create, start, stop, and so on.

analytics-instance-work-requests One or more work requests.

Supported Variables

The values of these variables are supplied by Oracle Analytics Cloud. In addition, other general variables are supported. See General Variables for All Requests.

Variable Type Description Sample Value
target.analytics-instance.id ocid OCID for the Analytics Cloud instance. target.analytics-instance.id = 'oci1.analyticsinstance.oc1..abc123'
target.analytics-instance.name string Name of the Analytics Cloud instance. target.analytics-instance.name = 'myanalytics_1'
target.analytics-instance.source-compartment.id ocid OCID of the source compartment, in a "move compartment" operation. target.analytics-instance.source-compartment.id = 'ocid1.compartment.oc1..aaa100'
target.analytics-instance.destination-compartment.id ocid OCID of the destination compartment in a "move compartment" operation. target.analytics-instance.destination-compartment.id = 'ocid1.compartment.oc1..aaa200'

Details for Verb and Resource-Type Combinations

Oracle Cloud Infrastructure offers a standard set of verbs to define permissions across Oracle Cloud Infrastructure resources (Inspect, Read, Use, Manage). These tables list the Oracle Analytics Cloud permissions associated with each verb. The level of access is cumulative as you go from Inspect to Read to Use to Manage.

INSPECT

Resource- Type INSPECT Permission
  • analytics-instance
  • analytics-instances
  • ANALYTICS_INSTANCE_INSPECT
  • analytics-instance-work-request
  • analytics-instance-work-requests
  • ANALYTICS_INSTANCE_WR_INSPECT

READ

Resource- Type READ Permission
  • analytics-instance
  • analytics-instances
  • ANALYTICS_INSTANCE_INSPECT
  • ANALYTICS_INSTANCE_READ
  • analytics-instance-work-request
  • analytics-instance-work-requests
  • ANALYTICS_INSTANCE_WR_INSPECT
  • ANALYTICS_INSTANCE_WR_READ

USE

Resource- Type USE Permission
  • analytics-instance
  • analytics-instances
  • ANALYTICS_INSTANCE_INSPECT
  • ANALYTICS_INSTANCE_READ
  • ANALYTICS_INSTANCE_USE
  • analytics-instance-work-request
  • analytics-instance-work-requests
  • N/A

MANAGE

Resource- Type MANAGE Permission
  • analytics-instance
  • analytics-instances
  • ANALYTICS_INSTANCE_INSPECT
  • ANALYTICS_INSTANCE_READ
  • ANALYTICS_INSTANCE_USE
  • ANALYTICS_INSTANCE_CREATE
  • ANALYTICS_INSTANCE_DELETE
  • ANALYTICS_INSTANCE_UPDATE
  • ANALYTICS_INSTANCE_MOVE
  • ANALYTICS_INSTANCE_MANAGE
  • analytics-instance-work-request
  • analytics-instance-work-requests
  • ANALYTICS_INSTANCE_WR_INSPECT
  • ANALYTICS_INSTANCE_WR_READ
  • ANALYTICS_INSTANCE_WR_DELETE

Permissions Required for Each API Operation

This table shows the API operations available for Oracle Analytics Cloud, grouped by resource type.

REST API Operation CLI Command Operation Permission Required to Use the Operation
ListAnalyticsInstances analytics-instance list ANALYTICS_INSTANCE_INSPECT
CreateAnalyticsInstance analytics-instance create ANALYTICS_INSTANCE_CREATE
GetAnalyticsInstance analytics-instance get ANALYTICS_INSTANCE_READ
UpdateAnalyticsInstance analytics-instance update ANALYTICS_INSTANCE_UPDATE
DeleteAnalyticsInstance analytics-instance delete ANALYTICS_INSTANCE_DELETE
StartAnalyticsInstance analytics-instance start ANALYTICS_INSTANCE_USE
StopAnalyticsInstance analytics-instance stop ANALYTICS_INSTANCE_USE
ScaleAnalyticsInstance analytics-instance scale ANALYTICS_INSTANCE_MANAGE
ChangeAnalyticsInstanceCompartment analytics-instance change-compartment ANALYTICS_INSTANCE_MOVE
ChangeAnalyticsInstanceNetworkEndpoint analytics-instance change-network-endpoint ANALYTICS_INSTANCE_MANAGE
ListWorkRequests work-request list ANALYTICS_INSTANCE_WR_INSPECT
GetWorkRequest work-request get ANALYTICS_INSTANCE_WR_READ
DeleteWorkRequest work-request delete ANALYTICS_INSTANCE_WR_DELETE
ListWorkRequestErrors work-request-error list ANALYTICS_INSTANCE_WR_INSPECT
ListWorkRequestLogs work-request-log list ANALYTICS_INSTANCE_WR_INSPECT

Example Policy Statements to Manage Analytics Cloud Instances

Here are typical policy statements that you might use to authorize access to Oracle Analytics Cloud instances.

When you create a policy for your tenancy, you grant users access to all compartments by way of policy inheritance. Alternatively, you can restrict access to individual Oracle Analytics Cloud instances or compartments.

Let users in the Administrators group fully manage any Analytics instance

# Full manage permissions (Create, View, Update, Delete, Scale, Start, Stop...)
allow group Administrators to manage analytics-instances in tenancy
allow group Administrators to manage analytics-instance-work-requests in tenancy

Let users in the analytics_power_users group read, start, and stop all Analytics instances in compartment MyOACProduction

# Use permissions (List, Get, Start, Stop)
allow group analytics_power_users to use analytics-instances in compartment MyOACProduction

Let users in the analytics_test_users group create and manage a single Analytics instance (myanalytics_1) in compartment MyOACTest

# Full manage permissions on a single instance
allow group analytics_test_users to manage analytics-instances in compartment MyOACTest where target.analytics-instances.name = 'myanalytics_1'

Let users in the analytics_power_users group move Analytics instances between two named compartments

# Custom permissions to move instances between two specific compartments.
allow group analytics_power_users to {ANALYTICS_INSTANCE_INSPECT, ANALYTICS_INSTANCE_READ, ANALYTICS_INSTANCE_MOVE} in tenancy
where all {
        target.analytics-instance.source-compartment.id =
        'ocid1.compartment.oc1..aaa100',
        target.analytics-instance.destination-compartment.id =
        'ocid1.compartment.oc1..aaa200'
  }

Let users in the analytics_users group inspect any Analytics instance and their associated work requests

# Inspect permissions (list analytics instances and work requests) using metaverbs.
allow group analytics_users to inspect analytics-instances in tenancy
allow group analytics_users to inspect analytics-instance-work-requests in tenancy
# Inspect permissions (list analytics instances and work requests) using permission names.
allow group analytics_users to {ANALYTICS_INSTANCE_INSPECT} in tenancy
allow group analytics_users to {ANALYTICS_INSTANCE_WR_INSPECT} in tenancy

Let users in the analytics_users2 group read details about any Analytics instance and their associated work requests

# Read permissions (read complete analytics instance and work request metadata) using metaverbs.
allow group analytics_users2 to read analytics-instances in tenancy
allow group analytics_users2 to read analytics-instance-work-requests in tenancy
# Read permissions (read complete analytics instance and work request metadata) using permission names.
allow group analytics_users2 to {ANALYTICS_INSTANCE_INSPECT, ANALYTICS_INSTANCE_READ} in tenancy
allow group analytics_users2 to {ANALYTICS_INSTANCE_WR_INSPECT, ANALYTICS_INSTANCE_WR_READ} in tenancy

Let users in the analytics_power_users2 group read, start, and stop all Analytics instances and read their associated work requests

# Use permissions (read, stop, start on analytics instance, read on work request) using metaverbs.
allow group analytics_power_users2 to use analytics-instances in tenancy
allow group analytics_power_users2 to read analytics-instance-work-requests in tenancy
# Use permissions (read, stop, start on analytics instance, read on work request) using permission names.
allow group
        analytics_power_users2 to {ANALYTICS_INSTANCE_INSPECT, ANALYTICS_INSTANCE_READ, ANALYTICS_INSTANCE_USE} in
        tenancy
allow group
        analytics_power_users2 to {ANALYTICS_INSTANCE_WR_INSPECT, ANALYTICS_INSTANCE_WR_READ} in
        tenancy

Let users in the Administrators2 group manage any Analytics instance and their associated work requests

# Full manage permissions (use, scale, delete on analytics instance, read and cancel on work request) using metaverbs.
allow group Administrators2 to manage analytics-instances in tenancy
allow group Administrators2 to manage analytics-instance-work-requests in tenancy
# Full manage permissions (use, create, scale, delete on analytics instance, read and cancel on work request) using permission names.
allow group 
        Administrators2 to
        {ANALYTICS_INSTANCE_INSPECT, ANALYTICS_INSTANCE_READ, ANALYTICS_INSTANCE_USE,
        ANALYTICS_INSTANCE_CREATE, ANALYTICS_INSTANCE_DELETE, ANALYTICS_INSTANCE_UPDATE,
        ANALYTICS_INSTANCE_MOVE, ANALYTICS_INSTANCE_MANAGE} in 
        tenancy
allow group
        Administrators2 to 
        {ANALYTICS_INSTANCE_WR_INSPECT, ANALYTICS_INSTANCE_WR_READ, ANALYTICS_INSTANCE_WR_DELETE} in
        tenancy

Typical Workflow for Setting Up Policies to Manage Analytics Cloud Instances

If you’re setting up policies for Oracle Analytics Cloud for the first time, take some time to understand what's required before you start.

Description of policy_flow.jpg follows

High-level steps:

  1. Create users in the federated Oracle Identity Cloud Service (IDCS).
  2. Create one or more groups and assign users to each group, as required.

    Give the groups suitable names and include only those users that you want to manage Oracle Analytics Cloud instances in Oracle Cloud Infrastructure (Gen 2). For example, prefix them with OCI and indicate the level of access for users in the group: OCI_Users, OCI_Power_Users, OCI_Analytics_Admins, and so on.

  3. Create groups in Oracle Cloud Infrastructure (OCI).

    Give the groups suitable names. For example, prefix them with analytics and mirror the naming convention that you used in Oracle Identity Cloud Service: analytics_users, analytics_power_users, analytics_service_admins, and so on.

  4. Map the groups you created in OCI to the groups in IDCS.
  5. Create one or more polices, as required.

    Give users in OCI groups suitable access permissions to compartments and Oracle Analytics Cloud instances.

For more detailed steps, see the next topic.

Give a User Permissions to Manage Analytics Cloud Instances

You can create security policies to give users suitable access to Oracle Analytics Cloud instances in Oracle Cloud Infrastructure Console.

  1. Sign-in to your Cloud Account as Cloud Account Administrator.
  2. Navigate to the federated Oracle Identity Cloud Service.
    1. Under Governance and Administration, click Identity, then Federation.
    2. Click the link to your Oracle Identity Cloud Service Console.
  3. In Oracle Identity Cloud Service, add one or more users.
    1. In the Users section, click Add a User.
    2. Enter details about the user, and click Finish.
  4. In Oracle Identity Cloud Service, create one or more groups and assign users to the appropriate group.
    1. Click Groups in the Navigator, and then click Add.
    2. Enter details about the group, and click Next.
      For example, if you're creating a policy that gives users permissions to fully manage Oracle Analytics Cloud instances you might name the group OCI_Analytics_Admins (or similar) and include a short description such as "Users with permissions to set up and manage Oracle Analytics Cloud instances on Oracle Cloud Infrastructure" (or similar).
    3. Add one or more users to the group.
  5. In Oracle Cloud Infrastructure Console, create an OCI group that corresponds to each of the groups you created in Oracle Identity Cloud Service.
    1. Under Governance and Administration, click Identity, then Groups.
    2. Click Create Group.
    3. Enter details about the group.
      For example, if you're creating a policy that gives users permissions to fully manage Oracle Analytics Cloud instances you might name the group analytics_service_admin (or similar) and include a short description such as "Users with permissions to set up and manage Oracle Analytics Cloud instances on Oracle Cloud Infrastructure" (or similar).
  6. Map OCI groups to the corresponding groups in Oracle Identity Cloud Service.
    1. Under Governance and Administration, click Identity, then Federation.
    2. Navigate to your Oracle Identity Cloud Service federation.
      For most tenancies, the federation is named OracleIdentityCloudService.
    3. Click Add Mapping and select the name of a group you created in Oracle Identity Cloud Service. For example, OCI_Analytics_Admins.
    4. Select the OCI group you want to map to. For example, analytics_service_admin.
  7. Create a policy that gives users belonging to an OCI group, specific access permissions to Oracle Analytics Cloud instances or compartments.
    1. Under Governance and Administration, click Identity, then Policies.
    2. Select a compartment, and click Create Policy.

Users belonging to any groups mentioned in the policy statement get their new permission when they next sign in to the Console.

Give Data Sources Access to Analytics Cloud Instances

You can connect Oracle Analytics Cloud to a wide range of data sources. Some data sources, such as Oracle Autonomous Data Warehouse, require you to include the IP address of your Oracle Analytics Cloud instance in their allowlist.

Topics:

Find the IP Address or Host Name of Your Oracle Analytics Cloud Instance

You can find the hostname and IP address information for your Oracle Analytics Cloud deployment on the Instance Details tab in Oracle Cloud Infrastructure Console.

You'll find this information useful for several scenarios.

  • Gateway IP Address: Some data sources use an allowlist to control access to their data. To include your Oracle Analytics Cloud instance in an allowlist, copy the Gateway IP Address that is displayed on the Additional Details tab and add it to the allowlist so that Oracle Analytics Cloud can connect and access the data.
  • IP Address: If you set up a vanity URL, you must add a DNS entry that maps the custom domain name you want to use to the IP Address of your Oracle Analytics Cloud instance.
  • Egress IP Addresses: If you set up a private access channel for Oracle Analytics Cloud, you can also find the egress IP addresses that Oracle Analytics Cloud uses to access private data sources. You copy the Egress IP Address information and add it to the allowlist for the private data source so that Oracle Analytics Cloud can connect and access the data.
  1. In Oracle Cloud Infrastructure Console, click Navigation menuin the top left corner.
  2. Under Solutions and Platform, select Analytics, then Analytics Cloud.
  3. Select the compartment that contains the Oracle Analytics Cloud instance you're looking for.
  4. Click the name of the instance.
  5. Click Additional Details.

    The Hostname, IP Address and Gateway IP Address of your instance is displayed in the Network section.

    Host name and IP Address information
  6. To find the egress IP addresses that Oracle Analytics Cloud uses to access private data sources over a private access channel.
    1. On the Instance Details page, navigate to the Resources section, click Private Access Channel, and then click the name of the private access channel.
    2. In the Private Access Details section, note down the Egress IP Addresses.
    Egress IP Addresses

Add the IP Address of Your Oracle Analytics Cloud Instance to Allowlists

Before you try to connect Oracle Analytics Cloud to an Oracle Cloud database, ask the database administrator to add the Gateway IP Address (or address range) for your Oracle Analytics Cloud instance to the target database's allowlist. The database administrator must add a security rule on the target Oracle Cloud database that allows TCP/IP traffic from Oracle Analytics Cloud on a specific database port.

This topic describes how to add Oracle Analytics Cloud to the allowlist for an Oracle Cloud database. If you want to connect to other data sources, follow similar steps, as required.

  1. Make a note of the Gateway IP Address of your Oracle Analytics Cloud instance or the Egress IP address of the private access channel that you or your database administrator must allow access to.
  2. Include the Gateway IP Address that you made a note of in Step 1 in the security list for your Oracle Cloud database.

    The way you register the IP address of your Oracle Analytics Cloud instance depends on whether the database you're trying to connect to is deployed on Oracle Cloud Infrastructure or Oracle Cloud Infrastructure Classic:

    • Database on Oracle Cloud Infrastructure
      1. Add an ingress rule.
        Description of uc1_securitylist.jpg follows

      2. Specify the IP address in the SOURCE CIDR field.
        Description of uc1_ingressrules.jpg follows

    • Database on Oracle Cloud Infrastructure Classic
      1. Add an access rule.Description of access_rules_ocic1-png.png follows
      2. Specify the IP address in the field below the Source fieldDescription of access_rules_ocic2-png.png follows

Public IP Ranges and Gateway IPs for Oracle Analytics Cloud Instances

If you want to connect Oracle Analytics Cloud with a public endpoint to a database in Oracle Cloud, you must add the public gateway IP Address (or IP address range) where your Oracle Analytics Cloud instance is located on Oracle Cloud Infrastructure to the database's allowlist.

The public IP address information that you provide depends on the type of database you want to connect to and whether or not your Oracle Analytics Cloud instance is deployed in the same region as the database.

Database Oracle Autonomous Data Warehouse Oracle Autonomous Transaction Processing Any Other Oracle Cloud Database
Same region as Oracle Analytics Cloud Allow 240.0.0.0/4 Allow 240.0.0.0/4 Allow the region-specific IP address.
Different region to Oracle Analytics Cloud Allow the region-specific IP address. Allow the region-specific IP address. Allow the region-specific IP address.

Region-Specific Public IP Address Information for Oracle Analytics Cloud

Use Oracle Cloud Infrastructure Console to find the public gateway IP address (or IP address range) of your Oracle Analytics Cloud instance that you or your database administrator must add to the database's allowlist. See Find the IP Address or Host Name of Your Oracle Analytics Cloud Instance.

Alternatively, if you know the region where you deployed your Oracle Analytics Cloud instance, find that region in the table below and make a note of the public IP address information listed in the IP Address Range column or the Gateway IP Address column.

The security policy enforced by your company or organization determines whether you must provide the IP address ranges or Gateway IP address. If you're not sure, check with your network administrator.

For example, if you deployed your Oracle Analytics Cloud instance in Tokyo, Japan East (ap-tokyo-1) and your company's security policy requires you to provide an IP address range, you add 192.29.39.56/29. Alternatively, if you're required to provide a Gateway IP address, you add 192.29.39.59.

Region Where Oracle Analytics Cloud Deployed Region Identifier IP Address Range Gateway IP Address
Asia Pacific (APAC)
Australia Southeast (Melbourne) ap-melbourne-1 192.29.211.152/29 192.29.211.154
Australia East (Sydney) ap-sydney-1 192.29.144.152/29 192.29.144.154
India South (Hyderabad) ap-hyderabad-1 129.148.128.56/29 129.148.128.61
India West (Mumbai) ap-mumbai-1 192.29.48.240/29 192.29.48.246
Japan Central (Osaka) ap-osaka-1 192.29.242.208/29 192.29.242.211
Japan East (Tokyo) ap-tokyo-1 192.29.39.56/29 192.29.39.59
South Korea Central (Seoul) ap-seoul-1 192.29.20.96/29 192.29.20.98
South Korea North (Chuncheon) ap-chuncheon-1 129.148.144.24/29 129.148.144.31
Europe, the Middle East and Africa (EMEA)
Germany Central (Frankfurt) eu-frankfurt-1

147.154.148.0/29

138.1.64.32/29

147.154.148.171

138.1.64.33

Netherlands Northwest (Amsterdam) eu-amsterdam-1

192.29.193.72/29

192.29.193.76

Switzerland North (Zurich) eu-zurich-1 192.29.60.112/29 192.29.60.112
Saudi Arabia West (Jeddah) me-jeddah-1 192.29.225.72/29 192.29.225.78
UAE East (Dubai) me-dubai-1 129.148.214.184/29 129.148.214.189
UK South (London) uk-london-1

147.154.229.168/29

147.154.229.170

UK West (Newport) uk-cardiff-1

129.149.20.112/29

129.149.20.118

Latin America
Brazil East (Sao Paulo) sa-saopaulo-1 192.29.128.232/29 192.29.128.238
North America
Canada Southeast (Montreal) ca-montreal-1 192.29.82.176/29 192.29.82.176
Canada Southeast (Toronto) ca-toronto-1 192.29.13.0/29

192.29.13.6

US East (Ashburn) us-ashburn-1

147.154.20.0/29

147.154.3.184/29

147.154.0.0/29

147.154.3.8/29

147.154.20.1

147.154.3.185

147.154.0.3

147.154.3.13

US West (Phoenix) us-phoenix-1

147.154.104.160/29

138.1.32.24/29

147.154.104.165

138.1.32.29

US West (San Jose) us-sanjose-1

129.148.161.112/29

129.148.161.117

Restrict Access to Oracle Analytics Cloud Deployed with a Public Endpoint

About Public Endpoints and Access Control Rules

When you set up an Oracle Analytics Cloud instance you have the option to deploy Oracle Analytics Cloud with a public internet accessible endpoint. For security reasons, you might want to restrict access through one or more access control rules.

You can add and edit access control rules whenever you want and manage access in several ways. You can manage access with:
  • A specific set of IP addresses
  • A CIDR block range (Classless Inter-Domain Routing)
  • An Oracle Cloud Infrastructure VCN (Virtual Cloud Network)
  • Any combination of the above, that is, IP addresses, CIDR ranges, VCNs

For example:

  • Scenario 1 - Allow access to Oracle Analytics Cloud over the public internet. Restrict access to a fixed set of IP addresses.
  • Scenario 2 - Allow access to Oracle Analytics Cloud over the public internet. Restrict access to hosts within a fixed CIDR block range.

  • Scenario 3 - Allow access to Oracle Analytics Cloud from an Oracle Cloud Infrastructure VCN that's deployed in the same region as Oracle Analytics Cloud, without going over the public internet. At the same time, allow other third-party cloud services or users to access Oracle Analytics Cloud over the public internet.

  • Scenario 4 - Allow access to Oracle Analytics Cloud from your on-premise network without going through the public internet. At the same time, allow other third-party cloud services or users to access Oracle Analytics Cloud over the public internet.
Public endpoint scenarios

The sample diagram shows Oracle Analytics Cloud deployed with a public endpoint and two access control rules. The first rule allows access from the IP address 204.204.100.100 and the second rule allows access from the Oracle Cloud Infrastructure VCN customer-oci-vcn. The VCN is peered to an on-premise network, and access to Oracle Analytics Cloud is routed through the VCN's service gateway.

While Oracle Analytics Cloud is accessible from the public internet, you can implement your own access control rules to provide any additional security that you need. In this example, only the third-party service with the egress gateway IP address 204.204.100.100 accessed Oracle Analytics Cloud over the public internet. Traffic from the on-premise network never uses the public internet, instead it uses the service gateway configured inside the VCN.

Prerequisites for a Public Endpoint

Before you create an Oracle Analytics Cloud instance that's accessible from the public internet, consider whether or not your organization wants to restrict access.

No Restrictions

No prerequisites. If you want Oracle Analytics Cloud to be accessible from anywhere, you can create the Oracle Analytics Cloud instance with no access control.

Restrict Access to a Specific IP Address or CIDR Block Range

If you plan to limit access to traffic from a specific IP address or CIDR block range, record all the IP addresses or CIDR ranges that you want to allow. When you create your Oracle Analytics Cloud instance, you use this information to define one or more access control rules for Oracle Analytics Cloud.

Restrict Access to a Specific VCN

If you plan to limit access to traffic from a specific Oracle Cloud Infrastructure VCN, ensure that the VCN exists and you have the required policies to access the VCN.

  1. Set up an Oracle Cloud Infrastructure VCN in the same region as the Oracle Analytics Cloud instance you plan to create.
  2. Set up a service gateway in your VCN, and a route table to send traffic to Oracle Analytics Cloud through the service gateway.
  3. Ensure that you (or whoever plans to create the Oracle Analytics Cloud instance) have the required policies to access the VCN.
    • READ policy for the compartment:
      ALLOW GROUP <ANALYTICS ADMIN GROUP> TO READ compartments IN TENANCY
    • READ policy for the VCN:
      ALLOW GROUP <ANALYTICS ADMIN GROUP> TO READ virtual-network-family IN TENANCY

Typical Workflow to Restrict Public Access using Rules

If you want to deploy an Oracle Analytics Cloud instance with a public endpoint for the first time with one or more access control rules, follow these tasks as a guide.

Task Description More Information
Understand prerequisites for a public endpoint Consider whether or not your organization plans to restrict access. If required, record the IP addresses, CIDR ranges, and VCNs that you plan to allow access to. Prerequisites for a Public Endpoint

Create Oracle Analytics Cloud with a public endpoint

Use Oracle Cloud Infrastructure Console to deploy a new service.

Create Oracle Analytics Cloud with a Public Endpoint

Allow access by IP address, CIDR range, or VCN

Add one or more access control rules. You can allow access to Oracle Analytics Cloud by public IP address, public CIDR block range, or VCN.

Manage Access Control Rules

(Optional) Set up private access from your on-premise network

Set up an Oracle Cloud Infrastructure VCN that connects to your on-premise network using FastConnect private peering or VPN Connect. The VCN must be deployed in the same region as Oracle Analytics Cloud.

Set up a service gateway in your VCN, and a route table to send traffic to Oracle Analytics Cloud through the service gateway.

Add an access control rule in your Oracle Analytics Cloud instance that allows access from your VCN.

Configure VCN peering to your on-premise network through FastConnect or VPN Connect to enable access from your on-premise network.

Configure transit routing with the VCN to give your on-premise network private access to Oracle Analytics Cloud.

Working with VCNs and Subnets

Setting Up a Service Gateway in the Console

Manage Access Control Rules

Access to Your On-Premises Network

Setting Up Private Access to Oracle Services

(Optional) Set up private access from hosts on your VCN

Set up an Oracle Cloud Infrastructure VCN in the same region as Oracle Analytics Cloud.

Set up a service gateway in your VCN, and a route table to send traffic to Oracle Analytics Cloud through the service gateway.

Add an access control rule in your Oracle Analytics Cloud instance that allows access from your VCN.

Working with VCNs and Subnets

Setting Up a Service Gateway in the Console

Manage Access Control Rules

Create Oracle Analytics Cloud with a Public Endpoint

You can use Oracle Cloud Infrastructure Console, API, or command line to deploy Oracle Analytics Cloud with a public endpoint.

If you're new to Oracle Analytics Cloud, see Create a Service for all the steps.

This topic highlights only the information you must configure to enable access over the public internet and define any access control rules that you require.

Options to create public endpoint
  1. For Network Access, select Public.
  2. To configure access control rules, select Configure Access Control Rules, and then add one or more rules using the specific public IP addresses, public CIDR block ranges, and VCNs that you want to allow access to.

    You can add, edit, and delete access control rules at any time. So if you prefer, you can add your rules later on.

Manage Access Control Rules

If you deployed Oracle Analytics Cloud with a public internet accessible endpoint, you can restrict access to your service through an access control list (ACL) that contains one or more rules. You can add and edit access control rules whenever you want and allow access by public IP address, public CIDR block range, or VCN using the Console, API, or command line.

Note

Required IAM Policy to Edit Analytics Instance

Verb: manage

Resource Types: analytics-instance, analytics-instances

Permission: ANALYTICS_INSTANCE_MANAGE

See About Permissions to Manage Oracle Analytics Cloud Instances.

Additional IAM Policy Required to Edit a Public Endpoint

Verb: read

Resource Type: virtual-network-family, compartment, compartments

See Prerequisites for a Public Endpoint.

Manage Access Rules for a Public Endpoint using the Console

If you deployed Oracle Analytics Cloud with a public internet accessible endpoint, you can restrict access to your service through an access control list (ACL) that contains one or more rules. You can add and edit access control rules whenever you want and allow access by public IP address, public CIDR block range, or VCN.

  1. In Console, click Navigation menuin the top left corner.
  2. Under Solutions and Platform, select Analytics, then Analytics Cloud.
  3. Select the compartment that contains the Oracle Analytics Cloud instance you're looking for.
  4. Click the name of the instance you want to control access to.
  5. On the Instance Information page, click the Edit icon next to the Access Control Rules option.
    Edit Access Control Rules
  6. Add or edit access control rules as required.

    You can specify the following types of rule:

    • IP Address: Select IP Address to a specific public IP address.
    • CIDR Block: Select CIDR Block to specify a range of public IP addresses using CIDR notation.
    • Virtual Cloud Network: Select Virtual Cloud Network to specify an existing Oracle Cloud Infrastructure VCN. The drop-down list shows all the VCNs in the current compartment that you have access to. If you can't see the VCN or subnet you want, check you have the required permissions. See About Public Endpoints and Access Control Rules.

      Click Change Compartment to select a VCN from a different compartment.

Manage Access Rules for a Public Endpoint using the REST API

You can use the ChangeAnalyticsInstanceNetworkEndpoint operation to change access control rules for an Oracle Analytics Cloud instance with a public endpoint.

Refer to the Oracle Cloud Infrastructure REST API Reference for information about how to use this operation:

Manage Access Rules for a Public Endpoint using the Command Line

You can use the change-network-endpoint command to change access control rules for an Oracle Analytics Cloud instance with a public endpoint.

For example:
oci
  analytics analytics-instance change-network-endpoint \
  --analytics-instance-id ocid1.analyticsinstance.oc1.us-ashburn-1.aaaaaaaa5pynfxr2e6wpshkhkoajoiqizwmhc6x7ogp4aw66whyq76fdk32q \
  --network-endpoint-details '{
"networkEndpointType": "PUBLIC", 
"whitelistedIps": ["168.122.67.231", "168.122.59.5", "10.20.30.35/26", "240.0.0.0/4"], 
"whitelistedVcns": [{"id": "ocid1.vcn.oc1.us-ashburn-1.amaaaaaarfop2rqahtll2uacphjioux3v346fgp6rscmgcekdg6uni3axzna"}]
}'

Refer to the Oracle Cloud Infrastructure CLI Command Reference for information about how to use this command:

Deploy Oracle Analytics Cloud with a Private Endpoint

If you want only hosts within your virtual cloud network (VCN) or your on-premise network to have access to Oracle Analytics Cloud, you can deploy your Oracle Analytics Cloud instance with a private endpoint.

Topics:

About Private Endpoints

When you set up an Oracle Analytics Cloud instance you have the option to restrict access through a private endpoint. Private access means that traffic doesn't go over the internet. Private access can be from hosts within your virtual cloud network (VCN) or your on-premise network.

For example:

  • Scenario 1 - Allow access to Oracle Analytics Cloud from an on-premise (corporate) network. Don't allow access to anyone outside the corporate network.

  • Scenario 2 - Allow access to Oracle Analytics Cloud from an Oracle Cloud Infrastructure VCN that's deployed in the same region as Oracle Analytics Cloud. Don't allow access to anyone outside the virtual cloud network.

When you deploy an Oracle Analytics Cloud instance with a private endpoint, the Oracle Analytics Cloud URL is only accessible from a browser if the client machine supports host name resolution. This means you must configure Domain Name Server (DNS) resolution on your private network to access the private endpoint. For example, you might use a DNS resolution strategy similar to that described in the article Hybrid DNS Configuration using DNS VM in VCN.

Private endpoint scenarios

The diagram shows Oracle Analytics Cloud deployed with a private endpoint. The private Oracle Analytics Cloud is only accessible through an Oracle Cloud Infrastructure VCN in your tenancy; you can't access Oracle Analytics Cloud from the public internet.

You must peer the VCN to your on-premise network. To enable access to Oracle Analytics Cloud, the on-premise network DNS must provide host name resolution for Oracle Analytics Cloud.

Prerequisites for a Private Endpoint

Before you create an Oracle Analytics Cloud instance with a private endpoint, complete the required prerequisites.

The prerequisites are the same for both scenarios:

  • Private access from an on-premise network through an Oracle Cloud Infrastructure VCN
  • Private access from hosts in an Oracle Cloud Infrastructure VCN
  1. Set up the Oracle Cloud Infrastructure VCN with a subnet for Oracle Analytics Cloud.

    The VCN must be in the region where you plan to deploy Oracle Analytics Cloud. See Working with VCNs and Subnets.

    Note

    If you plan to access Oracle Analytics Cloud from an on-premise network, keep some address space available in the VCN for additional subnets in case you need them for host name resolution.
  2. Ensure that you (or whoever plans to create the Oracle Analytics Cloud instance) have the required policies to access the VCN.

    Several options are available. Choose the most appropriate level for you:

    Broad Resource Access Policy

    • ALLOW GROUP <ANALYTICS ADMIN GROUP> TO READ compartments IN TENANCY
    • ALLOW GROUP <ANALYTICS ADMIN GROUP> TO MANAGE virtual-network-family IN TENANCY

    Limited Resource Access Policy

    • ALLOW GROUP <ANALYTICS ADMIN GROUP> TO READ compartments IN TENANCY
    • ALLOW GROUP <ANALYTICS ADMIN GROUP> TO READ virtual-network-family IN compartment <compartment name of VCN>
    • ALLOW GROUP <ANALYTICS ADMIN GROUP> TO USE subnets IN compartment <compartment name of subnet>
    • ALLOW GROUP <ANALYTICS ADMIN GROUP> TO MANAGE vnics IN compartment <compartment name of AnalyticsInstance>

    Moderate Resource Access Policy - Option 1

    • ALLOW GROUP <ANALYTICS ADMIN GROUP> TO READ compartments IN TENANCY
    • ALLOW GROUP <ANALYTICS ADMIN GROUP> TO READ virtual-network-family IN TENANCY
    • ALLOW GROUP <ANALYTICS ADMIN GROUP> TO USE subnets IN TENANCY
    • ALLOW GROUP <ANALYTICS ADMIN GROUP> TO MANAGE vnics IN TENANCY

    Moderate Resource Access Policy - Option 2

    • ALLOW GROUP <ANALYTICS ADMIN GROUP> TO READ compartments IN TENANCY
    • ALLOW GROUP <ANALYTICS ADMIN GROUP> TO USE virtual-network-family IN compartment <compartment name of VCN>
    • ALLOW GROUP <ANALYTICS ADMIN GROUP> TO MANAGE virtual-network-family IN compartment <compartment name of AnalyticsInstance>

Typical Workflow to Deploy Oracle Analytics Cloud with a Private Endpoint

If you want to deploy an Oracle Analytics Cloud instance with a private endpoint for the first time, follow these tasks as a guide.

Task Description More Information
Understand prerequisites for a private endpoint

Set up an Oracle Cloud Infrastructure virtual cloud network (VCN) with a subnet for Oracle Analytics Cloud.

The VCN must be in the region where you plan to deploy Oracle Analytics Cloud.

Prerequisites for a Private Endpoint

Create Oracle Analytics Cloud with a private endpoint

Use Oracle Cloud Infrastructure Console to deploy a new service.

Create Oracle Analytics Cloud with a Private Endpoint

Configure the connection to your on-premise network using FastConnect or VPN Connect.

(Only required if you want to access Oracle Analytics Cloud from an on-premise network)

Use FastConnect or VPN to peer your on-premise network with the Oracle Cloud Infrastructure VCN through which you plan to access Oracle Analytics Cloud.

Connect to Your On-premise Network using FastConnect or VPN Connect

Change the VCN or subnet used to access Oracle Analytics Cloud

If you want to access Oracle Analytics Cloud through a different VCN or subnet, you can edit the configuration at any time.

Change a Private Endpoint using the Console

Create Oracle Analytics Cloud with a Private Endpoint

You can use Oracle Cloud Infrastructure Console, API, or command line to deploy Oracle Analytics Cloud with a private endpoint.

If you're new to Oracle Analytics Cloud, see Create a Service for all the steps.

This topic highlights only the information you must configure to enable private access through a private endpoint.

Options to create a private endpoint
  1. For Network Access, select Private.
  2. Select the Virtual Cloud Network and the Subnet that you want to use to access Oracle Analytics Cloud.

Connect to Your On-premise Network using FastConnect or VPN Connect

If you want to access an Oracle Analytics Cloud instance that is deployed with a private endpoint in an Oracle Cloud Infrastructure VCN from your on-premise network, you must peer your on-premise network with the Oracle Cloud Infrastructure VCN. You can use FastConnect or VPN to peer your on-premise network with a VCN on Oracle Cloud Infrastructure.

Typically, these tasks are performed by the network administrator responsible for the on-premise network and the Oracle Cloud Infrastructure network. You can complete these steps before or after you create your Oracle Analytics Cloud instance.

  1. In Oracle Cloud Infrastructure Console, navigate to the Additional Details tab to determine the Hostname of your Oracle Analytics Cloud instance.
  2. Peer your on-premise network with the Oracle Cloud Infrastructure VCN through FastConnect or VPN Connect.
  3. In your on-premise network, configure a suitable host name resolution solution for Oracle Analytics Cloud.

    Several options are available to you:

    • (Testing purposes only) From a client machine in your on-premise network, add a host name entry in the /etc/hosts file for Oracle Analytics Cloud.

      Use the hostname that you copied in Step 1. For example:
      <myinstanceid>.analytics.ocp.oraclecloud.com
    • Add a DNS record in your on-premise intranet DNS server (Domain Name System) for Oracle Analytics Cloud, that is, specify the host name for Oracle Analytics Cloud and its private IP address.
    • Set up a hybrid DNS solution. For example, see Hybrid DNS configuration using DNS VM in OCI VCN.
      1. Configure your on-premise intranet DNS server with conditional DNS forwarding to the DNS server configured in the VCN, and specify the host name for Oracle Analytics Cloud.
      2. Configure your on-premise intranet DNS server with DNS forwarding to the DNS server configured in the VCN, and specify the entire Oracle Analytics Cloud domain, that is, analytics.ocp.oraclecloud.com.
  4. Test that you can access Oracle Analytics Cloud from your on-premise network.

Change the VCN or Subnet Used to Access a Private Endpoint

If you want to access Oracle Analytics Cloud through a different VCN or subnet, you can edit the configuration using the Console, API, or command line.

Note

Required IAM Policy to Edit Analytics Instance

Verb: manage

Resource Types: analytics-instance, analytics-instances

Permission: ANALYTICS_INSTANCE_MANAGE

See About Permissions to Manage Oracle Analytics Cloud Instances.

IAM Policy Required to Change a Private Endpoint

Verb: manage

Resource Type: virtual-network-family

Verb: read

Resource Type: compartment, compartments

To learn about other, more detailed access policy options, see Prerequisites for a Private Endpoint.

Change a Private Endpoint using the Console

If you want to access Oracle Analytics Cloud through a different VCN or subnet, you can edit the configuration.

  1. In Console, click Navigation menuin the top left corner.
  2. Under Solutions and Platform, select Analytics, then Analytics Cloud.
  3. Select the compartment that contains the Oracle Analytics Cloud instance you're looking for.
  4. Click the name of the instance you want to change access to.
  5. On the Instance Information page, click the Edit icon next to Subnet.
  6. Select a different Virtual Cloud Network, Subnet, or both.

    Click Change Compartment to select resources from a different compartment. If you can't see the VCN or subnet you want, check you have the required permissions. See Prerequisites for a Private Endpoint.

    Options to edit the VCN or subnet
Change a Private Endpoint using the REST API

You can use the ChangeAnalyticsInstanceNetworkEndpoint operation to command to change the VCN or subnet used to access an Oracle Analytics Cloud instance with a private endpoint.

Refer to the Oracle Cloud Infrastructure REST API Reference for information about how to use this operation:

Change a Private Endpoint using the Command Line

You can use the change-network-endpoint command to change the VCN or subnet used to access an Oracle Analytics Cloud instance with a private endpoint.

For example:
oci \
  analytics analytics-instance change-network-endpoint \
  --analytics-instance-id ocid1.analyticsinstance.oc1.us-ashburn-1.aaaaaaaa5pynfxr2e6wpshkhkoajoiqizwmhc6x7ogp4aw66whyq76fdk32q \
  --network-endpoint-details '{
"networkEndpointType": "PRIVATE", "vcnId" : 
"ocid1.vcn.oc1.us-ashburn-1.amaaaaaarfop2rqav4x2wox6dt72o57jmnevpguq63gcsdtrbk42bvz446sa", 
"subnetId": "ocid1.subnet.oc1.us-ashburn-1.aaaaaaaal5xb6vodov35nbcqhsnwoypeieowgy44vambmnokzpwv22pvjxoq"
}'

Refer to the Oracle Cloud Infrastructure CLI Command Reference for information about how to use this command:

Connect to Private Data Sources Through a Private Access Channel

If the data you want to analyze is stored on a private host, you can set up a private access channel between your Oracle Analytics Cloud instance and your data source.

Topics:

About Private Access Channels

If you want Oracle Analytics Cloud to access data on a private host, you can set up a private access channel. A private access channel can give Oracle Analytics Cloud access to private data sources within your virtual cloud network (VCN) on Oracle Cloud Infrastructure or other networks peered to the VCN such as your corporate network.

You can set up a private access channel for Oracle Analytics Cloud instances deployed with the Enterprise Analytics feature set. Private access channels aren't available to Oracle Analytics Cloud instances that offer only Self-Service Analytics.

It doesn’t matter whether your Oracle Analytics Cloud instance has a public endpoint or a private endpoint. Oracle Analytics Cloud can access private data sources through a private access channel for both network scenarios.
Note

Private access channels enable you to connect to private data source hosts. You can't use a private access channel to access any other types of private host, such as a private FTP or SMTP host.

Private Access Channel for Oracle Analytics Cloud Instances with Public Endpoint

If Oracle Analytics Cloud has a public endpoint you must specify the VCN and subnet you want the private access channel to use.

Network diagram

Private Access Channel for Oracle Analytics Cloud Instances with Private Endpoint

If Oracle Analytics Cloud has a private endpoint, the private access channel uses the same VCN and subnet as the private endpoint.

Network diagram

About Private Data Sources

Oracle Analytics Cloud can access private data sources with a Fully Qualified Domain Name (FQDN) that resolves through the Domain Name System (DNS) in your tenancy. For example, domain names such as custcorp.com, example.com, and so on.

You configure private access in two stages:

  • In Oracle Cloud Infrastructure Console, you set up a private access channel and register the domain names of the data sources that require private access.

    When you set up (or edit) a private access channel you alter the configuration of your Oracle Analytics Cloud instance. Some users might experience a temporary disruption in service during the configuration process so Oracle recommends that you plan private access channel configuration activities on critical instances accordingly.

  • In Oracle Analytics Cloud, you connect to the data source and analyze the data in the usual way.

For more guidance, see Typical Workflow to Set Up a Private Access Channel.

Supported Data Sources

You can use a private access channel to connect to a range of certified data sources. To check whether or not you can use a private access change to connect to your data source, see Supported Data Sources.
Note

Private access channels enable you to connect to private data source hosts. You can't use a private access channel to access any other types of private host, such as a private FTP or SMTP host.

Limitations

Oracle Analytics Cloud can't access private data sources on a Oracle Database that use IP forwarding. If you want to connect Oracle Analytics Cloud to an Oracle Database that uses a Single Client Access Name (SCAN) that is configured with IP forwarding (instead of FQDN hostname forwarding), use one of the following methods to set up the connection in Oracle Analytics Cloud:
  • Configure the data source connection using the Advanced Connection String option and connect directly to the Oracle Database nodes, instead of SCAN. For example:
    (DESCRIPTION=
    (ADDRESS_LIST= (LOAD_BALANCE=on)(FAILOVER=ON)
    (ADDRESS=(PROTOCOL=tcp)(HOST=<DB Host 1>)(PORT=1521))
    (ADDRESS=(PROTOCOL=tcp)(HOST=<DB Host 2>)(PORT=1521)))
    (CONNECT_DATA=(SERVICE_NAME=<DB Service Name>)))
  • Configure an Oracle Connection Manager in front of SCAN and then configure a data source connection in Oracle Analytics Cloud that connects to the Oracle Connection Manager endpoint.

Prerequisites for a Private Access Channel

Before you configure a private access channel, you need to know the domain names of the DNS zones you want Oracle Analytics Cloud to access, check that your Oracle Analytics Cloud deployment includes the Enterprise Analytics feature set, and verify you have the correct permissions.

If your Oracle Analytics Cloud is deployed with a public endpoint, you also need to know the VCN and subnet on Oracle Cloud Infrastructure that you want Oracle Analytics Cloud to use to access the private sources. If you deployed Oracle Analytics Cloud instance with a private endpoint, the private access channel automatically uses the same VCN and subnet you configured for the instance so you don't need to do step 3.

  1. Verify that your Oracle Analytics Cloud deployment includes the Enterprise Analytics feature set (Oracle Analytics Cloud - Enterprise Edition).

    Feature set information is available on the Instance Details page. See Verify Your Service.

    Private access channels aren't available on Oracle Analytics Cloud deployments that include the Self-Service Analytics feature set (Oracle Analytics Cloud - Professional Edition).

  2. Record the domain name of each private data source (DNS zone) you want Oracle Analytics Cloud to access through the private channel.

    For example, domain names such as example.com, companyabc.com, and so on.

    • Private data source in a corporate network peered to an Oracle Cloud Infrastructure VCN

      Register a DNS zone in the format: <domain name>

      For example:

      • If the data source FQDN hostname is data-source-ds01.companyabc.com, add the DNS Zone as companyabc.com.
      • If the data source FQDN hostname is db01.dbdomain.companyabc.com, add the DNS Zone as dbdomain.companyabc.com to only give Oracle Analytics Cloud access to hosts under dbdomain.companyabc.com.
    • Private data source in an Oracle Cloud Infrastructure VCN

      Register a DNS zone in the format: <VCN DNS label>.oraclevcn.com

      For example: companyabc.oraclevcn.com

      Tip: If you want to connect to a private source on the same VCN as the private access channel, select the checkbox Virtual Cloud Network's Domain Name as DNS Zone on the Configure Private Access Channel page to auto-fill the domain name value.

    • Private Oracle Autonomous Data Warehouse or Oracle Autonomous Transaction Processing in an Oracle Cloud Infrastructure VCN

      Register a DNS zone in the format: adb.<region>.<realm public domain>

      For example:

      • adb.ap-sydney-1.oraclecloud.com
      • adb.uk-gov-cardiff-1.oraclegovcloud.uk
  3. Determine the Oracle Cloud Infrastructure VCN and subnet that you want Oracle Analytics Cloud to use for the private channel.

    VCN Prerequisites

    • Region: The VCN must be in the same region as Oracle Analytics Cloud.

    Subnet Prerequisites

    • Size: Each private access channel requires at least four IP addresses. Two IP addresses are required for network traffic egress, one IP address for the private access channel, and one reserved for future use. This means that the minimum subnet size for a single private access channel is "/29". For example, subnet CIDR 10.0.0.0/29.

      If you have more than one Oracle Analytics Cloud instance, you might need to configure multiple private access channels. If you want to use a single subnet for multiple channels, you must ensure that the subnet is sized accordingly. Alternatively, use a dedicated subnet for each private access channel.

    • Egress Rule: The subnet must include an egress rule that enables communication to the private data source (IP address and port).

    • Ingress Rule: The subnet must include an ingress rule that enables communication from the private data source.

    If you're not sure, ask your network administrator.

    VCN and subnet configuration tasks are typically performed by the network administrator responsible for the Oracle Cloud Infrastructure network. More information is available in Task 1 Set up the VCN and subnet at Scenario B: Private Subnet with a VPN or Scenario C: Public and Private Subnets with a VPN.

  4. Ensure that you (or whoever plans to configure the private access channel for Oracle Analytics Cloud) belongs to a group that is granted the required policies to access the VCN.

    Several options are available. Choose the most appropriate level for you:

    Broad Resource Access Policy

    • ALLOW GROUP <ANALYTICS ADMIN GROUP> TO READ compartments IN TENANCY
    • ALLOW GROUP <ANALYTICS ADMIN GROUP> TO MANAGE virtual-network-family IN TENANCY

    Limited Resource Access Policy

    • ALLOW GROUP <ANALYTICS ADMIN GROUP> TO READ compartments IN TENANCY
    • ALLOW GROUP <ANALYTICS ADMIN GROUP> TO READ virtual-network-family IN compartment <compartment name of VCN>
    • ALLOW GROUP <ANALYTICS ADMIN GROUP> TO USE subnets IN compartment <compartment name of subnet>
    • ALLOW GROUP <ANALYTICS ADMIN GROUP> TO MANAGE vnics IN compartment <compartment name of AnalyticsInstance>
    • ALLOW GROUP <ANALYTICS ADMIN GROUP> TO USE private-ips IN compartment <compartment name of AnalyticsInstance>

    Moderate Resource Access Policy - Option 1

    • ALLOW GROUP <ANALYTICS ADMIN GROUP> TO READ compartments IN TENANCY
    • ALLOW GROUP <ANALYTICS ADMIN GROUP> TO READ virtual-network-family IN TENANCY
    • ALLOW GROUP <ANALYTICS ADMIN GROUP> TO USE subnets IN TENANCY
    • ALLOW GROUP <ANALYTICS ADMIN GROUP> TO MANAGE vnics IN TENANCY
    • ALLOW GROUP <ANALYTICS ADMIN GROUP> TO MANAGE private-ips IN compartment <compartment name of AnalyticsInstance>

    Moderate Resource Access Policy - Option 2

    • ALLOW GROUP <ANALYTICS ADMIN GROUP> TO READ compartments IN TENANCY
    • ALLOW GROUP <ANALYTICS ADMIN GROUP> TO USE virtual-network-family IN compartment <compartment name of VCN>
    • ALLOW GROUP <ANALYTICS ADMIN GROUP> TO MANAGE virtual-network-family IN compartment <compartment name of AnalyticsInstance>

Typical Workflow to Set Up a Private Access Channel

If you want to set up a private access channel for an Oracle Analytics Cloud instance for the first time, follow these tasks as a guide.

Task Description More Information
Understand prerequisites for a private access channel

Make a list of the private data sources (DNS zones) that you want Oracle Analytics Cloud to access through the private access channel and ensure you have the required permissions to set up the private access channel in Oracle Cloud Infrastructure.

Prerequisites for a Private Access Channel

Create an Oracle Analytics Cloud instance

Deploy Oracle Analytics Cloud with the Enterprise Analytics feature set.

Create a Service

Configure a private access channel

Use Oracle Cloud Infrastructure Console to configure a private access channel and list any data sources (DNS zones) that Oracle Analytics Cloud must connect to privately.

Configure a Private Access Channel

Create connections to private data sources

Use Oracle Analytics Cloud to create a connection to the private data source.

The way you create the connection depends on how you want to use the data source, that is, whether you want to build a visualization, analysis, pixel-perfect report, or data model.

Connect to Data for Visualizations and Analyses

Manage Database Connections for Data Models

Connect to Data for Pixel-Perfect Reports

Manage the data sources available through a private access channel

Add, edit, or delete the private data sources (DNS zones) that Oracle Analytics Cloud can access through the private access channel.

Manage the DNS Zones You Can Access on a Private Access Channel using the Console

Edit a Private Access Channel using the REST API

Edit a Private Access Channel using the Command Line

Edit network details for a private access channel Change the VCN or subnet on Oracle Cloud Infrastructure that Oracle Analytics Cloud uses to access private data sources.

Edit Network Details for a Private Access Channel using the Console

Edit a Private Access Channel using the REST API

Edit a Private Access Channel using the Command Line

Delete a private access channel

Delete a private access channel that you configured for Oracle Analytics Cloud but don't need anymore.

Delete a Private Access Channel

Configure a Private Access Channel

You can configure a private access channel using the Console, API, or command line.

Note

Required IAM Policy

Verb: manage

Resource Type: analytics-instance, analytics-instances

Custom Permission: ANALYTICS_INSTANCE_MANAGE

See About Permissions to Manage Oracle Analytics Cloud Instances.

Verb: manage

Resource Type: virtual-network-family

Verb: read

Resource Type: compartment, compartments

To learn about other, more detailed access policy options, see Prerequisites for a Private Access Channel.

Configure a Private Access Channel using the Console

You can use Oracle Cloud Infrastructure Console to configure a private access channel for your Oracle Analytics Cloud instance.

When you set up a private access channel you alter the configuration of your Oracle Analytics Cloud instance. Some users might experience a temporary disruption in service during the configuration process so Oracle recommends that you plan private access channel configuration activities on critical instances accordingly.

  1. In Console, click Navigation menuin the top left corner.
  2. Under Solutions and Platform, select Analytics, then Analytics Cloud.
  3. Select the compartment that contains the Oracle Analytics Cloud instance you're looking for.
  4. Click the name of the instance you want to configure a private access channel for.

    The instance must offer the Enterprise Analytics feature set.

  5. On the Instance Details page, navigate to the Resources section, click Private Access Channel, and then click Configure Private Access Channel.
    Configure Private Access Channel button
  6. For Name, enter any name to identify the private access channel.
  7. If your Oracle Analytics Cloud instance has a public endpoint, select the Virtual Cloud Network and the Subnet that you want Oracle Analytics Cloud to use to access private data sources.

    Click Change Compartment to select resources from a different compartment. If you can't see the VCN or subnet you want, check you have the required permissions.

    If your Oracle Analytics Cloud instance has a private endpoint, the private access channel automatically uses the same VCN and subnet as the private endpoint. See Create Oracle Analytics Cloud with a Private Endpoint.

  8. Enable access to at least one private data source:
    1. Optional. To add the domain name associated with the selected VCN as a private source, select Virtual Cloud Network's Domain Name as DNS Zone.
    2. In DNS Zone, enter the name of a domain you want to give access to.

      For example: companyabc.com

      • Private data source in a corporate network peered to an Oracle Cloud Infrastructure VCN

        Register a DNS zone in the format: <domain name>

        For example:

        • If the data source FQDN hostname is data-source-ds01.companyabc.com, add the DNS Zone as companyabc.com.
        • If the data source FQDN hostname is db01.dbdomain.companyabc.com, add the DNS Zone as dbdomain.companyabc.com to only give Oracle Analytics Cloud access to hosts under dbdomain.companyabc.com.
      • Private data source in an Oracle Cloud Infrastructure VCN

        Register a DNS zone in the format: <VCN DNS label>.oraclevcn.com

        For example: companyabc.oraclevcn.com

        Tip: If you want to connect to a private source on the same VCN as the private access channel, select the checkbox Virtual Cloud Network's Domain Name as DNS Zone on the Configure Private Access Channel page to auto-fill the domain name value.

      • Private Oracle Autonomous Data Warehouse or Oracle Autonomous Transaction Processing in an Oracle Cloud Infrastructure VCN

        Register a DNS zone in the format: adb.<region>.<realm public domain>

        For example:

        • adb.ap-sydney-1.oraclecloud.com
        • adb.uk-gov-cardiff-1.oraclegovcloud.uk
    3. Enter a useful description for the domain.
    4. To add additional domains, click Add DNS Zone.
  9. Click Configure.

    On the Analytics Instances page, the status changes to Active when the configuration process is complete.

  10. To test that the private access channel is working, connect Oracle Analytics Cloud to one of the private data sources you configured and verify you can access the data in Oracle Analytics Cloud.
    1. Sign-in to Oracle Analytics Cloud.
    2. Create a connection to the private data source.

      For example, if you registered the domain companyabc.com as a private source, set up a connection that includes this domain name.

      The way you create the connection depends on how you want to use the data source, that is, whether you want to build a visualization, analysis, pixel-perfect report, or data model.
    3. Create a visualization, analysis, or pixel-perfect report that uses the connection and verify you can access to the data.
Configure a Private Access Channel using the REST API

You can use the CreatePrivateAccessChannel operation to set up a private access channel for an Oracle Analytics Cloud instance.

Refer to the Oracle Cloud Infrastructure REST API Reference for information about how to use this operation:

Configure a Private Access Channel using the Command Line

You can use the analytics-instance create-private-access-channel command to set up a private access channel for an Oracle Analytics Cloud instance.

Refer to the Oracle Cloud Infrastructure CLI Command Reference for information about how to use this command:

Edit a Private Access Channel

You can edit a private access channel using the Console, API, or command line.

Note

Required IAM Policy

Verb: manage

Resource Type: analytics-instance, analytics-instances

Custom Permission: ANALYTICS_INSTANCE_MANAGE

See About Permissions to Manage Oracle Analytics Cloud Instances.

Verb: manage

Resource Type: virtual-network-family

Verb: read

Resource Type: compartment, compartments

To learn about other, more detailed access policy options, see Prerequisites for a Private Access Channel.

Edit Network Details for a Private Access Channel using the Console

If you deployed your Oracle Analytics Cloud instance with a public endpoint, you can change the VCN and subnet on Oracle Cloud Infrastructure that Oracle Analytics Cloud uses to access private sources.

When you deployed Oracle Analytics Cloud with a private endpoint, the private access channel uses the same VCN and subnet you configured for the private endpoint. To edit network settings for both the private endpoint and private network channel, see Change the VCN or Subnet Used to Access a Private Endpoint.

Note

Changing the VCN or subnet impacts any private data sources that you configured for this private access channel. You must ensure that the new network configuration provides a network route to these sources.
  1. In Console, click Navigation menuin the top left corner.
  2. Under Solutions and Platform, select Analytics, then Analytics Cloud.
  3. Select the compartment that contains the Oracle Analytics Cloud instance you're looking for.
  4. Click the name of the instance you want to configure private data sources for.
  5. On the Instance Details page, navigate to the Resources section, and click Private Access Channel.
  6. Click the name of the private access channel you want to edit.
  7. Click Edit Configuration.
    Edit Private Sources
  8. Select the new Virtual Cloud Network or Subnet that you want Oracle Analytics Cloud to use to access private sources.

    The private access channel and all the private sources that are associated with it inherit these changes.

    You can select a VCN and subnet if your Oracle Analytics Cloud instance has a public endpoint. If your Oracle Analytics Cloud instance has a private endpoint, the private access channel automatically uses the same VCN and subnet as the private endpoint.

    Click Change Compartment to select resources from a different compartment. If you can't see the VCN or subnet you want, check you have the required permissions.

  9. Click Save Changes.

    On the Analytics Instances page, the status changes to Active when the configuration is complete. Some users might experience a temporary disruption in service during the configuration process.

  10. Test that you can access the resources from Oracle Analytics Cloud.
    Sign-in to Oracle Analytics Cloud, connect to one of the private data sources that you listed, and verify you have access.
Manage the DNS Zones You Can Access on a Private Access Channel using the Console

You can add, edit, or delete the DNS zones of private sources available through the private channel at any time.

  1. In Console, click Navigation menuin the top left corner.
  2. Under Solutions and Platform, select Analytics, then Analytics Cloud.
  3. Select the compartment that contains the Oracle Analytics Cloud instance you're looking for.
  4. Click the name of the instance you want to configure private data sources for.
  5. On the Instance Details page, navigate to the Resources section, and click Private Access Channel.
  6. Click the name of the private access channel you want to edit.
  7. Click Edit Private Sources.
    Edit Private Sources
  8. To enable access to an additional DNS zone:
    1. Click Add DNS Zone.
    2. Enter the name of the domain you want to give access to.
      For example: companyabc.com
    3. Enter a useful description for the domain.
  9. To edit an existing DNS zone:
    1. Edit the name of the domain.
      Note

      If your Oracle Analytics Cloud instance has working data source connections that reference the current domain name, the connections won't work after you remove the domain from the private access channel.
    2. Edit the description.
  10. To revoke access to a DNS zone you configured earlier, click the X icon for the DNS zone.
  11. Click Save Changes.

    On the Analytics Instances page, the status changes to Active when the configuration is complete. Some users might experience a temporary disruption in service during the configuration process.

  12. Test that you can access the resources from Oracle Analytics Cloud.
    Sign-in to Oracle Analytics Cloud, connect to one of the private data sources that you listed, and verify you have access.
Edit a Private Access Channel using the REST API

You can use the UpdatePrivateAccessChannel operation to edit a private access channel that you configured for an Oracle Analytics Cloud instance.

You can manage the DNS zones accessible through the private access channel and, if your Oracle Analytics Cloud has a public endpoint, you can change the VCN and subnet that the private access channel uses to access the private data sources.

Refer to the Oracle Cloud Infrastructure REST API Reference for information about how to use this operation:

Edit a Private Access Channel using the Command Line

You can use the analytics-instance update-private-access-channel command to edit a private access channel that you configured for an Oracle Analytics Cloud instance.

You can manage the DNS zones accessible through the private access channel and, if your Oracle Analytics Cloud has a public endpoint, you can change the VCN and subnet that the private access channel uses to access the private data sources.

Refer to the Oracle Cloud Infrastructure CLI Command Reference for information about how to use this command:

Delete a Private Access Channel

You can delete a private access channel using the Console, API, or command line.

Note

Required IAM Policy

Verb: manage

Resource Type: analytics-instance, analytics-instances

Custom Permission: ANALYTICS_INSTANCE_MANAGE

See About Permissions to Manage Oracle Analytics Cloud Instances.

Verb: manage

Resource Type: virtual-network-family

Verb: read

Resource Type: compartment, compartments

To learn about other, more detailed access policy options, see Prerequisites for a Private Access Channel.

Delete a Private Access Channel using the Console

You can delete a private access channel that you configured for Oracle Analytics Cloud but don't need anymore.

  1. In Console, click Navigation menuin the top left corner.
  2. Under Solutions and Platform, select Analytics, then Analytics Cloud.
  3. Select the compartment that contains the Oracle Analytics Cloud instance you're looking for.
  4. Click the name of the instance you want to edit.
  5. On the Instance Details page, navigate to the Resources section, and click Private Access Channel.
  6. Click the name of the private access channel you want to delete.
  7. Click the Delete button, and then click Delete again to confirm.

    On the Analytics Instances page, the status changes to Active when the deletion is complete. Some users might experience a temporary disruption in service during the configuration process.

Delete a Private Access Channel using the REST API

You can use the DeletePrivateAccessChannel operation to delete a private access channel for an Oracle Analytics Cloud instance.

Refer to the Oracle Cloud Infrastructure REST API Reference for information about how to use this operation:

Delete a Private Access Channel using the Command Line

You can use the analytics-instance delete-private-access-channel command to delete a private access channel for an Oracle Analytics Cloud instance.

Refer to the Oracle Cloud Infrastructure CLI Command Reference for information about how to use this command:

Connect to a Database Deployed on Oracle Cloud Infrastructure with a Public IP Address

Configure Oracle Analytics Cloud to connect to a database deployed on Oracle Cloud Infrastructure with a public IP address, so that end users can analyze that data in visualizations, analyses, and pixel-perfect reports.

Typical Workflow to Connect to a Database Deployed on Oracle Cloud Infrastructure

If you’re connecting to an database deployment on Oracle Cloud Infrastructure for the first time, follow these tasks as a guide.

Task Description More Information

Verify the prerequisites

Verify that your environment satisfies the prerequisites required for this configuration.

Prerequisites

Record database information

Record connection information for database.

Record Database Information

Enable database access

Add an ingress rule to give Oracle Analytics Cloud access to the database.

Enable Database Access Through Port 1521

Connect to the database

Create and test your connections.

Connect to Your Database from Oracle Analytics Cloud

Prerequisites

Before you start, make sure you have the required environment.

Step Description Important Information to Note

Set up Oracle Analytics Cloud

Deploy Oracle Analytics Cloud.

Region

Availability Domain

Set up a Virtual Cloud Network (VCN) on Oracle Cloud Infrastructure

Set up a VCN for the database deployment on Oracle Cloud Infrastructure.

Note: The VCN must be in the same Region and Availability Domain as Oracle Analytics Cloud.

Virtual Cloud Network

Subnet

Same:

  • Region

  • Availability Domain

Deploy a database:

  • Deploy the database on the VCN in Oracle Cloud Infrastructure

  • Populate the database with data

  • Set up a database user with permissions to read database tables

Deploy a database on the VCN in Oracle Cloud Infrastructure.

Note: The database must be in the same Region and Availability Domain as the VCN.

Public IP

Database Unique Name

Host Domain Name

Database User/Password

Same:

  • Region

  • Availability Domain

  • Virtual Cloud Network

  • Client Subnet

Record Database Information

All the information you need to connect to a database is available in the Oracle Cloud Infrastructure Console. Record the information now, so you have the required details when you set up the connection in Oracle Analytics Cloud.

  1. In Oracle Cloud Infrastructure Console, click the navigation icon Hamburger icon for toggling navigation options.
  2. Under Database, click Bare Metal, VM, and Exadata, and then click DB Systems.
  3. Locate the database you want to connect to and record the Public IP address.
    Description of uc1_databases.jpg follows

  4. Click the name of the database you want to connect to and write down the values in these fields: Database Unique Name, Host Domain Name, Virtual Cloud Network, Client Subnet, and Port.
    Description of uc1_database.jpg follows

  5. Find out the user name and password of a database user with permissions to read from this database, and write them down as you need these later. For example, the user SYSTEM.

Enable Database Access Through Port 1521

Add an ingress rule that enables Oracle Analytics Cloud to access the database through port 1521.

  1. Make a note of the Oracle Analytics Cloud IP addresses that you want to allow access to.
  2. In the Oracle Cloud Infrastructure home page, click the navigation icon Hamburger icon for toggling navigation options, then under Databases, click Bare Metal, VM, and Exadata, and then DB Systems.
  3. Click the database that you want to connect to.
  4. Click the Virtual Cloud Network link.
    Description of uc1_database_vcn.jpg follows

  5. Navigate to the appropriate subnet, and under Security Lists, click Default Security List For <VCN>.
    Description of uc1_vnc.jpg follows

  6. Click Add Ingress Rules.
    Description of uc1_securitylist.jpg follows

  7. For each IP address that you want to give access to, add an ingress rule to allow any incoming traffic from the public internet to reach port 1521 on this database node, with the following settings:
    • SOURCE CIDR: Enter the IP address that you wrote down in Step 1.

    • IP PROTOCOL: TCP

    • SOURCE PORT RANGE: All

    • DESTINATION PORT RANGE: 1521

    • Allows: TCP traffic for ports: 1521


    Description of uc1_ingressrules.jpg follows

Connect to Your Database from Oracle Analytics Cloud

After enabling access to the database, use the database connection information you wrote down earlier to connect Oracle Analytics Cloud to the database. The way you connect to the database depends on what you want to do with the data.

  • Visualize the data.

  • Model the data using Data Modeler, then generate analyses and dashboards.

  • Model the data with Oracle Analytics Cloud Developer Client Tool, then generate analyses and dashboards.

  • Publish the data in pixel-perfect reports.

Connect to Your Database for Data Visualization
In Oracle Analytics Cloud, create an Oracle Database connection for data visualizations in the usual way. See Create Database Connections.

Description of uc1_conns.png follows

Use the database details you recorded earlier to fill in the Create Connection dialog.

Description of uc1_cconnection.png follows

Specify these values:
  • New Connection Name: A name for the database you want to connect to.

  • Host: The Public IP address for the database instance. For example, 123.213.85.123.

  • Port: The port number that enables access to the database. For example, 1521.

  • Username: The name of a user with read access to the database.

  • Password: The password for the specified database user.

  • Service Name: A concatenated name comprising Database Unique Name and Host Domain Name, separated with a period. For example, CustDB_iad1vm.sub05031027070.customervcnwith.oraclevcn.com.

Connect to Your Database for Data Modeler
In Oracle Analytics Cloud Console, create a connection in the usual way. See Connect to Data in an Oracle Cloud Database.
Use the database details you recorded earlier to fill in the Create Connection dialog.

Description of uc1_console1.jpg follows

Specify these values:
  • Name and Description: A name for the database you want to connect to.

  • Connect using: Select Host, Port, and Service Name.

  • Host: The Public IP address for the database. For example, 123.213.85.123.

  • Port: The port number that enables access to the database. For example, 1521.

  • Service Name: A concatenated name comprising Database Unique Name and Host Domain Name, separated with a period. For example, CustDB_iad1vm.sub05031027070.customervcnwith.oraclevcn.com.

  • Connect as: The name of a user with read access to the database.

  • Password: The password for the specified database user.

Connect to Your Database in Oracle Analytics Cloud Developer Client Tool
In Oracle Analytics Cloud Developer Client tool, click File, then Open, then In the Cloud to open your data model. See Edit a Data Model in the Cloud.
When you sign in, use connection information for your Oracle Analytics Cloud to fill in the Open in the Cloud dialog.
Create a connection pool for your database. In the Physical pane, expand the DBaaS node, right-click the database icon, and click Properties to display the Connection Pool dialog. Use the database details you recorded earlier to specify Call Interface, Data Source Name, User Name, and Password.


Description of connpool-gif.bmp follows

Specify these values:
  • Call interface: Select Default (Oracle Call Interface (OCI)).

  • Data Source Name: Specify the connection details. For example:

    (DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=129.213.85.177)(PORT=1521)))(CONNECT_DATA=(SERVICE_NAME=CustDB_iad1vm.sub05031027070.customervcnwith.oraclevcn.com))

    For SERVICE_NAME, specify the concatenated Database Unique Name and Host Domain Name separated by a period, for example, db1_phx1tv.mycompany.com. To find both these names in Oracle Cloud Infrastructure Console, click Databases, Bare Metal, VM, and Exadata, DB Systems, and then click the name of your database.

Connect to Oracle Autonomous Data Warehouse with a Public IP Address

Configure Oracle Analytics Cloud to connect to Autonomous Data Warehouse over a public IP address so that end users can analyze that data in visualizations, analyses, dashboards, and pixel-perfect reports.

Typical Workflow to Connect to Oracle Autonomous Data Warehouse with a Public IP Address

If you’re connecting Oracle Analytics Cloud to Autonomous Data Warehouse over a public IP address for the first time, follow these tasks as a guide.

Task Description More Information

Verify the prerequisites

Verify that your environment satisfies the prerequisites required for this configuration.

Prerequisites

Enable access to Autonomous Data Warehouse

Upload your Autonomous Data Warehouse Client Credentials file (wallet file) to Oracle Analytics Cloud.

Enable Access to Oracle Autonomous Data Warehouse

Connect to Autonomous Data Warehouse

Create and test your connections.

Connect to Oracle Autonomous Data Warehouse

Prerequisites

Before you start, make sure you have the required environment.

Step Description Important Information to Note

Set up Oracle Analytics Cloud

Deploy Oracle Analytics Cloud.

Region

Availability Domain

Set up Oracle Autonomous Data Warehouse

Deploy Autonomous Data Warehouse.

  • Deploy Autonomous Data Warehouse on Oracle Cloud Infrastructure.

  • Populate Autonomous Data Warehouse with data.

  • Set up a database user with permissions to read database tables on Autonomous Data Warehouse

Host Name

Port Number

Service Name

(Obtain these details from tnsnames.ora in the Autonomous Data Warehouse Client Credentials file.)

Enable Access to Oracle Autonomous Data Warehouse

To enable secure communication between Oracle Analytics Cloud and Autonomous Data Warehouse, you upload trusted SSL certificates to Oracle Analytics Cloud.

  1. In Autonomous Data Warehouse Console, obtain the Client Credentials file.
    The Client Credentials file is a ZIP file containing the files cwallet.sso and tnsnames.ora. See Download Client Credentials (Wallets) in Using Oracle Autonomous Data Warehouse.
  2. Extract the cwallet.sso file from the Client Credentials file.
  3. Upload the cwallet.sso file to Oracle Analytics Cloud.
    1. Sign in to Oracle Analytics Cloud, open the Console and click Connections.
    2. Click Upload Wallet to upload a wallet for the first time or Replace Wallet to update an existing wallet.
    3. Click Browse and locate the wallet file (cwallet.sso) you downloaded from Autonomous Data Warehouse.
    4. Select the file and click Open.
    5. Click Update and OK to update the existing wallet file.

Connect to Oracle Autonomous Data Warehouse

After enabling access to Oracle Autonomous Data Warehouse, use the connection details you recorded earlier to connect Oracle Analytics Cloud to Autonomous Data Warehouse. The way you connect depends on what you want to do with the data.

  • Visualize the data

  • Model the data using Data Modeler, then generate analyses and dashboards.

  • Model the data with Oracle Analytics Cloud Developer Client Tool, then generate analyses and dashboards.

  • Publish the data in pixel-perfect reports.

Connect to Autonomous Data Warehouse for Data Visualization
In Oracle Analytics Cloud, create an Autonomous Data Warehouse connection for data visualization. See Create Connections to Oracle Autonomous Data Warehouse.

Description of uc6_connectionadwc-gif.gif follows

Now create a new project and data set to visualize data from your Autonomous Data Warehouse.
Connect to Autonomous Data Warehouse for Data Modeler
In Oracle Analytics Cloud Console, create a connection in the usual way. See Connect to Data in an Oracle Cloud Database.
Use the database details you recorded earlier to fill in the Create Connection dialog.

Description of uc6_conn_console-gif.jpg follows

Specify these values:
  • Name and Description: A short name and description to identify this connection in Oracle Analytics Cloud.

  • Connect Using: Select Host, Port, and Service Name.

  • Host: The host name of the Autonomous Data Warehouse instance that you obtained from the downloaded tnsnames.ora file. For example, adwc.example.oraclecloud.com.

  • Port: The port number that you obtained from the downloaded tnsnames.ora file. For example, 1522.

  • Service Name: The service name that you obtained from the downloaded tnsnames.ora file. For example, adwc1_high.adwc.oraclecloud.com.

  • Connect as: The name of a user with read access to Autonomous Data Warehouse. For example, ADMIN.

  • Password: The password for the specified database user.

  • Enable SSL: Select this option.

In Data Modeler, you can now model data from your Autonomous Data Warehouse using this connection.
Connect to Autonomous Data Warehouse in Oracle Analytics Cloud Developer Client Tool
You can use Oracle Analytics Cloud Client Tool to edit a data model connected to Autonomous Data Warehouse.
  1. On the machine where you installed Oracle Analytics Cloud Developer Client Tool, copy the cwallet.sso, sqlnet.ora, and tnsnames.ora from the zip file that you downloaded from Autonomous Data Warehouse to the folder:
    <Developer Client Tool installation folder>\domains\bi\config\fmwconfig\bienv\core
    Description of uc6_admintool-gif.gif follows
  2. Edit sqlnet.ora so that the wallet location points to:
    <Developer Client Tool installation folder>\domains\bi\config\fmwconfig\bienv\core
    For example:
    WALLET_LOCATION = (SOURCE = (METHOD = file) (METHOD_DATA = (DIRECTORY="C:\ade\admintoolOAC18.2.1\domains\bi\config\fmwconfig\bienv\core"))) SSL_SERVER_DN_MATCH=yes
  3. In Oracle Analytics Cloud Developer Client tool, click File, then Open, then In the Cloud to open your data model. See Edit a Data Model in the Cloud.
    When you log in, use the connection information for your Oracle Analytics Cloud instance to fill in the Open in the Cloud dialog.
    • For Port, specify 443.

    • For Host name, specify the host domain name of your Oracle Analytics Cloud instance.

    • Select SSL. For Trust Store and Password, point to a local JDK/JRE cacerts keystore that trusts certificates signed by well-known CAs.

  4. Connect to Autonomous Data Warehouse.
    1. Click File, then Import Metadata to start the Import Metadata wizard, and follow the on-screen instructions.Description of uc6_imp_md-gif.gif follows
    2. On the Select Data Source page, for the Data Source Name value, specify a long TNS connection string from the downloaded tnsnames.ora file. Include the entire description, enclosed in brackets.

      For example:

      (description=(address=(protocol=tcps)(port=1522)(host=adwc.example.oraclecloud.com))(connect_data=(service_name=adwc1_high.adwc.oraclecloud.com))(security=(ssl_server_cert_dn="CN=adwc.example.oraclecloud.com,OU=Oracle BMCS US,O=Oracle Corporation,L=Redwood City,ST=California,C=US")) )

    3. For User Name and Password, enter the credentials for the ADMIN user or another suitable Autonomous Data Warehouse user.
You’re now ready to model the data in Oracle Analytics Cloud Developer Client Tool, publish the data model to Oracle Analytics Cloud, and create analyses and data visualizations using data from Autonomous Data Warehouse.

Connect to a Database Deployed on Oracle Cloud Infrastructure Classic with a Public IP Address

Configure Oracle Analytics Cloud to connect to Oracle Database Classic Cloud Service deployed on Oracle Cloud Infrastructure Classic so that end users can analyze that data in visualizations, analyses, and pixel-perfect reports.

Typical Workflow to Connect to a Database Deployed on Oracle Cloud Infrastructure Classic

If you’re connecting Oracle Analytics Cloud to a database deployed on Oracle Cloud Infrastructure Classic for the first time, follow these tasks as a guide.

Task Description More Information

Verify the prerequisites

Verify that your environment satisfies the prerequisites required for this configuration.

Prerequisites

Record database information

Record connection information for Oracle Database Classic Cloud Service.

Record Database Information

Enable database access

Add access rules to enable Oracle Analytics Cloud access to the database.

Enable Database Access Through Port 1521

Connect to the database

Create and test your connections.

Connect to Your Database from Oracle Analytics Cloud

Prerequisites

Before you start, make sure you have the required environment.

Step Description Note Important Information

Set up Oracle Analytics Cloud

Deploy Oracle Analytics Cloud.

Region

Availability Domain

Deploy Oracle Database Classic Cloud Service

  • Deploy Oracle Database Classic Cloud Service on the Virtual Cloud Network in Oracle Cloud Infrastructure Classic.

  • Populate Oracle Database Classic Cloud Service with data.
  • Set up a database user with permissions to read database tables.

Deploy Oracle Database Classic Cloud Service on the Virtual Cloud Network in Oracle Cloud Infrastructure Classic.

Public IP

Service Name

Host Domain Name

Database User/Password

Same:

  • Region

Record Database Information

All the information you need to connect to Oracle Database Classic Cloud Service is available in Oracle Cloud Infrastructure Console. Record the information now, so you have the required details when you set up the connection in Oracle Analytics Cloud.

  1. In Oracle Cloud Infrastructure Console, click Navigation menu icon in the top left corner.
  2. Under More Oracle Cloud Services, go to Classic Data Management Services, and click Database Classic.
  3. Click the name of the database you want to connect to and from the Instance Overview section, record the Service Name from the Connect String. For example, ucmdb906:1521/PDB1.504988564.oraclecloud.internal.
  4. Extract and record the Service Name of the database from the connect string value. For example, PDB1.504988564.oraclecloud.internal.
  5. Record the IP address of the database displayed in the Resources section.
  6. Find out the user name and password of a database user with permissions to read from this database, and write them down.  For example, the user SYSTEM.

Enable Database Access Through Port 1521

Add an access rule that enables Oracle Analytics Cloud to access the database through port 1521.

  1. In Oracle Cloud Infrastructure Console, click Navigation menu icon in the top left corner.
  2. Under More Oracle Cloud Services, go to Classic Data Management Services, and click Database Classic.
  3. Select the database you want to connect to.
  4. Click the Manage service icon and select Access Rules.
  5. For port 1521, click Actions and select Enable to enable the port for the default Oracle listener.
    Description of enable1521.png follows

Connect to Your Database from Oracle Analytics Cloud

After enabling access to the database, use the database connection information you recorded earlier to connect Oracle Analytics Cloud to the database deployed in Oracle Cloud Infrastructure Classic. The way you connect to the database depends on what you want to do with the data.

  • Visualize the data.

  • Model the data using Data Modeler, then generate analyses and dashboards.

  • Model the data with Oracle Analytics Cloud Developer Client Tool, then generate analyses and dashboards.

Connect to Your Database for Data Visualization
In Oracle Analytics Cloud, create an Oracle Database connection for data visualizations in the usual way. See Create Database Connections.

Description of classicdb1.png follows

Use the database details you recorded earlier to fill in the Create Connection dialog.

Description of classicdb2.png follows

Specify these values:
  • Connection Name: The name of the Oracle Database Classic Cloud Service you want to connect to.

  • Host: The Public IP address for Oracle Database Classic Cloud Service. For example, 123.213.85.123.

  • Port: The port number that enables access to Oracle Database Classic Cloud Service. For example, 1521.

  • Username: The name of a user with read access to Oracle Database Classic Cloud Service.

  • Password: The password for the specified database user.

  • Service Name: The service name on the Database Classic page. For example, PDB1.123456789.oraclecloud.internal.

Connect to Your Database for Data Modeler
In Oracle Analytics Cloud Console, create a connection in the usual way. See Connect to Data in an Oracle Cloud Database.
Use the database details you recorded earlier to fill in the Create Connection dialog.

Description of classicdb3.png follows

Specify these values:
  • Name and Description: The name of the Oracle Database Classic Cloud Service you want to connect to.

  • Connect Using: Select Host, Port, and Service Name.

  • Host: The Public IP address for Oracle Database Classic Cloud Service. For example, 123.213.85.123.

  • Port: The port number that enables access to Oracle Database Classic Cloud Service. For example, 1521.

  • Service Name: The service name from the Database Classic page. For example, PDB1.123456789.oraclecloud.internal.

  • Connect as: The name of a user with read access to Oracle Database Classic Cloud Service.

  • Password: The password for the specified database user.

Connect to Your Database in Oracle Analytics Cloud Developer Client Tool
In Oracle Analytics Cloud Developer Client tool, click File, Open, and then In the Cloud to open your data model in the usual way. See Edit a Data Model in the Cloud.
When you sign in, use connection information for your Oracle Analytics Cloud to fill in the Open in the Cloud dialog.
Create a connection pool for your database. In the Physical pane, expand the database node, right-click the database icon, and click Properties to display the Connection Pool dialog. Use the database details you recorded earlier to specify Call Interface, Data Source Name, User Name, and Password.


Description of connpool-gif.bmp follows

Specify these values:
  • Call interface: Select Default (Oracle Call Interface (OCI).

  • Data Source Name: Specify the connection details. For example:

    (DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=123.213.85.123)(PORT=1521)))(CONNECT_DATA=(SERVICE_NAME=PDB1.587075508.oraclecloud.internal))

    For SERVICE_NAME, use the Database Classic page to locate the service name. For example, PDB1.587075508.oraclecloud.internal.

You’re now ready to model the data in Oracle Analytics Cloud Developer Client Tool, publish the data model to Oracle Analytics Cloud, and create analyses and data visualizations using data from Oracle Database Classic Cloud Service.

Federate with Oracle Identity Cloud Service Manually

In most cases, Oracle Analytics Cloud is automatically federated with the primary Oracle Identity Cloud Service instance associated with your tenancy. If you want to federate Oracle Analytics Cloud with a secondary Oracle Identity Cloud Service instance or your tenancy is a government region where federation isn't set up automatically, you must federate with Oracle Identity Cloud Service manually.

The way you do this depends whether your Oracle Identity Cloud Service includes the COMPUTEBAREMETAL application. If a COMPUTEBAREMETAL application doesn’t exist in your tenancy, you must perform some additional steps to set up a trusted application that you can use.

Once set up, select the new Oracle Identity Cloud Service provider before you sign-in to Oracle Cloud and then create your Oracle Analytics Cloud instance. The new Oracle Analytics Cloud instance will use the federated Oracle Identity Cloud Service that you're signed-in with. You can't reconfigure Oracle Analytics Cloud to use a different Oracle Identity Cloud Service later on.

  1. Sign-in to your Oracle Identity Cloud Service console with administrator privileges.
  2. In the Oracle Identity Cloud Service console, click Applications.
  3. Determine whether the COMPUTEBAREMETAL application is available.
    • COMPUTEBAREMETAL application in the list

      1. Open the application, and click the Configuration tab.
      2. Expand General Information and make a note of the Client ID.
      3. Click Show Secret to display and then copy the Client Secret.
      4. Skip Step 4 and go to Step 5.
    • No COMPUTEBAREMETAL application in the list

      Continue with Step 4 to set up a trusted application.

  4. Set up a trusted application.
    1. In the Applications tab, click Add Application.
    2. Click Confidential Application.
    3. Enter a suitable Name (for example, OCI_Federation) and Description (for example, Confidential application to enable federation with OCI), and then click Next.
    4. In Allowed Grant Types, select Resource Owner, Client Credentials, and JWT Assertion.
    5. In the App Roles table, add the role Security Administrator.
    6. Click Next, and then click Finish.
    7. When the Application Added dialog is displayed, make a note of the Client ID and Client Secret.
    8. Click Activate and then OK to confirm that you want to activate the application.
  5. Create a group named OCI_Administrators.
    1. Click the Groups tab.
    2. Create a group called OCI_Administrators, and add one or more users to the group.
  6. Federate your Oracle Identity Cloud Service in Oracle Cloud Infrastructure.
    1. Sign-in to your Oracle Cloud Infrastructure Console.
    2. Under Governance and Administration, click Identity, then Federation.
    3. Click Add identity provider.
    4. Enter details about the Oracle Identity Cloud Service instance you want to use.

      Enter a Name (for example, MyOracleIdentityCloudProvider), Description, and for Type select Oracle Identity Cloud Service.

      Enter the Base URL for the Oracle Identity Cloud Service instance you want to use (primary or secondary), and then enter the Client ID and Client Secret values that you recorded earlier.

    5. Click Continue.
    6. Map the Oracle Identity Cloud Service group you created in Step 5 (OCI_Administrators) to the Administrators group in Oracle Cloud Infrastructure.
    7. Click Add Provider.

    The identity provider is displayed with the status Active.

  7. Sign out of your tenancy.

    The Sign In page displays the new federated identity provider. For example myoracleidentitycloudprovider.

    Oracle Identity Cloud Service users who sign in through the federated identity provider inherit permissions based on their Oracle Identity Cloud Service to Oracle Cloud Infrastructure group mappings. This means that users who belong to the Oracle Identity Cloud Service group OCI_Administrators have all the permissions granted to the Oracle Cloud Infrastructure group Administrators.

  8. In the Sign-in page, select the new federated identity provider, click Continue, and sign in.
    Any new Oracle Analytics Cloud instances that you create will use the federated Oracle Identity Cloud Service you signed-in with.

Set Up a Custom Vanity URL

About Vanity URLs

A vanity URL is a unique, customized web address that's branded for marketing purposes and helps users remember and find your web site. If you want to customize the user login experience for Oracle Analytics Cloud, you can use your own vanity URL instead of the default URL that Oracle provides.

These examples show the standard URL for Oracle Analytics Cloud and a sample vanity URL that you might use instead:

  • Standard URL: https://example-mytenancy.analytics.ocp.oraclecloud.com/ui

  • Vanity URL: https://mycoolanalytics.com/ui

Example of a default URL and a vanity URL

Typical Workflow to Set Up a Vanity URL

If you want to set up a vanity URL for an Oracle Analytics Cloud instance for the first time, follow these tasks as a guide.

Task Description More Information
Understand prerequisites for a vanity URL

Obtain the custom domain name and the required security certificates before you start.

Prerequisites for a Vanity URL

Deploy Oracle Analytics Cloud

Deploy Oracle Analytics Cloud with a public or private endpoint.

Create a Service

Configure a vanity URL

Use Oracle Cloud Infrastructure Console to configure a vanity URL.

Configure a Vanity URL

Update security certificates for the vanity domain

If the security certificate, private key file, or certificate chain associated with your vanity domain expires or changes you can upload new details.

Update Certificates for a Vanity URL

Delete a vanity URL

Delete a vanity URL that you configured for Oracle Analytics Cloud but don't need anymore.

Delete a Vanity URL

Prerequisites for a Vanity URL

Before you configure a vanity URL for an Oracle Analytics Cloud instance you need to know the custom domain name and valid certificate for the domain.

  1. Obtain the custom domain name you want to use from a web service provider or use the domain name of your company.
  2. Add a DNS entry that maps your custom domain name to the IP address of your Oracle Analytics Cloud instance.
  3. Obtain a public digital X.509 certificate (.pem) for your vanity domain name from a Certificate Authority.
  4. Obtain a private key file (.pem) that matches the certificate’s public key.
  5. Obtain a certificate chain for multiple certificates (.pem).

Configure a Vanity URL

You can configure a vanity URL using the Console, API, or command line.

Note

Required IAM Policy

Verb: manage

Resource Type: analytics-instance, analytics-instances

Custom Permission: ANALYTICS_INSTANCE_MANAGE

See About Permissions to Manage Oracle Analytics Cloud Instances.

Configure a Vanity URL using the Console

You can use Oracle Cloud Infrastructure Console to configure a vanity URL for your Oracle Analytics Cloud instance.

  1. In Console, click Navigation menuin the top left corner.
  2. Under Solutions and Platform, select Analytics, then Analytics Cloud.
  3. Select the compartment that contains the Oracle Analytics Cloud instance you're looking for.
  4. Click the name of the instance you want to configure a vanity URL for.
  5. On the Instance Details page, click Create Vanity URL.
    Create vanity URL
  6. For Hostname, enter the fully qualified, custom domain name that you want to appear in the URL.

    For example, enter mycoolanalytics.com.

    A preview of the HTTPS URL is displayed. For example: https://mycoolanalytics.com/ui/

  7. Specify the digital X.509 (public key) certificate for your vanity domain.
    • Upload a valid certificate file in PEM format (.pem .cer .cn).
    • Paste the valid X.509 certificate text.
  8. Enter the private key for this certificate.
    • Upload the private key file (.pem).
    • Paste the private key text.
  9. Optional: In Private Key Passphrase, enter the password for the private key.
  10. Optional: If your certificate requires a certificate authority chain:
    1. Select Custom Certificate Authority Chain.
    2. Enter the authority chain.
      • Upload the certificate authority chain file (.pem .cer .cn).
      • Paste the authority chain text.
  11. Click Create.
    You'll know when the vanity URL is ready to use because the URL becomes a live link in the Access Information section.

    Shows vanity URL link

  12. Click the link or enter the vanity URL in a browser to test you can access Oracle Analytics Cloud.
Configure a Vanity URL using the REST API

You can use the CreateVanityUrl operation to set up a vanity URL for an Oracle Analytics Cloud instance.

Refer to the Oracle Cloud Infrastructure REST API Reference for information about how to use this operation:

Configure a Vanity URL using the Command Line

You can use the analytics-instance create-vanity-url command to set up a vanity URL for an Oracle Analytics Cloud instance.

Refer to the Oracle Cloud Infrastructure CLI Command Reference for information about how to use this command:

Update Certificates for a Vanity URL

You can update the security certificates associated with your vanity URL using the Console, API, or command line.

Note

Required IAM Policy

Verb: manage

Resource Type: analytics-instance, analytics-instances

Custom Permission: ANALYTICS_INSTANCE_MANAGE

See About Permissions to Manage Oracle Analytics Cloud Instances.

Update Certificates for a Vanity URL using the Console

If the security certificate, private key file, or certificate chain associated with your vanity domain expires or changes you can upload new details using the Console.

  1. In Console, click Navigation menuin the top left corner.
  2. Under Solutions and Platform, select Analytics, then Analytics Cloud.
  3. Select the compartment that contains the Oracle Analytics Cloud instance you're looking for.
  4. Click the name of the instance you want to configure a vanity URL for.
  5. On the Instance Details page, click More Actions and then select Update Vanity URL Certificate.
  6. Update the digital X.509 (public key) certificate for your vanity domain.
    • Upload a valid certificate file in PEM format (.pem .cer .crt).
    • Paste the valid X.509 certificate text.
  7. Update the private key for this certificate.
    • Upload the private key file (.pem .key).
    • Paste the private key text.
  8. Optional: In Private Key Passphrase, enter the password for the private key.
  9. Optional: If your certificate requires a new certificate authority chain:
    1. Select Custom Certificate Authority Chain.
    2. Update the authority chain.
      • Upload the certificate authority chain file (.pem .cer .crt).
      • Paste the authority chain text.
  10. Click Update.
  11. Wait a few moments for the update to complete and then click the vanity URL link that displays in the Access Information section to verify you can access Oracle Analytics Cloud.
Update Certificates for a Vanity URL using the REST API

You can use the UpdateVanityUrl operation to update security certificates for the vanity URL that you configured for an Oracle Analytics Cloud instance.

Refer to the Oracle Cloud Infrastructure REST API Reference for information about how to use this operation:

Update Certificates for a Vanity URL using the Command Line

You can use the analytics-instance update-vanity-url command to update security certificates for the vanity URL that you configured for an Oracle Analytics Cloud instance.

Refer to the Oracle Cloud Infrastructure CLI Command Reference for information about how to use this command:

Delete a Vanity URL

You can delete a vanity URL using the Console, API, or command line.

Note

Required IAM Policy

Verb: manage

Resource Type: analytics-instance, analytics-instances

Custom Permission: ANALYTICS_INSTANCE_MANAGE

See About Permissions to Manage Oracle Analytics Cloud Instances.

Delete a Vanity URL using the Console

You can delete a vanity URL that you configured for Oracle Analytics Cloud but don't need anymore.

  1. In Console, click Navigation menuin the top left corner.
  2. Under Solutions and Platform, select Analytics, then Analytics Cloud.
  3. Select the compartment that contains the Oracle Analytics Cloud instance you're looking for.
  4. Click the name of the instance you want to edit.
  5. On the Instance Details page, click More Actions and then select Remove Vanity URL.
  6. Click Remove to confirm.
Delete a Vanity URL using the REST API

You can use the DeleteVanityUrl operation to delete the vanity URL configured for an Oracle Analytics Cloud instance.

Refer to the Oracle Cloud Infrastructure REST API Reference for information about how to use this operation:

Delete a Vanity URL using the Command Line

You can use the analytics-instance delete-vanity-url command to delete the vanity URL configured for an Oracle Analytics Cloud instance.

Refer to the Oracle Cloud Infrastructure CLI Command Reference for information about how to use this command:

Query Data Models Remotely Using JDBC

Overview to Querying Oracle Analytics Cloud Data Models Remotely

Java Data Base Connectivity (JDBC) is an industry standard API for accessing data sources. Use JDBC-compliant client tools to access data models defined in Oracle Analytics Cloud so that you can take advantage of its analytics engine and data abstraction features.

This feature requires Oracle Analytics Cloud 5.6 or later. Before you start, verify that the Oracle Analytics Cloud instance you're connecting to is version 5.6 or later. If you're not sure, contact your Oracle representative.

JDBC uses OAuth to secure access to Oracle Analytics Cloud. OAuth 2.0 is an authorization framework that enables an application to obtain limited access to a protected HTTP resource. Using OAuth, the applications are called clients; they access protected resources by presenting an access token to the HTTP resource.

To learn more about how Oracle Cloud services use OAuth, see Introduction to OAuth in Oracle Cloud.

Typical Workflow to Query Oracle Analytics Cloud Data Models Remotely

If you’re querying Oracle Analytics Cloud data models remotely for the first time, follow these tasks as a guide.

Task Description More Information
Decide how you want to secure your JDBC connection Depending on your security requirements, choose either Resource Owner (recommended) or JSON Web Tokens (JWT) as the assertion type. Choosing an Assertion Type for Your JDBC Connection

Register the BIJDBC application

Register the BIJDBC application in Oracle Identity Cloud Service to authenticate your JDBC connection.

(Recommended) Use Resource Owner assertion, see Register the BIJDBC Application Using Resource Owner Assertion.

Alternatively, use JWT assertion:

Enable refresh security token generation

Set up refresh security token generation in Oracle Identity Cloud Service.

Set Up Refresh Security Token Generation

Download the JDBC driver

Download the JDBC driver for Oracle Analytics Cloud.

Download the JDBC Driver

Connect to Oracle Analytics Cloud

Connect to Oracle Analytics Cloud remotely using JDBC.

Refer to the example as a guide, see Example: Connect to a Data Model Remotely Using SQuirrel.

Connect to Oracle Analytics Cloud Using a JDBC URL

Choosing an Assertion Type for Your JDBC Connection

When you register a BIJDBC application in Oracle Identity Cloud Service , you specify an assertion type that best secures your connection.

Here's some guidance on choosing an assertion type using the Allowed Grant Types option on the Add Confidential Application dialog.

Assertion Type Use this option when: Considerations

(Recommended) Resource Owner

Your application has access to the user name and password of the end user connecting to Oracle Analytics Cloud.

You want to create a 'gateway' connection to query data from the BI Server. Gateway accounts always use one single user name and password.

We recommend using this assertion type. It's simpler to configure.

JWT

You don't have the password and you need to connect to Oracle Analytics Cloud as different users.

This assertion type is more complex to configure. It also allows you to impersonate any BI user in the system, therefore you must ensure that the keys you generate are secured appropriately.

Register the BIJDBC Application Using Resource Owner Assertion

You register the BIJDBC application in Oracle Identity Cloud Service using Resource Owner assertion to authenticate your public JDBC connections.

  1. Sign-in to Oracle Identity Cloud Service as an administrator.
  2. Navigate to the Applications tab and click Add.
  3. In the Add Application dialog, click Confidential Application.
  4. Specify a Name (for example, bi-jdbc-connection) , a Description, and then click Next.
  5. Select Configure this application as a client now.
  6. In Allowed Grant Types, click Resource Owner.
    Register BIJDBC application in IDCS
  7. In the Token Issuance Policy section:
    1. Under Authorized Resources, select Specific.
    2. Click Add Scope.
    3. Select the Oracle Analytics Cloud instance you want to connect to (for example, select AUTOANALYTICSINST_<my_instance_ID>).
    4. Click Add.
  8. Click Next and then Finish to display an Application Added window.
  9. Copy the Client ID and Client Secret to use later.
  10. Close the Application Added page.
  11. Click Activate, then click Activate Application.
  12. Click Save to display a confirmation message.

Generate the Client Private Key and Client Certificate File

If you decide to secure your JDBC connection using the JWT assertion type, you generate a private key and certificate to authenticate the connection.

Note: You don't need a private key and certificate file if you're securing your JDBC connection using the Resource Owner assertion type.
  1. Generate a key pair and key store.
    From a command prompt, issue a keytool command, using the command format:
    keytool -genkeypair -v -keystore <keystore name> -storetype <store type i.e PKCS12> -storepass <store pass> -keyalg <key algorithm> -keysize <key size> -sigalg <sig algorithm> -validity <validity days> -alias <alias name> -keypass <key pass>
    For example:
    keytool -genkeypair -v -keystore bijdbckeystore.jks -storetype PKCS12 -storepass password -keyalg RSA -keysize 2048 -sigalg SHA256withRSA -validity 3600 -alias bijdbcclientalias -keypass password
  2. Generate a public certificate.
    From a command prompt, issue a keytool command, using the command format:
    keytool -exportcert -v -alias <alias name> -keystore <keystore name> -storetype <store type, such as PKCS12> -storepass <store pass> -file <certificate file> -rfc
    For example:
    keytool -exportcert -v -alias bijdbcclientalias -keystore bijdbckeystore.jks -storetype PKCS12 -storepass password -file bijdbcclient.cert -rfc
  3. Use OpenSS to extract the private key, in PKCS8 format, from the keystore file.
    Use the command format:
    openssl pkcs12 -in <keystore file name> -passin pass:<keystore password> -nodes -nocerts -nomacver > <PKCS8 key file path>
    For example:
    openssl pkcs12 -in bijdbckeystore.jks -passin pass:password -nodes -nocerts -nomacver |sed -n '/BEGIN PRIVATE KEY/,$p' > bijdbcclient.pem
  4. Save the generated key and certificates in a location accessible to your client machine.

Register the BIJDBC Application using JWT Assertion

You register the BIJDBC application in Oracle Identity Cloud Service using JWT assertion to authenticate your public JDBC connections.

Before you start, generate a Client Private Key and Client Certificate File as specified in the previous step.
  1. Sign-in to Oracle Identity Cloud Service as an administrator.
  2. Navigate to the Applications tab and click Add.
  3. In the Add Application dialog, click Confidential Application.
  4. Specify a Name (for example, bi-jdbc-connection) , a Description, and then click Next.
  5. Select Configure this application as a client now.
  6. In Allowed Grant Types, click JWT Assertion.
  7. For Security:
    1. Select Trusted Client.
    2. Click Import , enter a Certificate Alias, and then upload your client certificate file.
    Add Confidential Application
  8. In the Token Issuance Policy section:
    1. Under Authorized Resources, select Specific.
    2. Click Add Scope.
    3. Select the Oracle Analytics Cloud instance you want to connect to (for example, select AUTOANALYTICSINST_<my_instance_ID>).
    4. Click Add.
  9. Click Next and then Finish to display an Application Added window.
  10. Copy the Client ID and Client Secret to use later.
  11. Close the Application Added page.
  12. Click Activate, then click Activate Application.
  13. Click Save to display a confirmation message.

Set Up Refresh Security Token Generation

Configure your BIJDBC application to refresh security tokens.

  1. In Oracle Identity Cloud Service, enable the Refresh Token option for the BIJDBC application that you created earlier.
    1. In Oracle Identity Cloud Service Console, navigate to Applications, and click the name of the BIJDBC application that you created earlier.
    2. Click Configuration, then Client Configuration.
    3. Select Refresh Token, and click Save.
      Refresh Token option highlighted
    If your Oracle Analytics Cloud instance was created after 12th May 2020, your BIJDBC application is now configured to refresh security tokens.
    If your Oracle Analytics Cloud instance was created before 12th May 2020, perform the additional steps 2 to 4.
  2. In Oracle Identity Cloud Service Console, navigate to the application associated with Oracle Analytics Cloud you want to connect to, and make a note of the following information:
    • Oracle Identity Cloud Service HostnameIDCS Host name

    • Application ID (IDCS application associated with Oracle Analytics Cloud)IDCS Application ID

    • Client ID and Client Secret (IDCS application associated with Oracle Analytics Cloud)Client ID and Client Secret

  3. Use the Oracle Identity Cloud Service REST API to generate the access token using client credentials.
    Use this REST API command format:
    curl --insecure -i -u '<Client-ID>:<Client-Secret>' -H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8" --request POST https://<IDCS-Host>/oauth2/v1/token -d "grant_type=client_credentials&scope=urn:opc:idm:__myscopes__"
    Parameters:
    • Client-ID: Client ID of the Oracle Identity Cloud Service application associated with your Oracle Analytics Cloud instance.

    • Client-Secret: Client secret for the Oracle Identity Cloud Service application associated with your Oracle Analytics Cloud instance.

    • IDCS-Host: Host name of your Oracle Identity Cloud Service instance.

  4. Use the Oracle Identity Cloud Service REST API to update the flag.
    Use this REST API command format:
    curl --location --request PATCH 'https://<IDCS-Host>/admin/v1/Apps/<Application-Id>' \ --header 'Authorization: Bearer <Access-token>' \ --header 'Content-Type: application/json' \ --data-raw '{ "schemas": [ "urn:ietf:params:scim:api:messages:2.0:PatchOp" ], "Operations": [{ "op": "replace", "path": "allowOffline", "value": true }] }'
    Parameters:
    • IDCS-Host: Host name of your Oracle Identity Cloud Service instance.

    • Application-Id: Application ID of the Oracle Identity Cloud Service application associated with your Oracle Analytics Cloud instance.

    • Access-token: Access token value you generated earlier.

Download the JDBC Driver

Obtain the JDBC driver JAR file (bijdbc-all.jar) from an Oracle Analytics Cloud Client Tools installation on a Windows machine.

If you don't already have an installed version of Oracle Analytics Cloud Client Tools that matches your Oracle Analytics Cloud version, then download and install it first on a Windows machine. To connect to Oracle Analytics from an iOS machine, copy the JDBC driver file from the Windows installation folder to your iOS machine.
  1. Download the Analytics Client Tools for Oracle Analytics.
    1. Navigate to: Download page for Analytics Client Tools for Oracle Analytics Cloud.
    2. To start the download, click the Oracle Analytics Client Tools link for the version that matches your Oracle Analytics version.
    3. Accept the Oracle license agreement if prompted, and click the download link to download the software to your local machine.
  2. Install Analytics Client Tools.
    1. From the downloaded ZIP file, extract the setup_bi_client-<version number>-win64.exe file.
    2. In the local download area, double-click the setup_bi_client-<version number>-win64.exe file to start the installer.
    3. Follow the on-screen instructions.
  3. From the installation folder, copy the JDBC driver file <OH>/bi/bifoundation/jdbc/bijdbc-all.jar.

    To connect to Oracle Analytics from an iOS machine, copy the bijdbc-all.jar file to your iOS machine.

Connect to Oracle Analytics Cloud Using a JDBC URL

Determine the JDBC URL required to connect to your Oracle Analytics Cloud instance and test the connection.

  1. In Oracle Identity Cloud Service Console, make a note of the following information:
    • Oracle Identity Cloud Service host name

      IDCS Host name
    • Client ID (BIJDBC application)

      Client ID
    • Client Scope (BIJDBC application)

      Client Scope
  2. Create a bijdbc.properties file for OAuth authentication and authorization and add credentials for your Oracle Analytics Cloud instance.
    To connect using Resource Owner assertion, use the following format for your bijdbc.properties file:
    idcsEndpointUrl=https://<IDCS_hostname> 
    idcsClientId=<ID string>
    idcsClientScope=<ID string> 
    idcsClientSecret=<secret>
    user=<firstname.lastname@example.com>
    password=<mypassword>

    For example:

    idcsEndpointUrl=https://idcs-1a2bc345678901d2e34fgh56789j0ke.identity.c9abc1.oc9def.com
    idcsClientId=12a000dc9ef345678000ghij2kl8a34   
    idcsClientScope=https://<host>.com:443urn:opc:resource:consumer::all
    idcsClientSecret=xyz
    user=myuser@office.com
    password=mypassword
    If you're using JWT assertion, omit the password= and idcsClientSecret= properties and add certificateFile= and privateKeyFile=. For example, add the following:
    certificateFile=D:\\jdbc\\bijdbcclient.cert 
    privateKeyFile=D:\\jdbc\\bijdbcclient.pem
  3. Determine the URL required to connect to your Oracle Analytics Cloud instance. The format you use depends on when and how the instance was deployed.
    To connect to an instance deployed on Create date

    Oracle Cloud Infrastructure (Gen 2)

    Any

    Oracle Cloud Infrastructure

    12th May 2020 or later

    Use this URL format with OAuth:

    jdbc:oraclebi:https://<host>:<port>/api/jdbc?BIJDBC_PROPERTIES_FILE=<fully qualified location and name of properties file>

    For example:

    jdbc:oraclebi:https://<host>:443/api/jdbc?BIJDBC_PROPERTIES_FILE=D:\\Workspace\\bijdbc\\bijdbc.properties
    To connect to an instance deployed on Create date

    Oracle Cloud Infrastructure

    Before 12th May 2020

    Use this URL format with OAuth:

    jdbc:oraclebi:https://<host>:<port>/bimodeler/api/jdbc?BIJDBC_PROPERTIES_FILE=<fully qualified location and name of properties file>

    For example:

    jdbc:oraclebi:https://abcdefghi123-jklmnopqrs4t-je.analytics.ocp.oraclecloud.com:443/bimodeler/api/jdbc?BIJDBC_PROPERTIES_FILE=D:\\Workspace\\bijdbc\\bijdbc.properties
  4. Test the connection to the target Oracle Analytics Cloud instance.
    Use your favorite SQL command tool to connect to Oracle Analytics Cloud with the appropriate JBDC URL. For example:
    jdbc:oraclebi:https://abcdefghi123-jklmnopqrs4t-je.analytics.ocp.oraclecloud.com:443/api/jdbc?BIJDBC_PROPERTIES_FILE=D:\\Workspace\\bijdbc\\bijdbc.properties

Example: Connect to a Data Model Remotely Using SQuirrel

This example shows how to connect to a Oracle Analytics Cloud data model using JDBC with SQuirrel SQL Client tool.

  1. Register the JDBC driver.
    1. In SQuirrel SQL Client, under Drivers, click Create a New Driver.
    2. In the Example URL field, specify the BIJDBC application URL with a fully qualified properties file.
      For example: jdbc:oraclebi:https://abcdefghi123-jklmnopqrs4t-je.analytics.ocp.oraclecloud.com:443/bimodeler/api/jdbc?BIJDBC_PROPERTIES_FILE=D:\\Workspace\\bijdbc\\bijdbc.properties
    3. In the Extra Class Path tab, select the BIJDBC driver (JAR file) you downloaded from Client Installer.
    4. Click List Drivers, and under Class Name select oracle.bi.jdbc.AnaJdbcDriver, then save the details.
    Add driver information
  2. Create a connection or (alias).
    1. Under Aliases, click Create a New Alias.
    2. In the Driver option, select bijdbc.
    3. Edit the URL, specify credentials (if required), then click Test.

      If credentials are provided in the property file, you don't need to specify User Name or Password.

    4. Validate the connection by connecting to the Alias and exploring the metadata in the Objects section.
    Add connection details
  3. In the SQL tab, enter a sample logical SQL query and click the Run button.

    For more information, see Logical SQL Reference Guide.

    If the connection is working, the Results tab shows the results of your query.

    Test connection
  4. Check the Results tab to verify the rows returned by the query.