Oracle Cloud Infrastructure Documentation

Creating Workspaces

Your administrator can create workspaces for your data integration solutions after the connectivity requirements for Data Integration are satisfied.

Networking documentation:

Creating a Workspace

A workspace is an organizational construct to keep multiple data integration projects and their resources (data assets, data flows, tasks, and so on) separate from each other, helping you to stay organized. For example, you can have separate workspaces for development, testing, and production.

Before you can get started with Data Integration, you or your administrator must first create a workspace for your data integration projects.

Note

  • Ensure that you have the required policies for creating workspaces, as described in Creating Policies. For example, if creating a workspace using virtual cloud network (VCN) resources, you must allow Data Integration access to your VCN in the compartment.

  • Data Integration retains deleted and failed workspaces for 15 days. After 15 days, the workspaces are permanently removed.

    1. Open the navigation menu and click Analytics & AI. Under Data Lake, click Data Integration.
    2. Click Workpaces.
    3. On the Data Integration Workspaces page, select your Compartment, then click Create workspace.
    4. In the Create workspace panel, enter a name for the workspace in the Name field.
    5. (Optional) For Description, enter a short description for the workspace.
    6. In the Network selection section, select Enable private network to use a private network connection to your data sources.
    7. If you choose to enable a private network, complete the following fields:
      1. For Choose a VCN in <Compartment_Name>, select the VCN for your data integrations.
      2. For Choose a Subnet in <Compartment_Name>, select the subnet in the selected VCN for your data integrations.
      3. (Optional) For DNS server IP, enter the domain name system (DNS) server IP of your source data source.
      4. (Optional) For DNS server zone, if you entered a DNS Server IP, enter the DNS zone of your source data source.
    8. (Optional) In the Tags section, add tags to help you search for Data Integration resources within your tenancy.
    9. Click Create.
      Note

      If you have not added the required policies, the creation of workspace fails. In the Unauthorized access information box that appears, click Manage policies to view the details of the required policy statements. Specify the correct group name and compartment in the statements. If you are an administrator, you can add the policies by clicking Add policies. If you are not an administrator, click Copy policies. You can then send these policies to the administrator and get them added.
    You're returned to the Workspaces page. It might take a few minutes before your workspace is ready for you to access. When the status is Active, you can select the workspace from the list.

  • Use the oci data-integration workspace create command and required parameters to create a workspace:

    oci data-integration workspace create [OPTIONS]

    For a complete list of flags and variable options for CLI commands, see the Command Line Reference.

  • Run the CreateWorkspace operation to create a workspace.

Accessing a Workspace

You can access your workspace from the Workspaces page.

    1. In the Console navigation menu, click Analytics & AI.
    2. Under Data Lake, click Data Integration.
    3. Click Workpaces.
    4. On the Workspaces page, select your compartment, and then click the name of the workspace you want to work in.

      You can also select View Details from the Actions menu of a workspace.

    You're brought to the home page of the workspace.

  • Use the oci data-integration workspace get command and required parameters to retrieve a workspace:

    oci data-integration workspace get [OPTIONS]

    For a complete list of flags and variable options for CLI commands, see the Command Line Reference.

  • Run the GetWorkspace operation to retrieve a workspace.

Navigating a Workspace

When you open a Data Integration workspace, you're brought to the home page of the workspace.

About the Workspace Home Page

The workspace home page consists of three tiles:

  • Recents: Displays the 10 most recent Data Integration resources you updated or created in the workspace. Click a resource name to quickly access recent objects such as data assets, data flows, pipelines, design tasks, applications, projects, and folders. A resource with a solid star icon means you have marked the resource as a favorite. See Marking and Unmarking a Resource as Favorite.
  • Quick actions: Displays links to different resources you can create to start planning and designing your data integration solution.
  • Learn: Displays a list of resources that you might find helpful while you work with Data Integration.

Accessing Your Data Integration Resources

Use the Open tab (plus icon) in the tab bar to access data assets, projects, user-defined functions, and Applications in your workspace. You can also monitor metrics in the workspace. Each resource page opens as a new tab in the tab bar.

You can also use the navigation links below the tab bar to access your workspace resources.

Managing Tabs

During your Data Integration session, you might find yourself with several tabs open. Click Manage tabs (gear icon) to search open tabs, navigate to other open tabs, or close tabs.

Using Breadcrumbs

You can navigate within Data Integration using the breadcrumbs at the top of the tabs. Breadcrumbs are hyperlinks that help you see where you are in Data Integration and navigate up the hierarchy.

Viewing Workspace Settings

The Workspace Settings page displays general workspace details, and network resource information, if available.

To view your workspace settings:

  • From the workspace home page, select Settings on the Quick actions tile.
  • Alternatively, select Settings on the navigation links below the tab bar.

Searching a Workspace

The search field on the home page of a workspace lets you search within the entire workspace. By default a search is performed across all projects and folders, applications, and data assets in the workspace.

To allow Data Integration to search within workspaces in your tenancy, define the following policies in the root compartment of your tenancy:

allow service dataintegration to {TENANCY_INSPECT} in tenancy
allow service dataintegration to {DIS_METADATA_INSPECT} in tenancy

In the search field on the home page of a workspace, start a search by entering a search text and pressing Enter. Consider the following when entering a search text:

  • The search text can be a complete or partial text string.
  • The search text is not case-sensitive.
  • You can use * as a wildcard character anywhere in your search text. For example, you can enter *demo* and demo*.
Note

If the search text is part of two consecutive updates to an object and the consecutive updates were performed within five minutes of one another, the search text might not be found if you perform the search right away.

All objects in the workspace that match the search text are retrieved and listed in a report on the Search Results tab, where you can use the filters in the Filters section to refine the search report. The filters are:

  • Search In: Select the scope of a search. You can select an object name to limit the search to a specific project, folder, or application, or all data assets. Select Entire workspace to expand the scope of the search to all projects, applications, and data assets in the workspace.
  • Type: Select All workspace objects to expand the search across all object types, for example, Application, Data Assets, Data Flow, Project, Folder, and Task. Select an object type to limit the search within that type. You can filter by more than one type. Within Data Asset, you can refine the report by a specific data asset type (for example, Oracle Storage Object). Similarly within Task, you can refine the report by a task type such as integration or data loader task.
  • Created By: Enter a user name to limit the search to a specific user. To search for objects that are created automatically by Data Integration, enter system.

After adding filters to a search report, you can enter the complete name of an object in the search field to filter the results by name.

In a search report, you can:

  • Click an object name in the Name column to navigate to the details page for that object.
  • Click the Actions menu for an object to perform the following actions:
    • Select View Details to modify details of the object.
    • Select Delete to delete the object. A confirmation window displays. Type Delete to confirm you want to delete the object and then click Delete.

Using Projects and Folders

Projects are organizational resources within a workspace that you can use to organize your design-time resources, such as tasks or data flows. You can also create folders in a project to further organize the design-time resources into logical groups.

To create, view, or edit projects and folders, click Open tab (plus icon) in the tab bar, and then select Projects. Select a project to view or edit its details and access its folders. Learn more:

Marking and Unmarking a Resource as Favorite

To mark a Data Integration resource as a favorite, use the star icon in the Favorite column on the listing page of the resource.

You can mark any of these resources as favorites in a workspace:
  • Data assets
  • Projects
  • Applications
  • Folders
  • Tasks
  • Data Flows
  • Pipelines

When marked as a favorite, the icon in the Favorite column is displayed as a solid star. To unmark a resource as a favorite, you use the same star icon to change the mark. When a resource is not marked as a favorite, the star icon is clear.

The action of marking a favorite and clearing a favorite is considered as an update to the resource, so the updated resource is added to the Recents tile on the workspace home page.

To mark or unmark a resource as a favorite:

  1. Navigate to the listing page of a resource.
    By default, the Favorite filter is set to All, which means all resources (not marked and marked as favorite) are shown on the listing page.
  2. Click the star icon in the Favorite column next to the resource you want to mark or unmark.
  3. To show only the resources that are marked as favorite, select Favorite from the filter menu.
  4. To remove the favorite filter, select Clear or select All from the filter menu.

Editing a Workspace

You can edit the details of a workspace, such as the name or description.

You cannot edit the workspace identifier. For a workspace where a private network has been enabled, you cannot disable the private network connection, or change the compartment, VCN, or subnet selections.

  • To edit a workspace, in the Workspaces page, select Edit from the Actions menu for the workspace. Edit the fields you want to change, and then click Save Changes.
    Note

    If you have not added the required policies, the modification of workspace fails. In the Unauthorized access information box that appears, click Manage policies to view the details of the required policy statements. Specify the correct group name and compartment in the statements. If you are an administrator, you can add the policies by clicking Add policies. If you are not an administrator, click Copy policies. You can then send these policies to the administrator and get them added.

    To edit the tags applied to a workspace, select View Tags from the Actions menu for the workspace. To add tags, select Add Tags.

    For information about tagging, see Managing Tags and Tag Namespaces.

  • Use the oci data-integration workspace update command and required parameters to update a workspace:

    oci data-integration workspace update [OPTIONS]

    For a complete list of flags and variable options for CLI commands, see the Command Line Reference.

  • Run the UpdateWorkspace operation to update a workspace.

Adding Tags to a Workspace

You can use tags to help you organize the resources in your tenancy.

For information about tagging, see Managing Tags and Tag Namespaces.

To add tags to a workspace:

  1. On the Workspaces page, select Add Tags from the Actions menu for the workspace.
  2. Select a Tag Namespace, and then enter the Tag Key and Value.
  3. (Optional) Click Additional Tag if you want to add more tags.
  4. Click Add Tags when you're done.

Viewing a Workspace's Tags

You can view the tags that have been applied to a workspace.

On the Workspaces page, select View Tags from the Actions menu for the workspace.

For information about tagging, see Managing Tags and Tag Namespaces.

Copying a Workspace OCID

You use workspace OCIDs  to connect to your workspace using REST APIs, SDKs, and CLIs.

To copy a workspace OCID:

  • From the Workspaces page, click the Actions menu for the workspace whose OCID you want to copy and then select Copy OCID.
  • Alternatively from the home page of a workspace, click the Copy link in the workspace name tooltip.

Moving a Workspace to a Different Compartment

You can move Data Integration workspaces from one compartment to another.

When you move a workspace to a different compartment, all Data Integration resources within that workspace, such as data assets, data flows, tasks, and Applications are also moved.

Before you move a workspace, ensure that you add the following policy:

allow service dataintegration to inspect compartments in compartment <target-compartment-name>

The policy ensures that you can check that the target compartment is in a good state after the workspace is moved.

  • You move workspaces from the Workspaces page. For the workspace you want to move, select Move Resource from the Actions menu. Then select the compartment to move the workspace to, and click Move Resource.

    After you move the workspace to the new compartment, inherent policies apply immediately and affect access to the workspace through the Console. See Managing Compartments.

  • Use the oci data-integration workspace change-compartment command and required parameters to move a workspace to a specified compartment:

    oci data-integration workspace change-compartment [OPTIONS]

    For a complete list of flags and variable options for CLI commands, see the Command Line Reference.

  • Run the ChangeCompartment operation to move a workspace to a specified compartment.

Viewing the Status of a Workspace

When you perform an action on a workspace, such as Create, Start, Stop, or Terminate, you can select View Status from the workspace's Actions menu to get a more detailed status update.

In the View Status dialog, you see a progress bar along with the following statuses:

  • Queued: Indicates that your request was accepted but the action hasn't started yet.
  • In Progress: Indicates that the action is being performed.
  • Completed: Indicates that the action was performed and finished successfully.
  • Failed: Indicates that the action failed to complete.

Stopping a Workspace

When you stop a workspace, the workspace and its contents are unavailable to use and you are not billed until you restart the workspace.

    1. On the Workspaces page, locate the workspace you want to stop.
    2. From the Actions menu of the workspace you want to stop, select Stop.
    3. In the Stop workspace dialog, for Wait time for task runs to complete, enter the amount of time in minutes to wait before stopping the workspace.

      The wait time lets any active task run a chance to complete gracefully.

    4. Select Force stop active task runs when wait time expires if you want to enable force stop.
      Caution

      Force stopping an active task run could result in data inconsistencies in the target data entity. If Force stop is not selected, Data Integration attempts to stop the workspace and any active task runs until the wait time expires. If task runs are still active when the wait time expires, the workspace remains active.
    5. Click Stop.
    After the workspace is stopped, you can restart the workspace by selecting Start from the workspace's Actions menu.

  • Use the oci data-integration workspace stop command and required parameters to stop a workspace:

    oci data-integration workspace stop [OPTIONS]

    For a complete list of flags and variable options for CLI commands, see the Command Line Reference.

  • Run the StopWorkspace operation to stop a workspace.

Starting a Workspace

You can restart a previously stopped workspace. When you start a stopped workspace, you acknowledge that Oracle can continue to bill you for workspace use.

    1. On the Workspaces page, locate the stopped workspace that you want to start.
    2. From the Actions menu of the stopped workspace, select Start.
    3. Confirm that you want to start the workspace, and then click Start
    You can access the workspace when the status changes to Active.

  • Use the oci data-integration workspace start command and required parameters to start a stopped workspace:

    oci data-integration workspace start [OPTIONS]

    For a complete list of flags and variable options for CLI commands, see the Command Line Reference.

  • Run the StartWorkspace operation to start a stopped workspace.

Terminating a Workspace

You can terminate any workspace.

When you terminate a workspace, you remove all associated objects and resources:

  • Data Assets
  • Projects
  • Folders
  • Data Flows
  • Tasks
  • Applications
  • Task Runs

All task runs within a workspace must be stopped before you can terminate the workspace. Any open tabs associated with the workspace you're terminating are closed upon termination. After you terminate a workspace, the workspace cannot be restored. Be sure to carefully review the workspace and resources before you commit to a termination.

    1. Close all open tabs in the workspace that you're terminating.
    2. On the Workspaces page, from the Actions menu of the workspace you want to terminate, select Terminate.
    3. In the Terminate workspace dialog, for Wait time for task runs to complete, enter the amount of time in minutes to wait before terminating the workspace.

      The wait time lets any active task run a chance to complete gracefully.

    4. Select Force stop active task runs when wait time expires if you want to enable force stop.
      Caution

      Force stopping an active task run could result in data inconsistencies in the target data entity. If Force stop is not selected, Data Integration attempts to terminate the workspace and any active task runs until the wait time expires. If task runs are still active when the wait time expires, the workspace remains active.
    5. Select Terminate.

    You're returned to the Workspaces page and the status of the workspace changes to Terminating....

  • Use the oci data-integration workspace delete command and required parameters to delete a workspace:

    oci data-integration workspace delete [OPTIONS]

    For a complete list of flags and variable options for CLI commands, see the Command Line Reference.

  • Run the DeleteWorkspace operation to delete a workspace.