Dynamsoft SCM Anywhere Ant Plug-in

Introduction
The Tasks
How to install Dynamsoft SCM Anywhere Ant Plug-in
SCM Anywhere Ant Plug-in Configuration Example

In addition to the Dynamsoft SCM Anywhere CriuseControl.NET, Dynamsoft SCM Anywhere provides Ant Plug-in to allow users integrate SCM Anywhere with Ant.

The following tasks provide an interface to the Dynamsoft SCM Anywhere. The Dynamsoft SCM Anywhere Ant Plug-in consists of a simple framework to integrate with Ant to do automatical building.

The Tasks

addfile: Adds one or multiple files to a folder. The path of the file on the local machine is specified by the workdir parameter.
addfolder: Adds an entire local folder to Dynamsoft SCM Anywhere. The path of the folder on the local machine is specified by the workdir parameter. Use recursive to add the folder recursively.
checkinfile: Checks in and unlocks one or multiple files. This command also makes the local files readonly.
checkinfolder: Checks in and unlocks an entire folder. This command also makes the local files in the folder readonly. Use recursive to check in the folder recursively.
checkoutfile: Checks out and locks one or multiple files in the same folder. This command also makes the local files writable.
checkoutfolder: Checks out and locks an entire folder. This command also makes the local files in the folder writable. Use recursive to checkout a folder recursively.
newfolder: Creates an empty folder in the current team project. Use folder to specify the folder path and name.
getfilehistory: Displays the revision history of the file.
getlatestfile: Retrieves the most recent files from the current team project.
getoldversionfile: Retrieves the old file version from the current team project. The version parameter is used to specify an old file version.
getlatestfolder: Gets the latest version of all files in the specified folder from the current team project. Use recursive to get the folder recursively.
getolderversionfolder: Gets the old version of all files in the specified folder from the current team project. Use recursive to get the folder recursively.
getfolderhistory: Displays the revision history of the folder. If the v flag is set, the histories will be shown by version, or it will be shown by item.
labelfile: Adds a label to a file.
labelfolder: Adds a label to a folder.

Task Descriptions

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

Server IP = 127.0.0.1
Server Port = 7771
Username = test
Password = test123
Team project name = antplugin
Folder name = $/anttest
Temp folder = "D:\temp"
Working folder = "C:\projects\test"

addfile

Description

Task to perform Add File command to Dynamsoft SCM Anywhere.

Adds one or multiple files to a folder. 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 SCM Anywhere server.	Yes
port	Specifies the port of a running Dynamsoft SCM Anywhere server.	Yes
username	Specifies the user name used to log into Dynamsoft SCM Anywhere.	Yes
pwd	Specifies the password for the corresponding user to log into Dynamsoft SCM Anywhere.	Yes
teamproject	Specifies the team project you want to log into.	Yes
folder	Specifies a valid folder in the current Dynamsoft SCM Anywhere team project.	Yes
file	Specifies the name of the file(s) in the team project 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.. The default temporary directory is specified in the ServerInfo>General Settings section of Dynamsoft SCM Anywhere Service Configurator.	No
comment	Comments on the corresponding operations with text. The default value is None. 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" and "Http", 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
ssl	Specifies whether to connect to server using SSL encryption, true or false. The default value is false.	No
loglevel: normal or debug	Specifies the type of log level. Valid parameters are "normal" or "debug". The default value is normal.	No
compression: true or false	true or false. The default value is true.	No

Examples

<scm:addfile
server="127.0.0.1"
port="7771"
username="test"
pwd="test123"
teamproject="antplugin"
folder="$/anttest"
workdir="D:\Personal Folder\workpath "
file="1.txt"
ssl="true" />

Add the file named 1.txt into the root directory of the team project anttest.

addfolder

Description

Task to perform Add Folder command to Dynamsoft SCM Anywhere.

Adds an entire local folder to Dynamsoft SCM Anywhere. 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 SCM Anywhere server.	Yes
port	Specifies the port of a running Dynamsoft SCM Anywhere server.	Yes
username	Specifies the user name used to log into Dynamsoft SCM Anywhere.	Yes
pwd	Specifies the password for the corresponding user to log into Dynamsoft SCM Anywhere.	Yes
teamproject	Specifies the team project you want to log into.	Yes
folder	Specifies a valid folder in the current Dynamsoft SCM Anywhere team project.	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 SCM Anywhere Service Configurator.	No
comment	Comments on the corresponding operations with text. The default value is None. The default value is None.	No
recursive	Performs the folder level command recursively. Valid value are true or false. The default value is false.	No
writable	true or false. The default value is false.	No
ptype	Specifies the proxy type. Valid ptype parameters are "None" and "Http", 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
ssl	Specifies whether to connect to server using SSL encryption. true or false. The default value is false.	No
loglevel: normal or debug	Specifies the type of log level. Valid parameters are "normal" or "debug". The default value is normal.	No
compression: true or false	true or false. The default value is true.	No

Examples

<scm:addfolder
server="127.0.0.1"
port="7771"
username="test"
pwd="test123"
teamproject="antplugin"
folder="$/anttest"
workdir="D:\Personal Folder\workpath"
recursive="true"
ssl="true" />

Add the folder named workpath into the root directory of the team project anttest recursively.

checkinfile

Description

Task to perform Check In File command to Dynamsoft SCM Anywhere.

Checks in and unlocks one or multiple files. This command also makes the local files readonly.

Parameters

Attribute	Values	Required
server	Specifies the domain name or IP address of a running Dynamsoft SCM Anywhere server.	Yes
port	Specifies the port of a running Dynamsoft SCM Anywhere server.	Yes
username	Specifies the user name used to log into Dynamsoft SCM Anywhere.	Yes
pwd	Specifies the password for the corresponding user to log into Dynamsoft SCM Anywhere.	Yes
teamproject	Specifies the team project you want to log into.	Yes
folder	Specifies a valid folder in the current Dynamsoft SCM Anywhere team project.	Yes
file	Specifies the name of the file(s) in the team project or the absolute path and full name of the local file(s).	Yes
tempdir	Specifies a local folder for storing temporary files.. The default temporary directory is specified in the ServerInfo>General Settings section of Dynamsoft SCM Anywhere Service Configurator.	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: checkin or undo	Specifies the behavior when trying 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" and "Http", 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
ssl	Specifies whether to connect to server using SSL encryption. true or false. The default value is false.	No
loglevel: normal or debug	Specifies the type of log level. Valid parameters are "normal" or "debug". The default value is normal.	No
compression: true or false	true or false. The default value is true.	No

Examples

<scm:checkinfile
server="127.0.0.1"
port="7771"
username="test"
pwd="test123"
teamproject="antplugin"
folder="$/anttest"
file="1.txt"
ssl="true" />

Check in the file named 1.txt into the root directory of the team project anttest.

checkinfolder

Description

Task to perform Check In Folder command to Dynamsoft SCM Anywhere.

Checks in and unlocks an entire folder. This command also makes the local files in the folder readonly. Use recursively to check in the folder recursively.

Parameters

Attribute	Values	Required
server	Specifies the domain name or IP address of a running Dynamsoft SCM Anywhere server.	Yes
port	Specifies the port of a running Dynamsoft SCM Anywhere server.	Yes
username	Specifies the user name used to log into Dynamsoft SCM Anywhere.	Yes
pwd	Specifies the password for the corresponding user to log into Dynamsoft SCM Anywhere.	Yes
teamproject	Specifies the team project you want to log into.	Yes
folder	Specifies a valid folder in the current Dynamsoft SCM Anywhere team project.	Yes
tempdir	Specifies a local folder for storing temporary files.. The default temporary directory is specified in the ServerInfo>General Settings section of Dynamsoft SCM Anywhere Service Configurator.	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: checkin or undo	Specifies the behavior when trying 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" and "Http", 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
ssl	Specifies whether to connect to server using SSL encryption. true or false. The default value is false.	No
loglevel: normal or debug	Specifies the type of log level. Valid parameters are "normal" or "debug". The default value is normal.	No
compression: true or false	true or false. The default value is true.	No

Examples

<scm:checkinfolder
server="127.0.0.1"
port="7771"
username="test"
pwd="test123"
teamproject="antplugin"
folder="$/anttest" />

Check in the folder named anttest into the root directory of the team project antplugin.

checkoutfile

Description

Task to perform Check Out File command to Dynamsoft SCM Anywhere.

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 SCM Anywhere server.	Yes
port	Specifies the port of a running Dynamsoft SCM Anywhere server.	Yes
username	Specifies the user name used to log into Dynamsoft SCM Anywhere.	Yes
pwd	Specifies the password for the corresponding user to log into Dynamsoft SCM Anywhere.	Yes
teamproject	Specifies the team project you want to log into.	Yes
folder	Specifies a valid folder in the current Dynamsoft SCM Anywhere team project.	Yes
workdir	Specifies the local working folder.	Yes
file	Specifies the name of the file(s) in the team project or the absolute path and full name of the local file(s).	Yes
tempdir	Specifies a local folder for storing temporary files.. The default temporary directory is specified in the ServerInfo>General Settings section of Dynamsoft SCM Anywhere Service Configurator.	No
replacewritable: skip or replace	Specifies the behavior when replacing writable file(s). There are two options: skip or replace.	No
eol: windows or unix or mac	Specifies the type of EOL. There are three options: windows or unix or max.	No
time	Sets the modification time of the local file or folder. Valid time parameters are "current" (default), "modi" and "checkin". modi The item's last modified time. current Current time. checkin The item's last checked in time. Examples: time modi or time current or time checkin.	No
comment	Comments on the corresponding operations with text. The default value is None.	No
checkinunchanged: checkin or undo	Specifies the behavior when trying check in unchanged file(s). There are two options: checkin or undo.	No
ptype	Specifies the proxy type. Valid ptype parameters are "None" and "Http", 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
ssl	Specifies whether to connect to server using SSL encryption, true or false. The default value is false.	No
loglevel: normal or debug	Specifies the type of log level. Valid parameters are "normal" or "debug". The default value is normal.	No
compression: true or false	true or false. The default value is true.	No

Examples

<scm:checkoutfile
server="127.0.0.1"
port="7771"
username="test"
pwd="test123"
teamproject="antplugin"
folder="$/anttest"
file="1.txt"
workdir="D:\Personal Folder\workpath" />

Check out the file named 1.txt in the $/anttest folder of the team project anttest.

checkoutfolder

Description

Task to perform Check Out Folder command to Dynamsoft SCM Anywhere.

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

Parameters

Attribute	Values	Required
server	Specifies the domain name or IP address of a running Dynamsoft SCM Anywhere server.	Yes
port	Specifies the port of a running Dynamsoft SCM Anywhere server.	Yes
username	Specifies the user name used to log into Dynamsoft SCM Anywhere.	Yes
pwd	Specifies the password for the corresponding user to log into Dynamsoft SCM Anywhere.	Yes
teamproject	Specifies the team project you want to log into.	Yes
folder	Specifies a valid folder in the current Dynamsoft SCM Anywhere team project.	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 SCM Anywhere Service Configurator.	No
recursive	Performs the folder level command recursively. Valid value are true or false. The default value is false. The default value is false.	No
replacewritable: skip or replace	Specifies the behavior when replacing writable file(s). There are two options: skip or replace.	No
eol: windows or unix or mac	Specifies the type of EOL. There are three options: windows or unix or max.	No
time	Sets the modification time of the local file or folder. Valid time parameters are "current" (default), "modi" and "checkin". modi The item's last modified time. current Current time. checkin The item's last checked in time. Examples: time modi or time current or time checkin.	No
comment	Comments on the corresponding operations with text. The default value is None.	No
checkinunchanged: checkin or undo	Specifies the behavior when trying check in unchanged file(s). There are two options: checkin or undo.	No
ptype	Specifies the proxy type. Valid ptype parameters are "None" and "Http", 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
ssl	Specifies whether to connect to server using SSL encryption, true or false. The default value is false.	No
loglevel: normal or debug	Specifies the type of log level. Valid parameters are "normal" or "debug". The default value is normal.	No
compression: true or false	true or false. The default value is true.	No

Examples

<scm:checkoutfolder
server="127.0.0.1"
port="7771"
username="test"
pwd="test123"
teamproject="antplugin"
folder="$/anttest"
workdir="D:\Personal Folder\workpath" />

Check out the folder named anttest in the team project antplugin.

newfolder

Description

Task to perform New Folder command to Dynamsoft SCM Anywhere.

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

Parameters

Attribute	Values	Required
server	Specifies the domain name or IP address of a running Dynamsoft SCM Anywhere server.	Yes
port	Specifies the port of a running Dynamsoft SCM Anywhere server.	Yes
username	Specifies the user name used to log into Dynamsoft SCM Anywhere.	Yes
pwd	Specifies the password for the corresponding user to log into Dynamsoft SCM Anywhere.	Yes
teamproject	Specifies the team project you want to log into.	Yes
folder	Specifies a valid folder in the current Dynamsoft SCM Anywhere team 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" and "Http", 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
ssl	Specifies whether to connect to server using SSL encryption, true or false. The default value is false.	No
loglevel: normal or debug	Specifies the type of log level. Valid parameters are "normal" or "debug". The default value is normal.	No
compression: true or false	true or false. The default value is true.	No

Examples

<scm:newfolder
server="127.0.0.1"
port="7771"
username="test"
pwd="test123"
teamproject="antplugin"
folder="$/anttest" />

Add the folder named anttest under the root directory of the team project antplugin.

getfilehistory

Description

Task to perform Get File History command to Dynamsoft SCM Anywhere.

Displays the revision history of the file.

Parameters

Attribute	Values	Required
server	Specifies the domain name or IP address of a running Dynamsoft SCM Anywhere server.	Yes
port	Specifies the port of a running Dynamsoft SCM Anywhere server.	Yes
username	Specifies the user name used to log into Dynamsoft SCM Anywhere.	Yes
pwd	Specifies the password for the corresponding user to log into Dynamsoft SCM Anywhere.	Yes
teamproject	Specifies the team project you want to log into.	Yes
folder	Specifies a valid folder in the current Dynamsoft SCM Anywhere team project.	Yes
file	Specifies the name of the file(s) in the team project or the absolute path and full name of the local file(s).	Yes
user	Specifies an existing username.	No
ptype	Specifies the proxy type. Valid ptype parameters are "None" and "Http", 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
ssl	Specifies whether to connect to server using SSL encryption, true or false. The default value is false.	No
loglevel: normal or debug	Specifies the type of log level. Valid parameters are "normal" or "debug". The default value is normal.	No
compression: true or false	true or false. The default value is true.	No

Examples

<scm:getfilehistory
server="127.0.0.1"
port="7771"
username="test"
pwd="test123"
teamproject="antplugin"
folder="$/anttest"
file="1.txt" />

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

getlatestfile

Description

Task to perform Get Latest File command to Dynamsoft SCM Anywhere.

Retrieves the most recent files from the current team project.

Parameters

Attribute	Values	Required
server	Specifies the domain name or IP address of a running Dynamsoft SCM Anywhere server.	Yes
port	Specifies the port of a running Dynamsoft SCM Anywhere server.	Yes
username	Specifies the user name used to log into Dynamsoft SCM Anywhere.	Yes
pwd	Specifies the password for the corresponding user to log into Dynamsoft SCM Anywhere.	Yes
teamproject	Specifies the team project you want to log into.	Yes
folder	Specifies a valid folder in the current Dynamsoft SCM Anywhere team project.	Yes
workdir	Specifies the local working folder.	Yes
file	Specifies the name of the file(s) in the team project or the absolute path and full name of the local file(s).	Yes
tempdir	Specifies a local folder for storing temporary files.. The default temporary directory is specified in the ServerInfo>General Settings section of Dynamsoft SCM Anywhere Service Configurator.	No
writable	true or false. The default value is false.	No
replacewritable: skip or replace	Specifies the behavior when replacing writable file(s). There are two options: skip or replace.	No
time	Sets the modification time of the local file or folder. Valid time parameters are "current" (default), "modi" and "checkin". modi The item's last modified time. current Current time. checkin The item's last checked in time. Examples: time modi or time current or time checkin.	No
eol: windows or unix or mac	Specifies the type of EOL. There are three options: windows or unix or max.	No
ptype	Specifies the proxy type. Valid ptype parameters are "None" and "Http", 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
ssl	Specifies whether to connect to server using SSL encryption, true or false. The default value is false.	No
loglevel: normal or debug	Specifies the type of log level. Valid parameters are "normal" or "debug". The default value is normal.	No
compression: true or false	true or false. The default value is true.	No

Examples

<scm:getlatestfile
server="127.0.0.1"
port="7771"
username="test"
pwd="test123"
teamproject="antplugin"
folder="$/anttest"
workdir="D:\Personal Folder\Cooler\UnSecure"
file="1.txt"
eol="unix" />

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

getoldversionfile

Description

Task to perform Get Old Version File command to Dynamsoft SCM Anywhere.

Retrieves the old file version from the current team project. 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 SCM Anywhere server.	Yes
port	Specifies the port of a running Dynamsoft SCM Anywhere server.	Yes
username	Specifies the user name used to log into Dynamsoft SCM Anywhere.	Yes
pwd	Specifies the password for the corresponding user to log into Dynamsoft SCM Anywhere.	Yes
teamproject	Specifies the team project you want to log into.	Yes
folder	Specifies a valid folder in the current Dynamsoft SCM Anywhere team project.	Yes
workdir	Specifies the local working folder.	Yes
file	Specifies the name of the file(s) in the team project or the absolute path and full name of the local file(s).	Yes
label	Specifies a label that can be associated with a particular folder version or file version.	Yes
version	Specifies a version number of the file.	Yes
tempdir	Specifies a local folder for storing temporary files.. The default temporary directory is specified in the ServerInfo>General Settings section of Dynamsoft SCM Anywhere Service Configurator.	No
writable	true or false. The default value is false.	No
replacewritable: skip or replace	Specifies the behavior when replacing writable file(s). There are two options: skip or replace.	No
time	Sets the modification time of the local file or folder. Valid time parameters are "current" (default), "modi" and "checkin". modi The item's last modified time. current Current time. checkin The item's last checked in time. Examples: time modi or time current or time checkin.	No
eol: windows or unix or mac	Specifies the type of EOL. There are three options: windows or unix or max.	No
ptype	Specifies the proxy type. Valid ptype parameters are "None" and "Http", 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
ssl	Specifies whether to connect to server using SSL encryption, true or false. The default value is false.	No
loglevel: normal or debug	Specifies the type of log level. Valid parameters are "normal" or "debug". The default value is normal.	No
compression: true or false	true or false. The default value is true.	No

Examples

<scm:getoldversionfile
server="127.0.0.1"
port="7771"
username="test"
pwd="test123"
teamproject="antplugin"
folder="$/"
workdir="D:\Personal Folder\workpath"
file="1.txt"
version="31" />

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

getlatestfolder

Description

Task to perform Get Latest Folder command to Dynamsoft SCM Anywhere.

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

Parameters

Attribute	Values	Required
server	Specifies the domain name or IP address of a running Dynamsoft SCM Anywhere server.	Yes
port	Specifies the port of a running Dynamsoft SCM Anywhere server.	Yes
username	Specifies the user name used to log into Dynamsoft SCM Anywhere.	Yes
pwd	Specifies the password for the corresponding user to log into Dynamsoft SCM Anywhere.	Yes
teamproject	Specifies the team project you want to log into.	Yes
folder	Specifies a valid folder in the current Dynamsoft SCM Anywhere team project.	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 SCM Anywhere Service Configurator.	No
recursive	Performs the folder level command recursively. Valid value are true or false. The default value is false.	No
writable	true or false. The default value is false.	No
replacewritable: skip or replace	Specifies the behavior when replacing writable file(s). There are two options: skip or replace.	No
time	Sets the modification time of the local file or folder. Valid time parameters are "current" (default), "modi" and "checkin". modi The item's last modified time. current Current time. checkin The item's last checked in time. Examples: time modi or time current or time checkin.	No
eol: windows or unix or mac	Specifies the type of EOL. There are three options: windows or unix or max.	No
ptype	Specifies the proxy type. Valid ptype parameters are "None" and "Http", 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
ssl	Specifies whether to connect to server using SSL encryption, true or false. The default value is false.	No
loglevel: normal or debug	Specifies the type of log level. Valid parameters are "normal" or "debug". The default value is normal.	No
compression: true or false	true or false. The default value is true.	No

Examples

<scm:getlatestfolder
server="127.0.0.1"
port="7771"
username="test"
pwd="test123"
teamproject="antplugin"
folder="$/anttest"
workdir="D:\Personal Folder\workpath" />

Get the folder named anttest in the team project antplugin.

getoldversionfolder

Description

Task to perform Get Old Version Folder command to Dynamsoft SCM Anywhere.

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

Parameters

Attribute	Values	Required
server	Specifies the domain name or IP address of a running Dynamsoft SCM Anywhere server.	Yes
port	Specifies the port of a running Dynamsoft SCM Anywhere server.	Yes
username	Specifies the user name used to log into Dynamsoft SCM Anywhere.	Yes
pwd	Specifies the password for the corresponding user to log into Dynamsoft SCM Anywhere.	Yes
teamproject	Specifies the team project you want to log into.	Yes
folder	Specifies a valid folder in the current Dynamsoft SCM Anywhere team project.	Yes
workdir	Specifies the local working folder.	Yes
label	Specifies a label that can be associated with a particular folder version or file version.	Yes
version	Specifies a version number of the file.	Yes
tempdir	Specifies a local folder for storing temporary files.. The default temporary directory is specified in the ServerInfo>General Settings section of Dynamsoft SCM Anywhere Service Configurator.	No
recursive	Performs the folder level command recursively. Valid value are true or false. The default value is false.	No
writable	true or false. The default value is false.	No
replacewritable: skip or replace	Specifies the behavior when replacing writable file(s). There are two options: skip or replace.	No
time	Sets the modification time of the local file or folder. Valid time parameters are "current" (default), "modi" and "checkin". modi The item's last modified time. current Current time. checkin The item's last checked in time. Examples: time modi or time current or time checkin.	No
eol: windows or unix or mac	Specifies the type of EOL. There are three options: windows or unix or max.	No
ptype	Specifies the proxy type. Valid ptype parameters are "None" and "Http", 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
ssl	Specifies whether to connect to server using SSL encryption, true or false. The default value is false.	No
loglevel: normal or debug	Specifies the type of log level. Valid parameters are "normal" or "debug". The default value is normal.	No
compression: true or false	true or false. The default value is true.	No

Examples

<scm:getoldversionfolder
server="127.0.0.1"
port="7771"
username="test"
pwd="test123"
teamproject="antplugin"
folder="$/dd"
workdir="D:\Personal Folder\workpath"
label="1"
/>

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

getfolderhistory

Description

Task to perform Get Folder History command to Dynamsoft SCM Anywhere.

Displays the revision history of the folder. If the v flag is set, the histories will be shown by version, or it will be shown by item.

Parameters

Attribute	Values	Required
server	Specifies the domain name or IP address of a running Dynamsoft SCM Anywhere server.	Yes
port	Specifies the port of a running Dynamsoft SCM Anywhere server.	Yes
username	Specifies the user name used to log into Dynamsoft SCM Anywhere.	Yes
pwd	Specifies the password for the corresponding user to log into Dynamsoft SCM Anywhere.	Yes
teamproject	Specifies the team project you want to log into.	Yes
folder	Specifies a valid folder in the current Dynamsoft SCM Anywhere team project.	Yes
user	Specifies an existing username.	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
v	Shows the folder histories by version. true or false	No
ptype	Specifies the proxy type. Valid ptype parameters are "None" and "Http", 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
ssl	Specifies whether to connect to server using SSL encryption, true or false. The default value is false.	No
loglevel: normal or debug	Specifies the type of log level. Valid parameters are "normal" or "debug". The default value is normal.	No
compression: true or false	true or false. The default value is true.	No

Examples

<scm:getfolderhistory
server="127.0.0.1"
port="7771"
username="test"
pwd="test123"
teamproject="antplugin"
folder="$/anttest"
v="true"
/>

View the history of the folder named anttest in the team project antplugin.

labelfile

Description

Task to perform Label File command to Dynamsoft SCM Anywhere.

Adds a label to a file.

Parameters

Attribute	Values	Required
server	Specifies the domain name or IP address of a running Dynamsoft SCM Anywhere server.	Yes
port	Specifies the port of a running Dynamsoft SCM Anywhere server.	Yes
username	Specifies the user name used to log into Dynamsoft SCM Anywhere.	Yes
pwd	Specifies the password for the corresponding user to log into Dynamsoft SCM Anywhere.	Yes
teamproject	Specifies the team project you want to log into.	Yes
folder	Specifies a valid folder in the current Dynamsoft SCM Anywhere team project.	Yes
label	Specifies a label that can be associated with a particular folder version or file version.	Yes
file	Specifies the name of the file(s) in the team project or the absolute path and full name of the local file(s).	Yes
tempdir	Specifies a local folder for storing temporary files.. The default temporary directory is specified in the ServerInfo>General Settings section of Dynamsoft SCM Anywhere Service Configurator.	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" and "Http", 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
ssl	Specifies whether to connect to server using SSL encryption, true or false. The default value is false.	No
loglevel: normal or debug	Specifies the type of log level. Valid parameters are "normal" or "debug". The default value is normal.	No
compression: true or false	true or false. The default value is true.	No

Examples

<scm:labelfile
server="127.0.0.1"
port="7771"
username="test"
pwd="test123"
teamproject="antplugin"
folder="$/anttest"
file="1.txt"
label="release" />

Label the file named 1.txt with release label in folder anttest of the team project antplugin.

labelfolder

Description

Task to perform Label Folder command to Dynamsoft SCM Anywhere.

Adds a label to a folder.

Parameters

Attribute	Values	Required
server	Specifies the domain name or IP address of a running Dynamsoft SCM Anywhere server.	Yes
port	Specifies the port of a running Dynamsoft SCM Anywhere server.	Yes
username	Specifies the user name used to log into Dynamsoft SCM Anywhere.	Yes
pwd	Specifies the password for the corresponding user to log into Dynamsoft SCM Anywhere.	Yes
teamproject	Specifies the team project you want to log into.	Yes
folder	Specifies a valid folder in the current Dynamsoft SCM Anywhere team project.	Yes
label	Specifies a label that can be associated with a particular folder version or file version.	Yes
tempdir	Specifies a local folder for storing temporary files.. The default temporary directory is specified in the ServerInfo>General Settings section of Dynamsoft SCM Anywhere Service Configurator.	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" and "Http", 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
ssl	Specifies whether to connect to server using SSL encryption, true or false. The default value is false.	No
loglevel: normal or debug	Specifies the type of log level. Valid parameters are "normal" or "debug". The default value is normal.	No
compression: true or false	true or false. The default value is true.	No

Examples

<scm:labelfolder
server="127.0.0.1"
port="7771"
username="test"
pwd="test123"
teamproject="antplugin"
folder="$/anttest"
label="release" />

Label the folder named anttest with release label in the team project antplugin.

Install Dynamsoft SCM Anywhere Ant Plug-in

To install Dynamsoft SCM Anywhere Ant Plug-in, please follow steps below:

1. Install SCM Anywhere Server. It can be download from:

2. Download SCM Anywhere 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 directory appropriately. If there is no such file, create it.

4. Click Start->Run and input cmd in the Open editable box and click Yes to open command line window. And change the directory to the Bin folder of Ant. Then Ant will be running.

SCM Anywhere Ant Plug-in Configuration Example