Visual SourceSafe (VSS) Remote Access Tool Recommended by Microsoft

Dynamsoft SourceAnywhere for VSS Ant Plug-in

Introduction
The Tasks
How to install Dynamsoft SourceAnywhere for VSS Ant Plug-in
SourceAnywhere for VSS Ant Plug-in Configuration Example

Introduction

SourceAnywhere for VSS provides an Ant Plug-in which allow users to integrate SourceAnywhere for VSS with Ant.

The following tasks provide an interface to SourceAnywhere for VSS. The SourceAnywhere for VSS Ant Plug-in consists of a simple framework to integrate with Ant to do automatic building.

The Tasks

addfile: Adds one files to a project. The path of the file on the local machine is specified by the workdir parameter.
addproject: Adds an entire local project to the database. The path of the project on the local machine is specified by the workdir parameter. Use recursive to add the project recursively.
checkinfile: Checks in and unlocks one file. This command also makes the local files read-only.
checkinproject: Checks in and unlocks an entire project. This command also makes the local files in the project read-only.
checkoutfile: Checks out and locks one file in the same project. This command also makes the local files writable.
checkoutproject: Checks out and locks an entire project. This command also makes the local files in the project writable. Use recursive to checkout a project recursively.
newproject: Creates an empty project in the current project. Use project to specify the project path and name.
getfilehistory: Displays the revision history of the file.
getlatestfile: Retrieves the most recent files from the current project.
getoldversionfile: Retrieves the old file version from the current project. The version parameter is used to specify an old file version and the label parameter is used to specify a labeled version.
getlatestproject: Gets the latest version of all files in the specified project from the current project. Use recursive to get the project recursively.
getolderversionproject: Gets the old version of all files in the specified project from the current project. Use recursive to get the project recursively.
getprojecthistory: Displays the revision history of the project.
labelfile: Adds a label to a file.
labelproject: Adds a label to a project.

Task Descriptions

All examples in this section are based on the following assumptions:

Server IP = "127.0.0.1"
Server Port = "8877"
Username =" test "
Password = "test123"
Database name = "antplugin"
Project name ="$/anttest"
Temp folder = "D:\temp"
Working folder = "D:\projects\test"

addfile

Description

Task to perform Add File command to Dynamsoft SourceAnywhere for VSS.

Adds one or multiple files to a project. The path of the file on the local machine is specified by the workdir parameter.

Parameters

Attribute	Values	Required
server	Specifies the domain name or IP address of a running Dynamsoft SourceAnywhere for VSS server.	Yes
port	Specifies the port of a running Dynamsoft SourceAnywhere for VSS server.	Yes
username	Specifies the user name used to log into Dynamsoft SourceAnywhere for VSS.	Yes
pwd	Specifies the password for the corresponding user to log into Dynamsoft SourceAnywhere for VSS.	Yes
database	Specifies the VSS database you want to log into.	Yes
project	Specifies a valid project in the current database.	Yes
file	Specifies the name of the file(s) or the absolute path and full name of the local file(s).	Yes
workdir	Specifies the local working folder.	Yes
tempdir	Specifies a local folder for storing temporary files.	Yes
comment	Comments on the corresponding operations with text. The default value is None.	No
writable	true or false. The default value is false.	No
ptype	Specifies the proxy type. Valid ptype parameters are "None", "Http", "Socks4" and "Socks5", the default value is "None".	No
pserver	Specifies the domain name or IP address of the proxy server. If ptype = "None", this parameter is invalid and not required.	No
pport	Specifies the port of the proxy server.	No
puser	Specifies the user name used to connect to the proxy server. If ptype = "None", this parameter is invalid and not required.	No
ppwd	Specifies the password for the corresponding user to connect to the proxy server.	No
filetype	Specifies the file type. Valid parameters are "binary", "mergeable" and "autodetect", the default value is "autodetect".

Examples

<saw:addfile
server="127.0.0.1"
port="8877"
username="test"
pwd="test123"
database="antplugin"
project="$/anttest"
workdir="D:\projects\test"
tempdir="D:\temp"
file="1.txt" />

Add the file named 1.txt into the anttest directory of the database antplugin.

addproject

Description

Task to perform Add project command to Dynamsoft SourceAnywhere for VSS.

Adds an entire local folder to Dynamsoft SourceAnywhere for VSS. The path of the folder on the local machine is specified by the workdir parameter. Use recursive to add the folder recursively.

Parameters

Attribute	Values	Required
server	Specifies the domain name or IP address of a running Dynamsoft SourceAnywhere for VSS server.	Yes
port	Specifies the port of a running Dynamsoft SourceAnywhere for VSS server.	Yes
username	Specifies the user name used to log into Dynamsoft SourceAnywhere for VSS.	Yes
pwd	Specifies the password for the corresponding user to log into Dynamsoft SourceAnywhere for VSS.	Yes
database	Specifies the VSS database you want to log into.	Yes
project	Specifies a valid project in the current database.	Yes
workdir	Specifies the local working folder.	Yes
tempdir	Specifies a local folder for storing temporary files.	Yes
recursive	Specifies whether to add recursively, true or false.	No
comment	Comments on the corresponding operations with text. The default value is None.	No
writable	true or false. The default value is false.	No
ptype	Specifies the proxy type. Valid ptype parameters are "None", "Http", "Socks4" and "Socks5", the default value is "None".	No
pserver	Specifies the domain name or IP address of the proxy server. If ptype = "None", this parameter is invalid and not required.	No
pport	Specifies the port of the proxy server.	No
puser	Specifies the user name used to connect to the proxy server. If ptype = "None", this parameter is invalid and not required.	No
ppwd	Specifies the password for the corresponding user to connect to the proxy server.	No
filetype	Specifies the file type. Valid parameters are "binary", "mergeable" and "autodetect", the default value is "autodetect".	No

Examples

<saw:addproject
server="127.0.0.1"
port="8877"
username="test"
pwd="test123"
database="antplugin"
project="$/anttest"
workdir="D:\projects\test"
tempdir="D:\temp"
recursive="true"/>

Add the folder named test into the anttest directory of the database antplugin recursively.

checkinfile

Description

Task to perform Check In File command to Dynamsoft SourceAnywhere for VSS.

Checks in and unlocks one or multiple files. This command also makes the local files read-only.

Parameters

Attribute	Values	Required
server	Specifies the domain name or IP address of a running Dynamsoft SourceAnywhere for VSS server.	Yes
port	Specifies the port of a running Dynamsoft SourceAnywhere for VSS server.	Yes
username	Specifies the user name used to log into Dynamsoft SourceAnywhere for VSS.	Yes
pwd	Specifies the password for the corresponding user to log into Dynamsoft SourceAnywhere for VSS.	Yes
database	Specifies the VSS database you want to log into.	Yes
project	Specifies a valid project in the current VSS database.	Yes
file	Specifies the name of the file(s) in the repository or the absolute path and full name of the local file(s).	Yes
workdir	Specifies the local working folder.	Yes
tempdir	Specifies a local folder for storing temporary files.	Yes
keep	Keeps checkout status after the checkin operation. Valid value are true or false.	No
comment	Comments on the corresponding operations with text. The default value is None.	No
checkinunchanged	Specifies the behavior when trying to check in unchanged file(s). There are two options: checkin or undo.	No
writable	true or false. The default value is false.	No
ptype	Specifies the proxy type. Valid ptype parameters are "None", "Http", "Socks4" and "Socks5", the default value is "None".	No
pserver	Specifies the domain name or IP address of the proxy server. If ptype = "None", this parameter is invalid and not required.	No
pport	Specifies the port of the proxy server.	No
puser	Specifies the user name used to connect to the proxy server. If ptype = "None", this parameter is invalid and not required.	No
ppwd	Specifies the password for the corresponding user to connect to the proxy server.	No

Examples

<saw:checkinfile
server="127.0.0.1"
port="8877"
username="test"
pwd="test123"
database="antplugin"
project="$/anttest"
file="1.txt"
workdir="D:\projects\test"
tempdir="D:\temp" />

Check in the file named 1.txt into the anttest directory of the database antplugin.

checkinproject

Description

Task to perform Check In Project command to Dynamsoft SourceAnywhere for VSS.

Checks in and unlocks an entire folder. This command also makes the local files in the folder read-only. Use recursively to check in the project recursively.

Parameters

Attribute	Values	Required
server	Specifies the domain name or IP address of a running Dynamsoft SourceAnywhere for VSS server.	Yes
port	Specifies the port of a running Dynamsoft SourceAnywhere for VSS server.	Yes
username	Specifies the user name used to log into Dynamsoft SourceAnywhere for VSS.	Yes
pwd	Specifies the password for the corresponding user to log into Dynamsoft SourceAnywhere for VSS.	Yes
database	Specifies the VSS database you want to log into.	Yes
project	Specifies a valid project in the current VSS database.	Yes
workdir	Specifies the local working folder.	Yes
tempdir	Specifies a local folder for storing temporary files.	Yes
recursive	Specifies whether to check in recursively, true or false.	No
keep	Keeps checkout status after the checkin operation. Valid value are true or false.	No
comment	Comments on the corresponding operations with text. The default value is None.	No
checkinunchanged	Specifies the behavior when trying to check in unchanged file(s). There are two options: checkin or undo.	No
writable	true or false. The default value is false.	No
ptype	Specifies the proxy type. Valid ptype parameters are "None", "Http", "Socks4" and "Socks5", the default value is "None".	No
pserver	Specifies the domain name or IP address of the proxy server. If ptype = "None", this parameter is invalid and not required.	No
pport	Specifies the port of the proxy server.	No
puser	Specifies the user name used to connect to the proxy server. If ptype = "None", this parameter is invalid and not required.	No
ppwd	Specifies the password for the corresponding user to connect to the proxy server.	No

Examples

<saw:checkinproject
server="127.0.0.1"
port="8877"
username="test"
pwd="test123"
database="antplugin"
project="$/anttest"
workdir="D:\projects\test"
tempdir="D:\temp"/>

Check in the project named anttest in the root directory of the database antplugin.

checkoutfile

Description

Task to perform Check Out File command to Dynamsoft SourceAnywhere for VSS.

Checks out and locks one or multiple files in the same folder. This command also makes the local files writable.

Parameters

Attribute	Values	Required
server	Specifies the domain name or IP address of a running Dynamsoft SouceAnywhere for VSS server.	Yes
port	Specifies the port of a running Dynamsoft SouceAnywhere for VSS server.	Yes
username	Specifies the user name used to log into Dynamsoft SouceAnywhere for VSS.	Yes
pwd	Specifies the password for the corresponding user to log into Dynamsoft SourceAnywhere for VSS.	Yes
database	Specifies the VSS database you want to log into.	Yes
project	Specifies a valid project in the current VSS database.	Yes
workdir	Specifies the working folder to place files.	Yes
file	Specifies the name of the file(s) in the database.	Yes
tempdir	Specifies a local folder for storing temporary files.	Yes
replacewritable	Specifies whether to replace writable local copies. Valid value are skip or replace.	No
eol	Specifies the EOL type. Valid values are windows, unix or mac.	No
time	Sets the modification time of the local file or project. Valid time parameters are "current" (default), "modi" and "checkin".	No
comment	Comments on the corresponding operations with text. The default value is None.	No
ptype	Specifies the proxy type. Valid ptype parameters are "None", "Http", "Socks4" and "Socks5", the default value is "None".	No
pserver	Specifies the domain name or IP address of the proxy server. If ptype = "None", this parameter is invalid and not required.	No
pport	Specifies the port of the proxy server.	No
puser	Specifies the user name used to connect to the proxy server. If ptype = "None", this parameter is invalid and not required.	No
ppwd	Specifies the password for the corresponding user to connect to the proxy server.	No

Examples

<saw:checkoutfile
server="127.0.0.1"
port="8877"
username="test"
pwd="test123"
database="antplugin"
project="$/anttest"
file="1.txt"
workdir="D:\projects\test"
tempdir="D:\temp" />

Check out the file named 1.txt in the $/anttest project in database antplugin.

checkoutproject

Description

Task to perform Check Out Project command to Dynamsoft SourceAnywhere for VSS.

Checks out and locks an entire folder. This command also makes the local files in the project writable. Use recursively to checkout a project recursively.

Parameters

Attribute	Values	Required
server	Specifies the domain name or IP address of a running Dynamsoft SouceAnywhere for VSS server.	Yes
port	Specifies the port of a running Dynamsoft SouceAnywhere for VSS server.	Yes
username	Specifies the user name used to log into Dynamsoft SouceAnywhere for VSS.	Yes
pwd	Specifies the password for the corresponding user to log into Dynamsoft SourceAnywhere for VSS.	Yes
database	Specifies the VSS database you want to log into.	Yes
project	Specifies a valid project in the current database.	Yes
workdir	Specifies the working folder to place files.	Yes
tempdir	Specifies a local folder for storing temporary files.	Yes
recursive	Specifies whether to check out recursively, true or false.	No
replacewritable	Specifies whether to replace writable local copies. Valid value are skip or replace.	No
eol	Specifies the EOL type. Valid values are windows, unix or mac.	No
time	Sets the modification time of the local file or project. Valid time parameters are "current" (default), "modi" and "checkin".	No
comment	Comments on the corresponding operations with text. The default value is None.	No
ptype	Specifies the proxy type. Valid ptype parameters are "None", "Http", "Socks4" and "Socks5", the default value is "None".	No
pserver	Specifies the domain name or IP address of the proxy server. If ptype = "None", this parameter is invalid and not required.	No
pport	Specifies the port of the proxy server.	No
puser	Specifies the user name used to connect to the proxy server. If ptype = "None", this parameter is invalid and not required.	No
ppwd	Specifies the password for the corresponding user to connect to the proxy server.	No

Examples

<saw:checkoutproject
server="127.0.0.1"
port="8877"
username="test"
pwd="test123"
database="antplugin"
project="$/anttest"
workdir="D:\projects\test"
tempdir="D:\temp" />

Check out the project named anttest in the database antplugin.

newproject

Description

Task to perform New project command to Dynamsoft SourceAnywhere for VSS.

Creates an empty project in the current database. Use project to specify the project path and name.

Parameters

Attribute	Values	Required
server	Specifies the domain name or IP address of a running Dynamsoft SourceAnywhere for VSS server.	Yes
port	Specifies the port of a running Dynamsoft SourceAnywhere for VSS server.	Yes
username	Specifies the user name used to log into Dynamsoft SourceAnywhere for VSS.	Yes
pwd	Specifies the password for the corresponding user to log into Dynamsoft SourceAnywhere for VSS.	Yes
database	Specifies the VSS database you want to log into.	Yes
project	Specifies a valid project in the current VSS database.	Yes
newproject	Specifies the name of the new project.	Yes
comment	Comments on the corresponding operations with text. The default value is None.	No
ptype	Specifies the proxy type. Valid ptype parameters are "None", "Http", "Socks4" and "Socks5", the default value is "None".	No
pserver	Specifies the domain name or IP address of the proxy server. If ptype = "None", this parameter is invalid and not required.	No
pport	Specifies the port of the proxy server.	No
puser	Specifies the user name used to connect to the proxy server. If ptype = "None", this parameter is invalid and not required.	No
ppwd	Specifies the password for the corresponding user to connect to the proxy server.	No

Examples

<saw:newproject
server="127.0.0.1"
port="8877"
username="test"
pwd="test123"
database="antplugin"
project="$/"
newproject="anttest"/>

Add the project named anttest under the root directory of the database antplugin.

getfilehistory

Description

Task to perform Get File History command to Dynamsoft SourceAnywhere for VSS.

Displays the revision history of the file.

Parameters

Attribute	Values	Required
server	Specifies the domain name or IP address of a running Dynamsoft SourceAnywhere for VSS server.	Yes
port	Specifies the port of a running Dynamsoft SourceAnywhere for VSS server.	Yes
username	Specifies the user name used to log into Dynamsoft SourceAnywhere for VSS.	Yes
pwd	Specifies the password for the corresponding user to log into Dynamsoft SourceAnywhere for VSS.	Yes
database	Specifies the VSS database you want to log into.	Yes
project	Specifies a valid project in the current VSS database.	Yes
file	Specifies the name of the file that you would like to see history.	Yes
user	Specifies an existing username.	No
ptype	Specifies the proxy type. Valid ptype parameters are "None", "Http", "Socks4" and "Socks5", the default value is "None".	No
pserver	Specifies the domain name or IP address of the proxy server. If ptype = "None", this parameter is invalid and not required.	No
pport	Specifies the port of the proxy server.	No
puser	Specifies the user name used to connect to the proxy server. If ptype = "None", this parameter is invalid and not required.	No
ppwd	Specifies the password for the corresponding user to connect to the proxy server.	No

Examples

<saw:getfilehistory
server="127.0.0.1"
port="8877"
username="test"
pwd="test123"
database="antplugin"
project="$/anttest"
file="1.txt" />

View the history of the file named 1.txt in the $/anttest project of the database antplugin.

getlatestfile

Description

Task to perform Get Latest File command to Dynamsoft SourceAnywhere for VSS.

Retrieves the most recent files from the current database.

Parameters

Attribute	Values	Required
server	Specifies the domain name or IP address of a running Dynamsoft SourceAnywhere for VSS server.	Yes
port	Specifies the port of a running Dynamsoft SourceAnywhere for VSS server.	Yes
username	Specifies the user name used to log into Dynamsoft SourceAnywhere for VSS.	Yes
pwd	Specifies the password for the corresponding user to log into Dynamsoft SourceAnywhere for VSS.	Yes
database	Specifies the VSS database you want to log into.	Yes
project	Specifies a valid project in the current VSS database.	Yes
file	Specifies the name of the file(s) in the database.	Yes
workdir	Specifies the local working folder.	Yes
tempdir	Specifies a local folder for storing temporary files. The default temporary directory is specified in the ServerInfo>General Settings section of Dynamsoft SourceAnywhere Service Configurator.	Yes
writable	Makes the local files writable.	No
replacewritable	Specifies whether to replace writable local copies. Valid values are skip or replace.	No
time	Sets the modification time of the local file or project. Valid time parameters are "current" (default), "modi" and "checkin".	No
eol	Specifies the EOL type. Valid values are windws, unix or mac.	No
ptype	Specifies the proxy type. Valid ptype parameters are "None", "Http", "Socks4" and "Socks5", the default value is "None".	No
pserver	Specifies the domain name or IP address of the proxy server. If ptype = "None", this parameter is invalid and not required.	No
pport	Specifies the port of the proxy server.	No
puser	Specifies the user name used to connect to the proxy server. If ptype = "None", this parameter is invalid and not required.	No
ppwd	Specifies the password for the corresponding user to connect to the proxy server.	No

Examples

<saw:getlatestfile
server="127.0.0.1"
port="8877"
username="test"
pwd="test123"
database="antplugin"
project="$/anttest"
file="1.txt"
workdir="D:\projects\test"
tempdir="D:\temp" />

Get the latest file named 1.txt under $/anttest in the database antplugin.

getoldversionfile

Description

Task to perform Get Old Version File command to Dynamsoft SourceAnywhere for VSS.

Retrieves the old file version from the current database. The "version" parameter is used to specify an old file version.

Parameters

Attribute	Values	Required
server	Specifies the domain name or IP address of a running Dynamsoft SouceAnywhere for VSS server.	Yes
port	Specifies the port of a running Dynamsoft SouceAnywhere for VSS server.	Yes
username	Specifies the user name used to log into Dynamsoft SouceAnywhere for VSS.	Yes
pwd	Specifies the password for the corresponding user to log into Dynamsoft SouceAnywhere for VSS.	Yes
database	Specifies the VSS database you want to log into.	Yes
project	Specifies a valid project in the current VSS database.	Yes
file	Specifies the name of the file(s) in the database.	Yes
version/label	Specifies the version number the file or a label that can be associated with a particular file version.	Yes
workdir	Specifies the local working folder.	Yes
tempdir	Specifies a local folder for storing temporary files.	Yes
writable	Makes the local files writable.	No
replacewritable	Specifies whether to replace writable local copies. Valid values are skip or replace.	No
eol	Specifies the EOL type. Valid values are windows, unix or mac.	No
time	Sets the modification time of the local file or project. Valid time parameters are "current" (default), "modi" and "checkin".	No
ptype	Specifies the proxy type. Valid ptype parameters are "None", "Http", "Socks4" and "Socks5", the default value is "None".	No
pserver	Specifies the domain name or IP address of the proxy server. If ptype = "None", this parameter is invalid and not required.	No
pport	Specifies the port of the proxy server.	No
puser	Specifies the user name used to connect to the proxy server. If ptype = "None", this parameter is invalid and not required.	No
ppwd	Specifies the password for the corresponding user to connect to the proxy server.	No

Examples

<saw:getoldversionfile
server="127.0.0.1"
port="8877"
username="test"
pwd="test123"
database="antplugin"
project="$/"
workdir="D:\projects\test"
tempdir="D:\temp"
file="1.txt"
version="31" />

Get the 31th version of the file named 1.txt under $/anttest in the database antplugin.

getlatestproject

Description

Task to perform Get Latest Porject command to Dynamsoft SourceAnywhere for VSS.

Gets the latest version of all files in the specified project from the current database. Use recursive to get the project recursively.

Parameters

Attribute	Values	Required
server	Specifies the domain name or IP address of a running Dynamsoft SouceAnywhere for VSS server.	Yes
port	Specifies the port of a running Dynamsoft SouceAnywhere for VSS server.	Yes
username	Specifies the user name used to log into Dynamsoft SouceAnywhere for VSS.	Yes
pwd	Specifies the password for the corresponding user to log into Dynamsoft SouceAnywhere for VSS.	Yes
database	Specifies the VSS database you want to log into.	Yes
project	Specifies a valid project in the current VSS database.	Yes
workdir	Specifies the local working folder.	Yes
tempdir	Specifies a local folder for storing temporary files.	Yes
recursive	Specifies whether to get recursively, true or false.	No
writable	Makes the local files writable.	No
replacewritable	Specifies whether to replace writable local copies. Valid values are skip or replace.	No
eol	Specifies the EOL type. Valid values are windows, unix or mac.	No
time	Sets the modification time of the local file or project. Valid time parameters are "current" (default), "modi" and "checkin".	No
ptype	Specifies the proxy type. Valid ptype parameters are "None", "Http", "Socks4" and "Socks5", the default value is "None".	No
pserver	Specifies the domain name or IP address of the proxy server. If ptype = "None", this parameter is invalid and not required.	No
pport	Specifies the port of the proxy server.	No
puser	Specifies the user name used to connect to the proxy server. If ptype = "None", this parameter is invalid and not required.	No
ppwd	Specifies the password for the corresponding user to connect to the proxy server.	No

Examples

<saw:getlatestproject
server="127.0.0.1"
port="8877"
username="test"
pwd="test123"
database="antplugin"
project="$/anttest"
workdir="D:\projects\test"
tempdir="D:\temp" />

Get the project named anttest in the database antplugin.

getoldversionproject

Description

Task to perform Get Old Version Project command to Dynamsoft SourceAnywhere for VSS.

Gets the old version of all files in the specified project from the current database. Use recursive to get the project recursively.

Parameters

Attribute	Values	Required
server	Specifies the domain name or IP address of a running Dynamsoft SourceAnywhere for VSS server.	Yes
port	Specifies the port of a running Dynamsoft SourceAnywhere for VSS server.	Yes
username	Specifies the user name used to log into Dynamsoft SourceAnywhere for VSS.	Yes
pwd	Specifies the password for the corresponding user to log into Dynamsoft SourceAnywhere for VSS.	Yes
database	Specifies the database you want to log into.	Yes
project	Specifies a valid project in the current VSS database.	Yes
workdir	Specifies the local working folder.	Yes
Label	Specifies a label that can be associated with a particular project version.	Yes
tempdir	Specifies a local folder for storing temporary files.	Yes
recursive	Specifies whether to get recursively, true or false.	No
writable	Makes the local files writable.	No
replacewritable	Specifies whether to replace writable local copies. Valid values are skip or replace.	No
eol	Specifies the EOL type. Valid values are windows, unix or mac.	No
time	Sets the modification time of the local file or project. Valid time parameters are "current" (default), "modi" and "checkin".	No
ptype	Specifies the proxy type. Valid ptype parameters are "None", "Http", "Socks4" and "Socks5", the default value is "None".	No
pserver	Specifies the domain name or IP address of the proxy server. If ptype = "None", this parameter is invalid and not required.	No
pport	Specifies the port of the proxy server.	No
puser	Specifies the user name used to connect to the proxy server. If ptype = "None", this parameter is invalid and not required.	No
ppwd	Specifies the password for the corresponding user to connect to the proxy server.	No

Examples

<saw:getoldversionproject
server="127.0.0.1"
port="8877"
username="test"
pwd="test123"
database="antplugin"
project="$/dd"
workdir="D:\projects\test"
tempdir="D:\temp"
label="1" />

Get the history of the project named anttest in the database antplugin by label.

getprojecthistory

Description

Task to perform Get Project History command to Dynamsoft SourceAnywhere for VSS.

Displays the revision history of the project.

Parameters

Attribute	Values	Required
server	Specifies the domain name or IP address of a running Dynamsoft SourceAnywhere for VSS server.	Yes
port	Specifies the port of a running Dynamsoft SourceAnywhere for VSS server.	Yes
username	Specifies the user name used to log into Dynamsoft SourceAnywhere for VSS.	Yes
pwd	Specifies the password for the corresponding user to log into Dynamsoft SourceAnywhere for VSS.	Yes
database	Specifies the VSS database you want to log into.	Yes
project	Specifies a valid project in the current VSS database.	Yes
user	Specifies an existing username.	No
recursive	Specifies whether to get recursively, true or false.	No
datetime	Specifies a period of time. By default it's from the current time to one year ago. You can type two value in the format "datefrom\|dateto", or just one value as the ending date/time of period which begins from the current time . Acceptable date/time formats: "Jun/16/2005", "Jun/16/2005 6:10:00", "6/16/2005", "6/16/2005 6:10:00".	No
ptype	Specifies the proxy type. Valid ptype parameters are "None", "Http", "Socks4" and "Socks5", the default value is "None".	No
pserver	Specifies the domain name or IP address of the proxy server. If ptype = "None", this parameter is invalid and not required.	No
pport	Specifies the port of the proxy server.	No
puser	Specifies the user name used to connect to the proxy server. If ptype = "None", this parameter is invalid and not required.	No
ppwd	Specifies the password for the corresponding user to connect to the proxy server.	No

Examples

<saw:getprojecthistory
server="127.0.0.1"
port="8877"
username="test"
pwd="test123"
database="antplugin"
project="$/anttest" />

View the history of the project named anttest in the database antplugin.

labelfile

Description

Task to perform Label File command to Dynamsoft SourceAnywhere for VSS.

Adds a label to a file.

Parameters

Attribute	Values	Required
server	Specifies the domain name or IP address of a running Dynamsoft SouceAnywhere for VSS server.	Yes
port	Specifies the port of a running Dynamsoft SouceAnywhere for VSS server.	Yes
username	Specifies the user name used to log into Dynamsoft SouceAnywhere for VSS.	Yes
pwd	Specifies the password for the corresponding user to log into Dynamsoft SourceAnywhere for VSS.	Yes
database	Specifies the VSS database you want to log into.	Yes
project	Specifies a valid project in the current VSS database.	Yes
label	Specifies a label that can be associated with a particular project version or file version.	Yes
file	Specifies the name of the file(s) in the database.	Yes
comment	Comments on the label.	No
ptype	Specifies the proxy type. Valid ptype parameters are "None", "Http", "Socks4" and "Socks5", the default value is "None".	No
pserver	Specifies the domain name or IP address of the proxy server. If ptype = "None", this parameter is invalid and not required.	No
pport	Specifies the port of the proxy server.	No
puser	Specifies the user name used to connect to the proxy server. If ptype = "None", this parameter is invalid and not required.	No
ppwd	Specifies the password for the corresponding user to connect to the proxy server.	No

Examples

<saw:labelfile
server="127.0.0.1"
port="8877"
username="test"
pwd="test123"
database="antplugin"
project="$/anttest"
file="1.txt"
label="release" />

Label the file named 1.txt in project anttest of the database antplugin with release.

labelproject

Description

Task to perform Label Project command to Dynamsoft SourceAnywhere for VSS.

Adds a label to a project.

Parameters

Attribute	Values	Required
server	Specifies the domain name or IP address of a running Dynamsoft SouceAnywhere for VSS server.	Yes
port	Specifies the port of a running Dynamsoft SouceAnywhere SourceAnywhere for VSS server.	Yes
username	Specifies the user name used to log into Dynamsoft SouceAnywhere SourceAnywhere for VSS.	Yes
pwd	Specifies the password for the corresponding user to log into Dynamsoft SourceAnywhere SourceAnywhere for VSS.	Yes
database	Specifies the VSS database you want to log into.	Yes
project	Specifies a valid project in the current VSS database.	Yes
label	Specifies a label that can be associated with a particular project version or file version.	Yes
comment	Comments on the label.	No
ptype	Specifies the proxy type. Valid ptype parameters are "None", "Http", "Socks4" and "Socks5", the default value is "None".	No
pserver	Specifies the domain name or IP address of the proxy server. If ptype = "None", this parameter is invalid and not required.	No
pport	Specifies the port of the proxy server.	No
puser	Specifies the user name used to connect to the proxy server. If ptype = "None", this parameter is invalid and not required.	No
ppwd	Specifies the password for the corresponding user to connect to the proxy server.	No

Examples

<saw:labelproject
server="127.0.0.1"
port="8877"
username="test"
pwd="test123"
database="antplugin"
project="$/anttest"
label="release" />

Label the project named anttest with release label in the database antplugin.

Install Dynamsoft SourceAnywhere for VSS Ant Plug-in

To install Dynamsoft SourceAnywhere for VSS Ant Plug-in, please follow the steps below:

1. Install SourceAnywhere for VSS Server.

2. Download SourceAnywhere for VSS Ant Plug-in and unzip it into the Lib folder under the Ant directory.

3. Edit the build.xml file in the Bin folder under the Ant direct ory appropriately. If there is no such file, create it.

4. Click Start->Run to open command line window. And go to the Bin folder of Ant and perform "ant" command. Then Ant will run.

SourceAnywhere for VSS Ant Plug-in Configuration Example

SourceSafe (VSS) Remote/Web/Internet Access | Software Configuration Management | SCM Solution
Software Configuration Management Online | Source/Version Control Online | Version/Source Control Software
Copyright © 2011 Dynamsoft Corporation. All Rights Reserved.

Dynamsoft SourceAnywhere for VSS Ant Plug-in

Contents

Introduction

The Tasks

Task Descriptions