Visual Paradigm Teamwork Server LDAP Authentication

Teamwork Server supports two ways of authentication - built-in authentication and directory server authentication. While the built-in authentication allows you to easily set up and manage member accounts completely inside Teamwork Server, active server authentication allows users to login to Teamwork Server and VP Server with credentials stored in and managed by a directory server.

In order for directory server authentication to work, administrator has to install a utility called DS Connector, and have it configured to connect both VP Server and the directory server. DS Connector acts as bridge between VP Server and directory server. It's capable to synchronize user listing from directory server to VP Server, and to manage the authentication from Visual Paradigm to directory server, through VP Server.

In this page, you will learn how to work with LDAP authentication from creating users in Apache Directory Studio to installing and configuring DS Connector. If you are interested in working with user group instead of user, please read Visual Paradigm Teamwork Server LDAP Authentication (Groups). If you are interested in Active Directory Authentication, please read Visual Paradigm Teamwork Server Active Directory Authentication.

There are series of steps you need to take in order to make LDAP authentication works. Please read through all the steps below without skipping any of them, even if you are familiar with LDAP and Apache Directory Studio.

Step 1 - Creating user account in ApacheDS

In this section you will learn how to create user account in ApacheDS using Apache Directory Studio. It's mainly written for people who are not familiar with ApacheDS. However, even if you are familiar with ApacheDS, be sure to read through the steps as some of the settings will influence the authentication process.

• In LDAP Browser, navigate to the ou=users node under DIT > Root DSE > ou=system.
• Right click on the ou=users node in and select New Entry... from the popup menu.

Adding a new entry via LDAP Browser

• In the New Entry window, keep Create entry from scratch selected and click Next.
• You are prompted to enter one structural object for creating the new user. Select inetOrgPerson as the object class

Selected inetOrgPerson

• Click Add to add inetOrgPerson to the list of selected object classes. You will see a list the object classes from the inetOrgPerson object hierarchy are being added automatically.

inetOrgPerson added to the list of selected object classes

• Click Next.
• For RDN, enter uid=jdoe, where jdoe is a unique shortname of the user you want to add now.

RDN entered

• Click Next.
• Fill in the attributes for jdoe. Enter John Doe as cn.
• Enter Doe as sn.

cn and sn specified

• You can optionally add more attributes for this user. In particular, you may want to supply an email for this user. Doing so allows this user to login to Teamwork Server by entering his/her email address. Without supplying an email, he/she will need to login by entering string like uid=jdoe,ou=users,ou=system as username. If you want to add the mail attribute, click New Attribute... on top of the table, on the right hand side. Then, add and fill in the mail attribute. (note: Make sure you've selected the mail attribute, not email/emailAddress)
• Create a password for this user. Click on New Attribute... as shown in the image below. By the way, be sure to set password for users who will use Visual Paradigm. Users without password won't be able to access the Teamwork Server.

Create an attribute

• In the New Attribute window, select userPassword as Attribute Type.

Selected userPassword as attribute type

• Click Finish.
• Enter the password and click OK.

Password entered

• Click Finish.

 

Step 2 - Downloading DS Connector from VP Server

DS Connector acts as a bridge between VP Server and directory server. In this section you will see how to download DS Connector from VP Server.

• Open a web browser.
• Visit the Teamwork Server URL and login as administrator. Note that the login ID of the default server administrator is Admin.
• Select System Tools from the menu on the left hand side.
• Open the tab Single Sign-On.
• Click on Configure under the section Directory Service Connector.

To configure directory service connector

• Choose the operating system for the machine where ApacheDS is installed.

Choosing the right operating system

• Click Download. Keep the dialog box opened as you will need to copy the key presented in the dialog box when you configure DS Connector in the next section.

Step 3 - Installing and configuring DS Connector

In this section you will install DS Connector, and configure it to make it connect to both VP Server and ApacheDS.

• Copy the downloaded zip file to the machine where ApacheDS is installed.
• Extract the zip file to a folder.

DS Connector (zip) extracted

• Open an elevated command prompt.
  
  For Windows Server 2008 users, click the Start button, type cmd, and then right-click Command Prompt and select Run as administrator from the popup menu.
  
  For Windows Server 2012 users, search cmd in the Apps screen, and then right-click Command Prompt and select Run as administrator at the bottom of the screen.

Run elevated command prompt

• Navigate to DS_Connector_12.1\service where DS_Connector_12.1 is the name of the folder extracted.
• Type the following command to install DS Connector as service:
  install_service.bat

Installing DS Connector as system service

• Run DS_Connector_12.1\DSConnectorUI.exe. Please run it as administrator to avoid any potential issues caused by insufficient write permission.
• When you run DS Connector the first time, you are prompted to configure the connection to VPository/Teamwork Server. In the Configure Server window, click Other and then select VP Server from the popup menu.

To configure connection to VP Server

• Enter the host name and port of VP Server.
• Enter the key, which is the code you saw in the end of the previous section. If you have accidentally closed that dialog box, or if the key has expired, don't worry, just click Configure again (step 5 of the previous section) to obtain another key.

Entering key for server configuration

• Click Connect. If succeed, you should see the message Server configuration succeed.
• DS Connector is now connected to VP Server. Now, you need to configure the connection to ApacheDS. On the left hand side of the DS Connector Console, click Add Directory Server.

To add a directory server

• Select ApacheDS as Directory Server.

Selecting ApacheDS

• Enter a name for this configuration.
• Enter the host name and port of the ApacheDS. As we suggested you to install DS Connector on the machine where ApacheDS is installed, your host name is pretty likely to be localhost or 127.0.0.1. Regarding the port, while the default port of ApacheDS is 10389, you may need to confirm it with your administrator in case it has been changed.
• Enter Bind DN or User. If you use Apache Directory Studio, you can obtain the required value by right clicking on the LDAP connection and selecting Properties from the popup menu. The Bind DN or user can be found under the Authentication tab.

Obtaining the Bind DN or user from Apache Directory Studio

• Enter the password for logging into ApacheDS.

Configuring ApacheDS connection

• Click Test Connection. If succeed, you should see the message Test connection succeed.
• Click Save in the Configure Directory Server window.
• The newly configured directory server is listed on the left hand side of the DS Connector Console. If necessary you can add more directory servers by repeating from step 11 until this step.

Directory server added

Step 4 - Synchronizing users to VP Server

In this section you will add users into DS Connector Console to let it synchronize the users to VP Server. When you finished this section, the chosen users can login Teamwork Server from Visual Paradigm, using the login details managed by ApacheDS.

• Select the directory server in DS Connector Console.

Selecting a directory server

• On the right hand side, click Add.
• In the Add users/group window, select the user(s) to be made available on Teamwork Server. The selected users will become members of Teamwork server, and will have access to Visual Paradigm projects.

Select users to add to DS Connector Console

• Click Add.
• That's it. You can see the selected users listed on the right hand side of the DS Connector Console.

Users added to DS Connector Console

The name and login ID of the selected users will be synchronized to VP Server shortly (~1 minute). Once the synchronization has been completed, you will see the users available in the Members page of VP Server. Note that the synchronization will synchronize only the user name and login ID. It will not synchronize nor to process any password of any users in ApacheDS. Whenever a user tries to login to Teamwork Server from Visual Paradigm, Teamwork Server will communicate with ApacheDS for authentication.

Users synchronized from ApacheDS

So now, you assign the users to projects so that they can open the project from Visual Paradigm and start working. If necessary you can also grant them admin permissions.

To login Teamwork Server from Visual Paradigm, please enter the Email (Login ID) of member as Email (not the display name), and the password stored in ApacheDS as Password.

Login from Visual Paradigm