Articles

[Collapse]Automated Build Studio/viewarticle/9302/
 [Expand]Introduction/viewarticle/9304/
 [Expand]Getting Started/viewarticle/9312/
 [Expand]Working With Automated Build Studio/viewarticle/9325/
 [Collapse]Operations Reference/viewarticle/9623/
   Common Operation Properties/viewarticle/9386/
  [Expand].NET Tools/viewarticle/9933/
  [Expand]ADO/viewarticle/10368/
  [Expand]Amazon EC2/viewarticle/22737/
  [Expand]Archivers/viewarticle/9794/
  [Expand]Authenticode/viewarticle/10217/
  [Expand]Build Tools/viewarticle/10156/
  [Expand]Borland Compilers/viewarticle/9679/
  [Expand]Burn CD/DVD/viewarticle/10301/
  [Expand]Communication/viewarticle/10094/
  [Expand]Concurrent Versions System/viewarticle/9634/
  [Expand]Embarcadero Compilers/viewarticle/63530/
  [Expand]Encrypting File System/viewarticle/10352/
  [Expand]Execute/viewarticle/10365/
  [Expand]Files and Directories/viewarticle/10107/
  [Expand]Frequently Used/viewarticle/10195/
  [Expand]FTP/viewarticle/10093/
  [Expand]Help Compilers/viewarticle/10109/
  [Expand]HTTP/viewarticle/10092/
  [Expand]Installers/viewarticle/9795/
  [Expand]Interactive/viewarticle/9504/
  [Expand]Internet Information Services (IIS)/viewarticle/9964/
  [Expand]Issue Tracking/viewarticle/9472/
  [Expand]JediVCS/viewarticle/9949/
  [Expand]Logging/viewarticle/10210/
  [Expand]Mercurial/viewarticle/10353/
  [Expand]Microsoft Compilers/viewarticle/9676/
  [Expand]Microsoft Compilers for Smart Device/viewarticle/9675/
  [Expand]Microsoft Hyper-V/viewarticle/42211/
  [Expand]Microsoft Source Server/viewarticle/10291/
  [Expand]Microsoft SQL Server/viewarticle/9882/
  [Expand]Microsoft Virtual PC/viewarticle/10015/
  [Expand]Microsoft Virtual Server/viewarticle/9508/
  [Expand]Microsoft Visual SourceSafe/viewarticle/9626/
  [Expand]Misc/viewarticle/10263/
  [Expand]MySQL/viewarticle/9885/
  [Expand]Oracle/viewarticle/10203/
  [Expand]Other Compilers/viewarticle/9677/
  [Expand]Patch Management/viewarticle/10167/
  [Expand]Perforce/viewarticle/9624/
  [Expand]Prepare Code/viewarticle/10134/
  [Expand]PsTools/viewarticle/9720/
  [Expand]PVCS/viewarticle/9632/
  [Expand]Rational ClearCase/viewarticle/9629/
  [Expand]Read/Write/viewarticle/10241/
  [Expand]Remote Macro Execution/viewarticle/9369/
  [Expand]Serena Dimensions/viewarticle/10364/
  [Expand]SmartBear and AutomatedQA Tools/viewarticle/10098/
  [Expand]Source Code Tools/viewarticle/10194/
  [Expand]SourceGear Vault/viewarticle/9625/
  [Expand]SourceOffSite/viewarticle/9633/
  [Expand]Standard/viewarticle/10212/
  [Collapse]StarTeam/viewarticle/9622/
    Get Changes From StarTeam Operation/viewarticle/9967/
    StarTeam Add Operation/viewarticle/10653/
    StarTeam Apply Label Operation/viewarticle/10654/
    StarTeam Checkin Operation/viewarticle/10225/
    StarTeam Checkout Operation/viewarticle/10656/
    StarTeam Create Label Operation/viewarticle/10657/
    StarTeam Custom Command Operation/viewarticle/10658/
    StarTeam Delete Local Operation/viewarticle/10268/
    StarTeam File Enumerator Operation/viewarticle/10659/
    StarTeam Lock Operation/viewarticle/10661/
    StarTeam Remove Operation/viewarticle/10242/
    StarTeam Unlock Operation/viewarticle/10662/
    StarTeam Update Status Operation/viewarticle/10660/
    StarTeam File Statuses/viewarticle/10655/
  [Expand]String Manipulation/viewarticle/10308/
  [Expand]Subversion/viewarticle/9628/
  [Expand]Surround SCM/viewarticle/9621/
  [Expand]Team Coherence/viewarticle/9471/
  [Expand]Team Foundation Version Control/viewarticle/9608/
  [Expand]Unit Tests/viewarticle/10115/
  [Expand]User Interface Actions/viewarticle/10346/
  [Expand]VMware Server/viewarticle/10008/
  [Expand]VMware vSphere/viewarticle/42215/
  [Expand]VMware Workstation/viewarticle/9913/
  [Expand]Wait/viewarticle/9994/
  [Expand]WMI/viewarticle/10136/
  [Expand]XML/viewarticle/9702/
 [Expand]Technical Support and Resources/viewarticle/9314/
 [Expand]Other Tools for Improving Your Build Processes/viewarticle/42205/
Updated: 1/9/2014 Applies To: Automated Build Studio 6 Rating: Not badNot badNot badNot badNot bad 4 vote(s) Click to rate: PoorNot badAverageGoodExcellent
StarTeam Operations

StarTeam Add Operation

This operation lets you add one or more files to a project stored in a StarTeam repository.

Requirements

In order for the operation to execute successfully, the client application of StarTeam, stcmd.exe, must be installed on your computer. Otherwise, an error will occur.

Child Operations

The operation cannot have child operations.

Operation Properties

The operation properties are organized into the following pages:

Properties

This page contains properties common for all operations. For more information on them, see Properties That Are Common for All Operations. We would like to draw your attention to the Timeout property on this page:

Timeout

The purpose of this property is to stop the StarTeam client if it is working too long and probably has frozen. When the operation execution reaches the timeout limit, Automated Build Studio closes the StarTeam client instance started by the operation. Using the operation's Timeout property is one of two ways to set the timeout limit for operations. Besides the operation's Timeout property, you can use the timeout common for all operations in the macro (see Macro Properties Dialog).

General

User Name and Password

Required. Your account name (login) and password used to connect to the desired StarTeam server.

Hostname

Optional. The host name or IP address of the computer that hosts the desired StarTeam server. If this parameter is omitted, the default value (localhost) will be used.

Endpoint

Optional. The endpoint used to connect to the desired StarTeam server. The endpoint is the port number, named pipe, or name associated with the protocol. The default port number is 49201.

Project

Required. The name of the StarTeam server’s project to which the file(s) will be added.

View

Optional. Specifies the StarTeam server’s project view to which the file(s) will be added. Project views are used to limit the portion of the project that is visible to team members. To identify the needed view, a view hierarchy should be used. To separate individual view names in the view hierarchy, use the colon (:). The view hierarchy should always include the root view. For example, “StarDraw:Release 4:Service Packs” indicates that the view to be used is the Service Packs view, which is a child of the Release 4 view and a grandchild of the StarDraw root view. If the view name is omitted, the root view is used. If the view is the only view in that project with that name, you can use only the view name.

In any property on this page, you can either enter the desired value manually or specify an existing variable or constant that holds this value. To specify the property values, you can also use the single-lined scripts.

Files

Folder

Specifies the StarTeam server’s folder to which the file(s) will be added. To identify the needed folder, a folder hierarchy should be used. To separate individual folder names in the folder hierarchy, use backslashes (/). The folder hierarchy never includes the root folder. Omit the folder hierarchy if the file is in the view’s root folder. For example, if the root folder of the view is StarDraw and the hierarchy to your files is “StarDraw/SourceCode/Client”, use only “SourceCode/Client”. If the properties of the General page specify a valid StarTeam database, project and, optionally, a project view, you can click the ellipsis button and select the desired StarTeam folder from the resulting Select StarTeam Repository Path dialog.

File Name or Mask

Specifies the file(s) to be added to the given StarTeam server. To add one particular file, enter its name with the extension. To add several files, enter the mask for the needed files. You can use wildcards (* and ?) in this mask.

Recursive

If it is enabled, the operation will process all the subfolders of the specified working folder in order to add appropriate files to the StarTeam server.

Working Folder

Specifies the path to the working folder from which the needed files will be added to the StarTeam server. The following values are available:

  • Use default working folder - The working folder of the specified StarTeam folder or view will be used.

  • Override working directory - The folder specified in this property will override the working folder of the StarTeam folder entered for the operation.

  • Override working directory for the view’s root folder - The folder specified in this property will override the working folder of the view entered for the operation.

File Attributes

Specifies how the operation will change attributes of the local files once they are added to the StarTeam server. The following values are available.

  • Do not change

  • Make read-only

  • Make writable

Lock Status

Specifies whether and how the operation will lock the newly added files in the StarTeam server’s repository. The following values are available:

  • Keep current - The file’s lock status will be left as is.

  • Lock - The files will be locked exclusively.

  • Non-exclusive lock - The files will be locked, but not exclusively.

  • Unlock - The files will be unlocked.

Version Label

The name of an existing label (of the view or revision type) that will be assigned to all the files once they are added to the StarTeam server.

Description

The description that will be tagged to all the files once they are added to the StarTeam server.

Note that in any property, where possible, you can either enter the desired value manually or specify an existing macro variable or constant that holds this value. To specify the property values, you can also use the single-lined scripts.

Options

Encryption

Specifies whether and how the operation will encrypt all data sent between the StarTeam client and server and decrypt it when it arrives. Encryption protects files and other project information from being read by unauthorized parties over unsecured network lines. The following values are available (the encryption types are ordered from fastest to slowest; each of the slower encryption types is safer than the one preceding it):

  • None - Encryption is not used.

  • RSA R4 stream cipher - fastest

  • RSA R2 block cipher (Electronic Codebook)

  • RSA R2 block cipher (Cipher Block Chaining)

  • RSA R2 block cipher (Cipher Feedback) - slowest

Use Compression

If it is enabled, the operation will compress all data sent between the StarTeam client and the server and decompress it when it arrives. Compression is most useful and appropriate when the client and server communicate over a slow connection.

Case-Sensitive Folder Names

If it is enabled, the operation will differentiate StarTeam folders based on the case-sensitive spelling of their names. That is, StarTeam folders named doc and Doc are recognized as different folders. If this property is disabled, either folder could be recognized as the doc folder.

End-of-Line Conversion

If it is enabled, the operation will perform end-of-line conversion of text files, which makes sense if the StarTeam client and server work under operating systems of different kinds (Windows, UNIX or MAC).

Additional Options

Specifies additional command-line arguments that the operation will pass to the StarTeam client.
Export Results

The properties on this page specify where the result of the operation execution will be exported.

None

The log is neither displayed nor stored anywhere.

Log

The log is displayed directly in the Log panel of Automated Build Studio.

Variable

The log is saved to the specified macro variable.

File

The log is saved to a file. You can either enter the file name manually (with the full path), or specify an existing variable or constant that holds this name. To specify the property value, you can also use the single-lined scripts. The Append to the file property determines what to do if a file with the specified name already exists. If this property is disabled, the existing file will be deleted and created anew. Otherwise, the log will be appended to the end of the existing file.

Log Only Errors If Operation Fails

Specifies which part of the console output generated by the StarTeam command-line client the operation will export if the operation fails. If this property is enabled, only errors will be exported. Otherwise, the entire console output of this executable will be exported.

Remarks

You can use variables and constants to specify the operation's property values and to obtain the operation's output. Using the variables and constants has the following specifics:

  • If you use a variable or constant to specify the property value, enclose the variable (or constant) name in the % symbols, for instance, %VariableName%.

  • If the operation saves the property value to a variable, do not enclose the variable name in the % symbols.

To specify a property value, you can concatenate variables and constants with each other or with other values. For detailed information, see Using Variables and Constants in Operation Properties.

See also
StarTeam Operations | Specifying Operation Properties


© 2014 SmartBear Software. All rights reserved.
Email Send feedback on this document