Perform a Lockdown on Client Options

You can use StarFlow extensions to enable or disable (perform a lockdown on) client options that appear in the Personal Options tab.

Lockdown options

Lockdowns can be applied to the following client options:

File component
Clear Locks On Check-In Give access to change the Clear Locks On Check-In setting.
Use MD5 To Calculate Status Give access to change the Use MD5 To Calculate Status setting.
URL Display Template

Give access to change the display URL. The default format is:

"Project: ~~Project~~ | View: ~~View~~ | ~~Path~~\~~Name~~"
Central Status Dir

Give access to change the Central Status directory, by default:

c:\users\username\AppData\Local\Borland\StarTeam\syncdb

Default Status Method Give access to change the Default Status Method.
Set Active Process Item Give access to change the Active Process Item.
ID Based URL Give access to change the ID-based URL.
Use Modified Time Stamp Give access to change the Use Modified Time Stamp setting.
Folder Component
ID Based URL Give access to change the ID-based URL.
URL Display Template

Give access to change the display URL. The default format is:

"Project: ~~Project~~ | View: ~~View~~ | ~~Path~~\~~Name~~"
Use Modified Time Stamp Give access to change the Use Modified Time Stamp setting.
Requirement
ID Based URL Give access to change the ID-based URL.
Workspace
Component Order

Give access to change the order of the components. The default order is: File, Folder, Change Request, Requirement, Audit
Confirm Move

Give access to change the Confirm Move setting.

Confirm Delete

Give access to change the Confirm Delete setting.

Enable File System Watching

Give access to change the Enable File System Watching setting.

Show Search Perspective

Give access to change the Show Search Perspective setting.

Allow Multiple Editors

Give access to change the Allow Multiple Editors setting.

Cache Credentials Locally

Give access to change the Cache Credentials Locally setting.

Checkin Update Existing Links Selected Give access to change the Checkin Update Existing Links Selected setting.
Checkin Pin Process Item Selected Give access to change the Checkin Pin Process Item Selected setting.

Back to top

Implement Lockdown Options

To use this feature, create a file called locked.starteam-client-opiton.xml with all or a subset of the content shown below, and assign the desired values to each of the options.

This file should have the exact format and structure as the starteam-client-options.xml, and should actually be derived from it. However, it should only contain those options and their values that need to be locked down.

Most options use boolean values, either 0 or 1. The only exception to this is DefaultStatusMethod, which uses 1 for Central and 2 for per folder. When the client (CPC) starts up, any options found in this file are used by the client for the life of its runtime, and the graphical controls used to manage these option values are disabled in the CPC Personal Options UI.

In order to use this functionality, users need to have access permissions to see the StarFlow Extensions project, and to see and check-out the project's files.

When you have completed preparing the file, check it into the StarFlow Extensions project's root folder.

The XML should contain one or more of the following options:

<?xml version="1.0" encoding="UTF-8"?>

<StarTeamClientOptions version="1.0">

<category name="File Component">

  <option name="Clear Locks On Check-In" value="1"/>
  <option name="Use MD5 To Calculate Status" value="1"/>
  <option name="URL Display Template" value="Project: ~~Project~~ | View: ~~View~~ | ~~Path~~\~~Name~~"/>
  <option name="CentralStatusDir" value="c:\users\username\AppData\Local\Borland\StarTeam\syncdb"/>
  <option name="DefaultStatusMethod" value="1"/>
  <option name="Set Active Process Item" value="1"/>
  <option name="ID Based URL" value="1"/>
  <option name="Use Modified Time Stamp" value="1"/>

</category>

<category name="Folder Component">

  <option name="ID Based URL" value="1"/>
  <option name="URL Display Template" value="Project: ~~Project~~ | View: ~~View~~ | ~~Path~~\~~Name~~"/>
  <option name="Use Modified Time Stamp" value="1"/>

</category>

<category name="Requirement Component">

  <option name="ID Based URL" value="1"/>

</category>

<category name="Workspace">

  <option name="ComponentOrder{guid}" value="File,Folder,ChangeRequest,Requirement,Audit"/>
  <option name="Confirm Move" value="1"/>
  <option name="Confirm Delete" value="1"/>
  <option name="Enable File System Watching" value="0"/>
  <option name="Show Search Perspective" value="0"/>
  <option name="Allow Multiple Editors" value="0"/>
  <option name="Cache Credentials Locally" value="0"/>
  <option name="Checkin Update Existing Links Selected" value="0"/>
  <option name="Checkin Pin Process Item Selected" value="1"/>

</category>

</StarTeamClientOptions>

Note: The ability to lock client options in the CPC's Personal Options tab, was introduced with the 16.3 CPC Patch 1 release (CPC 16.0.3.73, SDK 16.0.3.28).

Back to top

Lockdown Options Example

In the following example, the File System Watching check box on the Personal Options tab will be unchecked and disabled.

<?xml version="1.0" encoding="UTF-8"?>

<StarTeamClientOptions version="1.0">

 <category name="Workspace">

    <option name="Enable File System Watching" value="0"/>
  </category>

</StarTeamClientOptions>