Document server Amazon S3

Last modified by Aurelie Bertrand on 2023/05/11 10:24

Prerequisites

  • An Amazon Web Services (AWS) account with users created via the AWS console interface available at :

    console.aws.amazon.com

    Follow the steps of the IAM (Identity Access Management) service to create and manage your users (Services > Security, Identity & Compliance > IAM).

amazonS3_en_html_270afb69f10317bf.png
 

Screenshot: the IAM Web service of Amazon allows to manage your users

  •  
  • When creating new users, do not forget to note the combination (Access key ID, Secret access key) of each user. Digdash’s Amazon S3 client needs this information to connect to your server.
  • Create a bucket with a universally unique name.
amazonS3_en_html_829eaa34e529ef0c.png
 
  • Amazon S3 is cloud storage for the Internet. To upload your data (photos, videos, documents etc.), you first create a bucket in one of the AWS Regions. You can then upload an unlimited number of data objects to the bucket.

Creating a new Amazon S3 document server

Digdash Enterprise allows you to get your documents on your Amazon S3 account.

  • Via the Digdash Studio 

To create a new Amazon S3 document server in the Digdash Studio :

Open Digdash’s Enterprise Studio > Tools > Server URL manager… > New...

amazonS3_en_html_380ffec9fdf5b40.png

 

amazonS3_en_html_adb58ed688c97e6c.png
 

Screenshot: Creation of a new Amazon S3 document server

Via the browser

amazonS3_en_html_d057beaef5d1f988.png
 

amazonS3_en_html_50b6c75132116e78.png
Screenshot: Creation of a new Amazon S3 document server via the browser

Server configuration

  • Via the Digdash Studio

amazonS3_en_html_ca563db2c2963ec5.png
 

Screenshot: Server configuration for Amazon S3 via the Studio

  • Via the browser

amazonS3_en_html_d0abd57fc31797fb.png
 

Screenshot: Server configuration for Amazon S3 via the browser

Server name

Give a name to your new Amazon S3 document server.

URL

You do not need to mention any URL to create a new Amazon S3 document server.

Path (documents path for a user)

The user document path absolutely must start with the bucket name you want to explore, potentially followed by the path of subfolders.

Besides, the bucket name allows Digdash to check whether the connection is valid.

Example : Given this bucket name: « dd-com-test-bucket »

So a valid path may be :

dd-com-test-bucket/directory1/directory2/directory3/

Exploration of subfolders

You have the possibility to set the level of exploration of the subfolders from your document path. By default, Digdash seeks for all your documents, recursively, and explores all the subfolders.

FieldsExplore subfoldersLevel of subfolders
ValuesSelected

Empty

Default value, exploration in all subfolders

N > 0

Exploration in the N subfolders

Deselected

0

No exploration in the subfolders, only in the current directory

Table for the different levels of exploration of subfolders

Read only

Only the lecture is possible when this option is selected.

Access key ID

Enter the access key ID that you got when the user was created.

Secret access key

Enter the secret access key that you got when the user was created.

Possible actions

Via the browser version of the document manager, you can proceed many actions on your documents on your Amazon S3 account.

Downloading

amazonS3_en_html_7aac75ab9598d22.png
 

Screenshot : Downloading a document from Amazon S3

It is a basic action. Every connected Digdash user is at least able to read any documents on the server.

This action is possible via this icon:amazonS3_en_html_fb114753cc5d7478.png .

Uploading

amazonS3_en_html_a4f5cdb9acd7dc62.png

Screenshot: Uploading a document on Amazon S3

Note: In Digdash, it is preferable to upload documents with explicit extensions.

Three options are possible:

  • Choose a local file: click on Browse...  to select the document to add. Click OK.  The dialog Open shows.
  • Enter a URL: Enter the URL of your document. If the checkbox Only add the URL link to the Documents server is deselected, the content pointed by the URL is downloaded only just once. If the checkbox Only add the URL link to the Documents server is selected, the content will be downloaded by the server every time it needs to (for a data source or required by the user). If required by the user, the URL must be reachable by the server. You can also insert user variables in the URL (${user.uid}, etc. Cf documentation). You can use a URL starting with « file:// » but in that case, the option Only add the URL link to the Documents server is selected by default. This kind of URL should refer to a file on the disk of the server. The link name must end with the extension of the file (.csv, .html, etc.).
  • Create a new link: Create a new link to a document on the server. The pointed file is the last document (alphabetically) corresponding to the link. For example, a link like “document*.csv” will refer to the last CSV file starting with “document”.

Updating

amazonS3_en_html_b49b3620b2a5eace.png
 

Screenshot : Updating a document on Amazon S3

This action is possible via this icon:amazonS3_en_html_5bf0156c61aee07c.png .

Here are the possible actions:

Updating a document content

You are able to update the content of an existing document selecting another file on their file system.

amazonS3_en_html_391450f0053994db.jpg This unique action will not alter the document name.

Renaming

You are able to rename a document. You will specify in the text field the new name without any extension (it remains the same).

Deleting

You are able to delete one or several existing documents in the directory specified during the server configuration.

If the user wants to delete more than one document, they can do it thanks to the check boxes.

This action is possible via this icon: amazonS3_en_html_3f54b9224a4c4ef3.png .