IntroductionOn this connector page we're going to take a look at the TOPdesk 2 Connector. You might have noticed that we have two TOPdesk connectors; TOPdesk and TOPdesk 2. The new connector has a bit more functions compared to the first. New features:
- Support for Friendly Names for the fields in the TOPdesk environment
- Possibility to show a CI on the exceptions tab if there is no source data for some fields
- Define composite sources (as Union)
- Functionality to ignore empty fields in the source
- ID fields don't have to be used anymore (practically at least), but the fields with readable content (i.e. location xyz instead of locationid with GUID) can be used.
TOPdesk 2 Connector
Figure 1: The Connector Properties
Creating the connectorTo create the connector, leave open solutions and select:
- Tools > Settings > Connector [TAB] > Add.
- Select: "Application - TOPdesk 2"
- Click Ok
The Connector properties
|Datasource name||Textbox||This is the name of the datasource that you are creating, we advise to give it a descriptive and appropriate name.|
|Physical Datasource||Dropdown menu||You need to select which datasource to use as a database. Usually an SQL Server connection to the TOPdesk database. This can be any of the created connectors.|
|Default owner||Textbox||Here you can set the default owner of the source (TOPdesk database). In most cases the value must be: dbo|
|Server||Textbox||The hostname or ipaddress of the server where the TOPdesk installation is residing.|
|Port||Textbox||The port that TOPdesk uses to run. Default value: 80|
|Proxy host [optional]||Textbox||If you want to connect to TOPdesk through a proxy, fill in the proxy host here.|
|Proxy port [optional]||Textbox||The hostname or ipaddress of the server where the TOPdesk installation is residing.|
|TOPdesk User||Textbox||Fill in the TOPdesk user that you need to login.|
|TOPdesk Password||Textbox||The password to the corresponding user that you filled in at TOPdesk User.|
|Topdesk 5||Checkbox||If you want to connect to TOPdesk 5, check this checkbox. Leave unchecked if you use a lower version number.|
|Language code||Textbox||Either nl or en. In the folder
|Entity column name||Textbox||The name of the column that will be created to contain the information passed|
|Composite sources||Button||Button that will open the Composites window. This window will be explained in more detail here|
*These files are provided by the TOPdesk installation, below is an explanation on how to retrieve these files.
|Datasource name||TOPdesk 2 Connector|
|Physical Datasource||TOPdesk 2 DataSource|
|Entity column name||Entity|
Figure 2: Composite example
The TOPdesk 2 consolidation needs specific files from TOPdesk itself to function properly. In the /S4M_DM/DMETL/ folder you need to create a new folder called TOPdesk. Within this folder, you need to place 6 files:
- mangocards-[version number*].jar
- tas-[version number*].jar
.../S4M_DM/DMETL/TOPdesklocation. The other files can be found in the TOPdesk directory:
- C:\Program Files\TOPdesk\Enterprise\boot\tasresources.properties
- C:\Program Files\TOPdesk\Enterprise\boot\tasresources_[lang].properties
- C:\Program Files\TOPdesk\Enterprise\lib\tas-5.5.1.jar
- C:\Program Files\TOPdesk\Enterprise\lib\mangocards-5.5.1.jar
.../S4M_DM/DMETL/TOPdesk/you're ready to test the connection. You can test the connection by clicking on the Test datasource button.
- Click OK to close and save the connector screen
Multiple versions of TOPdeskETL+ can handle more versions of TOPdesk at the same time. When you create a TOPdesk connector, make sure the name is unique, for example: TOPdesk6. You can create a new directory in S4M_DM\DMETL\ with the same name as the datasource name, in this case: TOPdesk6. Then paste the files specified above into that folder. You have now successfully created the connector. If you want to know how to perform a consolidation, please check TOPdesk 2 Consolidation.
Object_object_link relationsWhen you have unlinked object_object_link relations, it could happen that the targets aren't properly presented. In that case we have released a fix in version 2.4.1611.1. The fix works like this: Create a CSV file with on each row a target item. It also needs the information to link data together, so you have to define the field id's as well. It could look like this:
link_name1,field1id,field2id link_name2,field1id,field2idIf you want these targets to only be presented with a specific datasource, you must save the CSV with the name
[DataSource Name]_links.csv. If you want the targets to show up regardless of a specific datasource, you must save the CSV under the name
links.csv. NOTE: The records found in the CSV will be appended to the target list. If the item in the CSV already exists in the target list generated from the database, the CSV record will overwrite it.
IntroductionSince this window needs a bit more explaining, it got its own page. The Composite window is a screen where you can select groups of certain entities from TOPdesk. The result will be a table with all entities selected.
How does it work?When you open the window, you'll see something like Figure 1. To create a new source, click on the Add button. A list of all available entities will be displayed in the listbox in the middle of the window. You can give the Composite source a different name by changing it in the textbox below the Composite sources listbox.
Figure 1: Composite WindowYou can select entities one-by-one or hold ctrl to select multiple ones. Use the ">>" button to put the selected entities in the composite. You can remove them by selecting items in the right pane and use the "<<" button to put them back in the Available entities pane (See Figure 2).
Figure 2: Adding entities to compositeOnce you have created all the sources, click OK to apply the changes made. Go to the TOPdesk 2 Connector part.