Table of contentPrerequisites
TOPdesk ConnectorThis guide will describe 3 steps:
- Creating the connector.
- Importing data to DM-ETL+.
- Consolidation to TOPdesk.
GeneralThis chapter describes how to configure the TOPdesk datasource/connector
- Accessible TOPdesk Application layer and accessible physical TOPdesk database(server). It can be two seperate servers.
- TOPdesk application - Username/password with sufficient rights to meet endgoals intended with use of this connector-definition.
- Physical database - Username/password with sufficient rights to meet endgoals intended with use of this connector-definition.
DetailsThe TOPdesk data source is used for user friendly data collection and for reconciliation of data to TOPdesk (using the TOPdesk Application (Web)Server - DM-ETL+ never writes to the database directly). Multiple TOPdesk connectors to multiple TOPdesk servers are technically supported. The TOPdesk data source is used to collect data from TOPdesk in a very user friendly way. The connector will present TOPdesk entities like "Hardware", "Incidents", as defined in the Data Dictonary of TOPdesk.
Creating the connectorFrom the DM-ETL+ menu select Tools > Settings > Connectors > Add See Figure 1.
Figure 1Select the TOPdesk Datasource Type and Click OK. The following dialog comes up: See Figure 2.
Figure 2Inputs explained
- Datasource name
- The logical name of this data source (we advise to TOPdeskConnector or a similar recognizable name).
- Physical Datasource
- Use the drop down list to select the appropriate logical data source.
- Default owner
- This refers to the database table owner of the TOPdesk tables. By default this is the dbo owner.
- This is the hostname, FQDN or IP number of the TOPdesk Application server.
- Port [opt]
- This setting is optional and refers to the tcp/ip port number of the Top Desk (Web) Application Server.
- If the default port (80) is used this option, you can leave it empty.
- Proxy host [opt]
- This setting is optional and refers to the proxy server that is used.
- Proxy port [opt]
- This setting is optional and refers to the port that the proxy server uses.
- TOPdesk user
- TOPdesk user account that will perform the data exchange actions, like the account Admin.
- The account needs to have enough rights to perform all update and add item actions configured in DM-ETL+ solutions.
- TOPdesk Password
- TOPdesk user account password that corresponds with the TOPdesk user.
Importing data to DM-ETL+This chapter assumes that a TOPdesk connector already is configured as described in the previous chapter. See Figure 3.
- First add a diagram to the solution and select the TOPdesk connector as datasource.
- Then double click the title of the diagram to open the diagram main window.
- Select the table that contains the data to be imported.
- The table will now open in the diagram window.
- Check the Visible checkbox for the columns that contains the data required.
- Press Import And View Last to import and view the data.
- When the required data is selected and imported, click save to save the diagram and go back to the solution.
Consolidation to TOPdesk
GeneralThis chapter will describe the TOPdesk Consolidation Task.
DetailsTo create a TOPdesk consolidation task in the solution window, select the TOPdesk consolidation task from the left and select the TOPdesk connector as the data source. The TOPdesk Consolidation Task makes it possible to compare and maintain TOPdesk data within a DM-ETL+ solution. Differences between the DM-ETL+ Data Source and TOPdesk Target will be visible within the result section. With a TOPdesk Consolidation Task it is possible to:
- Update existing attributes of records already present in TOPdesk.
- Insert new records into TOPdesk.
Figure 5Other Fields that may not contain 'Null' values are defined in the Data Dictionary of TOPdesk. If the column is named 'Null allowed?' and has the value 'no' and the column does not have a default value (Indicated by the value 'yes' in the column 'Has default?'). Then a value must be provided by DM-ETL+. If Field, that needs to be provided by DM-ETL+, is a field with a reference to a value in a other column, then the value of the linked table must be provided. This is indicaded by the columns 'Many-to-one linktable' and 'Many-to-one linkfield' See Figure 6.
Figure 6Important note: The fieldnames displayed in the GUI of TOPdesk are localized labels and therefor not always the same as the fieldnames on tabel/entity level. In the Data Dictonary Report within TOPdesk the 'relation' between label, as displayed in the TOPdesk GUI, and the fieldname on table/entity level is displayed. Be sure that when you are consolidating, the following options are enabled: When you check the mapping properties, make sure the mapping name is set to the same as the Target column:
Figure 7Also, in the fieldmappings editor, make sure you have the checkbox "Advanced - High performance compare logic" checked:
Figure 8Since version 3.15.37201, there's a dropdown menu with 4 options below the Advanced - high performance compare logic checkbox. The options are:
- Default If the source is empty, the consolidation will write as empty.
- Ignore empty If the source is empty, it will be ignored and won't be consolidated.
- Mandatory source When this option is checked, there needs to be data in the source. If not, a record will be added to the exceptions tab.
- Mandatory source or target This option is comparable with the Mandatory source, but with this option selected, the consolidation will also check if the target is already set, if so, the empty value of the source will be ignored. If both the source and target values are empty, a record will be added to the exceptions tab.
The dropdown menu below the Advanced - high performance logic checkbox is a default for all fields. However, it is possible to set a specific handling method for each field. Just click on the mapping name. A new window will popup and the last option on that window will be the error handling dropdown, you can select a specific error handling for that particular field instead of using the default.