Dynamsoft SourceAnywhere Ant Plug-in

Contents

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

Introduction

In addition to the SourceAnywhere CriuseControl.NET plug-in, SourceAnywhere provides an Ant Plug-in which allow users to integrate SourceAnywhere with Ant.

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

The Tasks

• addfile: Adds one or multiple 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 r to add the project recursively.
• checkinfile: Checks in and unlocks one or multiple files. This command also makes the local files readonly.
• checkinproject: Checks in and unlocks an entire project. This command also makes the local files in the project readonly.
• checkoutfile: Checks out and locks one or multiple files 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.
• getlatestproject: Gets the latest version of all files in the specified project from the current project. Use r to get the project recursively.
• getolderversionproject: Gets the old version of all files in the specified project from the current project. Use r to get the project recursively.
• getprojecthistory: Displays the revision history of the project. 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.
• 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 = "7777"
• Username =" test "
• Password = "test123"
• Repository name = "antplugin"
• Project name ="$/anttest"
• Temp folder = "D:\temp"
• Working folder = "D:\projects\test"

addfile

Description

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

Parameters

Examples

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

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

addproject

Description

Task to perform Add  project command to Dynamsoft SourceAnywhere.

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

Parameters

Examples

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

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

checkinfile

Description

Task to perform Check In File command to Dynamsoft SourceAnywhere.

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

Parameters

Examples

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

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

checkinproject

Description

Task to perform Check In Project command to Dynamsoft SourceAnywhere.

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

Parameters

Examples

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

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

checkoutfile

Description

Task to perform Check Out File command to Dynamsoft SourceAnywhere.

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

Parameters

Examples

<saw:checkoutfile
server="127.0.0.1"
port="7777"
username="test"
pwd="test123"
repository="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 repository anttest.

checkoutproject

Description

Task to perform Check Out Project command to Dynamsoft SourceAnywhere.

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

Examples

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

Check out the  project named anttest in the repository antplugin.

newproject

Description

Task to perform New  project command to Dynamsoft SourceAnywhere.

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

Parameters

Examples

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

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

getfilehistory

Description

Task to perform Get File History command to Dynamsoft SourceAnywhere.

Displays the revision history of the file.

Parameters

Examples

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

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

getlatestfile

Description

Task to perform Get Latest File command to Dynamsoft SourceAnywhere.

Retrieves the most recent files from the current repository.

Parameters

Examples

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

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

getoldversionfile

Description

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

Retrieves the old file version from the current team project. The version parameter is used to specify an old file version.

Parameters

Examples

<saw:getoldversionfile
server="127.0.0.1"
port="7777"
username="test"
pwd="test123"
repository="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 repository antplugin.

getlatestproject

Description

Task to perform Get Latest Porject command to Dynamsoft SourceAnywhere.

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

Parameters

Examples

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

Get the project named anttest in the repository antplugin.

getoldversionproject

Description

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

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

Parameters

Examples

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

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

getprojecthistory

Description

Task to perform Get Project History command to Dynamsoft SourceAnywhere.

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

Parameters

Examples

<saw:getprojecthistory
server="127.0.0.1"
port="7777"
username="test"
pwd="test123"
repository="antplugin"
project="$/anttest"
v="true" />

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

labelfile

Description

Task to perform Label File command to Dynamsoft SourceAnywhere.

Adds a label to a file.

Parameters

Examples

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

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

labelproject

Description

Task to perform Label Project command to Dynamsoft SourceAnywhere.

Adds a label to a project.

Parameters

Examples

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

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

Install Dynamsoft SourceAnywhere Ant Plug-in

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

1. Install SourceAnywhere Server.

2. Download SourceAnywhere 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 Ant Plug-in Configuration Example

<project name="sawant" basedir="." default="sawgetlatestfile" xmlns:saw="antlib:com.dynamsoft.saws.ant.sawsant">
<target name="sawgetlatestfile">
<saw:getlatestfile
server="127.0.0.1"
port="7777"
username="admin"
pwd="1"
repository="anttest"
project="$/"
workdir="D:\projects\test"
tempdir="D:\temp"
file="1.txt">
</target>
</project>