diff --git a/content/datahub/getting-started-with-datahub-bundle/accessing-and-logging-in.md b/content/datahub/getting-started-with-datahub-bundle/accessing-and-logging-in.md index 6c04b2424e..bc532eaa55 100644 --- a/content/datahub/getting-started-with-datahub-bundle/accessing-and-logging-in.md +++ b/content/datahub/getting-started-with-datahub-bundle/accessing-and-logging-in.md @@ -15,8 +15,10 @@ Mobile devices like smartphones or tablets are not supported. ### How to log into {{< product-c8y-iot >}} DataHub {#how-to-log-into-datahub} -After the {{< product-c8y-iot >}} DataHub services have been subscribed for your tenant, you must log into your tenant. In the **application switcher** you will find the {{< product-c8y-iot >}} DataHub button. By clicking the button you will be taken to the home page of {{< product-c8y-iot >}} DataHub. The UI provides management and monitoring capabilities for {{< product-c8y-iot >}} DataHub. Alternatively your tenant administrator can give you the URL directly navigating to {{< product-c8y-iot >}} DataHub, which requires a login as well. +After the {{< product-c8y-iot >}} DataHub services have been subscribed for your tenant, you must log into your tenant, using your {{< product-c8y-iot >}} account. In the **application switcher** you will find the {{< product-c8y-iot >}} DataHub button. By clicking the button you will be taken to the home page of {{< product-c8y-iot >}} DataHub. The UI provides management and monitoring capabilities for {{< product-c8y-iot >}} DataHub. Alternatively your tenant administrator can give you the URL directly navigating to {{< product-c8y-iot >}} DataHub, which requires a login as well. As working with {{< product-c8y-iot >}} DataHub requires you to have corresponding [{{< product-c8y-iot >}} DataHub permissions](/datahub/setting-up-datahub/#defining-permissions), you will get a warning after login if you lack those permissions. When you want to log out, click the **User** button at the right of the top bar and select **Logout** from the context menu. + +In addition to your {{< product-c8y-iot >}} account, you have a separate account (which is created during the initial configuration) for accessing Dremio. Contact your administrator for the Dremio account credentials. If required for your use case your administrator can also create additional Dremio users. On the **Home** page under **Next steps**, there is a direct link to the Dremio UI. diff --git a/content/datahub/getting-started-with-datahub-bundle/overview-of-ui-features.md b/content/datahub/getting-started-with-datahub-bundle/overview-of-ui-features.md index 12627f078e..259fc900a3 100644 --- a/content/datahub/getting-started-with-datahub-bundle/overview-of-ui-features.md +++ b/content/datahub/getting-started-with-datahub-bundle/overview-of-ui-features.md @@ -2,13 +2,17 @@ weight: 20 title: Overview of UI features layout: redirect +helpcontent: + - label: status-offloading-jobs + title: Getting an overview of offloading jobs + content: "Once you have configured and started your offloading pipelines, they regularly offload data to the data lake. The overview allows you to quickly check for running, failed, and successful pipelines. These summaries consider for each configured pipeline the corresponding last or current execution. Running and failed pipelines are available in tables, with each entry being linked to the associated job history. Successful pipelines are depicted in a graph, based on their execution time and the number of offloaded records. More details of a successful execution are shown when hovering over an entry or clicking on it, which navigates you to the job history." --- {{< product-c8y-iot >}} DataHub provides the UI for managing and monitoring your offloading pipelines. The main navigation bar at the left provides links to the relevant pages. The access to these pages is restricted and depends on corresponding user roles/permissions as defined in [Defining {{< product-c8y-iot >}} DataHub permissions and roles](/datahub/setting-up-datahub#defining-permissions). | Page | Description | Required role | Prerequisites | --- | --- | --- | --- -| Home | Get an introduction to {{< product-c8y-iot >}} DataHub and access quick links with related functionality | DataHub Reader, DataHub Administrator, or DataHub Manager | - +| Home | Get an introduction to {{< product-c8y-iot >}} DataHub, access quick links with related functionality, or investigate the current offloading status | DataHub Reader, DataHub Administrator, or DataHub Manager | - | Offloading | Configure and manage your offloading pipelines | DataHub Administrator or DataHub Manager | - | Auditing / Query log | View the query log | DataHub Reader, DataHub Administrator, or DataHub Manager | Tracking of usage statistics must be enabled | Auditing / System log | View the system log | DataHub Administrator | - @@ -19,3 +23,9 @@ layout: redirect | Administration / Usage statistics | View usage statistics | DataHub Reader, DataHub Administrator, or DataHub Manager | Tracking of usage statistics must be enabled | Administration / Compaction status | View the latest compaction job status of your offloading pipelines | DataHub Administrator | - | Administration / System status | Check system status | DataHub Administrator | - + +### Home {#home-screen} + +The Home screen is the starting point for working with {{< product-c8y-iot >}} DataHub. **Next Steps** provides a collection of links which directly navigate you, for example, to the Dremio UI or to the offloading configuration form. **Info** provides for the different connectivity options of {{< product-c8y-iot >}} DataHub, like ODBC or JDBC, the corresponding connection details. + +Once you have offloading pipelines configured, the Home screen provides an offloading status overview. The overview is based on the latest execution of each currently configured offloading pipeline. The latest execution has either failed or succeeded or it is still running. Click **Reload** in the action bar to reload the status and refresh the overview. Running and failed pipelines are available in tables. Clicking on a table entry navigates you to the job history of the corresponding offloading pipeline. Successful pipeline executions are depicted in a graph, wich has the execution time on the x-axis and the number of offloading records on the y-axis. You can use that graph to find offloading pipelines with an unexpected behavior. For example, the pipeline offloads a moderate number of records, but requires a very long timespan for the execution. More details of a successful execution are shown when hovering over an entry or clicking on it, which navigates you to the job history. diff --git a/content/datahub/getting-started-with-datahub-bundle/tenant-and-user-settings.md b/content/datahub/getting-started-with-datahub-bundle/tenant-and-user-settings.md deleted file mode 100644 index c5e2e56da3..0000000000 --- a/content/datahub/getting-started-with-datahub-bundle/tenant-and-user-settings.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -weight: 30 -title: Tenant and user settings -layout: redirect ---- - -The {{< product-c8y-iot >}} DataHub instance you have access to is tenant-specific, that means, this instance solely serves your tenant. You use your {{< product-c8y-iot >}} account to access your {{< product-c8y-iot >}} DataHub instance. - -In addition to your {{< product-c8y-iot >}} account, you have a separate account (which is created during the initial configuration) for accessing Dremio. Contact your administrator for the Dremio account credentials. If required for your use case your administrator can also create additional Dremio users. On the **Home** page there is a direct link to the Dremio instance under **Quick links**. diff --git a/content/datahub/working-with-datahub-bundle/monitoring-offloading-jobs.md b/content/datahub/working-with-datahub-bundle/monitoring-offloading-jobs.md index 764184d88e..8647d75db4 100644 --- a/content/datahub/working-with-datahub-bundle/monitoring-offloading-jobs.md +++ b/content/datahub/working-with-datahub-bundle/monitoring-offloading-jobs.md @@ -14,6 +14,8 @@ helpcontent: Once you have configured and started your offloading pipelines, they regularly offload data to the data lake. The {{< product-c8y-iot >}} DataHub UI provides insights into the execution status of the different pipelines so that you can investigate whether everything is running as expected. For the case of offloading failures, you can also configure the offloading pipeline to raise an alarm as described in [Raising alarms](#raising-alarms). +An overview of the offloading status is shown on the [Home screen](/datahub/getting-started-with-datahub/#home-screen), while the details are available in the job history. + {{< c8y-admon-req >}} You need administration or management permissions to access the offloading job histories. See [Defining {{< product-c8y-iot >}} DataHub permissions and roles](/datahub/setting-up-datahub#defining-permissions) for details. {{< /c8y-admon-req >}}