Oracle Cloud Infrastructure Documentation

Create Services with Oracle Analytics Cloud

As Cloud Account Administrator, you can create and set up services in Oracle Analytics Cloud for your organization.

Topics

Typical Workflow to Create a Service

If you’re about to create an Oracle Analytics Cloud instance on Oracle Cloud Infrastructure and you’re using Oracle Cloud Infrastructure Console for the first time, follow these tasks as a guide.

Task Description More Information

Before you start

    

Activate your order and sign in to your Oracle Cloud account

As the Cloud Account Administrator, you can complete all setup tasks for Oracle Analytics Cloud.

Request and Manage Free Oracle Cloud Promotions

Upgrade to a Paid Account

Determine your service requirements

Plan your Oracle Analytics Cloud deployment. Think about what you need before you start.

Plan Your Service

(Optional) Enable other users to set up services

If you don’t want to set up Oracle Analytics Cloud yourself, give other users permissions to create services.

Give Another User Permission to Set Up Oracle Analytics Cloud
(Recommended) Create a compartment for your service Create a compartment for your Oracle Analytics Cloud deployment. Create a Compartment
Create the service    

Create a service

Use Oracle Cloud Infrastructure Console to deploy a new service.

Create a Service

Verify your service

When your service is ready, check that you can sign in and your service is up and running.

Verify Your Service and Sign In

Complete the setup

Set up users and groups

Set up users and groups for Oracle Analytics Cloud and assign them to application roles.

Set Up Users

Schedule regular backups of your data (snapshots)

As part of your business continuity plan, take a snapshot before people start using the system and again at suitable intervals so you can restore the environment if something goes wrong.

Schedule Regular Snapshots

Set service-level options

Configure service-level options for everyone using the service.

Configure Options for Your Service

Migrate content

Leverage your existing content in Oracle Analytics Cloud.

Migrate to Oracle Analytics Cloud from Other Environments

Before You Create a Service

Before you set up Oracle Analytics Cloud on Oracle Cloud Infrastructure using Oracle Cloud Infrastructure Console, Oracle recommends that you take some time to plan your service.

Plan Your Service

Take some time to plan your Oracle Analytics Cloud service before you create it. Think about the questions outlined here and decide what you want to do, before you start.

Which Edition Do You Need?

When you set up a service you specify the edition you subscribe to and this determines which features are deployed.

Edition Description

Professional Edition

Enables you to deploy an instance with data visualization.

Enterprise Edition

Enables you to deploy an instance with enterprise modeling, reporting, and data visualization.

For more information about the features available with each edition, see Editions: Enterprise and Professional .

Where Do You Want to Deploy Your Service?

Oracle Cloud Infrastructure (Gen 2) is hosted in several different geographic areas, called regions. When you sign up for Oracle Analytics Cloud, Oracle creates a tenancy for your company with access to one or more regions. If multiple regions are available to you, decide where you want to deploy your Oracle Analytics Cloud instance.

To find out more, see Region Availability.
Note

The way you deploy and manage Oracle Analytics Cloud depends on the region, type, and start date of your subscription. If your Oracle Analytics Cloud subscription started before Oracle Analytics Cloud was available on Oracle Cloud Infrastructure (Gen 2), the deployment process is different. See:
Do You Need a Public or Private Endpoint?

When you create an Oracle Analytics Cloud instance, you specify how you want to access your service: through a public internet accessible endpoint or a private endpoint.

After you've created Oracle Analytics Cloud, you can't switch from a public endpoint to a private endpoint (or the other way around). So it's important to decide what type of access your organization needs and complete the required prerequisites before you start. See Prerequisites for a Public Endpoint and Prerequisites for a Private Endpoint.

If you're not sure, see About Public Endpoints and Access Control Rules and About Private Endpoints.

What Sizing Options Are Available to You?

When you create an Oracle Analytics Cloud instance for your production or non-production environment, you either specify the number of Oracle Compute Units (OCPUs) you want to deploy or the number of people you expect to use the service.

How Many OCPUs Do You Think You’ll Need?

Oracle Analytics Cloud offers a range of compute sizes (OCPUs) to suit different scenarios and environments. The larger the compute size, the greater the processing power. If you're not sure which size to use, contact your sales team to discuss sizing guidelines.

The compute size you select also determines some configuration limits for the different types of content that users can create:

  • Data visualizations

  • Classic analyses and dashboards

  • Classic pixel-perfect reports

For example, limits such as the maximum number of input rows you can return from a data source query or the maximum number of rows you can download from a report to a file (for example, when you export to a CSV file).

Limits Querying Data (Data Visualization Workbooks, Classic Analyses and Dashboards)

When you query a data source for visualizations or classic analyses and dashboards, the compute size determines the maximum number of rows that are returned from the data source.

Which compute size do you think you’ll need? Limits when querying data for visualizations, analyses, and dashboards
Max input rows returned from any data source query Query timeout (seconds)

1 OCPU

(non-production only)

125,000

space

660

space

2 OCPU

2,000,000

 660

4 OCPU

2,000,000

 660

6 OCPU

2,000,000

 660

8 OCPU

2,000,000

 660

10 OCPU

2,000,000

 660

12 OCPU

2,000,000

 660

16 OCPU

4,000,000

 660

24 OCPU

4,000,000

 660

36 OCPU

4,000,000

 660

52 OCPU

4,000,000

 660

Limits Displaying Data (Data Visualization Workbooks, Classic Analyses and Dashboards)

When you display data in visualizations or classic analyses and dashboards, the compute size determines the maximum number of summarized rows returned from the data source that are displayed.

Which compute size do you think you’ll need? Limits when displaying data in visualizations, analyses, and dashboards
Max summarized rows returned from any data source query

1 OCPU

(non-production only)

125,000

space

2 OCPU

500,000

4 OCPU

500,000

6 OCPU

500,000

8 OCPU

500,000

10 OCPU

500,000

12 OCPU

500,000

16 OCPU

1,000,000

24 OCPU

1,000,000

36 OCPU

1,000,000

52 OCPU

1,000,000

Limits Exporting Data (Data Visualization Workbooks)

When you export data from a data visualization workbook, the compute size determines the maximum number of rows you can export. There are different limits for formatted and unformatted data.

  • Unformatted data limit: Comma Separated Values (CSV)

  • Formatted data limit: Microsoft Excel (XLSX)

Note

Data exports are expensive operations and have a direct impact on the overall system performance. The impact on system performance increases with the number of rows and columns that you export. Oracle recommends that you export large amounts of data during non-peak hours to reduce any performance impact.
Which compute size do you think you’ll need? Limits when exporting data from data visualization workbooks
Maximum number of rows exported to CSV Maximum number of rows exported to Microsoft Excel (XLSX)

1 OCPU

(non-production only)

125,000

space

25,000

space

2 OCPU

2,000,000

 25,000

4 OCPU

2,000,000

 25,000

6 OCPU

2,000,000

 25,000

8 OCPU

2,000,000

 25,000

10 OCPU

2,000,000

 25,000

12 OCPU

2,000,000

 25,000

16 OCPU

4,000,000

 25,000

24 OCPU

4,000,000

 25,000

36 OCPU

4,000,000

 25,000

52 OCPU

4,000,000

 25,000

Limits Exporting Data (Classic Analyses and Dashboards)

When you export data from analyses and dashboards, the compute size determines the maximum number of rows you can export. There are different limits for formatted reports and unformatted reports.

  • Unformatted report limits: formats such as CSV, Excel, XML, and Tab Delimited.

  • Formatted report limits: formats such as PDF, Excel, Powerpoint, and Web Archive/HTML.

When two pivot views are laid out side by side in a union the formatted export limit will be 20,000 rows.

Note

Data exports are expensive operations and have a direct impact on the overall system performance. The impact on system performance increases with the number of rows and columns that you export and the output format. Oracle recommends that you export large amounts of data during non-peak hours or export unformatted data to reduce any performance impact.
Which compute size do you think you’ll need? Limits when exporting data from analyses and dashboards
Max rows exported to unformatted reports Max rows exported to formatted reports

1 OCPU

(non-production only)

125,000

space

1,000

space

2 OCPU

2,000,000

200,000

4 OCPU

2,000,000

200,000

6 OCPU

2,000,000

200,000

8 OCPU

2,000,000

200,000

10 OCPU

2,000,000

200,000

12 OCPU

2,000,000

200,000

16 OCPU

4,000,000

400,000

24 OCPU

4,000,000

400,000

36 OCPU

4,000,000

400,000

52 OCPU

4,000,000

400,000

Limits Delivering by Email (Classic Analyses and Dashboards)

When you send analyses and dashboards by email, the compute size determines the maximum number of rows you can deliver in a single email. There are different limits for delivering formatted reports and unformatted reports.

  • Unformatted report limits: formats such as CSV, Excel, XML, and Tab Delimited.

  • Formatted report limits: formats such as PDF, Excel, Powerpoint, and Web Archive/HTML.

Note

Content delivery by email is an expensive operation and has a direct impact on the overall system performance. The impact on system performance increases with the number of recipients, the number of rows and columns that you send, and the delivery format. Oracle recommends that you schedule deliveries during non-peak hours or change the delivery format to reduce any performance impact.
Which compute size do you think you’ll need? Limits when delivering analyses and dashboards by email
Max rows in unformatted reports delivered by email Max rows in formatted reports delivered by email

1 OCPU

(non-production only)

2,000

space

1,000

space

2 OCPU

200,000

50,000

4 OCPU

200,000

50,000

6 OCPU

200,000

50,000

8 OCPU

200,000

50,000

10 OCPU

200,000

50,000

12 OCPU

200,000

50,000

16 OCPU

300,000

100,000

24 OCPU

300,000

100,000

36 OCPU

300,000

100,000

52 OCPU

300,000

100,000

Data Size Limits (Classic Pixel-Perfect Reports)

The compute size determines several limits associated with generating reports.

Which compute size do you think you’ll need? Report data size limits when generating pixel-perfect reports
Max data size for online reports Max data size for offline (scheduled) reports Max data size for bursting reports Max data size for data generation

1 OCPU

(non-production only)

200MB

space

500MB

space

2GB

space

500MB

space

2 OCPU

500MB

2GB

4GB

2GB

4 OCPU

500MB

2GB

4GB

2GB

6 OCPU

500MB

2GB

4GB

2GB

8 OCPU

500MB

2GB

4GB

2GB

10 OCPU

500MB

2GB

4GB

2GB

12 OCPU

500MB

2GB

4GB

2GB

16 OCPU

500MB

4GB

8GB

4GB

24 OCPU

500MB

4GB

8GB

4GB

36 OCPU

500MB

4GB

8GB

4GB

52 OCPU

500MB

4GB

8GB

4GB

Processing Limits (Classic Pixel-Perfect Reports)

The compute size determines several limits associated with processing reports.

Which compute size do you think you’ll need? Data model and report processing limits when generating pixel-perfect reports
SQL Query timeout for scheduled reports (seconds) Max rows for CSV output Max number of in-memory rows in XPT layout Max number of concurrent scheduled jobs Max number of concurrent online reports

1 OCPU

(non-production only)

1,800

space

1,000,000

space

100,000

space

1

space

2

space

2 OCPU

1,800

4,000,000

200,000

4

16

4 OCPU

1,800

4,000,000

200,000

4

32

6 OCPU

1,800

4,000,000

200,000

4

48

8 OCPU

1,800

4,000,000

200,000

 4

64

10 OCPU

1,800

4,000,000

200,000

 4

80

12 OCPU

1,800

4,000,000

200,000

4

96

16 OCPU

3,600

6,000,000

300,000

10

320

24 OCPU

3,600

6,000,000

300,000

10

480

36 OCPU

3,600

6,000,000

300,000

10

720

52 OCPU

3,600

6,000,000

300,000

10

1040

How Many People Do You Expect to Use the Service?

With Oracle Analytics Cloud, you can opt to specify how many people you expect to use the service. Typically, services have between 10 and 3000 users. Configuration limits for user-based subscriptions are equivalent to those shown here.

Configuration Limits for User-based Subscriptions: Data Visualization Workbooks, Classic Analyses and Dashboards

Limit Description Limit Value
Limits when querying data for visualizations, analyses, and dashboards  
Max input rows returned from any data source query 2,000,000 rows
Query timeout (seconds) 660 seconds
Limits when displaying data in visualizations, analyses, and dashboards
Max summarized rows returned from any data source query 500,000 rows
Limits when exporting data from data visualization workbooks
Maximum number of rows exported to CSV 2,000,000 rows
Maximum number of rows exported to Microsoft Excel (XLSX) 25,000 rows
Limits when exporting data from analyses and dashboards
Max rows exported to unformatted reports 2,000,000 rows
Max rows exported to formatted reports 200,000 rows
Limits when delivering analyses and dashboards by email
Max rows in unformatted reports delivered by email 200,000 rows
Max rows in formatted reports delivered by email 50,000 rows

Configuration Limits for User-based Subscriptions: Classic Pixel-Perfect Reports

Limit Description Limit Value
Report data size limits when generating pixel-perfect reports
Max data size for online reports 500MB
Max data size for offline (scheduled) reports 2GB
Max data size for bursting reports 4GB
Max data size for data generation 2GB
Data model and report processing limits when generating pixel-perfect reports
SQL Query timeout for scheduled reports (seconds) 1,800 seconds
Max rows for CSV output 4,000,000 rows
Max number of in-memory rows in XPT layout 200,000 rows
Max number of concurrent scheduled jobs 4 jobs
Max number of concurrent online reports 32 reports

What's the Difference Between Production and Non-Production Environments

  • Non-production environment: Oracle enables you to deploy a non-production environment with 1 OCPU. A non-production environment is specifically sized and designed for test, development and training purposes. Non-production services aren't intended for daily use, multiple concurrent users, or complex business scenarios.

    If you decide you want to keep the content that you create during testing, you can save it to a snapshot and copy it to a production service (minimum 2 OCPU or 10 users). See Migrate Oracle Analytics Cloud Using Snapshots. Alternatively, you can scale up your 1 OCPU environment to between 2 and 8 OCPUs.

  • Production environment: A production environment is designed for daily commercial use. You can scale some production environments up and down. For example, you can scale between 2 and 8 OCPUs and 10 and 12 OCPUs. You can also scale between various user ranges such as 10 - 400 users and 401 - 601 users. See About Scaling.

What Name Do You Want for Your Service?

Think about a suitable name for your service. The name that you specify is displayed in Oracle Cloud Infrastructure Console and the URL for your service.

Name restrictions:

  • Must contain between 1 and 25 characters.

  • Must start with an ASCII letter: a to z or A to Z.

  • Must contain only ASCII letters or numbers.

  • Mustn't contain any other special characters.

  • Must be unique within the identity domain.

Give Another User Permission to Set Up Oracle Analytics Cloud

When you activate your order for Oracle Analytics Cloud, you get the Cloud Account Administrator role. This role gives you full administration privileges in Oracle Cloud Infrastructure so you can complete all aspects of Oracle Analytics Cloud setup and much more. There’s no need to delegate this responsibility but, if you want to, you can give someone else privileges to create and manage Oracle Analytics Cloud instances through the manage analytics-instances permission.

In Oracle Cloud Infrastructure you use IAM security policies to grant permissions. First, you must add the user to a group, and then you create a security policy that grants the group the manage analytics-instances permission on a specific compartment or the tenancy (any compartment in the tenancy). For example, you might create a policy statement that looks like one of these: 
  • allow group MyAdminGroup to manage analytics-instances in tenancy
  • allow group MyAdminGroup to manage analytics-instances in compartment MyOracleAnalytics
To find out how to create security policy statements specifically for Oracle Analytics Cloud, see Give Users Permissions to Manage Analytics Cloud Instances.

Create a Compartment

When you sign up for Oracle Cloud Infrastructure, Oracle creates your tenancy with a root compartment that holds all your cloud resources. You then create additional compartments within the tenancy (root compartment) and corresponding policies to control access to the resources in each compartment. Before you create an Oracle Analytics Cloud instance, Oracle recommends that you set up the compartment where you want the instance to belong.

You create compartments in Oracle Cloud Infrastructure Identity and Access Management (IAM). See Setting Up Your Tenancy and Managing Compartments.

Create a Service

You can create an Oracle Analytics Cloud instance using the Console, API, or command line.

Note

Required IAM Policy

Verb: manage

Resource Type: analytics-instance, analytics-instances

Custom Permission: ANALYTICS_INSTANCE_CREATE

See About Permissions to Manage Oracle Analytics Cloud Instances.

Additional IAM Policy Required to Create a Public Endpoint

Verb: read

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

See Prerequisites for a Public Endpoint.

Additional IAM Policy Required to Create a Private Endpoint

Verb: manage

Resource Type: virtual-network-family

Verb: read

Resource Type: compartment, compartments

Required only for network security groups:

Verb: use

Resource Type: network-security-groups

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

Topics

Create a Service using the Console

You can use Oracle Cloud Infrastructure Console to set up a service instance with Oracle Analytics Cloud.

You must belong to an OCI group that is granted the required policies to create an Analytics instance. See Give Users Permissions to Manage Analytics Cloud Instances.

  1. Sign in to your Oracle Cloud account.

    The way you sign in depends whether your cloud account uses identity domains or federates with Oracle Identity Cloud Service. See Signing In to the Oracle Cloud Infrastructure Console.

  2. In Console, click Navigation menu in the top left corner.
  3. Click Analytics & AI. Under Analytics, click Analytics Cloud.
    Description of console_oac_nav.jpg follows
  4. From the Compartment list, select the compartment in which you want to create the service.
  5. Click Create Instance.
    Description of console_oac.jpg follows
  6. Enter a Name and a brief description.
    The name must start with a letter and can contain only letters and numbers.
  7. For Capacity, select the size of your deployment.

    Configure the capacity type that matches your subscription, that is, either OCPUs per hour or Users per month.

    • OCPU: Select the number of OCPUs you want to deploy.
      • Production environment: Select between 2 and 52 OCPUs.

      • Non-production environment: Select 1 OCPU if you want to create an instance for test purposes.

      See What's the Difference Between Production and Non-Production Environments.

      You must select the OCPU option if you plan to use your Oracle Middleware on-premise license with Oracle Analytics Cloud (BYOL).

    • Users: Enter the number of users you expect to use this service.

      You can split your capacity over multiple services. For example, if your subscribe to 100 users per month, you might deploy a test instance for 10 users and a production instance with the remaining 90 users.

  8. For License, select License Included to subscribe to an Oracle Cloud license for Oracle Analytics Cloud or Bring Your Own License (BYOL) to use your Oracle Middleware on-premise license with Oracle Analytics Cloud and be charged the Bring Your Own License (BYOL) rate.

    The Bring Your Own License (BYOL) option is available when you select OCPU for Capacity.

    If you select Users, you must have an Oracle Cloud license for Oracle Analytics Cloud.

  9. Select the Edition that matches your subscription.
    • Enterprise Edition: Deploys an instance with enterprise modeling, reporting, and data visualization.
    • Professional Edition: Deploys an instance with data visualization.
    For example:
    Description of console_oac_create.jpg follows
  10. Optional: Click Show Advanced Options to configure network or encryption options.
    Description of console_oac_create2.jpg follows
  11. In Network Access, configure how you want users to access Oracle Analytics Cloud: over the public internet or through a private network.

    • Public: Enable access over the public internet.

      The Public option deploys Oracle Analytics Cloud with a public internet accessible endpoint. If required, you can configure access control rules to restrict access by public IP address, public CIDR block range, VCN, and Oracle services. See Restrict Access to Oracle Analytics Cloud Deployed with a Public Endpoint.

    • Private: Enable private access from an on-premise network or hosts on a virtual cloud network (VCN). Private access means that traffic doesn't go over the internet.

      The Private option deploys Oracle Analytics Cloud with a private endpoint. Before you configure this option, you must set up the Oracle Cloud Infrastructure VCN that you plan to use with a subnet for Oracle Analytics Cloud. If required, you can restrict access to private endpoints through network security groups. If your network security groups aren't set up yet, you can save this task for later. See Deploy Oracle Analytics Cloud with a Private Endpoint.

    You can configure access control rules for a public endpoint or change the VCN, subnet, and network security group access for a private endpoint, later on as required. However, you can't change your network access selection from public to private (or private to public).

  12. Optional: In Data Encryption, customize how Oracle Analytics Cloud encrypts customer data.

    • Encrypt using Oracle-managed Keys: Leave all data encryption to Oracle.

    • Encrypt using Customer-managed Keys: Specify the custom encryption key you want to use.

    You can configure data encryption now or later. If you haven’t created a master encryption key yet, leave this task for later. See Encrypt Sensitive Information.

    Your Oracle Analytics Cloud instance must be deployed with Enterprise Edition. Custom encryption isn't available on Oracle Analytics Cloud instances deployed with Professional Edition.

  13. Verify that the details are correct, and click Create.
It takes about 20 minutes to create the service. Display the Instance page to check the current status.
Description of console_oac_create3.jpg follows

Create a Service using the REST API

You can use the CreateAnalyticsInstance operation to set up a service instance with Oracle Analytics Cloud.

To use the REST API, you need to generate an access token and specify the token value in the parameter idcsAccessToken. See Generate Access Tokens for the REST API and CLI.

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

Create a Service using the Command Line

You can use the analytics-instance create command to set up a service instance with Oracle Analytics Cloud.

To use the CLI, you need to generate an access token, copy the token value to a file, and specify the name of the file in the CLI parameter --idcs-access-token-file [filename]. See Generate Access Tokens for the REST API and CLI.

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

Generate Access Tokens for the REST API and CLI

You need an access token to create an Oracle Analytics Cloud instance using the command line interface (CLI) or REST API. This section describes how to set up a confidential application to generate the required access tokens, and how to specify the tokens in CLI and REST API payloads.

Note

The instructions are different for identity domains and Oracle Identity Cloud Service. Follow the correct instructions for your tenancy. If you're not sure, see How can I find information about the identity provider my Oracle Analytics Cloud uses?

Topics:

For tenancies offering identity domains:

For tenancies offering Oracle Identity Cloud Service:

Create a Confidential Application to Generate Access Tokens (Identity Domains)

Create a confidential application that enables you to generate the access token required to create an Analytics instance using CLI or REST API.

Note

These instructions are for tenancies that use identity domains. If your tenancy uses Oracle Identity Cloud Service (IDCS), see Create a Confidential Application to Generate Access Tokens (IDCS).
  1. Sign in to your Oracle Cloud account as an administrator.
  2. In Oracle Cloud Infrastructure Console, navigate to Identity & Security, and click Domains.
  3. Click the name of the identity domain where you plan to create an Analytics instance, and click Integrated applications.
    Add application
  4. Click Add application, select Confidential Application, and then click Launch workflow.
    Add a confidential application
  5. Enter a name for the application (for example, Analytics_Token_App), and click Next.
  6. Select Configure this application as a client now.
  7. Under Authorization, select the allowed grant types: Resource Owner, Client credentials, and JWT assertion.
    Confgure allowed grant types
  8. Under Token issuance policy, select Add app roles, click Add roles, and select Me.
    Grant access to Me
  9. Click Next, then Finish.
  10. Click Activate, then Activate Application.

Now you can use the confidential application to generate access tokens that you can include in REST API and CLI payloads. See Generate and Use Access Tokens in REST API and CLI Payloads (Identity Domains).

Generate and Use Access Tokens in REST API and CLI Payloads (Identity Domains)

If you want to create an Oracle Analytics Cloud instance programmatically, you must generate an access token that you can include in the payload for REST API or CLI create operations. Access tokens are set to expire after a certain time period so you might need to repeat this task for subsequent create operations. By default, access tokens are valid for one hour (3600 seconds).

Note

These instructions are for tenancies that use identity domains. If your tenancy uses Oracle Identity Cloud Service (IDCS), see Generate and Use Access Tokens in REST API and CLI Payloads (IDCS).

You can generate access tokens using the Console or programmatically (using CLI or an API).

To generate access tokens from the Console:

  1. Sign in to your Oracle Cloud account as an administrator.
  2. In Oracle Cloud Infrastructure Console, navigate to Identity & Security, and click Domains.
  3. Click the name of the identity domain where you plan to create an Analytics instance, and click Integrated applications.
  4. Navigate to the application that you previously created to generate tokens. For example, Analytics_Token_App.
  5. Under Resources, click Access Token.
    Access token page
  6. Select Customized Scopes.
  7. Select Invokes identity domain APIs, and specify Me.
  8. Click Download token and save the tokens.tok file.

    tokens.tok contains the access token with the attribute name app_access_token.

  9. Open tokens.tok.

    For example:

    {"app_access_token":"eyJ4NXQjUzI...0jxcCw5oR0ajaNw"}
  10. Copy the access token value between the quotes. For example, the value eyJ4NXQjUzI...0jxcCw5oR0ajaNw.
  11. To create an Oracle Analytics Cloud instance with this access token, do one of the following:
    • REST API CreateAnalyticsInstance: Specify the token value in the parameter idcsAccessToken.
    • CLI analytics-instance create: Copy the token value to a file and specify the name of the file in the CLI parameter --idcs-access-token-file [filename].
To generate access tokens using an API or CLI:
  1. Generate the access token using an API or from the CLI. For example:
    curl 
-X POST 
-u "<client_id>:<client_secret>" 
-H 'content-type: application/x-www-form-urlencoded;charset=UTF-8' 
-d "grant_type=password" 
-d "username=<user>" 
-d "password=<password>" 
-d 'scope=urn:opc:idm:t.user.me' 
"https://<stripe>.identity.oraclecloud.com:443/oauth2/v1/token"
    Note

    Navigate to your domain's information page to obtain the stripe associated with your domain. Click Show next to the Domain URL property to discover the stripe value.

    The command returns a JSON response similar to this:

    {"access_token":"eyJ4NXQjUzI...0jxcCw5oR0ajaNw","token_type":"Bearer","expires_in":3600}
  2. Copy the access token from the JSON. For example,eyJ4NXQjUzI...0jxcCw5oR0ajaNw.
  3. To create an Oracle Analytics Cloud instance with this access token, do one of the following:
    • REST API CreateAnalyticsInstance: Specify the token value in the parameter idcsAccessToken.
    • CLI analytics-instance create: Copy the token value to a file and specify the name of the file in the CLI parameter --idcs-access-token-file [filename].
Create a Confidential Application to Generate Access Tokens (IDCS)

Create a confidential application that enables you to generate the access token required to create an Analytics instance using CLI or REST API.

Note

These instructions are for tenancies that use Oracle Identity Cloud Service (IDCS). If your tenancy uses identity domains, see Create a Confidential Application to Generate Access Tokens (Identity Domains).
  1. Sign in to your Oracle Cloud account as an administrator.
  2. In Oracle Cloud Infrastructure Console, navigate to Identity & Security, click Federation, select OracleIdentityCloudService, and then click the Oracle Identity Cloud Service Console URL.
  3. Navigate to the Applications tab, and click Add.
  4. Select Confidential Application.
  5. Enter a name for the application (for example, Analytics_Token_App), and click Next.
    Add a confidential application
  6. Select Configure this application as a client now and provide the following Allowed Grant Types for client authorization:
    • Resource Owner
    • Client Credentials
    • JWT Assertion
  7. Under Grant the client access to Identity Cloud Service Admin APIs, click Add.
  8. Select Me, then click Add.
    Grant Me access to IDCS APIs
  9. Click Next to go to the Resources tab.
  10. Click Next to go to the Web Tier Policy tab.
  11. Click Next to go to navigate to the Authorization tab.
  12. Click Finish.
  13. Copy and save the Client ID and Client Secret.
    Copy Client ID and Client Secret
  14. Click Activate, then click to confirm that you want to activate the application.
    Activate the confidential application

Now you can use the confidential application to generate access tokens that you can include in REST API and CLI payloads. See Generate and Use Access Tokens in REST API and CLI Payloads (IDCS)

Generate and Use Access Tokens in REST API and CLI Payloads (IDCS)

If you want to create an Oracle Analytics Cloud instance programmatically, you must generate an access token that you can include in the payload for REST API and CLI create operation. Access tokens are set to expire after a certain time period so you might need to repeat this task for subsequent create operations. By default, access tokens are valid for one hour (3600 seconds).

Note

These instructions are for tenancies that use Oracle Identity Cloud Service (IDCS). If your tenancy uses identity domains, see Generate and Use Access Tokens in REST API and CLI Payloads (Identity Domains).

You can generate access tokens using the Console or programmatically (using CLI or an API).

To generate access tokens from the Console:

  1. Sign in to your Oracle Cloud account as an administrator.
  2. In Oracle Cloud Infrastructure Console, navigate to Identity & Security, click Federation, select OracleIdentityCloudService, and then click the Oracle Identity Cloud Service Console URL.
  3. Navigate to the Applications tab, and click the application that you previously created to generate tokens. For example, Analytics_Token_App.
  4. Click Generate Access Token.
    Generate access token
  5. Select Customized Scopes.
  6. Select Invokes Identity Cloud Service APIs, and specify Me.
  7. Click Download Token and save the tokens.tok file.

    tokens.tok contains the access token with the attribute name app_access_token.

    Download token
  8. Open tokens.tok.

    For example:

    {"app_access_token":"eyJ4NXQjUzI...0jxcCw5oR0ajaNw"}
  9. Copy the access token value between the quotes. For example, the value eyJ4NXQjUzI...0jxcCw5oR0ajaNw.
  10. To create an Oracle Analytics Cloud instance with this access token, do one of the following:
    • REST API CreateAnalyticsInstance: Specify the token value in the parameter idcsAccessToken.
    • CLI analytics-instance create: Copy the token value to a file and specify the name of the file in the CLI parameter --idcs-access-token-file [filename].
To generate access tokens using an API or CLI:
  1. Generate the access token using an API or from the CLI. For example: 
    curl 
-X POST 
-u "<client_id>:<client_secret>" 
-H 'content-type: application/x-www-form-urlencoded;charset=UTF-8' 
-d "grant_type=password" 
-d "username=<user>" 
-d "password=<password>" 
-d 'scope=urn:opc:idm:t.user.me' 
"https://<stripe>.identity.oraclecloud.com:443/oauth2/v1/token"

    The command returns a JSON response similar to this:

    {"access_token":"eyJ4NXQjUzI...0jxcCw5oR0ajaNw","token_type":"Bearer","expires_in":3600}
  2. Copy the access token from the JSON. For example,eyJ4NXQjUzI...0jxcCw5oR0ajaNw.
  3. To create an Oracle Analytics Cloud instance with this access token, do one of the following:
    • REST API CreateAnalyticsInstance: Specify the token value in the parameter idcsAccessToken.
    • CLI analytics-instance create: Copy the token value to a file and specify the name of the file in the CLI parameter --idcs-access-token-file [filename].

After You Create a Service

After creating and verifying a service with Oracle Analytics Cloud, you must set up your users and configure additional options for your service. If you’re migrating to Oracle Analytics Cloud from on-premises or another cloud service you might want to migrate your existing content now.

Verify Your Service and Sign In

Oracle sends an email to the designated email address when your Oracle Analytics Cloud service is ready. Navigate to your service in Oracle Cloud Infrastructure Console, click the Analytics Home Page button, and then sign in to verify your Oracle Analytics Cloud service is up and running.

Note

Required IAM Policy

Verb: read

Resource Types: analytics-instance, analytics-instances

Permission: ANALYTICS_INSTANCE_READ

See About Permissions to Manage Oracle Analytics Cloud Instances.

  1. In Console, click Navigation menu icon in the top left corner.
  2. Click Analytics & AI. Under Analytics, click Analytics Cloud.
  3. Select the compartment in which you created the instance.
  4. Click the name of the new instance.
  5. Take some time to familiarize yourself with the information and actions available for your instance.
    • Action buttons: Instance-level actions that enable you to access your service, pause, resume, and scale. Click More Actions to change the license type, edit the description, move your instance to a different compartment or delete your service.
    • Instance Details tab: OCID, compartment, current capacity, edition deployed, license used, encryption, public or private access, access control rules for public endpoints, VCN and subnet configuration for private endpoints, service URL, and vanity URL configuration (if any).
    • Additional Details tab: Network configuration such as your service host name, IP address, and gateway IP address. Identity provider configuration; the Identity and Access Management (IAM) domain or Oracle Identity Cloud Service instance (stripe).
    • Resources tab: Access to status and activity logs, private access channel configuration, and metrics.
  6. Verify and explore your service.
    1. Click Analytics Home Page.
    2. Sign into Oracle Analytics Cloud service with your administrator credentials.
Description of console_oac_open.jpg follows

Configure Options for Your Service

Administrators perform many critical duties; they control user permissions and amend accounts, set up database connections for data modelers, manage data storage to avoid exceeding storage limits, take regular snapshots so users don't risk losing their work, authorize access to external content by registering safe domains, troubleshoot user queries, and much more. After setting up a service with Oracle Analytics Cloud, you can review typical administrator tasks for your service.

See Administrator Task List in Configuring Oracle Analytics Cloud.

Migrate to Oracle Analytics Cloud from Other Environments

Do you have content in an existing on-premise system or another cloud service that you want to leverage in Oracle Analytics Cloud? After setting up your service, you can migrate the content to the new environment.

Migrate From... More Information

Other Oracle Analytics Cloud deployments on Oracle Cloud Infrastructure

Migrate Oracle Analytics Cloud Using Snapshots

Oracle Analytics Cloud - Classic deployed on Oracle Cloud Infrastructure Classic

Migrating Oracle Analytics Cloud - Classic Instances to Oracle Cloud Infrastructure

Oracle BI Cloud Service

Migrating Oracle Business Intelligence Cloud Service Instances to Oracle Cloud Infrastructure

Oracle Data Visualization Cloud Service

Migrating Oracle Data Visualization Cloud Service Instances to Oracle Cloud Infrastructure

Oracle Analytics Server

In Oracle Analytics Server: Take a Snapshot and Export the Snapshot

In Oracle Analytics Cloud: Import the Snapshot and Restore from the Snapshot

Oracle BI Enterprise Edition

Migrating Oracle Business Intelligence Enterprise Edition to Oracle Analytics Cloud