Creating Workspaces

After your administrator satisfies the connectivity requirements for Data Integration, they can create workspaces for your data integration solutions.

A workspace is an organizational construct to keep multiple data integration solutions 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.

Creating a Workspace

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

You can access the Data Integration service under Data and AI in the Console navigation menu.

To create a workspace using the Console:

  1. On the Data Integration Workspaces page, click Create Workspace.
  2. In the Create Workspace panel, enter a name for the workspace in the Name field.
  3. (Optional) For Description, enter a short description for the workspace.
  4. In the Network Connectivity section, select whether or not to enable a Private Network Connection.
  5. If you chose to enable a private network connection, complete the following fields:
    1. For Choose a VCN in <Compartment_Name>, select the VCN for your data integrations.
    2. For 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 Zone, if you entered a DNS Server IP, enter the DNS zone of your source data source.
  6. (Optional) In the Tags section, add tags to help you search for Data Integration resources within your tenancy.
  7. Click Create.
You're returned to the Workspaces page. It may be a few minutes before your workspace is ready for you to access. After it's created and its status is Active, you can select the workspace from the list.

Accessing a Workspace

You can access your workspace from the Workspaces page.

To access a workspace in the Console:

  1. Open the navigation menu and then under Data and AI, select Data Integration.
  2. In the Workspaces list, select the workspace you want to work in.

    You can also select View Details from the workspace's Actions menu.

You're brought to the workspace Home page.

Navigating the Workspace

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

About the Workspace Home Page

The Home page consists of three tiles:

  • Recents: Displays the ten 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, 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 may find helpful while you work with Data Integration.

Accessing Your Data Integration Resources

The Open tab (plus icon) in the tab bar, lets you access Data Assets, Projects, Applications, and Monitor Task Runs. You can also use the navigation links at the top of the Home page. Each resource page opens as a new tab in the tab bar.

Managing Tabs

During your Data Integration session, you may 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 located at the top of the tabs. Breadcrumbs are hyperlinks that help you see where you are in Data Integration and navigate up the hierarchy.

Searching the 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 5 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:

  • Scope: Select an object name to limit the search to a specific project or folder, application or data asset. 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, namely, Application, Connection, Data Asset, Data Flow, Project, Folder, Task, and Run. 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 Integration or data loader task.
  • Created by: Enter a user name to limit the search to a specific user. You can enter system for objects that are created automatically by Data Integration.

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.

Projects and Folders

Projects are organizational constructs 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 these 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

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, Favorite Filter is set to All, which means all resources (not marked and marked as favorite) are shown on the listing page.
  2. Locate the resource you want to mark or unmark.
    You can use the Favorite Filter menu to display only those resources you want to mark or unmark. For example, select Favorite from the filter to show only favorite resources that you can then unmark. Similarly, to mark resources as favorites, select Not Favorite from the filter to show only those resources that are currently not marked. Clicking Clear removes the filter.
  3. Click the star icon in the Favorite column next to the resource you want to mark or unmark.

Editing a Workspace

You can edit the details of a workspace, such as the name or description. You can't edit the identifier, private network connection, compartment, VCN, or subnet selections. To edit the tags applied to a workspace, select Add Tags from the Workspace's Actions menu.

In the Console, you edit a workspace from the Workspaces page. Select Edit from a workspace's Actions menu. Edit the fields you want to change, and then click Save Changes.

Adding Tags to a Workspace

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

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

To add tags to a workspace in the Console:

  1. On the Workspaces page, select a workspace to add tags to, and then select Add tag(s) from the Actions menu.
  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 added to a workspace from its Actions menu.

In the View Tags dialog, you can view both defined and free form tags added to the workspace. For more information, see Resource Tags.

Copying the Workspace OCID

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

To copy the workspace OCID using the Console:

  • 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 tab for a workspace, click the Copy link in the workspace name tooltip.

Moving Workspaces to a Different Compartment

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

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

You can move a workspace to a different compartment from the Workspaces page. Before you can move a workspace, ensure that you add the following policy:

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

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

To move a workspace, select Move Resource from the workspace's Actions menu, choose the compartment to move the workspace to, and then 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. For more information, see Managing Compartments.

Viewing a Workspace's Status

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 will not be billed until you restart it.

To stop a workspace:

  1. On the Workspaces page, locate the workspace you want to stop in the list.
  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 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 there are still active task runs 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 in the workspace's Actions menu.

Starting a Workspace

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

To start a workspace, select Start from the stopped workspace's Actions menu. Confirm that you want to start the workspace, and then click Start. You can access the workspace when the status changes to Active.

Terminating a Workspace

Only workspaces with an Active status can be terminated.

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. Once terminated, a workspace cannot be restored. Be sure to carefully review the workspace and resources before you commit to a termination.

To terminate a workspace in the Console:

  1. Close all open tabs in the workspace you're terminating.
  2. On the Workspaces page, select the workspace, and then select Terminate from its Actions menu.

    You can also click Terminate the workspace's Home page.

  3. In the Terminate Workspace dialog, click Terminate.

You're returned to the Workspaces page and the workspace's status displays Terminating...