This operation lets you add one or more files to a project stored in a StarTeam repository.
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.
The operation cannot have child operations.
The operation properties are organized into the following pages:
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:
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).
User Name and Password
Required. Your account name (login) and password used to connect to the desired StarTeam server.
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.
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.
Required. The name of the StarTeam server’s project to which the file(s) will be added.
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.
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.
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.
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.
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
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.
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.
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.
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
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.
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).
The properties on this page specify where the result of the operation execution will be exported.
The log is neither displayed nor stored anywhere.
The log is displayed directly in the Log panel of Automated Build Studio.
The log is saved to the specified macro variable.
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.
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.
© 2012 SmartBear Software. All rights reserved.