AAA User Guide

8/12/2019 AAA User Guide

1/28


2/28

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


3/28


1.0 OVERVIEW

The Accellion Automation Agent is a command line utility that extends and automatesenterprise secure file transfer capabilities. It allows the automation of upload anddownload of files and folders, email notification of file transfer activities and status, andautomated 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 anddownload 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 Offor Continuous Scan and Do

o In a One Offtask, AAA exits once the send/download task finishes

o In Continuous scan and Dotask, AAA keeps scanning either the local

folder or the inbox on the Appliance for new files. User can stop theAAAs continuous run by pressing Ctrl-C, Ctrl-Pause or Ctrl-Break


4/28


2.0 SETTING 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 onlyor download onlyor

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


5/28


3.0 INSTALLATION

3.1 WINDOWS AND MAC

Unzip the AAA distribution to the final install location.

While using Winzipto extract the files from the AAA distribution zip, the Use Folder

Namescheck 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 AccellionEnd 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 uploadedwhen 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 configsubdirectory i.e.

\AAA\Aclagent\config


6/28


3.2 LINUX

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.8cor later

(http://www.openssl.org/source/)

zlib-1.2.3or later

(http://www.zlib.net/)

curl-7.15.4or 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.pyand 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_PATHto 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


7/28


Test the pycurl install in Python by running:

/usr/local/bin/python2.5import pycurlpycurl.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


8/28


3.3 AAA LICENSE

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 f ile AAA exits without doing anything.

Location of the AAlicense.cfg on different operating systems is:

Windows:\AAA\aclagent\config

Mac:aaagent.app/Contents/Resources/config

Linux:/AAA/aclagent/config

3.0 INSTALLATION


9/28


10/28


5.0 USAGEThe application can be run from the console as aaagent.exe from the directory:

\AAA\AclagentTask 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


11/28


6.0 SEND FILES AS DOWNLOAD LINKS IN E-MAIL

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

aaagent.exe t upload

or

aclagent.exe t

The parameter pathis mandatory while the all the rest are optional.


-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: - exclude none)

IncludeFilter- A regular expression to send only the matching files (Default:

- 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


12/28


TemplateSubstituitions:Path to the file containing the values for place holdersin the e-mail template

First line of the file must be [EmailSubs]

Subsequently each line specifies one substitution value like = value e.g. Account = 1234

$Dateand $Timeare 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 previousparameter 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 f ile 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 beingsent. 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


13/28


send the abc.txt again. This is because the parameter was not set as 1 when thefile 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=, nothing will be done by default)

GetRecipientFromPath:- 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\[email protected]\file1.doc , this file will be sent to [email protected]

along with the email-id specified in MailTo

6.0 SEND FILES AS DOWNLOAD LINKS IN E-MA


14/28


7.0 DOWNLOAD

A download task can be started using the command:

aclagent.exe t download

or

aclagent.exe t

The target path, where the downloaded files have to be stored, must be specified for this

task. All other parameters are optional.


-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)


15/28


8.0 PLUG-IN SCRIPTS FOR POST TASK PROCESSINGAAA 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: 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


16/28


$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


17/28


9.0 APPLICATION LEVEL CONFIGURABLE OPTIONS

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.txtis 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::

ProxyUserPassword::

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)


18/28


LogToConsole = 0 or 1. 0 will result in the log messages to be suppressed formthe 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 ane-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$. Itcan 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 OPTION


19/28


%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


20/28


10.0 USING THE SAMPLES

The AAA install contains sample task configuration files and scripts to run AAA.

The samples are in the folder: /samples

Task Files

The Samples folder contains 4 sample text files that can be used as taskfiles. 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 [email protected]

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 [email protected]

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.batInvokes 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.


21/28


11.0 TROUBLESHOOTING

Config File not found

The AAlicense.cfg must be present in the config directory:

\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 -.AAAgent.log. This file can be found in the directory:

\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 =4in the AAconfiguration.txtfile that

can be found in the directory:

\AAA\aclagent\config


22/28


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.cfgmust 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 LINUX USERS

The command to invoke AAA on Linux is:

python aclagent.py

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.


23/28


13.0 ERROR CODESThe 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 possibleresolutions are classified as:

Account Errors The AAA account should be re-created on theAppliance, and the new AAlicense.cfg should be copied to the folder -AAA\aclagent\config

Application Errors AAA should be invoked again after settingLogLevel=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/foldersshould be checked. The AAA allowed tasks as per the license may also

lead to this type of errors.

Connectivity Errors The network connection including proxysettings between the machine running AAA and the appliance shouldbe checked.

Script Errors The post/pre send/receive scripts should be checked forany errors.

Setup Errors Invalid task parameters or Configuration options canlead 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


24/28


24 Account Incorrect Username201 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 detected2 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

original406 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


25/28


attachments422 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 tryagain

907 Application Invalid Expiry

908 Application Invalid File List911 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


26/28


1032 Application AES encryption failed1033 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 file438 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 forScript 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 confirmation1888 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 containany valid host names or IPs

433 Setup Failed to send as no recipient has been specified

13.0 ERROR CODES


27/28


440 Setup Unsupported encryption scheme441 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 thedecryption 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


28/28

14.0 GLOSSARY

AAA Acronym for Accellion Automation Agent

Accellion

ApplianceFile Transfer Appliance i.e. the server hosting the Accellionsolution

Aaagent The main application to be invoked to run AAA

AAlicense.cfg The license file that enables AAA to authenticate itself to theAccellion appliance

AAconfiguration.txt A text file that could be used to supply application settings to AAA

Documents

AAA User Guide