Klokwork Team Connector

Synchronize the client, project and tasks across your entire organization. Allow users to submit timesheet data to a centralized location. This connector is free when you buy a Klok license. Download now!

Download Now

  • Download v1.1.8
  • Requires Klok 2.3.7 or higher
  • Note: Do not unzip the file. You will install it as a complete package.

Related Products

Installation

To start, download the plugin from the menu to the right. To install the plugin, click on the "Tools" menu at the top of the screen and select the "Preferences" option. On the preferences screen, select the "Plugins" option. Click the "Install connector plugin..." and select the downloaded plugin file and click OK. Once the plugin is installed it will be shown on the "Plugins" screen.

Once installed, you must configure the connector for your environment. To open the connector configuration, click the area at the bottom left corner of the screen which will either say "Offline" or "Connected". The connector panel will open where you will see a "Connector Configuration" link. Click it to view the connector configuration panel. Select whether you want to use Network Path mode or URL mode by selecting the appropriate radio button. Everyone in your organization will use the same mode and path/url. If you are not sure which mode to select, start with Network File Mode.

You may optionally choose to include a device identifier in your configuration. This value will be passed along with the generated data when you submit your time. This may be used by external systems, such as the Klokwork Team Console, to allow time to be submitted from more than one computer or device.

You may also specify whether colors specified within the downloaded projects should overwrite your local colors or not.

Network File Location Configuration
In the Network Path field, enter the network location where the files will be stored. The path should point to the root network folder set up by for your organization. This folder will contain the Projects.xml file and a folder for each user (see the figure to the right). Each user's folder should be named uniquely. The name of their folder will become their username. This folder should be set up by your network administrator such that every user of Klok has read access to the Projects.xml file and write access to their own user folder. The connector also supports user specific Projects.xml files. If a Projects.xml file exists in the user's directory it will be loaded. If not, it will fall back to the global one.

URL Configuration
In the URL field, enter the url which Klok will communicate with to retrieve projects and submit timesheet data. You may configure separate urls for upload and download. The username and password fields should contain the credentials that your server will use to authenticate the request. These credentials will be passed as a Base64 encoded string in the Authorization header. The same credentials will be passed to both the upload and download URLs.

Regardless of which method you choose, the projects data must be returned to Klok in the following format

<klok>
  <projects>
    <project name="Sample Client" color="10092288" billable="false" estimate="0" rate="-1" tags="" description="" code="123" remoteId="1" contactName="" contactEmail="" contactPhone="">
      <project name="Print Ad/Poster" color="10092288" billable="true" estimate="0" rate="-1" tags="" description="" code="123.1" remoteId="2" contactName="" contactEmail="" contactPhone="">
        <project name="Copywriting" color="10092288" billable="false" estimate="0" rate="0" tags="" description="" code="123.1.1" remoteId="3" contactName="" contactEmail="" contactPhone=""/>
        <project name="Design" color="10092288" billable="false" estimate="0" rate="0" tags="" description="" code="123.1.2" remoteId="4" contactName="" contactEmail="" contactPhone=""/>
        <project name="Project Management" color="10092288" billable="false" estimate="0" rate="0" tags="" description="" code="123.1.3" remoteId="5" contactName="" contactEmail="" contactPhone=""/>
      </project>
    </project>
    <project name="Sample Client 2" color="10092288" billable="false" estimate="0" rate="-1" tags="" description="" code="456" remoteId="6" contactName="" contactEmail="" contactPhone="">
      <project name="Website Site" color="10092288" billable="true" estimate="0" rate="-1" tags="" description="" code="456.1" remoteId="7" contactName="" contactEmail="" contactPhone="">
        <project name="Copywriting" color="10092288" billable="false" estimate="0" rate="0" tags="" description="" code="456.1.1" remoteId="8" contactName="" contactEmail="" contactPhone=""/>
        <project name="Design" color="10092288" billable="false" estimate="0" rate="0" tags="" description="" code="456.1.2" remoteId="9" contactName="" contactEmail="" contactPhone=""/>
        <project name="Project Management" color="10092288" billable="false" estimate="0" rate="0" tags="" description="" code="456.1.3" remoteId="10" contactName="" contactEmail="" contactPhone=""/>
      </project>
    </project>
    
  </projects>
</klok>

Latest Release Notes (Full List)