You are on page 1of 28

ACCELLI ON AUTOMATI ON AGENT (AAA) USER GUI DE

Accellion, Inc.
1804 Embarcadero Road
Suite 200
Palo Alto, CA 94303
Tel +1 650 485-4300
Fax +1 650 739-0561
www.accellion.com
support@accellion.com
PROPRIETARY AND CONFIDENTIAL
SUBJECT TO CHANGE WITHOUT NOTICE.
2010-2014 Accellion, Inc. All Rights
Reserved.
Version 2.9 Accellion AAA User Guide 2
TABLE OF CONTENTS
1.0 OVERVIEW .................................................................................... 3
2.0 SETTING UP AN AAA ACCOUNT ................................................ 4
3.0 INSTALLATION ............................................................................. 5
3.1 Windows and Mac ....................................................................................... 5
3.2 LINUX ........................................................................................................... 6
3.3 AAA License ................................................................................................ 8
4.0 CAPABILITIES ............................................................................... 9
5.0 USAGE ......................................................................................... 10
6.0 SEND FILES AS DOWNLOAD LINKS IN E-MAIL ...................... 11
7.0 DOWNLOAD ................................................................................ 14
8.0 PLUG-IN SCRIPTS FOR POST TASK PROCESSING ............... 15
9.0 APPLICATION LEVEL CONFIGURABLE OPTIONS .................. 17
10.0 USING THE SAMPLES .............................................................. 20
11.0 TROUBLESHOOTING ............................................................... 21
12.0 NOTES ....................................................................................... 22
12.1 Mac Users ................................................................................................ 22
12.2 Linux Users ............................................................................................. 22
13.0 ERROR CODES ......................................................................... 23
14.0 GLOSSARY ............................................................................... 28
Version 2.9 Accellion AAA User Guide 3
1. 0 OVERVI EW
The Accellion Automation Agent is a command line utility that extends and automates
enterprise secure file transfer capabilities. It allows the automation of upload and
download of files and folders, email notification of file transfer activities and status, and
automated scheduled file transfers.
HIGHLIGHTS
A tool for scripted file transfer solution using the Accellion appliance
Able to send files as downloadable links in e-mails via the Accellion Appliance
Can scan for files received for its account on the Accellion Appliance and
download the same
Runs as a command line application that can be invoked for specific send or
download task
Tasks can be specified using command line options or a taskconfiguration
file
Console log that updates with activity messages while the task is running
The tasks can be of two types One Off or Continuous Scan and Do
o In a One Off task, AAA exits once the send/download task finishes
o In Continuous scan and Do task, AAA keeps scanning either the local
folder or the inbox on the Appliance for new files. User can stop the
AAAs continuous run by pressing Ctrl-C, Ctrl-Pause or Ctrl-Break


Version 2.9 Accellion AAA User Guide 4

2. 0 SETTI NG UP AN AAA ACCOUNT

A new AAA account can be created using the Manage->Automation menu option on the
Accellion Administration Interface.
The following details are needed when creating a new AAA account:
The E-mail id to be associated with this account
Target operating system for the AAA install Windows or Mac (Intel) or
Linux
The allowed tasks for this account upload only or download only or
both upload and download
An account invitation e-mail is sent to the E-mail id associated with the account. This e-
mail contains download links for:
The AAA distribution - a zipped file for Windows and Mac, or two .tar files for
Linux
The license file (AAlicense.cfg) for the new account
The AAA User Guide



Version 2.9 Accellion AAA User Guide 5

3. 0 I NSTALLATI ON

3. 1 WI NDOWS AND MAC
Unzip the AAA distribution to the final install location.
While using Winzip to extract the files from the AAA distribution zip, the Use Folder
Names check box must be ticked.
This will create a folder structure like:
AAA - Contains the Readme.txt file
aclagent - Main directory with all the program files.
Contains aaagent.exe: the main utility to be invoked
config - Contains the configuration file:
AAconfiguration.txt. The account License
(AALicense.cfg), downloaded using the invitation e-
mail, needs to be placed in this directory
Licenses - Contains license files including Accellion
End User License Agreement
samples - Contains samples task files, email body
template, email substitutions, and script files to run
these task files
UploadFolder - The test folder that gets uploaded
when running the sample scripts

The subdirectory aclagent contains a file called Library.zip - do not unzip it.
AAA License:
Copy the downloaded AAlicense.cfg to the config subdirectory i.e.
<AAA install directory>\AAA\Aclagent\config




Version 2.9 Accellion AAA User Guide 6

3. 2 LI NUX
AAA is available as a Python module on Linux
To use AAA, the Linux admin must install Python (2.5 only) and other required libraries
and Python modules.
Required Libraries:
Sqlite3 3.0.8 or later
(http://www.sqlite.org/sqlite-3.3.16.tar.gz)
Python 2.5 only
(http://www.python.org/download/)
openssl-0.9.8c or later
(http://www.openssl.org/source/)
zlib-1.2.3 or later
(http://www.zlib.net/)
curl-7.15.4 or later build with SSL support
(http://curl.haxx.se/download.html)

Python Modules:
The Python packages listed below must be installed using the respective source tar balls.
All the tar balls contain a setup.py and can be installed with the command:

python setup.py install

All these Python package installs require a C compiler and certain development packages
should also be available on the Linux install. If these are not already present on the target
machine, the sys admin would need to install the missing development packages as
suggested by the errors during the setup.py execution.
List of required Python modules:
pycurl-7.15.4
(http://pycurl.sourceforge.net/download/pycurl-7.15.4.tar.gz)
May require setting the LD_LIBRARY_PATH to the install path of curl lib
e.g./usr/local/lib
It must be built with SSL support, a typical install command would be:
python2.5 setup.py install openssl-dir=/usr/local/ssl


3.0 INSTALLATION
Version 2.9 Accellion AAA User Guide 7
Test the pycurl install in Python by running:
/usr/local/bin/python2.5
import pycurl
pycurl.version
pycurl.version : should echo the installed versions of curl, openssl and zlib
pyxml-0.8.4
(http://prdownloads.sourceforge.net/pyxml/PyXML-0.8.4.tar.gz?download)
pycrypto-2.0.1
(http://www.amk.ca/files/python/crypto/pycrypto-2.0.1.tar.gz)
twisted-2.5.0
(http://tmrc.mit.edu/mirror/twisted/Twisted/2.5/Twisted-2.5.0.tar.bz2)
ZopeInterface-3.0.1final
(http://www.zope.org/Products/ZopeInterface/3.0.1final/ZopeInterface-3.0.1.tgz)
Installing AAA Tar ball
AAA.tar.bz2 Its contents can be extracted to any convenient location. This contains the
script to be run to execute the AAA
3.0 INSTALLATION


Version 2.9 Accellion AAA User Guide 8

3. 3 AAA LI CENSE
Account information for each AAA account is stored in the license file, AAlicense.cfg.
The license includes the Accellion Account id and other parameters that AAA uses to
authenticate to the Appliance.
In the absence of the license file AAA exits without doing anything.
Location of the AAlicense.cfg on different operating systems is:
Windows: <install directory>\AAA\aclagent\config
Mac: aaagent.app/Contents/Resources/config
Linux: <install directory>/AAA/aclagent/config
3.0 INSTALLATION


Version 2.9 Accellion AAA User Guide 9

4. 0 CAPABI LI TI ES
Sending an Accellion E-Mail containing links for a file or folder:
AAA can be setup to send either a particular file or all files from a folder to the specified
recipients.
The subject and body of the e-mail can be set using the task file options.
There are options to change the default recipient authentication method, file expiration,
receiving download notification e-mails, or sending a copy of the e-mail to the AAA
account owner.
There is an option to not upload subdirectories.
Downloading files received for the AAA account:
AAA can download files that have been received on the Accellion Appliance for an
account.
The local download path can be configured to include the email id of the sender as well
as the timestamp when the file was received.
Continuous Scan Mode:
1. For a Send Task:
AAA can be setup to periodically scan a folder and send any new files added to it
AAA waits for a new file to stabilize before trying to send it out.
AAA can be setup to rename or delete a file after being sent
2. For a Download Task:
AAA can be setup to periodically scan the inbox of the account on the Accellion
Appliance and download any files as they are received
The periodic scan frequency can be set in the task file
Optional Task Summary E-mail
AAA can send a task summary e-mail to a specified address before quitting.
The summary contains success or failure data (file size/s, time, error info, etc) pertaining
to the task.
Plug-in Scripts for Post Send or Download Processing
AAA can invoke an external script upon completing a Send or Download task.
The external script can be an executable, Python script, or shell script on Linux.




Version 2.9 Accellion AAA User Guide 10

5. 0 USAGE
The application can be run from the console as aaagent.exe from the directory:
<AAA install dir>\AAA\Aclagent
Task details can be specified through either command line options or in a task
configuration file.
A basic subset of options is available through the command line as compared to the
complete list of parameters available in a task configuration file.
If a parameter is passed via command line and appears in the task configuration file also,
then the command line value is used.
Command Line Parameters:
h or help: Print a short usage guide on console.
s: Prompts the user for proxy information that will be stored encrypted for later
use
t or task: A required parameter that specifies the task type directly or the task
configuration file path
Return Codes:
AAA exits once the task is completed with an exit code:
0: Signifies a successful completion of the task. Any other value indicates an
error




Version 2.9 Accellion AAA User Guide 11

6. 0 SEND FI LES AS DOWNLOAD LI NKS I N E-MAI L

A send e-mail task can be started using the command:

aaagent.exe t upload
or
aclagent.exe t <path to upload task configuration file>

The parameter path is mandatory while the all the rest are optional.

Command Line Parameters:
-p or --path: Full path of the folder or file that is to be uploaded
-m or --mailto: Comma separated list of e-mail id, to whom an e-mail will be sent
containing the links to the uploaded files
-i or --includesubdirs: 0 or 1, 1 uploads the subdirectories, 0 does not
(Default=1)

Task File Parameters:
Task: upload
Path: Full path of the folder or file that is to be sent
MailTo: Recipients that receive an e-mail containing download links to the
uploaded files. Multiple recipients must be comma separated.
MailCc: Comma separated list of e-mail recipients that will receive a copy of the
e-mail containing download links to the uploaded files
MailBcc: Comma separated list of e-mail recipients that will receive a blind copy
of the e-mail containing download links to the uploaded files
IncludeSubDirs: 0 or 1 , 1 uploads the subdirectories, 0 does not (Default=1)
ExcludeFilter- A regular expression to exclude the matching files from being
sent. (Default: <Blank> - exclude none)
IncludeFilter- A regular expression to send only the matching files (Default:
<Blank> - include all)
EmailSubject: The subject of the email message (Default=UploadSummary)
EmailTemplate: Path to the file containing the e-mail body template in plain text
The text may contain place holders to be substituted with values specified in
the TemplateSubstitutions file
Each place holder starts with a $. e.g. $Account

Version 2.9 Accellion AAA User Guide 12

TemplateSubstituitions: Path to the file containing the values for place holders
in the e-mail template
First line of the file must be [EmailSubs]
Subsequently each line specifies one substitution value like <place holder
name> = value e.g. Account = 1234
$Date and $Time are substituted with the current date and time respectively
if not specified in this file
ReturnReceipt: 0 or 1, 1 results in a notification e-mail being sent to the AAA
account owner when a recipient downloads a file. (Default=1)
ReturnReceiptAddresses: Comma separated list of e-mail recipients that will
receive a download notification. The notification is sent only if the previous
parameter ReturnReceipt is set to 1. This is in addition to the notification sent to
the account owner
RecipientAuthentication: Can be set to one of the following:
na: No authentication anybody can download the file by clicking on the
link
vr: Verify recipient download is allowed only to the direct recipients of the
e-mail
vi: Verify internal - the direct recipients may forward the link to same
domain e-mail ids
ck: Cookie any authenticated user on the Accellion appliance may
download the file
(Default=vr)
LinkValidity: Number of days for which the link remains valid (Default: as set on
Accellion Appliance Manager Interface)
EmailCopyToOwner: 0 or 1, 1 results in a copy of the e-mail with links to be
sent back to the AAA account owner (Default=0)
RenameSuffix: Folder is renamed by adding this suffix after task completion
ZipBeforeSending: 0 or 1, 1 results in sending the files or folder as a single zip
file (Default=0)
EncryptBeforeSending: 0 or 1, 1 results in the file being encrypted before being
sent. The Appliance will de-crypt the file when the user clicks on the download
link (Default=0)
EnableResume: 0 or 1, 1 results in the current task being compared with earlier
unfinished tasks and, if found, will restart a 'same' old unfinished task (Default=0 )
SendNewOrChanged: 0 or 1, 1 results in sending only those files that have not
been sent previously or have changed since being sent. Please note that the
AAA will track this information only if the parameter is set to 1 e.g., if the AAA is
invoked without this parameter and sends out a file c:\folder\abc.txt, and then if
AAA is invoked again for the same folder but with SendNewOrChanged =1, it will
6.0 SEND FILES AS DOWNLOAD LINKS IN E-MAIL

Version 2.9 Accellion AAA User Guide 13

send the abc.txt again. This is because the parameter was not set as 1 when the
file was sent earlier. (Default: 0.)
SendNewerThan: This date-time value serves as a cutoff for the modified or
creation time of the files being sent. Only those files will be sent that have been
created or modified after the specified date-time. Format YYYY-MM-DD-HH-
mm-SS (where YYYY= year, MM= month, DD=day, HH= hour, mm=minute,
SS=second). (Default: None i.e. all files will be sent.)
SendOnlyToAccellion: 0 or 1, 1 results in the files being sent only to the
Accellion Inbox of the recipients the e-mail with download links is not sent. This
option is useful for machine to machine transfers where the text and download
links in the e-mail are not required. (Default: 0.)
Parameters that apply only for the Continuous Scan mode:
ContinuousRun: 0 or 1, 1 makes AAA periodically scan the folder specified by
the parameter Path. It starts the send process immediately on detecting any
stable file in the folder (Default=0)
ScanFrequency: Any whole number this is the time period in seconds between
two successive scans for new files that need to be uploaded (Default=120)
PostSendProcess: This parameter dictates what AAA will do with files after
sending them:
0 - delete- delete files after sending
1 - rename rename the files by appending the RenameSuffix to the
filename
(Default=<Not specified>, nothing will be done by default)
GetRecipientFromPath: <a valid regular expression>- The part of the upload
path that matches the regular expression will be used as the recipient email-id/s.
E.g. if GetRecipientFromPath = ^.*?(?=\\) and the upload Path is
c:\uploadfolder\abc@xyz.com\file1.doc , this file will be sent to abc@xyz.com
along with the email-id specified in MailTo

6.0 SEND FILES AS DOWNLOAD LINKS IN E-MAIL

Version 2.9 Accellion AAA User Guide 14

7. 0 DOWNLOAD

A download task can be started using the command:
aclagent.exe t download
or
aclagent.exe t <path to download task configuration file>
The target path, where the downloaded files have to be stored, must be specified for this
task. All other parameters are optional.
Command Line Parameters:
-p or --path: Full path of the local target folder to which all files will be
downloaded

Task File Parameters:
Task: download
Path: Full path of the local target folder to which all files will be downloaded
SenderEmail: Files received from only the SenderEmail will be downloaded. If
omitted it downloads all files irrespective of the sender. This parameter is ignored
for ContinuousRun=1
EmailAge: 0 or any number Files received in the last EmailAge days will only
be downloaded. 0 means unlimited. (Default=0) This parameter is ignored for
ContinuousRun=1
UnzipAfterDownloading: 0 or 1, 1 results in unzipping of any .zip that gets
downloaded (Default=0)
EnableResume: 0 or 1, 1 results in the current task being compared with earlier
unfinished tasks and if found to restart a 'same' old unfinished task (Default=0)
DownloadMailBody: 0 or 1, 1 results in the text of the e-mail being downloaded
as well as the files. (Default=0)
Parameters that apply only for the Continuous Scan mode:
ContinuousRun: 0 or 1 , 1 makes AAA scan its inbox on the Accellion Appliance
every 5 seconds. It starts the download process immediately for any files found
on the Appliance. (Default=0)
ScanFrequency: Any whole number this is the time period in seconds between
two successive scans for new files that need to be downloaded. (Default=120)
DownloadAgain: 0 or 1 , In continuous scan and download mode, AAA keeps
track of the timestamp of when the last file was downloaded. Setting
DownloadAgain=1, will make AAA disregard the already downloaded timestamp,
and will download all files that are available in the inbox irrespective of whether it
has already been downloaded or not (Default=0)
Version 2.9 Accellion AAA User Guide 15
8. 0 PLUG-I N SCRI PTS FOR POST TASK PROCESSI NG
AAA can invoke an external plug-in after sending or downloading a file/email package.
The plug-in can be an executable or a shell script or a Python script. The parameters to
control the invocation of the plug-in are placed in a separate section of the task file.
Plug-in Section Header Names:
[PostSendScript]: This section specifies the plug-in to be invoked after sending
a file
[PostDownloadScript]: This section specifies the plug-in to be invoked after
downloading a file
[PostEmailDownloadScript]: This section specifies the plug-in to be invoked
after downloading an e-mail package
Plug-in Parameters:
Type: exe or script or python specifies the plug-in type
Name: Full path to the plug-in script or executable. Any Python scripts must be
placed in the Python environment path, and the Name should be just the name
of the Python module
Call: Only required for a Python script this is the method name to be invoked
from the python module specified in the previous parameter Name
RunCondition: RunAlways' or 'RunOnSuccess' or RunOnFailure The plug-in
is invoked according to the task result (Default=RunOnSuccess, the plug-in is
invoked only if the basic task was successful)
WaitForResult: 0 or 1 Decides if the AAA waits for the exit code of the plug-in
or not (Default=0)
FailureMode: FailTask or IgnoreFailure Decides if the failure of the plug-in is
treated as task failure or not (Default=FailTask)
Parameter<x>: <x> is the serial number of the parameter The plug-in section
may contain any number of parameters to be passed to the plug-in. The
parameters are expected to be numbered 1 onwards
Internally Available Parameters:
The following may be specified as the value of a parameter:
$FILE_PATH$: utf8 encoded path of the downloaded file (not available for
PostEmailDownloadScript)
$FILE_LIST$: comma separated list of utf8 encoded paths to the list sent or
downloaded files (in case these were unzipped). (not available for
PostEmailDownloadScript)
$Result$: Error code of the send/download task. 0 denotes success
$MailTo$: Recipient e-mail id in case of a send operation
Version 2.9 Accellion AAA User Guide 16
$MailCc$: Cc Recipient e-mail id in case of a send operation
$MailBcc$: Bcc Recipient e-mail id in case of a send operation
$SenderId$: E-mail id of the sender in case of a download operation
$ATT_DIR$: utf8 encoded folder path where all the attachments in the e-mail
package are stored after being downloaded (only for PostEmailDownloadScript)
$BODY_PATH$: utf8 encode path to the file that stores the body of the
downloaded e-mail (only for PostEmailDownloadScript)
8.0 PLUG-IN SCRIPTS FOR POST TASK PROCESSING

Version 2.9 Accellion AAA User Guide 17

9. 0 APPLI CATI ON LEVEL CONFI GURABLE OPTI ONS

AAA exposes certain application level options to configure its behavior.
These options apply irrespective of the task file parameters.
These configurable parameters are to be specified in the text file AAconfiguration.txt
that is placed in the config directory of the AAA install.
A sample AAconfiguration.txt is part of the AAA install and it may be edited to suit the
requirements of a particular installation.
The first line of the file must always be [configuration].
Each of the subsequent lines can be used to specify value for one parameter in the
format: Parameter Name = Parameter Value.
A line is ignored if it starts with the character #.
Application Level Parameters:
ProxyServer: <Proxy host name>:<port>
ProxyUserPassword: <username for proxy>:<password>
SendSummaryEmail: 0 or 1, 1 will result in a task summary e-mail being sent
on completion of the task (Default=0)
SummaryEmailId: The e-mail id to which the summary e-mail should be sent
SameLinkInSummary=0 or 1. 1 results in one of the original file download links
to be included in the upload summary e-mail also. (Default = 1).
LogLevel: 1, 2, 3 or 4, 4 is the debugging level and results in a detailed log
HostName: Hostname for the Accellion appliance, specifying it here will override
the entry in the license
UploadServerList: A comma separated list of hostnames or IP addresses that
determines the priority order for file uploads (Default=$HostName$)
MaxLinksInMail = 0 or (any number), The file-links in the e-mail will be limited to
a maximum of MaxLinksInMail. Setting it to 0 removes the limit (Default=0)
ChunkSize = 10000000 (size in bytes). Specifies the size of subparts while
uploading a large file. Any interrupted uploads are resumed from the last
uploaded subpart. (Default = 10000000 - 10Mb)
TaskCleanupSeconds = 86400 (or any number). The time in seconds after
which the entries in the task database are deleted. Set it to LinkExpiry*86400 for
EnableResume=1 to work properly for downloads.
CompressMaxSize = 1000000000 (size in bytes). Maximum limit on file size
that controls if a file is to be zipped or not. (Default = 1000000000 - 1Gb)
EncryptMaxSize = 1000000000 (size in bytes). Maximum limit on file size that
controls if a file is to be encrypted or not. (Default = 1000000000 - 1Gb)

Version 2.9 Accellion AAA User Guide 18

LogToConsole = 0 or 1. 0 will result in the log messages to be suppressed form
the console and be logged only to the log file. (Default =1)
LogHeartBeat =0 or 1. 0 will result in suppressing the heart beat log messages
like +++++ from appearing in the log. (Default =1)
MaxTries = any number. Controls the number of times a task it tried before being
treated as failed. (Default =3).
UploadBatchSize= any number. Controls the number of files that can be
uploaded in parallel. (Default =3).
DownloadBatchSize= any number. Controls the number of files that can be
downloaded in parallel. (Default =3).
MailDownloadPath= Logical placeholder for deciding the download path for an
e-mail package. (Default = $BasePath$/$SenderEmail$/$MessageTimeStamp$)
AttachmentDownloadPath = Logical placeholder to specify a folder to download
all attachment files within an e-mail package. (Default = $MailDownloadPath$)
BodyDownloadPath = name and path of the text file that should contain the
downloaded body of the e-mail. (Default = $MailDownloadPath$/mailbody.txt)
DownloadPath: It decides the final path for downloaded files. (Default =
$AttachmentDownloadPath$/$FullPath$/$FileName$). The preceding e-mail
download path related parameters may contain any combination of the following
parameters:
$BasePath$: The local path specified in the parameter Path in task file or
on the command line
$SenderEmail$: E-mail id of the sender
$MessageTimeStamp$: The time at which the file was received on the
Accellion Appliance (in GMT). The format is changeable using the
parameter FileTimeFormat
$MessageUnixTimeStamp$: The Unix timestamp (seconds since epoch
time) at which the file was received on the Accellion Appliance (in GMT)
$FullPath$: The original folder structure associated with the file on the
sender machine. This is available only if the file was sent using AAA
$FileName$: Name of the file
FileTimeFormat: Timestamp format to be used in the $MessageTimeStamp$. It
can be a combination of any the following placeholders and any other characters
that are allowed in a filename:
%Y: 4 digit year
%y: 2 digit year
%m: 2 digit month
%d: 2 digit day of month
%j: 3 digit day of the year
9.0 APPLICATION LEVEL CONFIGURABLE OPTIONS

Version 2.9 Accellion AAA User Guide 19

%H: 2 digit 24 hour clock hour
%I: 2 digit 12 hour clock hour
%p: am/pm
%M: 2 digit minute
%S: 2 digit second
(Default=%Y%m%d_%H%M%S)
Failure Alert E-mail Setup
A feature to send out failure alert e-mails can be activated using the following parameters:
AlertId: E-mail address to be notified in case of a failure
SMTPHost: SMTP host to be used to send the failure e-mail. This SMTP
server must accept e-mails originating from the e-mail id that is associated
with the AAA account
AlertAfterFailureCount: Number of failures after which the notification
should be sent. (Default=0, no alert e-mails.)
AlertFrequency: Time in seconds after which AAA will check for failures
since the last alert e-mail. Another email will be sent if something else
subsequently fails (Default=1800, half hour)
AlertOnEveryFailure: 0 or 1, Setting this to 1, will result in a notify e-mail
for every failure regardless of the AlertFrequency
9.0 APPLICATION LEVEL CONFIGURABLE OPTIONS

Version 2.9 Accellion AAA User Guide 20

10. 0 USI NG THE SAMPLES

The AAA install contains sample task configuration files and scripts to run AAA.
The samples are in the folder: <AAA install>/samples
Task Files
The Samples folder contains 4 sample text files that can be used as task files. These
sample task files make use of a minimal set of parameters and contain helpful text for all
the available parameters .These can be easily edited to suit the requirements.
Upload.tsk: The parameters in this file specify a task to send the folder
samples/uploadfolder to the e-mail id agent1@accellion.com
Continuous_upload.tsk: The parameters in this file specify a task to
continuously scan the folder samples/uploadfolder and send new files to the e-
mail id agent1@accellion.com
Download.tsk: The parameters in this file specify a task to download files
received in the last 10 days for the AAA account. The files are downloaded to
the folder samples/downloadfolder
Continuous_download.tsk: The parameters in this file specify a task to keep
scanning and downloading any incoming files for the AAA account to the folder
samples/downloadfolder
Batch Files
The samples folder contains scripts to invoke AAA with upload.tsk or download.tsk. The
script files are OS dependent:
Windows- upload.bat Invokes AAA using the upload.tsk, and download.bat
invokes AAA using the download.tsk
Linux- upload.sh: Invokes AAA using the upload.tsk, and download.sh
invokes AAA using the download.tsk
Email Template Files
The following text files are used for the email notification:
emailtemplate.txt: This text file contains a sample email body template.
emailsubs.txt: This text file is a sample email body substitutions file.
Running the Samples
The first step in running the samples is to create a new AAA account on the Accellion
Administration Interface.
Then the AAA account license file should be downloaded and placed in the config folder
in the AAA install.

Version 2.9 Accellion AAA User Guide 21

11. 0 TROUBLESHOOTI NG
Config File not found
The AAlicense.cfg must be present in the config directory:
<AAA install dir>\AAA\Aclagent\config
Expired Account
If the reported error says Share key not found or invalid it means that the AAA
account has expired and needs to be renewed via the Accellion Administration interface.
Each time it runs, the AAA logs its activity in the file <yyyymmdd>-<unixtime
stamp>.AAAgent.log. This file can be found in the directory:
<AAA install dir>\AAA\aclagent\logs
Debugging Mode
If AAA is behaving abnormally, Accellion support should be contacted with the relevant
task information and the logs.
Accellion Support may ask the user to retry the task in the debugging mode. Debugging
mode can be switched on by specifying LogLevel =4 in the AAconfiguration.txt file that
can be found in the directory:
<AAA install dir>\AAA\aclagent\config

Version 2.9 Accellion AAA User Guide 22

12. 0 NOTES

12. 1 MAC USERS
AAA distribution is available only for Intel Macs
The distribution requires Mac OS X
It has been tested on Mac OS X Tiger
The AAlicense.cfg must be copied to the directory:
aclagent.app/Contents/Resources/config
To command to run the AAA application is

aclagent.app/Contents/MacOS/aclagent

The location of the log files is:
aclagent.app/Contents/Resources/logs

12. 2 LI NUX USERS
The command to invoke AAA on Linux is:

python aclagent.py <options>

If an earlier version of AAA (older than 2.2.6.8) was installed on the same machine,
upgrading to this version requires an old directory named FTAfoundation (in Python
lib/site-packages) be deleted.

Version 2.9 Accellion AAA User Guide 23

13. 0 ERROR CODES
The exit return value of an AAA invocation can be used to check if the task
was completed successfully or not. A return value of 0 denotes success. Any
other value indicates the failure error code. The error codes and possible
resolutions are classified as:
Account Errors The AAA account should be re-created on the
Appliance, and the new AAlicense.cfg should be copied to the folder -
AAA\aclagent\config
Application Errors AAA should be invoked again after setting
LogLevel=4 in the AAconfiguration.txt. And if it fails again, the log
file and task parameters should be sent to Accellion support
Authorization Errors The local permissions to access files/folders
should be checked. The AAA allowed tasks as per the license may also
lead to this type of errors.
Connectivity Errors The network connection including proxy
settings between the machine running AAA and the appliance should
be checked.
Script Errors The post/pre send/receive scripts should be checked for
any errors.
Setup Errors Invalid task parameters or Configuration options can
lead to these errors.
The complete list of error codes is as below:

Error
Code
Type of
Error
Details
5 Connectivity Could not resolve proxy server name or ip
6 Connectivity Unable to connect to DNS server
7 Connectivity Unable to connect to server
18 Connectivity Incomplete result from server
27 Connectivity Connection thread is out of memory
28 Connectivity Awaiting response: Operation timed out
33 Connectivity HTTP RANGE command error
34 Connectivity HTTP POST error
35 Connectivity SSL connection error
45 Connectivity HTTP connection error
47 Connectivity Exceeded Limit of redirects
52 Connectivity No response received from server(on SSL/http)
53 Connectivity Unable to verify SSL support
54 Connectivity Unable to initialize SSL support
55 Connectivity Unable to send network data
56 Connectivity Unable to receive network data
99 Connectivity Upload Suspended pending space limit check

Version 2.9 Accellion AAA User Guide 24

24 Account Incorrect Username
201 Account Undefined user id or password
202 Account Undefined username token index
203 Account Undefined hash token
901 Account Invalid/Non-existent account number
902 Account Either the user id does not exist or the user
id/password is invalid
903 Account Invalid User
904 Account Either the user id does not exist or the user
id/password is invalid
905 Account Recipient(s) are not valid users of the service
1034 Account Blank share key detected
2 Application Application cannot create network connection
23 Application Unable to write local file
26 Application Unable to open or read file
37 Application Unable to read file
40 Application Unable to locate required library
41 Application Unable to locate required function
43 Application Function called with invalid argument
44 Application Invalid sequence of Functions called
46 Application Incorrect password
204 Application Undefined expiry date
205 Application Undefined allowed host
206 Application Invalid parameter
211 Application Token has expired
213 Application Invalid token
222 Application Token has expired
400 Application Unable to parse the WDDX packet
401 Application Upload null confirmation
403 Application Encountered an unexpected problem. Please e-mail
the log files to Accellion
405 Application The secure hash for the file did not match the
original
406 Application Unsupported file name
407 Application It is already uploaded
408 Application Unable to read the file
411 Application Failed to copy a part of the file
415 Application Some of the compulsory parameters have not been
specified
416 Application Failed to send the e-mail through the appliance
417 Application Failed to parse the incoming mail to extract the
13.0 ERROR CODES

Version 2.9 Accellion AAA User Guide 25

attachments
422 Application Files larger than 2G are not supported
423 Application Failed to write the mail body
424 Application There are no files to be downloaded
431 Application Failed to parse the incoming e-mail
432 Application Failed to send the e-mail
434 Application Failed to create a zip of the files
435 Application Failed to extract files from a zip
906 Application An error occurred while sending the email. Please try
again
907 Application Invalid Expiry
908 Application Invalid File List
911 Application This mail has already been sent
912 Application API should be called on the controller location
1000 Application Invalid number of arguments
1002 Application MD5 token is invalid
1003 Application MD5 token has expired
1006 Application File has expired
1007 Application File handle already exists
1008 Application File handle does not exist
1009 Application Redirected to other locations
1010 Application Unknown method
1011 Application Invalid upload parameter range
1014 Application Specified location/s is/are invalid
1015 Application Specified search pattern is invalid
1016 Application MD5 token is invalid due to incorrect format
1017 Application MD5 token is invalid due to incorrect expiry
datetime format
1018 Application MD5 token is invalid due to expiry datetime
conversion failure
1019 Application File handle is invalid
1020 Application Invalid byte-range download request
1022 Application Parameters (file_handle, info_tag or event_tag)
exceeded character limit
1024 Application MD5 token is invalid due to invalid file path
1025 Application Invalid total number of fragment files in one of the
fragment file
1026 Application Invalid total number of fragment files found
1027 Application One of the fragment file not found
1028 Application Encryption/Decryption key format is invalid
1030 Application Encryption/Decryption key checksum failed
13.0 ERROR CODES

Version 2.9 Accellion AAA User Guide 26

1032 Application AES encryption failed
1033 Application AES decryption failed
1050 Application Partial Success: Only some of the files were
uploaded successfully
1051 Application Failed to upload all of the files
212 Authorization Host is not allowed
221 Authorization Host IP is not allowed
301 Authorization Unauthorized access
404 Authorization Could not create local file
409 Authorization Unable to read the file as it is being used by some
other process
437 Authorization Failed to rename the file
438 Authorization Failed to delete the file
439 Authorization Failed to encrypt the file
1004 Authorization MD5 token is invalid due to unauthorized IP address
1023 Authorization This file is unavailable for public download
1035 Authorization Cookie authentication failed
418 Script Task file does not contain the required parameter for
Script Type
419 Script Unsupported script type specified in the Task file
420 Script External script raised an unspecified error
421 Script Task file does not contain the required parameter for
Script Call
425 Script The specified script or call could not be found
22 Server Requested page not found on Server
999 Server Internal Error
1001 Server Error connecting to database or executing SQL
statement
1005 Server Unable to locate File
1012 Server CGI error - missing Application ID
1013 Server CGI error - error creating temporary file
1021 Server Internal redirection
1300 Server Upload null confirmation
1888 Server Status mode is on
1999 Server Fatal error
51 Setup Invalid SSL certificate
402 Setup There are no files to be uploaded
410 Setup Insufficient disk space for temporary files
413 Setup The parameter UploadServerList does not contain
any valid host names or IPs
433 Setup Failed to send as no recipient has been specified
13.0 ERROR CODES

Version 2.9 Accellion AAA User Guide 27

440 Setup Unsupported encryption scheme
441 Setup Failed to get the task parameters from the task file
442 Setup Type of the task is not specified
443 Setup The continuous scan task is not supported
1029 Setup Encryption/Decryption scheme not supported
910 Temporary
Account
All the files do not exist on server
913 Temporary
Account
All the files do not exist on server yet
42 Cancelled by User
412 Task was aborted by the user
414 Encrypted files cannot be downloaded as the
decryption key is not stored on the appliance
436 The task was interrupted
444 Application is not licensed to execute upload tasks
445 Application is not licensed to execute download tasks
1031 File is infected with virus and has been quarantined.
Please contact the sender

13.0 ERROR CODES

Version 2.9 Accellion AAA User Guide 28

14. 0 GLOSSARY

AAA Acronym for Accellion Automation Agent
Accellion
Appliance
File Transfer Appliance i.e. the server hosting the Accellion
solution
Aaagent The main application to be invoked to run AAA
AAlicense.cfg The license file that enables AAA to authenticate itself to the
Accellion appliance
AAconfiguration.txt A text file that could be used to supply application settings to AAA