7pace Timetracker Settings: Reporting & API: Service Account, Reporting & REST API and Access Tokens

Set up your Service Account, view your Reporting API root, confirm reporting page status/health, view team access tokens

Settings - Reporting and API - Service Account

How to set up the "Service Account" for 7pace Timetracker (cloud)

How to set up the "Service Account" for 7pace Timetracker (on-prem)

Configuring Service Account Settings for 7pace Timetracker (on-prem) Using the Configuration Tool

Settings - Reporting and API - Reporting & REST API

REST API

Settings - Reporting and API - Access Tokens

Intro

Under "Settings" -> "Reporting and API" -> "Service Account", you can view the Service Account that been set up for your project.

We created the Service Account to perform requests and display more accurate data on some pages within 7pace Timetracker that would normally not be accessible or viewable to users with more limited permission levels or who do not have access to all projects. Without the Service Account enabled, these users may see one of following error messages display when they open a page within 7pace Timetracker:

• "You don't have access to all projects or some included iterations or work items were deleted. Time calculation may not be accurate."
• "You don't have access to all projects, iterations or work items or some of them were deleted. Please ask your administrator to increase your access level or set up a Service Account in Configuration - Settings."
• On the "Budgets" page, the work items might display as "removed or not available" to users with restricted permissions (these become visible when the Service Account is configured to an account with elevated permissions).

Instead of having to give these team members higher user group rights for all areas of 7pace Timetracker, an administrator can just set up the Service Account to give them a better overall read-only picture of the Budgets page, the Budgets export functionality, the API, and the ability to fetch work item names within the Times Explorer page. 

7pace Timetracker (on-premise)

This is what Service Account Settings look like on the 7pace Timetracker (on-prem) version:

As an administrator, you can configure it in the configuration tool so that all users of the system can view the data that is currently not accessible. Select a user who belongs to the Project Collection Administrator user group in the configuration tool to achieve this.

As an admin, you would set up or change the Service Account in the configuration tool wizard of 7pace Timetracker (see Configuring Service Account Settings for 7pace Timetracker Using the Configuration Tool for more information on this process).  

Configuring Service Account Settings for 7pace Timetracker (on-prem) Using the Configuration Tool

The 7pace Timetracker configuration tool wizard automatically starts after you complete 7pace Timetracker installation. For more information on this initial process, including setting up Service Account the first time, please see the Installation and Configuration section. You can also start this tool later by running the TimetrackerOnline.ConfigTool application, as described in more detailed, below, from the Tools directory in the default location (C:\Program Files (x86)\7pace Timetracker\) of your 7pace Timetracker. 

Important: Please note that the Service Account setting is required in order for server side tracking to work.

Making Changes to Service Account Settings

1. Navigate to the Timetracker Configuration tool in the Tools directory at the default location (C:\Program Files (x86)\7pace Timetracker\) of 7pace Timetracker.

2. In the Service Account field, check the Service Account configured.

Note: A blank status indicates that the Service Account is not configured.

3. In the Service Account field, click the Change Service Account link.

4. Click the appropriate option for the Service Account.

5. If selecting the Custom Service Account option, enter the required username and password for the selected Service Account.

6. Click the Save button to save the changes. 

7pace Timetracker (cloud)

This is what Service Account Settings look like on the 7pace Timetracker (cloud) version:

To use this feature, as an admin, you would click the "Set Myself as Service Account" for all users. Please note that the user account that will be set as the Service Account must be a member of the DevOps Collection Administrator group in order for 7pace Reporting to work.

Once you have set yourself as the Service Account user, 7pace Timetracker automatically detects the configured Service Account and displays the data that would normally not be accessible to all your users. 

Clicking the "Do Not Use Service Account" button clears this option and returns the Budgets page, the Budgets Export functionality, the API, and the ability to fetch work item names within "Times Explorer" back to their default settings (meaning, your team members will once again see what they saw prior to the Service Account being configured, as detailed in the error messages listed, above). If your team members are seeing these messages in areas of 7pace Timetracker that currently support Service Account functionality, as an administrator, set yourself as the Service Account so that these messages disappear.

Reporting API

7pace Timetracker for DevOps Server (on-premise)

7pace Timetracker for DevOps Services (cloud)

REST API

7pace Timetracker for DevOps Server (on-prem)

7pace Timetracker for DevOps Services (cloud)

For our full documentation section on 7pace Timetracker's API, click here. 

Intro

The "Access Tokens" section of 7pace Timetracker's "Settings" page displays information about tokens that you are currently using within 7pace Timetracker for DevOps Services (cloud). Tokens allow users to gain access to 7pace Timetracker for DevOps Services' API, including the Reporting API and Client API, and are used when you pair the Windows Client, for example. 

7pace Timetracker's "Access Tokens" page also allows users and administrators to remove tokens for security reasons in the event that you suspect they were stolen or are being used by someone else (for example, if you prepare an Excel file connected by a token with the Reporting API and then share this file, the token can also be shared and your data could be accessed).

Access Tokens

Admins can view the access tokens of all users of 7pace Timetracker (see screenshot, below) and can also remove the tokens of these users. Non-admin users of 7pace Timetracker can view and remove only their own tokens.