diff --git a/docs/auto-discovery/autodisc-best-practices.mdx b/docs/auto-discovery/autodisc-best-practices.mdx index eb563693e..5d19f66c2 100644 --- a/docs/auto-discovery/autodisc-best-practices.mdx +++ b/docs/auto-discovery/autodisc-best-practices.mdx @@ -7,7 +7,7 @@ sidebar_position: 5 Device42 automates a significant portion of your IT infrastructure with agentless, automated, device discovery tools to build an accurate picture. The discovery tools work seamlessly in the background to collect inventory data and populate the Device42 Configuration Management Database (CMDB). -Autodiscovery is based on your unique requirements and can be scheduled to keep your CMDB updated. The process isn't network-load intensive because autodiscovery only collects and reports inventory data. You can schedule many autodiscoveries in a day or even in an hour. The autodiscovery frequency depends on the amount of change occurring in the data center, with more change requiring more frequent autodiscovery jobs. +Autodiscovery is based on your unique requirements and can be scheduled to keep your CMDB updated. The process isn't network-load intensive because autodiscovery only collects and reports inventory data. You can schedule many discoveries in a day or even in an hour. The autodiscovery frequency depends on the amount of change occurring in the data center, with more change requiring more frequent autodiscovery jobs. ## Initial Discovery Sequence @@ -19,7 +19,7 @@ While the discoveries can be run in any order, Device42 suggests the following o **Windows/Linux/Hyper-V:** Brings in Windows, Linux, and Hyper-V machine data. -**Cloud autodiscovery:** Brings in virtual machine and storage data from Amazon Web Services, Microsoft Azure, Cloudstack, OpenStack, and numerous other platforms. +**Cloud autodiscovery:** Brings in virtual machine and storage data from Amazon Web Services, Microsoft Azure, OpenStack, and numerous other platforms. **Blade:** Blade server autodiscovery identifies the blade chassis, S blade servers, and their location within the chassis. By matching serial numbers to previously discovered data, Device42 builds a comprehensive blade database. diff --git a/docs/integration/external-integrations/freshservice-integration/customize-freshservice.mdx b/docs/integration/external-integrations/freshservice-integration/customize-freshservice.mdx index c26e60483..eec5fc4e8 100644 --- a/docs/integration/external-integrations/freshservice-integration/customize-freshservice.mdx +++ b/docs/integration/external-integrations/freshservice-integration/customize-freshservice.mdx @@ -14,7 +14,7 @@ This page covers advanced data mapping customization and XML file editing. ## Manage Customization with Newer Releases -The Device42-Freshservice integration ships with a default mapping file. Newer versions of the mapping file may include sending additional elements to Freshservice (such as assets, devices, CIs, and metadata). We share these new additions in the [Freshservice mapping release notes](/release-notes/freshservice-mapping/mapping-4.0). +The Device42-Freshservice integration ships with a default mapping file. Newer versions of the mapping file may include sending additional elements to Freshservice (such as assets, devices, CIs, and metadata). We share these new additions in the [Freshservice mapping release notes](/release-notes/freshservice-mapping/mapping-4.0-changes). If you make an adjustment and use a custom XML file, Device42 will not update the custom XML during updates. diff --git a/docs/integration/external-integrations/odbc-driver-integration.mdx b/docs/integration/external-integrations/odbc-driver-integration.mdx index 5b6dab53a..1c5185f7b 100644 --- a/docs/integration/external-integrations/odbc-driver-integration.mdx +++ b/docs/integration/external-integrations/odbc-driver-integration.mdx @@ -3,13 +3,11 @@ title: "ODBC Driver Integration" sidebar_position: 20 --- -## Device42 ODBC driver +The Device42 ODBC driver allows users to connect to Device42 and pull data externally as an ODBC (Open Database Connectivity) data source. The current ODBC driver installs on Microsoft Windows, and Device42 provides instructions to leverage both generic ODBC connectivity, and to connect Microsoft PowerBI to your Device42 ODBC datasource below. -The Device42 ODBC driver allows users to connect to Device42 and pull data externally as an ODBC \[Open Database Connectivity\] data source. The current ODBC driver installs on Microsoft Windows, and we provide instructions to leverage both generic ODBC connectivity, and to connect Microsoft PowerBI to your Device42 ODBC datasource below. +**Download the Device42 ODBC driver** _(which should work with many ODBC-compatible consumers)_ directly from the [Device42 Miscellaneous Tools Download page](https://www.device42.com/miscellaneous-tools/). -**Download the Device42 ODBC driver** _\[which should work with many ODBC-compatible consumers\]_ directly from the [Device42 Misc. Tools DL page](https://www.device42.com/miscellaneous-tools/). - -### ODBC system requirements +## ODBC System Requirements System requirements for connecting to Device42 via ODBC are as follows: @@ -17,27 +15,27 @@ System requirements for connecting to Device42 via ODBC are as follows: - A host system for the D42 ODBC driver running Microsoft Windows. - PowerBI software to follow the tutorial below to connect to the Device42 ODBC data source. -### Installing the Device42 ODBC driver +## Installing the Device42 ODBC Driver -To install the Device42 ODBC driver, download the .exe installer from https://device42.com and double click to install on a Microsoft Windows-based instance. Simply follow the instructions on the screen, clicking "Next" until you see "Installation Complete", indicating you have finished installing the Device42 ODBC data source driver: +To install the Device42 ODBC driver, download the .exe installer from https://device42.com and double-click to install on a Microsoft Windows-based instance. Follow the instructions on the screen, clicking **Next** until you see **Installation Complete**, indicating you have finished installing the Device42 ODBC data source driver: ![ODBC Driver Installation complete Windows](/assets/images/ODBC_driver_install_complete.png) -## Connecting PowerBI to the Device42 ODBC datasource +## Connecting PowerBI to the Device42 ODBC Datasource Device42's ODBC driver works to connect Microsoft PowerBI directly to your Device42 CMDB. For details on using PowerBI with Device42's ODBC driver, see the [Microsoft PowerBI Integration documentation](integration/external-integrations/powerbi-integration.mdx). ## Creating a DSN -1. To create / pre-define a DSN (Data Source Name), open the Windows ODBC Data Source Administrator via the Windows Start Menu. Windows 10: click **_Start -> Windows Administrative Tools -> ODBC Data Sources (64-bit)_**; \[note there is also a 32-bit version, which you can ignore\]. Windows 7: Click **_Start -> All Programs -> Administrative Tools -> Data Sources (ODBC)_**: +1. To create or pre-define a DSN (Data Source Name), open the Windows ODBC Data Source Administrator via the Windows Start Menu. **Windows 10:** Click **Start > Windows Administrative Tools > ODBC Data Sources (64-bit)** (note there is also a 32-bit version, which you can ignore). **Windows 7:** Click **Start > All Programs > Administrative Tools > Data Sources (ODBC)**: ![ODBC Datasource Admin](/assets/images/ODBC_Datasource_Administrator.png) -2. Click the **Add** button to begin adding a new datasource. In the "Create New Data Source" window that is displayed, choose the "Device42 ODBC Driver" and click "Finish": +2. Click the **Add** button to begin adding a new datasource. In the **Create New Data Source** window that is displayed, choose **Device42 ODBC Driver** and click **Finish**: ![Add Device42 ODBC Driver DSN](/assets/images/add_device42_ODBC_driver_source.png) -3. On the "Device42 ODBC Driver DSN Configuration" screen that is displayed, enter values as explained below: +3. On the **Device42 ODBC Driver DSN Configuration** screen that is displayed, enter values as explained below: ![Device42 DSN configuration](/assets/images/DSN_Configuration_Screen.png) @@ -47,81 +45,85 @@ Device42's ODBC driver works to connect Microsoft PowerBI directly to your Devic - **Username**: The username you use to login to Device42. - **Password**: The password you use to login to Device42. -4. Click the “Test” button to try connecting using the information you specified. You will receive a message if the connection could or could not be made. If the connection could not be made, verify that the information you entered is correct. -5. Click the “Save” button to save the changes you made to the DSN. Your changes will only be saved if the information entered results in a successful connection. If the connection could not be made, verify that the information you entered is correct. +:::note +The ODBC connection requires a valid SSL certificate on your Device42 instance, otherwise the connection will error out. If you're using Device42 for internal use only and don't have a valid certificate, you can upload a self-signed certificate to your Main Appliance and restart the service to get the ODBC connection working. +::: + +4. Click the **Test** button to try connecting using the information you specified. You will receive a message if the connection could or could not be made. If the connection could not be made, verify that the information you entered is correct. +5. Click the **Save** button to save the changes you made to the DSN. Your changes will only be saved if the information entered results in a successful connection. If the connection could not be made, verify that the information you entered is correct. Setup of the Device42 ODBC DSN is complete. You should now be able to utilize the pre-configured DSN throughout PowerBI. -* * * +--- ## Importing Data into MS SQL Server -Using the Device42 ODBC driver, it is possible to import data directly into SQL Server. The following procedure will facilitate a data import. \[The following instructions are for Windows 10 and may be differ from other versions of Windows.\] +Using the Device42 ODBC driver, it is possible to import data directly into SQL Server. The following procedure will facilitate a data import. (The following instructions are for Windows 10 and may differ from other versions of Windows). -### Import Pre-requisites +### Import Prerequisites 1. Begin by copying the Mapping files (The mapping files control how data types from the Device42 ODBC Driver map to Microsoft SQL Server data types). -2. Start the SQL Server Import and Export Wizard -3. Start Task Manager. -4. Browse to the location of the SQL Server Import and Export Wizard executable. Right click on the app executable (it will be named similar to “SQL Server Import and Export Wizard”. Note that the name may end with “32 bit” or “64 bit” and the .exe file extension. +2. Start the **SQL Server Import and Export Wizard**. +3. Start **Task Manager**. +4. Browse to the location of the **SQL Server Import and Export Wizard** executable. Right-click on the app executable (it will be named similar to **SQL Server Import and Export Wizard**). Note that the name may end with "32 bit" or "64 bit" and the .exe file extension. ![Browse to the SQL import export wizard](/assets/images/DTSWizard.exe-explorer.png) - 1. Click “Open file location” and go up one level to the “DTS” folder. - 2. Go into the “MappingFiles” folder. + 1. Click **Open file location** and go up one level to the `DTS` folder. + 2. Go into the `MappingFiles` folder. 3. Open another instance of Windows Explorer. - 4. Go to C:\\Program Files\\Device42\\Device42 ODBC Driver\\MS SQL Server Mapping Files. - 5. Copy files D42ODBCToMSSql10.XML and D42ODBCToSSIS10.XML from C:\\Program Files\\Device42\\Device42 ODBC Driver\\MS SQL Server Mapping Files and paste them in the “DTS\\MappingFiles” folder of the SQL Server Import and Export Wizard that you found earlier. - 6. Close the SQL Server Import and Export Wizard. The mapping files that were just copied will not take effect until the SQL Server Import and Export Wizard is restarted. + 4. Go to `C:\\Program Files\\Device42\\Device42 ODBC Driver\\MS SQL Server Mapping Files`. + 5. Copy files `D42ODBCToMSSql10.XML` and `D42ODBCToSSIS10.XML` from `C:\\Program Files\\Device42\\Device42 ODBC Driver\\MS SQL Server Mapping Files` and paste them in the `DTS\\MappingFiles` folder of the **SQL Server Import and Export Wizard** that you found earlier. + 6. Close the **SQL Server Import and Export Wizard**. The mapping files that were just copied will not take effect until the **SQL Server Import and Export Wizard** is restarted. ### SQL Server Data Import Procedure Note: These instructions are for SQL Server Management Studio v17.9.1 and may differ from other versions of SQL Server Management Studio. -1. Start the SQL Server Import and Export Wizard; You will see the following screen and can press NEXT: +1. Start the **SQL Server Import and Export Wizard**. You will see the following screen and can press **Next**: ![SQL Server import export wizard welcome](/assets/images/welcome_to_SQL_import_export_wizard.png) -2. Select a data source of “.Net Framework Data Provider for ODBC”: +2. Select a data source of **.Net Framework Data Provider for ODBC**: ![Choose a Data Source](/assets/images/Choose-data-source.png) -3. Enter a connection string or DSN for the Device42 ODBC Driver and then click the “Next” button. -4. Select a destination of “SQL Server Native Client 11.0”: +3. Enter a connection string or DSN for the Device42 ODBC Driver and then click the **Next** button. +4. Select a destination of **SQL Server Native Client 11.0**: ![Choose destination SQL native client](/assets/images/choose-destination.png) 5. Enter the server and database to import the data to, plus appropriate authentication details with proper permissions. -6. Choose how you'd like to select Device42 data -- From a table/view, or using a query, then click "Next": +6. Choose how you'd like to select Device42 data – from a table or view, or using a query, then click **Next**: ![Copy data from table/view or from a query](/assets/images/specify-table-or-query.png) -7. **If you selected “Write a query to specify the data to transfer”**, then go ahead and enter your query _(otherwise, skip this step)_: +7. **If you selected “Write a query to specify the data to transfer”**, then go ahead and enter your query _(otherwise, skip this step)_: ![Provide source query](/assets/images/provide-source-query.png) -8. **If you selected “Copy data from one or more tables or views”**, select the views you'd like to copy: +8. **If you selected “Copy data from one or more tables or views”**, select the views you'd like to copy: ![Select Source Tables and Views](/assets/images/select-source-tables.png) -9. Click the “Edit Mappings” button to review/change which data will be copied (you can select a destination of “” if you do not want to copy a column) and attributes of the destination column such as data type. +9. Click the **Edit Mappings** button to review or change which data will be copied (you can select a destination of "" if you do not want to copy a column) and attributes of the destination column such as data type. ![Column Mappings window](/assets/images/column-mappings.png) -10. Close the “Column Mappings” window, and then Click the “Preview” button to see a sample of the data that will be copied: +10. Close the **Column Mappings** window, and then click the **Preview** button to see a sample of the data that will be copied: ![Preview data to be copied](/assets/images/preview-data.png) -11. Close the “Preview Data” window, and then Click the “Next” button to continue. -12. Review the selected data type mappings, and then click the Next button: +11. Close the **Preview Data** window, and then click the **Next** button to continue. +12. Review the selected data type mappings, and then click the **Next** button: ![Review Data Type Mappings](/assets/images/review-data-type-mapping.png) -13. Select if you want to run the data import immediately and/or to save it as an SSIS package: +13. Select if you want to run the data import immediately and or to save it as an SSIS package: ![Run now or Create Save and Run Package](/assets/images/save-and-run-package.png) -14. Click the “Next” button, and Review the selections made in the SQL Server Import and Export Wizard. -15. Click the “Finish” button to complete the wizard. Your data import should be imported according to your chosen settings. +14. Click the **Next** button, and review the selections made in the **SQL Server Import and Export Wizard**. +15. Click the **Finish** button to complete the wizard. Your data import should be imported according to your chosen settings. -_Should you have any questions about the Device42 ODBC driver that aren't answered here, please open a ticket at [https://support.device42.com](https://support.device42.com) or email support@device42.com._ +If you have any questions about the Device42 ODBC driver that aren't answered here, please open a ticket at [https://support.device42.com](https://support.device42.com) or email support@device42.com. diff --git a/docs/release-notes/freshservice-mapping/mapping-3.0.mdx b/docs/release-notes/freshservice-mapping/mapping-3.0-changes.mdx similarity index 99% rename from docs/release-notes/freshservice-mapping/mapping-3.0.mdx rename to docs/release-notes/freshservice-mapping/mapping-3.0-changes.mdx index 624b1cd16..053e68221 100644 --- a/docs/release-notes/freshservice-mapping/mapping-3.0.mdx +++ b/docs/release-notes/freshservice-mapping/mapping-3.0-changes.mdx @@ -1,6 +1,6 @@ --- title: "Changes in Version 3.0" -sidebar_position: 2 +sidebar_position: 3 --- These are the changes to the `mapping.xml` file that version 3.0 has from version 2.0 diff --git a/docs/release-notes/freshservice-mapping/mapping-4.0.mdx b/docs/release-notes/freshservice-mapping/mapping-4.0-changes.mdx similarity index 88% rename from docs/release-notes/freshservice-mapping/mapping-4.0.mdx rename to docs/release-notes/freshservice-mapping/mapping-4.0-changes.mdx index 927bf709b..a95524388 100644 --- a/docs/release-notes/freshservice-mapping/mapping-4.0.mdx +++ b/docs/release-notes/freshservice-mapping/mapping-4.0-changes.mdx @@ -1,6 +1,6 @@ --- -title: "Changes in Version 4.0 (CC5.1.0)" -sidebar_position: 1 +title: "Changes in Version 4.0 (CC 5.1.0)" +sidebar_position: 2 --- The following changes to the `mapping.xml` file are part of the Cloud Connector 5.1.0 release. @@ -38,13 +38,13 @@ Two changes were made within the `D42 VMware VCenter Disk to Freshservice VMware - The `item_id` value in the DOQL query was changed from the following: ``` - resource.details ->> 'uuid' AS item_id, + resource.details ->> 'uuid' AS item_id, ``` To the following: ``` - resource.identifier AS item_id, + resource.identifier AS item_id, ``` - The `WHERE` clause in the DOQL query was updated from the following: diff --git a/docs/release-notes/freshservice-mapping/mapping-5.0-changes.mdx b/docs/release-notes/freshservice-mapping/mapping-5.0-changes.mdx new file mode 100644 index 000000000..6021f1dda --- /dev/null +++ b/docs/release-notes/freshservice-mapping/mapping-5.0-changes.mdx @@ -0,0 +1,51 @@ +--- +title: "Changes in Version 5.0 (CC5.1.2)" +sidebar_position: 1 +--- + +The following changes to the `mapping.xml` file are part of the Cloud Connector 5.1.2 release (CC 5.1.2). + +If you are using a custom mapping.xml file, you need to manually apply these updates. See [Manage Customization with Newer Releases](/integration/external-integrations/freshservice-integration/customize-freshservice#manage-customization-with-newer-releases). + +## Obsolete Field Attributes Removed + +The following field element attributes were removed from all field mappings because null and blank values are no longer sent to Freshservice by default. + +- `not-null` +- `skip-if-null` +- `set-space` + +## Examples + +The examples below show field elements with these attributes removed. + +### Example 1: `set-space` Attribute Removed + +- Version 4.0: + + ```xml + + ``` + +- Version 5.0: + + ```xml + + ``` + +### Example 2: `not-null` and `skip-if-null` Attributes Removed + +- Version 4.0: + + ```xml + + ``` + +- Version 5.0: + + ```xml + + ``` diff --git a/docs/release-notes/freshservice-mapping/mapping-6.0-changes.mdx b/docs/release-notes/freshservice-mapping/mapping-6.0-changes.mdx new file mode 100644 index 000000000..ffad2fa8a --- /dev/null +++ b/docs/release-notes/freshservice-mapping/mapping-6.0-changes.mdx @@ -0,0 +1,37 @@ +--- +title: "Changes in Version 6.0 (CC 5.2.0)" +sidebar_position: 0 +--- + +The following two changes to the `mapping.xml` file were made as part of the Cloud Connector 5.2.0 release (CC 5.2.0). + +If you are using a custom `mapping.xml` file, you need to manually apply these updates. See [Manage Customization with Newer Releases](/integration/external-integrations/freshservice-integration/customize-freshservice#manage-customization-with-newer-releases). + +## Change to the Azure Network Interface Task + +Regarding this Azure Network Interface task: + +```html + +``` + +The DOQL `SELECT` statement of the `` element was changed from: + +```sql +netport.details ->> 'mac_address' AS mac_address, +``` + +To the following: + +```sql +netport.hwaddress AS mac_address, +``` + +## Additional Tasks Added + +Two tasks were added to delete software installations that no longer exist in Device42: + +```xml + + +``` diff --git a/docusaurus.config.js b/docusaurus.config.js index 9b9f132d2..0d6b4a36d 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -63,6 +63,14 @@ const config = { '@docusaurus/plugin-client-redirects', { redirects: [ + { + to: '/release-notes/freshservice-mapping/mapping-3.0-changes/', + from: ['/release-notes/freshservice-mapping/mapping-3.0/'], + }, + { + to: '/release-notes/freshservice-mapping/mapping-4.0-changes/', + from: ['/release-notes/freshservice-mapping/mapping-4.0/'], + }, { to: '/getstarted/getting-started-with-auto-discovery/', from: ['/getstarted/getting-started-with-a-blank-slate/'],