download free 30 days trial version buy bucket explorer
Documentation  Download  Purchase  Support  FAQs   Forum   ScreenShots & Demos

Amazon S3 - Bucket Commander Configuration

Bucket Commander needs a configuration file to perform Upload/Download/Copy operations. If Bucket Commander configuration file does not exist, it will show the message: Configuration file ' \config\BucketCommander.xml' does not exist. You can use 'Edit Commander Config File' option from Tools in Bucket Explorer to set commander config. If you are using only Bucket Commander, then you need to edit BucketCommander.xml manually.

You need to follow the given steps to run Bucket Commander for Download/Upload/Copy operations:

1. Save Credential
2. Edit Commander Configuration File
3. Set Email Configuration to send Email Report for Commander Operations

  Save Credential

To save credentials, you need to edit BucketExplorer.XML.
  1. Open Bucket Explorer.XML from <Bucket Explorer Root Folder>\config\BucketExplorer .xml.
  2. You will find the <Authentication> tag in XML.
  3. Under this tag, you will find these tags:


    <CommanderAKey> tag with value "PlainText:[sampleAccessKey]"
    <CommanderSKey> tag with value "PlainText:[sampleSecretKey]"
  4. Replace the [sampleAccessKey] with your Access key.
  5. Now replace the [sampleSecretKey] with your Secret key.
  1. Replace the existing value of <Name> Tag with any new value.

    E.g. BucketExplorer.xml:


    <Authentication>
    <Akey>PlainText:[sampleAccessKey]</Akey>
    <Skey>PlainText:[sampleSecretKey]</Skey>
    <CommanderAKey>PlainText:GHKLIURTYHNMKLUMGT76</CommanderAKey>
    <CommanderSKey>PlainText:2rU8bnRhrkpf0qG50cXW7tyvlwogtdbUFQnJn56th</CommanderSKey>
    <Password>false</Password>
    <Time>1257853614647</Time>
    <DontPromptUntil>1257853614647</DontPromptUntil>
    <Name>examplename</Name>
    </Authentication>
     
  2. Save your changes and close BucketExplorer.XML.

Note: Do not worry about providing access key and secret key in configuration. As you run Bucket Commander, both keys get decrypted.

 

Elements

The following table describes the child tags in the Authentication tag.

Name Description
Akey

This tag is used for Bucket Explorer authentication. It represents AWS Access Key value. In the case of Bucket Commander it is optional.

Default: None
Required for Bucket Explorer Only
e.g.  <AKey> PlainText: GHKLIURTYHNMKLUMGT76 </AKey>

Skey

This tag is used for Bucket Explorer authentication. It represents AWS Secret Key value. In the case of Bucket Commander it is optional.

Default: None
Required for Bucket Explorer Only
e.g.  <SKey> PlainText: 2rU8bnRhrkpf0qG50cXW7tyvlwogtdbUFQnJn56th </SKey>

CommanderAKey

This tag is used for Bucket Commander authentication. It represents AWS Secret Key value. If you are trying to update commander config manually then you have to enter the AWS access key value followed by "PlainText:" at CommanderAKey tag value. After authentication it will automatically update in valid encrypted format.

Default: None
Required for Bucket Commander Only
e.g. <CommanderAKey> PlainText: GHKLIURTYHNMKLUMGT76 </CommanderAKey>
CommanderSKey

This tag is used for Bucket Commander authentication. It represents AWS Secret Key value. If you are trying to udpate commander cofing manually, you have to enter AWS secret key value followed by "PlainText:" as at CommanderAKey tag value. After authentication it will automatically be updated in valid encrypted string.

Default: None
Required for Bucket Commander Only 
e.g.  <CommanderSKey> PlainText: 2rU8bnRhrkpf0qG50cXW7tyvlwogtdbUFQnJn56th </CommanderSKey>
 Password

Password is the flag to identify whether the AWS credentials are saved with password or not.

Default: None
Type: Boolean
Valid Value: true or false
Required for Bucket Explorer Only 

Time Time value is saved in long. This tag value is updated by Bucket Explorer automatically. This is an optional part.

Default: None
Valid Type: Long
 
DontPromptUntil
This is the marker that prompts to the user to change the credentials for security purposes.  This tag value is updated by Bucket Explorer automatically.

Default: It will prompt after 30days from the date of the saved credentials.
 
Name
It represents the profile name for the saved authentication details. You can save a number of AWS credentials with a distinct profile name. You can keep an empty name if you have only one authentication tag.

Default: examplename
Type: String
 

  Edit Commander Configuration file

  1. Open BucketCommander.xml file.
    e. g. <Bucket Commander Home>\config\BucketCommander.xml.
  2. Fill up the entries for Upload/Download/Copy tag in BucketCommander.xml, for the required operations which you want to perform.
    e.g Suppose you want to configure commander for upload.

    Open BucketCommander.xml file and you will find a structure like this:


    <?xml version="1.0" encoding="UTF-8" standalone="no"?>
    <root>
    <Debug>off</Debug>
    <Upload>
    <UploadContents>
    <ParentVirtualFolderPath/>
    <CompareNameAndSize>true</CompareNameAndSize>
    <Overwrite>true</Overwrite>
    <FileList>
    <FilePath>/../ Desktop/Ready_To_Upload</FilePath>
    </FileList>
    <Bucket>Bucket_Name</Bucket>
    </UploadContents>
    </Upload>
    <Download>
    .... // Download Configuration
    ....
    </Download>
    <CopyBucket>
    ..... // Copy Configuration
    .....
    </CopyBucket>
    </root>
     

Elements

The following table describes the child tags in BucketCommander Config.

Name Description
Debug

This tag represents the flag for the debug. If this flag is off then debugging for the operation is off, else on. When flag is on, you can see debug logs in log folder.
 
Default: off
 
IgnoreRootFolderInQueueOperation

This tag represents the flag for ignoring the root folder of local folder path. e.g. If you select the folder c:\mydata\, then it will not create mydata folder at S3 rather it only uploads the contents of the mydata folder  at S3 bucket if this tag value is true; otherwise root folder will also be created at specified path in S3 bucket. 

Default: false

ParentVirtualFolderPath

This tag represents the remote path in the Amazon S3 Bucket. This path is the location where you want to upload/download your data.
 
Default: None (root level)
Parent Tag: UploadContents / DownloadContents
CompareNameAndSize

This tag represents quick compare option. With the help of this option you can speedup the queue operation process by applying the required option. If this tag value is true that means when file is being uploaded/downloaded to/from S3, the file existence will be checked and if that file exists then file size will be checked. On the basis of file size it is decieded whether the file is to be uploaded/downloaded or not. If the size matches then file is put in an identical list else added to the list to be uploaded/downloaded.
If this tag value is false that means the compare option is Name and Hash. After file existence is checked, Hash of the file is compared instead of file size.
 
Default: true (if multiple file) false (if single file)
Parent Tag: UploadContents/DownloadContents
Overwrite 

This tag represents the action value that is applied on the already existing file. If this tag value is true then the file is overwritten else ignored.
 
Default: false
Parent Tag: UploadContents/DownloadContents
FilePath 
This tag represents the file path that is going to be uploaded. This tag can be multiple under the FileList tag (Parent Tag). You can mention files as well as folder path here.
 
Default: None
Parent Tag: UploadContents/DownloadContents
Bucket 
This tag represents the S3 Bucket Name from/to where files/folders are to be uploaded/download.
 
Default: None
Parent Tag: UploadContents/DownloadContents
DestinationFolderPath
This tag represents where the file are to be downloaded.

Default: None
Parent Tag: DownloadContents
 
ObjectPath
This tag represents the object name of the S3 Bucket, it has an attribute named "Type". The Type value is needed to be set here according to that object whether it is file or folder type. Type value is either file or folder. You can add a number of Object Path under ObjectList (Parent Tag).

Default: None
Parent Tag: DownloadContents 
 
DestinationBucket
This tag represents the destination bucket name for the copy operation. You have to enter the bucket name for the AWS account as a  destination bucket name. Do not add suffix "s3.amazonaws.com" with bucket name.

Default: None
Parent Tag: Copy
 
SourceBucket
This tag represents the source bucket name for the copy operation. You have to enter bucket name for the AWS account as a source bucket name. Do not add suffix "s3.amazonaws.com" with bucket name.

Default: None
Parent Tag: Copy 
 

  Set Email Configuration to send Email Report for Commander Operations

  1. Open BucketExplorer.XML.
  2. You will find the tag in Xml like this


    <SMTPServers>
    <SMTPServer Name="emailprofilename" Status="ON">
    <From>example1@example.com</From>
    <To>example2@example.com</To>
    <Cc>example3@example.com</Cc>
    <Bcc>example4@example.com</Bcc>
    <Port>25</Port>
    <Secure>Yes</Secure>
    <ServerName>example.server.com</ServerName>
    <Password>PlainText:Password</Password>
    </SMTPServer>
     
  3. You will find a  tag with value "PlainText:Password" .
  4. Now replace the Password with your desired Password.
  5. Replace the other given tag with your desired value.
  6. Save your changes and close BucketExplorer.XML.

Elements

The following table describes the child tags in the SMTP Service tag.

Name Description
SMTPServer  
This tag represents the profile for SMTP server setting. This tag has two attributes 1. Name, 2. Status.
1. Name is the name of the SMTP server profile. The name should be unique.
2. Status represents whether the SMTP server profile is active or not. Valid values are "ON" and "OFF"  
 
From 
This tag represents the email address from which you want to send the operation report in mail as a status report came from.
Default: None
 
To 
This tag represents the email address to which you want to send the operation report in mail as a status report.

Default: None 
 
Cc
This tag represents the email address to which you want to send the operation report in mail as a status report as Carbon Copy.

Default: None  
 
Bcc
This tag represents the email address to which you want to send the operation report in mail as a status report as Blind Carbon Copy

Default: None   
 
Port
This tag represents the port number on which you want to send the status report via mail

Default: 25
 
Secure

This tag represents whether the process of sending mail for the status report is secured or not. If this tag value is true, then the process of sending mail is secured; else not.

Default: false

ServerName
This tag represents the server name of the email account. e.g. If from tag has email address myname@example.com then serverName may be like smtp.example.com

Default: None
 
Password
This tag represents the password of the email address entered in from tag. This password is saved in encrypted form. So when you enter your password in the tag, you have to enter in the following format. 
PlainText:  yourpassword
When the profile is authenticated, this password gets encrypted and the encrypted string will replace the value of the password tag.

Default: None