TeamShare API

Reference Guide

Last updated: 1860219 MJa~~nuary~~y 20010

Dear Customer,

This document describes TeamShare’s database schema and Application Programming Interface (API) for TeamTrack.

With TeamTrack 4.0, we have opened our API to our customers to be used to safely modify TeamTrack databases. Through the database you can extend TeamTrack functionality to meet your company needs. Using the schema is a great means to read and report on information collected through TeamTrack that is not readily available through standard reporting. While this document is available upon customer request, we recommend using the schema only to report on data that is not easily accessible via TeamTrack. Modifications to the database should only be performed using the TeamTrack administrator or our Application Programming Interface (API).

Database

The TeamTrack database is stored in an underlying relational database. This document describes the tables, columns, and relationships of the database. This information should be used cautiously. Please note, TeamShare Customer Support does not support backend modifications. Additionally, changes, deletions and modifications performed directly to the database are not recommended as TeamShare reserves the right to modify the schema when necessary to implement new features. Hence changes made directly to the database may not be upward compatible. If a new table or column is added in a future version, any code written to a prior version will not have knowledge of the new tables or columns, and thus may not perform correctly.

Through TeamTrack, important information is captured in the database. Companies may have unique needs to gather, organize and analyze this data. While keeping in mind the schema may change with new releases of the product, it is safe to use this information to read and display data from the database. For example, you may wish to write a custom report that processes issues in a special way or you may want to capture time metrics (historical data) using the TS_CHANGES table. This document will aid you in creating reports of this nature and more.

Application Programming Interface (API)

TeamShare recommends performing database modifications through the Administrator or by creating an application which uses the API. Alterations that can not be done through the Administrator should be performed through the API. TeamShare makes best efforts to ensure upward compatibility should database changes be performed in this manner. The API is available to all TeamTrack customers.

The TeamShare API is written in C++. Using the API, modification to the database can now be done safely. Applications can be written to this API, which import and export data between TeamShare applications and other application programs. C++ programming experience is required to create an application using this class library. Please note, TeamShare does not support the API through its standard Customer Support contract. API support will be available in time-blocks through our Professional Services Group (PSG). PSG staffs expert C++ developers who are available to support and/or develop these applications to meet your needs. Should assistance be required in creating or understanding API classes, please contact your sales executive.

For more information about securing PSG services to support and/or develop API applications to meet your needs, contact your TeamShare account manager.

Thank you,