This documentation page will show you how to use the Planon connector and how to configure it.
Table of ContentsCopy Scope4mation.jar to Planon Directory
Copy Scope4mation.jar to Planon DirectoryTo be able to read data from Planon within ETL+, we developed a small Java file that can connect to Planon to retrieve data. The so-called JAR-file is included in the DM-package. You can find the file in APPDIR\DMETL\Scope4mation.jar. For it to work properly, it needs to be copied into the services folder of Planon (on the Planon server). In our case, that location can be found here: C:\Planon\PlanonEE201311\Server\tomcat-7.0.57\webapps\nyx\WEB-INF\services. Be sure to paste the Scope4mation.jar file there before continuing.
Establishing a connection with PlanonOnce the Scope4mation.jar file is in place, we can go ahead and establish a connection with Planon using ETL+. Before we establish the connection to Planon, we need to create the Physical Datasource first. This is the database that Planon uses to store data. So start by adding an SQL Server Connector. From the top menu, select Tools > Settings > Connectors tab > Add. (See Figure 1).
Figure 1: Adding an SQL Server Connector
- Give an appropriate name to the connector, in this case, we use Planon Datasource.
- Fill in or select the server where Planon is running, since we need the PlanonProd DB for the connection.
- Fill in the username and password that have read and write access to that database.
- Select the database that you want to connect to, in this case it's PlanonProd like described above.
Figure 1a: Filling in informationNow we can go ahead and create the Planon Connector. You can do that by selecting > Tools > Settings > Connect tab > Add. (See Figure 2).
Figure 2: Adding the Planon ConnectorOnce you click on OK, Figure 3 will popup. This screen has a couple of properties that we will go through one-by-one. Datasource name The Datasource name is a label within ETL+ to show what Datasource is used. So make sure it's a logical and appropriate name. For this case, we used 'Planon Connector'. Physical Datasource With this property you can select one of the connectors within ETL+ to use as Datasource. In the previous step we created this datasource, so go ahead and select it. Default owner This property can be used to show data that belongs to an owner. If you leave this field blank, it will show all data regardless of it's owner. Server This is the hostname of the server where Planon is running. Port [opt] This is the port that Planon uses to run on. In this case we will use port 18070, but this can be different in your environment. Planon User Here you can specify the username that you need to login to Planon with. Planon Password Use the password that corresponds to the username at the Planon User field. Language Here, you can select the language of the Planon Server. Use Planon English or System (if available). Administration Select the Administration you need to use. These are configured within Planon itself. Note: If the Administration field is not instantly filled with options, make sure that the information above the Administration field are correctly entered (you can do this by clicking on the "Test webservice" and the "Test datasource" buttons). Then click the 'OK' button to close the window, then select it in the Connectors List and click on Modfy. The same screen will popup, but with the data already filled in. If all the data is filled in correctly, the Administration dropdown list should be filled and you should be able to select one. Enable unsupported entities If you check this box, all data that Planon gathers will be available within ETL+. When unchecked, it will only return the CMDB data. Please be aware that even though this functionality is available, it is not thoroughly tested and can result in unexpected behavior. Include archived entities Within Planon, it is possible to archive information. This option allows you to neglect this data, if you leave it unchecked. But if you check this box, the archived data will also be available within ETL+.
Figure 3: Configuring the Planon ConnectorOnce you have filled in the required data, you can hit the "Test webservice" button to test the Webservice and you can test the datasource by clicking on "Test datasource" If both return a successful message, it means that all connections are configured correctly. Click the "OK" button to add the Planon Connector to the list of connectors. You will be prompted to confirm the password, it's the same as you filled in at the Planon Password field. This is done for security purposes (See Figure 4). Fill in the password and click "OK" to continue.
Figure 4: Re-enter password for security purposes.Now you have successfully added the connector that you can use within solutions.
How to use the Planon Connector in a solutionOnce you have added the connector like described above, it's time to create a solution. Let's create one by clicking on File > New Solution. (See Figure 5)
Figure 5: Create a new solutionGive the solution an appropriate name and click "OK". Add a diagram and also give that an appropriate name (you can find it under Import at the left side of the screen). Now you see a dropdown box on the Diagram, this defines what the datasource is for the particular diagram. Select the Planon Connector to use the Planon Connector we just created. Now double click on the title bar of the diagram. In the diagram, you can see that there is a huge list of tables (We used the standard Planon Demo Data as an example). Select the table you want to use within ETL+ and select the column you want to import by checking the Visible checkbox. Then click on the Import button and after that on the View Last button to see the result on the bottom of the screen (See Figure 6). The data is now imported and can be used within Data Manager.
Figure 6: Importing a table from PlanonNote: If there are a lot of columns, checking all checkboxes could lead to an SQL error saying that the query that you tried to execute was to long (more than 8000 characters). This is an SQL limitation, so you will have to uncheck checkboxes to make sure the query is less than 8000 characters. Related topics:
IntroductionOn this page, we will give an example on how to perform a consolidation with the Planon.
Planon ProCenter Consolidation
- Create the Planon Connector
- Create a new solution by going to File > New Solution
- Give it an appropriate name and click OK.
- Choose Diagram from the input menu
- As a datasource, select the Planon Connector you've created
- Go inside the diagram by double-clicking on the title bar
- Select which table you want to use. We chose 02.01.01.05, Switch
Figure 1: adding a table to diagramAs an example we selected 1 attribute; Code (You need unique values to create a mapping). Hit the Import button and View Last button at the top of ETL (See Figure 2).
Figure 2: Import and View LastGo back to into the solution by clicking on the Solution button on the top bar.
- Choose Planon ProCenter from the consolidation column at the left.
- Set the datasource to the Planon Connector.
- Double-click on the title bar to go inside the consolidation.
Figure 3: Mappings screenFirst, we need to select what the source and what the target is of our consolidation. We can set that with the 2 dropdown boxes that are found at the top of the Mappings window. This consolidation needs the high performance logic, so:
- Check Advanced - high performance compare logic
- Click the Auto Mappings button
- Click Close to close the Mappings window
- Click on Import to import the records
- Now click on Compare to compare
Figure 4: Consolidation buttonsYou've done a simple consolidation!