Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 16 additions & 24 deletions docs/reports/reports/advanced-reporting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ sidebar_position: 2
import ThemedImage from '@theme/ThemedImage'
import useBaseUrl from '@docusaurus/useBaseUrl'

Device42's Advanced Reporting engine is a schedulable reporting platform that lets you create reports with visualizations and export the output in different formats. A selection of predefined reports is included, and you can add an unlimited number of user-defined reports.

:::caution
We are primarily invested in **[Standard Reports](standard-reports.mdx)** and **[Insights+](insights-plus.mdx)** and encourage customers to use those first.
We are primarily invested in **[Standard Reports](/reports/reports/standard-reports)** and **[Insights+](/reports/reports/insights-plus)** and encourage customers to use those first.
:::

## Advanced Reporting Engine Overview

Device42's Advanced Reporting engine is a quantum leap forward in functionality. It is a fully incorporated, schedulable BI or reporting platform that lets you create both ad-hoc reports that may include visualizations, and export the output in different formats as desired. A changing selection of predefined reports is included with Advanced Reporting, while an unlimited number may be added under **User-Defined** reports, exported, imported, and shared!

Head to **Analytics > Reports > Advanced Reporting** to get started:
Navigate to **Analytics > Reports > Advanced Reporting** to get started.

<ThemedImage
alt="Advanced reporting screen"
Expand All @@ -24,15 +24,11 @@ Head to **Analytics > Reports > Advanced Reporting** to get started:
}}
/>

Device42's Advanced Reporting engine is extremely flexible, and you can use it to take your reporting to the next level, extracting insight and business intelligence from your infrastructure data.

In this section, you'll learn how to select data and build reports in advanced reporting. If you prefer a video, see [this advanced reporting blog post](https://www.device42.com/blog/2018/04/25/advanced-reporting-video-walk-through/) for a quick advanced reporting walkthrough!
This page covers how to run, customize, schedule, and build advanced reports. For a video walkthrough, see [this advanced reporting blog post](https://www.device42.com/blog/2018/04/25/advanced-reporting-video-walk-through/).

### Running an existing report
### Run an Existing Report

Running an existing report in advanced reporting is fast and easy.

Head to **Analytics > Reports > Advanced Reporting** and expand **Pre-defined reports** on the left by clicking the arrow to show the list of existing reports.
Navigate to **Analytics > Reports > Advanced Reporting** and expand **Pre-defined reports** on the left by clicking the arrow to show the list of existing reports.

1. Choose a report from the list, highlight it, and click the **play icon** to run the report.

Expand Down Expand Up @@ -64,9 +60,9 @@ Head to **Analytics > Reports > Advanced Reporting** and expand **Pre-defined re
}}
/>

### Customizing an existing report
### Customize an Existing Report

Customizing an existing report is easy! Simply make a copy and edit the copy, or double-click any user-created report to edit it directly.
To customize an existing report, make a copy and edit the copy, or double-click any user-created report to edit it directly.

1. To customize an existing report, either right-click or click on the hamburger menu and choose **Duplicate** to make a copy:

Expand All @@ -80,7 +76,7 @@ Customizing an existing report is easy! Simply make a copy and edit the copy, or

2. Now, double-click the report you just copied, make your desired edits, and run as before.

### Scheduling Advanced Reports
### Schedule Advanced Reports

Click the hamburger menu, select **Schedule**, and define the report to send out.

Expand Down Expand Up @@ -112,8 +108,6 @@ To edit the schedule of a report, click the **pencil icon** on the far right of
}}
/>

* * *

## Building a Custom Advanced Report

The following is the basic flow for building an advanced report.
Expand All @@ -129,7 +123,7 @@ The following is the basic flow for building an advanced report.
}}
/>

3. Next, head to the **Filter and sort** tab to configure your sorting and to filter your data.
3. Go to the **Filter and sort** tab to configure sorting and filtering for your data.

<ThemedImage
alt="Filter and sort data"
Expand Down Expand Up @@ -169,19 +163,17 @@ The following is the basic flow for building an advanced report.
}}
/>

### Sorting and Ordering Report Data
### Sort and Order Report Data

Device42 uses joins to handle sorting in Advanced Reporting by matching primary and foreign keys. Note that Advanced Reporting does a pretty good job attempting to set these for you, but for complicated reports, you will have to set or customize the joins yourself. You'll want to create joins that result in the data you care about, consulting the Device42 data dictionary when necessary. Note that each primary key should almost always have a matching foreign key, from being a primary key matching to a foreign key. If you are seeing data that you didn't expect, there may still be joins that need to be modified. Access joins by clicking the **gear icon** and selecting **Joins**.
Device42 uses joins to handle sorting in Advanced Reporting by matching primary and foreign keys. Advanced Reporting attempts to set these automatically, but for complex reports, you may need to set or customize the joins yourself. Consult the Device42 data dictionary when necessary. Each primary key should almost always have a matching foreign key. If you are seeing unexpected data, check whether any joins need to be modified. Access joins by clicking the **gear icon** and selecting **Joins**.

## Use a DOQL Query To Create a Report Dataset

With Device42's Advanced Reporting, you can use DOQL (a SQL derivative) to create your dataset for your report.

To create a report based on a DOQL query, name the report, and then choose **Add SQL** during the **Category** selection step of report creation instead of choosing any categories.

For a full set of steps in more detail, with pictures, see the dedicated [Use Custom SQL in Advanced Report](reports/reports/use-custom-sql-advanced-report.mdx) page.

* * *
For detailed steps, see [Use Custom SQL in Advanced Report](/reports/reports/use-custom-sql-advanced-report).

## Reporting Data Categories

Expand Down Expand Up @@ -209,7 +201,7 @@ You can browse all available categories:

### The Viewer Entity Relationship Diagram (ERD)

The Viewer Entity Relationship Diagram, or ERD for short, is a handy and powerful way to navigate the Device42 database schema. It's useful for visualizing relationships and writing DOQL queries. You can quickly navigate to the ERD from the Advanced Reporting page:
The Viewer Entity Relationship Diagram (ERD) is a visual way to navigate the Device42 database schema. It is useful for understanding relationships and writing DOQL queries. Navigate to the ERD from the Advanced Reporting page.

<ThemedImage
alt="ERD button highlight"
Expand All @@ -219,7 +211,7 @@ The Viewer Entity Relationship Diagram, or ERD for short, is a handy and powerfu
}}
/>

Clicking the **Entity Relationship Diagram** button brings up the ERD. Here is an example screenshot of the ERD. For more information, check out the dedicated [Device42 ERD/Viewer Schema page](reports/device42-doql/db-viewer-schema.mdx).
Clicking the **Entity Relationship Diagram** button brings up the ERD. For more information, see [Device42 ERD/Viewer Schema](/reports/device42-doql/db-viewer-schema).

In this example, the **Find** field contains the search keyword `affinity`, and therefore much of the ERD has been greyed out, while the items that match the `affinity` search query are visible:

Expand Down
14 changes: 8 additions & 6 deletions docs/reports/reports/aws-migration-evaluator.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ sidebar_position: 3
import ThemedImage from '@theme/ThemedImage'
import useBaseUrl from '@docusaurus/useBaseUrl'

You can generate a Device42 AWS Migration Evaluator report from Device42's predefined reports and upload the report to the AWS Migration Evaluator portal. To see a sample report, see the [AWS Migration Business Case](https://d1.awsstatic.com/asset-repository/tso-logic/MigrationEvaluator_TSOLogic_AWS_BusinessCaseSample.pdf).
You can generate a Device42 AWS Migration Evaluator report from Device42's predefined reports and upload it to the AWS Migration Evaluator portal. To see a sample report, see the [AWS Migration Business Case](https://d1.awsstatic.com/asset-repository/tso-logic/MigrationEvaluator_TSOLogic_AWS_BusinessCaseSample.pdf).

To generate the report, follow the steps below.
## Generate the Report

1. Navigate to **Insights+** via the header menu.

Expand All @@ -34,7 +34,9 @@ To generate the report, follow the steps below.

4. Combine the CSV files into a single `.xlsx` file for consumption by AWS. Each tab should be named to match its data.

Migration Evaluator will provide console access to the customer so you can securely upload the data to us for processing.
Migration Evaluator provides console access so you can securely upload the data for processing.

## Upload the Report

Before you upload the Device42 report, you may want to open and edit the `.xlsx` file to:

Expand All @@ -46,10 +48,10 @@ In this example, the Device42 report is named `TSO Logic.xlsx`.
1. In the Migration Evaluator console, select **Discover > Self Reported Files**, and then click **Upload**.
2. Select your Device42 report file, and click **Upload**.

![](/assets/images/WEB-504_AWS-D42-file-import-1.png)
![Migration Evaluator file upload](/assets/images/WEB-504_AWS-D42-file-import-1.png)

![](/assets/images/WEB-504_AWS-D42-file-import-3.png)
![Upload confirmation](/assets/images/WEB-504_AWS-D42-file-import-3.png)

:::tip
To learn more about Migration Evaluator, please visit [https://aws.amazon.com/migration-evaluator/resources/](https://aws.amazon.com/migration-evaluator/resources/).
To learn more about Migration Evaluator, see [https://aws.amazon.com/migration-evaluator/resources/](https://aws.amazon.com/migration-evaluator/resources/).
:::
56 changes: 33 additions & 23 deletions docs/reports/reports/aws-migration-hub.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,15 @@
title: "AWS Migration Hub"
sidebar_position: 4
---

import ThemedImage from '@theme/ThemedImage'
import useBaseUrl from '@docusaurus/useBaseUrl'

You can generate a Device42 AWS Migration Hub report from Device42's predefined reports and upload the report to the AWS Migration Hub portal. Follow the steps below.
You can generate a Device42 AWS Migration Hub report from Device42's predefined reports and upload the report to the AWS Migration Hub portal.

## Generate the Report

- Select **Analytics > Advanced Reporting**, and from the left panel, go to **Pre-Defined Reports > Integrations > Workload Portability**.
1. Select **Analytics > Advanced Reporting**, and from the left panel, go to **Pre-Defined Reports > Integrations > Workload Portability**.

<ThemedImage
alt="Advanced Reporting AWS Migration Evaluation"
Expand All @@ -17,7 +20,7 @@ You can generate a Device42 AWS Migration Hub report from Device42's predefined
}}
/>

- Select the **AWS Migration Hub** hamburger menu, choose **Export As**, and then click **CSV**. This generates and downloads a report — the amount of time required to generate the report depends on how much Device42 data you have.
2. Select the **AWS Migration Hub** hamburger menu, choose **Export As**, and then click **CSV**. This generates and downloads a report — the time required depends on how much Device42 data you have.

<ThemedImage
alt="Advanced Reporting"
Expand All @@ -28,43 +31,50 @@ You can generate a Device42 AWS Migration Hub report from Device42's predefined
/>


After the Device42 AWS Migration Hub report downloads, go to your AWS Console.
## Upload the Report to AWS

After the report downloads, go to your AWS Console.

- Click **Services**, and then search for **Migration Hub**.
1. Click **Services**, then search for **Migration Hub**.

![](/assets/images/WEB-515_AWS-MH-Console-2.png)
![AWS Console services search](/assets/images/WEB-515_AWS-MH-Console-2.png)

- Once you are on the Migration Hub home page, click **Tools**, and then select **Import** on the Discovery Tools page.
2. On the Migration Hub home page, click **Tools**, then select **Import** on the Discovery Tools page.

![](/assets/images/WEB-515_AWS-MH-Console-3.png)
![Migration Hub tools](/assets/images/WEB-515_AWS-MH-Console-3.png)

![](/assets/images/WEB-515_AWS-MH-Console-4-1.png)
![Discovery tools import](/assets/images/WEB-515_AWS-MH-Console-4-1.png)

**Note:** AWS requires that the import file be on an AWS S3 bucket. You must navigate to AWS S3 and upload the Device42 AWS Migration Hub file to an S3 bucket.
:::note
AWS requires that the import file be on an AWS S3 bucket. You must upload the Device42 AWS Migration Hub file to an S3 bucket before importing.
:::

![](/assets/images/WEB-515_AWS-MH-Console-5-Import-3.png)
![S3 upload requirement](/assets/images/WEB-515_AWS-MH-Console-5-Import-3.png)

- Navigate to your AWS S3 console and upload your Device42 AWS Migration Hub file to the appropriate S3 bucket.
- After you have uploaded your Device42 file to the AWS S3 bucket, copy the file's **Object URL** link.
3. Navigate to your AWS S3 console and upload the Device42 AWS Migration Hub file to the appropriate S3 bucket.

![](/assets/images/WEB-515_AWS-MH-Console-6-Import-Object-URL-fromS3-5.png)
4. After uploading the file, copy its **Object URL** link.

- Go back to Migration Hub and paste the object URL in the **Amazon S3 Object URL** field, enter an **Import name**, and click **Import**.
![S3 object URL](/assets/images/WEB-515_AWS-MH-Console-6-Import-Object-URL-fromS3-5.png)

![](/assets/images/WEB-515_AWS-MH-Console-7-Import-URL-OLD-2.png)
5. Go back to Migration Hub and paste the object URL in the **Amazon S3 Object URL** field, enter an **Import name**, and click **Import**.

![Import URL field](/assets/images/WEB-515_AWS-MH-Console-7-Import-URL-OLD-2.png)

The AWS import process starts and displays a list of imports.

![](/assets/images/WEB-515_AWS-MH-Console-8-Import-list.png)
![Import list](/assets/images/WEB-515_AWS-MH-Console-8-Import-list.png)

## View Imported Data

- You can click on the name of the import file to see the imported information in detail.
Click the name of the import file to see the imported information in detail.

![](/assets/images/WEB-515_AWS-MH-Console-9-Import-details.png)
![Import details](/assets/images/WEB-515_AWS-MH-Console-9-Import-details.png)

- You can also click on a name in the **Server Info** column to see details about that particular server, with information about that imported item.
Click a name in the **Server Info** column to see details about that server.

![](/assets/images/WEB-515_AWS-MH-Console-10-Import-details.png)
![Server details](/assets/images/WEB-515_AWS-MH-Console-10-Import-details.png)

- You can also click **Applications** to view information about the applications created in Device42 that were imported.
Click **Applications** to view information about the applications created in Device42 that were imported.

![](/assets/images/WEB-515_AWS-MH-Console-11-Apps.png)
![Applications view](/assets/images/WEB-515_AWS-MH-Console-11-Apps.png)
25 changes: 12 additions & 13 deletions docs/reports/reports/cloud-endure-device42.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ sidebar_position: 5
import ThemedImage from '@theme/ThemedImage'
import useBaseUrl from '@docusaurus/useBaseUrl'

After you have performed your HyperVisors / \*nix / Windows scans and associated your business applications with your devices using the Device42 Business Application functionality, you are ready to prepare for your migration to AWS using CloudEndure.
After performing your Hypervisors, \*nix, and Windows scans and associating business applications with devices using the Device42 Business Application functionality, you can prepare for your migration to AWS using CloudEndure.

Device42 has streamlined the process of conducting cloud migrations to AWS by integrating with the CloudEndure Blueprint. With a few short clicks, Device42 users can assess which workloads have the CloudEndure agent loaded as well as export blueprints for CloudEndure migrations.
Device42 integrates with the CloudEndure Blueprint to streamline cloud migrations to AWS. You can assess which workloads have the CloudEndure agent installed and export blueprints for CloudEndure migrations.

## Here's How It Works
## Assess CloudEndure Agent Status

When performing a migration with CloudEndure, the first step is to ensure the CloudEndure agent is installed on the workloads in scope, which you can easily view from the built-in **CloudEndure Prep** report.
When performing a migration with CloudEndure, first ensure the CloudEndure agent is installed on the workloads in scope. You can check this from the built-in **CloudEndure Prep** report.

- Select **Analytics > Advanced Reporting**.

Expand Down Expand Up @@ -40,19 +40,19 @@ After ensuring the workloads in scope have the CloudEndure agent installed, down
}}
/>

### What Happens Next?
### Run the Mass Blueprint Setter

Once you have generated the CloudEndure **CSV** file from **Advanced Reporting**, you must make sure to download the [Mass Blueprint Setter](https://docs.cloudendure.com/Content/Scripts/CloudEndure%20mass%20blueprints%20setter.zip) script.
After generating the CloudEndure **CSV** file from **Advanced Reporting**, download the [Mass Blueprint Setter](https://docs.cloudendure.com/Content/Scripts/CloudEndure%20mass%20blueprints%20setter.zip) script.

This script requires **Python2.7** to run, and in order to have the blueprint set in CloudEndure, the devices in the **CSV** file must have the CloudEndure agent installed and be connected to your chosen project.
This script requires **Python 2.7**. The devices in the **CSV** file must have the CloudEndure agent installed and be connected to your chosen project.

Before running the script, you must open the CloudEndure CSV file and add the project name in the first column (**projectName**) for each device. Include the relevant name of the matching project for each listed machine.

![](/assets/images/WEB-607_Cloud-Endure-4.png)
![CloudEndure CSV with project names](/assets/images/WEB-607_Cloud-Endure-4.png)

There will also be other blank columns for **iamRole**, **placementGroup**, and others that you can supply in the CSV if you have already made decisions for these values for each machine.

Once the CSV file is prepped, you can then run the **Mass Blueprint Setter** script.
After prepping the CSV file, run the **Mass Blueprint Setter** script.

Use `python CE_Update_Blueprints.py -h` to list all available options:

Expand All @@ -75,10 +75,9 @@ optional arguments:

When ready to run, supply all of the above parameters. If there are any issues when running the script, a `.log` file will be created in the same directory.

Once completed, all the machines in the CSV file that match machines in CloudEndure will have their respective blueprints updated.
When the script completes, all machines in the CSV file that match machines in CloudEndure will have their blueprints updated.

### Reference Links

CE API Docs available with Sample Scripts - [https://docs.cloudendure.com/Content/Getting\_Started\_with\_CloudEndure/API/API.htm](https://docs.cloudendure.com/Content/Getting_Started_with_CloudEndure/API/API.htm)

Download the Mass Blueprint Setter - [https://docs.cloudendure.com/Content/Scripts/CloudEndure%20mass%20blueprints%20setter.zip](https://docs.cloudendure.com/Content/Scripts/CloudEndure%20mass%20blueprints%20setter.zip)
- [CE API Docs with Sample Scripts](https://docs.cloudendure.com/Content/Getting_Started_with_CloudEndure/API/API.htm)
- [Download the Mass Blueprint Setter](https://docs.cloudendure.com/Content/Scripts/CloudEndure%20mass%20blueprints%20setter.zip)
Loading