Skip to content

Commit

Permalink
Updated: Implement Data Sharing with ADB Data Studio workshop (#313)
Browse files Browse the repository at this point in the history
* Update use-delta-sharing.md

* livelabs folder

* Update adw-dcat-integrate.md

* updates

* updates to Introduction lab

* Update introduction.md

* LiveLabs workshop version and other freetier changes

* Update introduction.md

* Update introduction.md

* livelabs and freetier changes

* Update load-analyze-json.md

* Update load-analyze-rest.md

* more changes

* more updates

* more updates

* Update adw-dcat-integrate.md

* changed shared with serverless as deployment type

* Update load-local-data.md

* update shared to serverless

* update adb-dcat workshop

* added new lab 12

* Update manifest.json

* added new folder with an .md file in it

Please work!

* more testing

* Delete introduction.md

* new workshop and labs wip

* update labs

* more updates

* more updates

* more updates

* updates

* more updates

* updates before review cycle

* Update endpoint.png

* Update setup-workshop-environment.md

* Update setup-workshop-environment.md

* more updates

* final update before review

* updates

* replacement code

* Update create-share-recipients.md

* Update create-share-recipients.md

* Update create-share-recipients.md

* Update create-share-recipients.md

* Update create-share-recipients.md

* Update create-share-recipients.md

* updates

* Update manifest.json

* folder rename

* added content to data studio folder

* Delete user-bucket-credential-diagram.png

* updates self-qa

* Update introduction.md

* remove extra text files

* Update introduction.md

* Update setup-workshop-environment.md

* Data Studio Workshop Changes

* changes to data studio workshop

* Update setup-workshop-environment.md

* adb changes

* Update recipient-diagram.png

* diagram change

* Update user-bucket-credential-diagram.png

* SME feedback

* Update create-share.md

* Nilay changes

* changes

* Update consume-share.md

* Anoosha's feedback

* Update consume-share.md

* updated 2 screens and a sentence

* minor changes

* deleted extra images and added doc references

* new ECPU changes

* more changes to data sharing workshops

* more changes to fork (data studio)

* more changes

* Marty's feedback

* Marty's feedback to plsql workshop too

* Update setup-workshop-environment.md

* Delete 7381.png

* workshop # 3 ADB set up

and a couple of minor typos in workshops 1 and 2

* changes to adb-dcat workshop

* more changes

* minor typos in all 4 workshops

* quarterly qa build data lake

* new lab 11 in build DL with ADW

* minor changes database actions drop-down list

* final changes to build data lake workshop

* AI updates

AI workshop updates

* ai workshop updates

* Update query-using-select-ai.md

* Update query-using-select-ai.md

* updates

* more updates

* Update query-using-select-ai.md

* more new updates to ai workshop

* Update query-using-select-ai.md

* a new screen capture

* push Marty's feedback to fork

Final changes.

* updates sandbox manifest

* updates

* restored sandbox manifest

* Update setup-environment.md

* updates after CloudWorld

* final updates to ai workshop (also new labs 4 and 5)

* marty's feedback

* incorporated feedback

* minor PR edits by Sarah

* removed steps 7 & 8 Lab 2 > Task 3 per Alexey

The customer asked to remove this as it's not a requirement for the bucket to be public.

* more changes

* more changes per Alexey

* Update load-os-data-public.md

* Quarterly QA

I added a new step per the PM's request in the Data Sharing PL/SQL workshop. I also made a minor edit (removed space) in the Data Lake workshop.

* more updates

* Quarterly QA changes

* Update consume-share.md

* minor edit based on workshop user

* quarterly qa November 2023

* Added new videos to the workshop

Replaced 3 old silent videos with new ones. Added two new videos.

* Adding important notes to the two data sharing workshops

Per the PM's request.

* folder structure only  push to production

This push and the PR later is to make sure the folder structure is in the production repo before I start development. Only 1 .md file and the workshops folder.

* typos

* cloud links workshop

* UPDATES

* Update query-view.png

* update

* minor updates to chat ai workshop (Fork)

* test clones

* test pr

* Alexey's feedback

* Update data-sharing-diagram.png

* sarah's edits

* changes to Data Load UI

* removed script causing ML issue

* Update load-local-data.md

* updates: deprecated procedure and new code

* updates and test

* more updates

* minor update

* testing using a building block in a workshop

* updates

* building blocks debugging

* Update manifest.json

* fixing issues

* Update manifest.json

* delete cleanup.md from workshop folder (use common file)

* use common cleanup.md instead of local cleanup.md

* test common tasks

* update data sharing data studio workshop

* Update create-recipient.png

* PM's 1 feedback

* quarterly qa

* missing "Lab 2" from Manifest

* always free note addition

added a note

* always free change

* Update setup-environment.md

* update manage and monitor workshop

* Folder structure for new data share workshop (plus introduction.md)

* Updated Load and Analyze from clone

* Data Lake minor changes from clone

* manage and monitor workshop

* Remove the lab from the workshop per Marty's request

* mark-hornick-feedback

* used marty's setup file

* replaced notebook with a new one

* updates to lab 6 of manage and monitor

* Update adb-auto-scaling.md

* Nilay's feedback

* Update adb-auto-scaling.md

* updates to second ai workshop

* note change

* Changes to Load and Analyze workshop (other minor changes too)

* quarterly qa

* Update diagrams per Alexey (remove delta share icon)

* updated the 15-minutes workshop

* Update analyzing-movie-sales-data.md

* ords updates and misc

* updated data studio workshop

---------

Co-authored-by: Michelle Malcher <[email protected]>
Co-authored-by: Sarah Hirschfeld <[email protected]>
  • Loading branch information
3 people authored Apr 25, 2024
1 parent 0427a26 commit 3f95100
Show file tree
Hide file tree
Showing 56 changed files with 125 additions and 129 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -53,21 +53,11 @@ As the **`training_recipient`**, you can use the activation link URL that was se

![Open the delta share profile file.](images/open-profile.png)

<!--- comment
2. Log out of the `admin` user. On the **Oracle Database Actions | SQL** banner, click the drop-down list next to the `ADMIN` user, and then select **Sign Out** from the drop-down menu. Click **Leave**.
3. Log in as the newly created user, `share_consumer`. On the **Sign-in** page, enter **`share_consumer`** as the username and **`DataShare4ADW`** as the password, and then click **Sign in**.
![Log in as share_consumer](images/login-share-consumer.png)
You are now logged in as the `share_consumer` user. In the **Development** section, click the **SQL** card to display the SQL Worksheet.
--->

## Task 2: Log in as the share_consumer User

1. Log in as the **`share_consumer`** user. On the **Sign-in** page, enter **`share_consumer`** as the username and **`TrainingADW`** as the password, and then click **Sign in**.

2. Scroll-down to the **Data Studio** section, and then click the **DATA SHARE** tile.
2. On the **Database Actions Launchpad** page, click the **Data Studio** tab, and then click the **Data Share** tab.

![click the data share tile.](images/click-data-share.png)

Expand All @@ -83,12 +73,17 @@ To consume a data share, a recipient must have the required network connection t

![click the consume share tile.](images/click-consume-share.png)

2. Click **+ Subscribe to Share Provider**.
2. Click the **+ Subscribe to Share Provider** drop-down list, and then click the **Subscribe to Delta Share Provider** option.

![click Subscribe to Share Provider.](images/click-subscribe-provider.png)

3. In the **Subscribe to Share Provider** wizard, on the **Provider Settings** page, provide the following information:
The **Subscribe to Share Provider** wizard is displayed.

![The Subscribe to Share Provider wizard is displayed.](images/subscribe-wizard.png)

3. On the **Provider Settings** page 1 of the wizard, provide the following information:

* **Share Source:** Accept the default **Delta Share Provider JSON** option.
* **Share Provider JSON:** Accept the **From file** option.
* **Delta Share Profile JSON:** Click this field to display the **Open** dialog box. Navigate to your **Downloads** directory where you downloaded the **`delta_share_profile.json`** file, and then click **Open**.

Expand Down Expand Up @@ -127,7 +122,7 @@ For information about the `DBMS_NETWORK_ACL_ADMIN` package, see the [PL/SQL Pack

![Set ACLs.](images/set-acls.png)

The `admin` user informs the recipient that he or she has access to the **`share_provider`** host machine; therefore, the recipient can now subscribe to the share provider.
The **`admin`** user informs the recipient that he or she has access to the **`share_provider`** host machine; therefore, the recipient can now subscribe to the share provider.

5. Now that you are subscribed to the **`share_provider`** host machine, as the **`share_consumer`** user, on the **Provider Settings** wizard page, click **Next** again.

Expand Down Expand Up @@ -163,11 +158,11 @@ For information about the `DBMS_NETWORK_ACL_ADMIN` package, see the [PL/SQL Pack

![The changed table name is displayed.](images/table-name-changed.png)

4. Click **Start**. A **Start Link from Cloud Store** dialog box is displayed. Click **Run**. When the job completes successfully, a green **Complete** icon with a checkmark is displayed. The **`CUSTOMER_CONTACT_SHARE`** external table is created. Click **Done**.
4. Click **Start**. A **Start Link from Cloud Store** dialog box is displayed. Click **Run**. When the job completes successfully, a link icon is displayed. The **`CUSTOMER_CONTACT_SHARE`** external table is created.

![The link job is completed.](images/link-job-complete.png)

5. Click the **Database Actions | Launchpad** banner, and then select the **SQL** tile from the **Development** section to display the SQL Worksheet.
5. Click the **Database Actions | Data Share** banner. On the **Database Actions | Launchpad**, click the **Development** tab, and then click the **SQL** tab to display the SQL Worksheet.

![Click the banner.](images/click-banner.png)

Expand Down Expand Up @@ -197,11 +192,11 @@ You may now proceed to the next lab.

* **Author:** Lauran K. Serhal, Consulting User Assistance Developer
* **Contributor:** Alexey Filanovskiy, Senior Principal Product Manager
* **Last Updated By/Date:** Lauran K. Serhal, February 2024
* **Last Updated By/Date:** Lauran K. Serhal, April 2024

Data about movies in this workshop were sourced from Wikipedia.

Copyright (C) Oracle Corporation.
Copyright (C) 2024, Oracle Corporation.

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -26,17 +26,17 @@ In this lab, you will:

## Task 1: Navigate to Data Share

1. Make sure you are still logged in as the **share_provider** user. Click **Oracle Database Actions | Launchpad** in the banner to display the Launchpad.
1. Make sure you are still logged in as the **share_provider** user. Click **Oracle Database Actions | Launchpad** in the banner to display the **Database Actions Launchpad** page.

![Click the banner.](./images/click-banner.png " ")

2. Scroll-down to the **Data Studio** section, and then click the **DATA SHARE** tile.
2. Click the **Data Studio** tab, and then click the **DATA SHARE** tab.

![Click the data share tile.](./images/click-data-share.png " ")

>**Note:** If you do not see the **DATA SHARE** card in the **Data Studio** section, it indicates that your database user is missing the required **`DWROLE`** role.
The **Provider and Consumer** page is displayed. The **PROVIDE SHARE** and the **CONSUME SHARE** tools enable you to create a data share as a share provider and to subscribe and consume a data share as a recipient respectively. You can click the [Quick Start Guide](https://docs.oracle.com/en/database/oracle/sql-developer-web/sdwfd/index.html) button to view step by step instructions on how to use Oracle Autonomous Database as a data share provider and as a data share recipient. For the complete Data Share documentation, see [The Data Share Tool](https://docs.oracle.com/en/cloud/paas/autonomous-database/adbsa/adp-data-share-tool.html#GUID-7EECE78B-336D-4853-BFC3-E78A7B8398DB).
The **Provider and Consumer** page is displayed. The **PROVIDE SHARE** and the **CONSUME SHARE** tools enable you to create a data share as a share provider and to subscribe and consume a data share as a recipient respectively. You can click the [Quick Start Guide](https://docs.oracle.com/en/database/oracle/sql-developer-web/sdwfd/index.html) button to view step by step instructions on how to use Oracle Autonomous Database as a data share provider and as a data share recipient. For the complete Data Share documentation, see [The Data Share Tool](https://docs.oracle.com/en/cloud/paas/autonomous-database/adbsa/adp-data-share-tool.html#GUID-7EECE78B-336D-4853-BFC3-E78A7B8398DB). You can also try one of the available Data Sharing LiveLabs workshops.

![The Data Share Home page.](./images/data-share-home-page.png " ")

Expand All @@ -60,65 +60,91 @@ As the **`share_provider`** user, create a new data share named **`training_shar

![Access provide share.](./images/access-provide-share.png " ")

2. On the **Provide Share** page, there are no data shares or recipients initially. Click **Create Share**.
2. On the **Provide Share** page, you must provide the details of the provider before you share the data. The share provider identification will be available to recipients with whom you grant the share. click **Provider Identification** to create a Provider ID to provide information to the recipient on how to identify you.

![Click create share.](./images/click-create-share.png " ")
![Click provider information.](./images/click-provider-identification.png " ")

The **Create Share** wizard is displayed.
The **Provider Identification** panel is displayed.

3. On the **General** page, enter **`training_share`** as the name for the new share, an optional description, and then click **Next**.
3. In the **General** tab, specify the following:

* **Name:** Enter **`training_share`**.
* **Email:** Enter the email address for the provider such as **`[email protected]`**.
* **Description:** Enter a meaningful description of the provider (required).

![The General tab.](./images/general-tab.png " ")

4. Click **Save**. The **Provide Share** page is re-displayed. Initially, there are no data shares or recipients.

![The Provide Share page is displayed.](./images/provide-share-page-redisplayed.png " ")

5. Click **Create Share**. The **Create Share** wizard is displayed.

![Click create share.](./images/create-share-wizard.png " ")

6. On the **General** page, enter **`training_share`** as the name for the new share, an optional description, and then click **Next**.

![The general page.](./images/wizard-general.png " ")

4. On the **Publish Details** page, select the **DELTA\_SHARE\_STORAGE** credential that you created in the previous lab from the drop-down list, and then click **Next**.
7. On the **Publish Details** page, select the **DELTA\_SHARE\_STORAGE** credential that you created in the previous lab from the drop-down list, and then click **Next**.

![The publish details page.](./images/wizard-publish-details.png " ")

5. On the **Select Tables** page, add the **`CUSTOMER_CONTACT`** table that you created in the previous lab to the **`training_share`** data share. In the **Available Tables** section, click the table name, and then click the **Select** (>) icon.
8. On the **Select Tables** page, add the **`CUSTOMER_CONTACT`** table that you created in the previous lab to the **`training_share`** data share. In the **Available Tables** section, click the table name, and then click the **Select** (>) icon.

![Add table to share.](images/add-table-to-share.png)

The **`CUSTOMER_CONTACT`** table is added to the **Shared Tables** section. Click **Next**.

![The table is added.](images/table-added.png)

6. On the **Recipients** page, there are no recipients available initially. Create a new recipient that will consume this data share. Click **New Recipient**.
9. On the **Recipients** page, there are no recipients available initially. Create a new recipient that will consume this data share. Click **New Recipient**.

![Create a new recipient.](images/create-recipient.png)

7. In the **Create Share Recipient** panel, enter **`training_recipient`** as the name of the recipient, an optional description, and the recipient's email address. Next, click **Show Advanced Options**.
10. In the **Create Share Recipient** panel, enter **`training_recipient`** as the name of the recipient, an optional description, and the recipient's email address. Next, click **Show Advanced Options**.

![Create the new recipient and show advanced options.](images/create-recipient-advanced-options.png =50%x*)
![Create the new recipient and show advanced options.](images/create-recipient-advanced-options.png =65%x*)

8. In the **User token lifetime** section, modify the **TOKEN_LIFETIME** for the **`training_user`** recipient to **90** days. This property specifies for how long the generated token will be valid after which the recipient loses access to the data share and must request a new token. Enter **90** in the first text field. Select **Days** from the drop-down menu. Next, click **Create** to create the new recipient.
11. In the **User token lifetime** section, modify the **TOKEN_LIFETIME** for the **`training_user`** recipient to **90** days. This property specifies for how long the generated token will be valid after which the recipient loses access to the data share and must request a new token. Enter **90** in the first text field. Select **Days** from the drop-down menu. Next, click **Create** to create the new recipient.

![Create the new recipient.](images/click-create-recipient.png =50%x*)

9. The new recipient is displayed in the **Create Share** page.
12. The new recipient is displayed in the **Create Share** page.

![The recipient is created.](images/recipient-created.png =60%x*)
![The recipient is created.](images/recipient-created.png =75%x*)

10. Click **Create** to create and publish the data share. The **Provide Share** page is displayed. Two information boxes are displayed briefly to indicate that the share is created and that publishing is in progress. The **training_share** is displayed along with its details such as the entity type, owner, shared objects, and the recipients. Note the status of the share is **Unpublished**. It will take a few minutes to publish it depending on the size of the table in the share.
13. Click the **Email recipient profile download link** icon to email the activation link to the recipient.

![The data share is created.](images/share-created.png)
>**Note:** You can also click the **Copy Profile activation link to clipboard** icon as a backup in case the user didn't get the email.
![Copy activation link to clipboard.](images/copy-activation-link-clipboard.png =70%x*)

11. An email message that will be sent to the recipient is automatically generated and displayed. This email message contains the _personal authorization profile_ (activation link) URL that the recipient will use to download the **`delta_share_profile.json`** configuration file. This file is required to access the data share in the next lab. In our example, we are using Microsoft Outlook as the email client. Click **Send** to send the email to the recipient.
14. An email message that will be sent to the recipient is automatically generated and displayed. This email message contains the _personal authorization profile_ (activation link) URL that the recipient will use to download the **`delta_share_profile.json`** configuration file. This file is required to access the data share in the next lab. In our example, we are using Microsoft Outlook as the email client. Click **Send** to send the email to the recipient.

![Click send email.](images/activation-email.png)

12. After a few minutes, click the **Reload** icon to refresh the page. The status of the **training_share** is now **Published**.
The recipient gets the email with the activation link.

![Recipient recieves email.](images/recipient-activation-email.png)

15. In the **Create Share** wizard, click **Create** to create and publish the data share. The **Provide Share** page is displayed. Two information boxes are displayed briefly to indicate that the share is created and that publishing is in progress. The **training_share** is displayed along with its details such as the entity type, owner, shared objects, and the recipients. Note the status of the share is **Unpublished**. It will take a few minutes to publish it depending on the size of the table in the share.

![The data share is created.](images/share-created.png)

16. After a few minutes, click the **Reload** icon to refresh the page. The status of the **training_share** is now **Published**.

![The data share is published.](images/share-published.png)

13. Click the **RECIPIENTS** tile. The **`training_recipient`** is displayed along with its details.
17. Click the **RECIPIENTS** tile. The **`training_recipient`** is displayed along with its details.

![Click the recipients tile.](images/click-recipients-tile.png)

When you publish a `versioned` share type, the tool generates and stores the data share as `parquet` files in the specified bucket such as `data-share-bucket` in our example. Any authenticated data share recipient can directly access the share in that bucket.

![Versioned share type.](images/versioned-share-type.png)

14. Log out of the **`SHARE_PROVIDER`** user. On the **Oracle Database Actions | Data Share** banner, click the drop-down list next to the `SHARE_PROVIDER` user, and then select **Sign Out** from the drop-down menu. If you are prompted to leave, click **Leave**.
18. Log out of the **`SHARE_PROVIDER`** user. On the **Oracle Database Actions | Data Share** banner, click the drop-down list next to the `SHARE_PROVIDER` user, and then select **Sign Out** from the drop-down menu. If you are prompted to leave, click **Leave**.

You may now proceed to the next lab.

Expand All @@ -132,11 +158,11 @@ You may now proceed to the next lab.

* **Author:** Lauran K. Serhal, Consulting User Assistance Developer
* **Contributor:** Alexey Filanovskiy, Senior Principal Product Manager
* **Last Updated By/Date:** Lauran K. Serhal, February 2024
* **Last Updated By/Date:** Lauran K. Serhal, April 2024

Data about movies in this workshop were sourced from Wikipedia.

Copyright (C) Oracle Corporation.
Copyright (C) 2024, Oracle Corporation.

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 3f95100

Please sign in to comment.