Wiki source code of Amazon S3
Last modified by Aurelie Bertrand on 2020/07/21 11:35
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
1.1 | 1 | {{ddtoc/}} |
| 2 | |||
| |
40.1 | 3 | = Prerequisites = |
| |
1.1 | 4 | |
| |
40.1 | 5 | * An Amazon Web Services (AWS) account with users created via the AWS console interface available at :((( |
| |
1.1 | 6 | console.aws.amazon.com |
| 7 | |||
| |
40.1 | 8 | Follow the steps of the IAM (Identity Access Management) service to create and manage your users (**Services** > **Security, Identity & Compliance** > **IAM**). |
| |
1.1 | 9 | ))) |
| 10 | |||
| |
40.1 | 11 | [[image:amazonS3_en_html_270afb69f10317bf.png||height="371" width="526"]] |
| 12 | |||
| |
1.1 | 13 | |
| |
40.1 | 14 | //__Screenshot: the IAM Web service of Amazon allows to manage your users__// |
| |
1.1 | 15 | |
| |
40.1 | 16 | * |
| 17 | * 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. | ||
| 18 | * Create a bucket with a universally unique name. | ||
| |
1.1 | 19 | |
| |
40.1 | 20 | |[[image:amazonS3_en_html_829eaa34e529ef0c.png||height="72" width="72"]] |
| 21 | |((( | ||
| 22 | * 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. | ||
| |
1.1 | 23 | ))) |
| 24 | |||
| |
40.1 | 25 | = Creating a new Amazon S3 document server = |
| |
1.1 | 26 | |
| |
40.1 | 27 | Digdash Enterprise allows you to get your documents on your Amazon S3 account. |
| |
1.1 | 28 | |
| |
40.1 | 29 | * Via the Digdash Studio |
| |
1.1 | 30 | |
| |
40.1 | 31 | To create a new Amazon S3 document server in the Digdash Studio : |
| |
1.1 | 32 | |
| |
40.1 | 33 | Open Digdash’s Enterprise Studio > **Tools** > **Server URL manager…** > **New...** |
| |
1.1 | 34 | |
| |
40.1 | 35 | [[image:amazonS3_en_html_380ffec9fdf5b40.png||height="178" width="423"]] |
| 36 | \\ | ||
| |
1.1 | 37 | |
| |
40.1 | 38 | [[image:amazonS3_en_html_adb58ed688c97e6c.png||height="128" width="461"]] |
| 39 | |||
| |
38.1 | 40 | |
| |
40.1 | 41 | //__Screenshot: Creation of a new Amazon S3 document server__// |
| |
1.1 | 42 | |
| |
40.1 | 43 | Via the browser |
| |
1.1 | 44 | |
| |
40.1 | 45 | [[image:amazonS3_en_html_d057beaef5d1f988.png||height="253" width="472"]] |
| 46 | |||
| |
1.1 | 47 | |
| |
40.1 | 48 | [[image:amazonS3_en_html_50b6c75132116e78.png||height="291" width="486"]] |
| 49 | //__Screenshot: Creation of a new Amazon S3 document server via the browser__// | ||
| |
1.1 | 50 | |
| |
40.1 | 51 | = Server configuration = |
| |
39.1 | 52 | |
| |
40.1 | 53 | * Via the Digdash Studio |
| |
1.1 | 54 | |
| |
40.1 | 55 | [[image:amazonS3_en_html_ca563db2c2963ec5.png||height="300" width="400"]] |
| 56 | |||
| |
1.1 | 57 | |
| |
40.1 | 58 | //__Screenshot: Server configuration for Amazon S3 via the Studio__// |
| |
1.1 | 59 | |
| 60 | |||
| |
40.1 | 61 | * Via the browser |
| |
1.1 | 62 | |
| |
40.1 | 63 | [[image:amazonS3_en_html_d0abd57fc31797fb.png||height="254" width="285"]] |
| 64 | |||
| |
1.1 | 65 | |
| |
40.1 | 66 | //__Screenshot: Server configuration for Amazon S3 via the browser__// |
| |
1.1 | 67 | |
| 68 | |||
| |
40.1 | 69 | == Server name == |
| |
1.1 | 70 | |
| |
40.1 | 71 | Give a name to your new Amazon S3 document server. |
| |
1.1 | 72 | |
| |
40.1 | 73 | == URL == |
| 74 | |||
| 75 | You do not need to mention any URL to create a new Amazon S3 document server. | ||
| 76 | |||
| 77 | == Path (documents path for a user) == | ||
| 78 | |||
| 79 | The user document path absolutely must start with the bucket name you want to explore, potentially followed by the path of subfolders. | ||
| 80 | |||
| 81 | Besides, the bucket name allows Digdash to check whether the connection is valid. | ||
| 82 | |||
| 83 | Example : Given this bucket name: « dd-com-test-bucket » | ||
| 84 | |||
| 85 | So a valid path may be : | ||
| 86 | |||
| 87 | dd-com-test-bucket/directory1/directory2/directory3/ | ||
| 88 | |||
| 89 | == Exploration of subfolders == | ||
| 90 | |||
| 91 | 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. | ||
| 92 | |||
| 93 | |Fields|//Explore subfolders//|(% colspan="2" %)//Level of subfolders// | ||
| 94 | |(% rowspan="2" %)Values|Selected|((( | ||
| 95 | Empty | ||
| 96 | |||
| 97 | Default value, exploration in all subfolders | ||
| |
1.1 | 98 | )))|((( |
| 99 | N > 0 | ||
| 100 | |||
| |
40.1 | 101 | Exploration in the N subfolders |
| |
1.1 | 102 | ))) |
| |
40.1 | 103 | |Deselected|(% colspan="2" %)((( |
| |
1.1 | 104 | 0 |
| 105 | |||
| |
40.1 | 106 | No exploration in the subfolders, only in the current directory |
| |
1.1 | 107 | ))) |
| 108 | |||
| |
40.1 | 109 | __//Table for the different levels of exploration of subfolders//__ |
| |
1.1 | 110 | |
| |
40.1 | 111 | == Read only == |
| |
1.1 | 112 | |
| |
40.1 | 113 | Only the lecture is possible when this option is selected. |
| |
1.1 | 114 | |
| |
40.1 | 115 | == Access key ID == |
| |
1.1 | 116 | |
| |
40.1 | 117 | Enter the access key ID that you got when the user was created. |
| |
1.1 | 118 | |
| |
40.1 | 119 | == Secret access key == |
| |
1.1 | 120 | |
| |
40.1 | 121 | Enter the secret access key that you got when the user was created. |
| |
1.1 | 122 | |
| |
40.1 | 123 | = Possible actions = |
| 124 | |||
| 125 | Via the browser version of the document manager, you can proceed many actions on your documents on your Amazon S3 account. | ||
| 126 | |||
| 127 | == Downloading == | ||
| 128 | |||
| 129 | [[image:amazonS3_en_html_7aac75ab9598d22.png||height="224" width="450"]] | ||
| 130 | |||
| 131 | |||
| 132 | //__Screenshot : Downloading a document from Amazon S3__// | ||
| 133 | |||
| 134 | It is a basic action. Every connected Digdash user is at least able to read any documents on the server. | ||
| 135 | |||
| 136 | This action is possible via this icon:[[image:amazonS3_en_html_fb114753cc5d7478.png]] . | ||
| 137 | |||
| 138 | |||
| 139 | == Uploading == | ||
| 140 | |||
| 141 | [[image:amazonS3_en_html_a4f5cdb9acd7dc62.png||height="378" width="624"]] | ||
| 142 | |||
| 143 | //__Screenshot: Uploading a document on Amazon S3__// | ||
| 144 | |||
| 145 | |||
| 146 | (% class="box infomessage" %) | ||
| 147 | ((( | ||
| 148 | __**Note:**__ In Digdash, it is preferable to upload documents with explicit extensions. | ||
| 149 | ))) | ||
| 150 | |||
| 151 | Three options are possible: | ||
| 152 | |||
| 153 | * **Choose a local file**: click on **Browse... **to select the document to add. Click **OK**.** **The dialog **Open** shows. | ||
| 154 | * **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.). | ||
| 155 | * **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”. | ||
| 156 | |||
| 157 | == Updating == | ||
| 158 | |||
| 159 | [[image:amazonS3_en_html_b49b3620b2a5eace.png||height="190" width="554"]] | ||
| 160 | |||
| 161 | |||
| 162 | //__Screenshot : Updating a document on Amazon S3__// | ||
| 163 | |||
| 164 | |||
| 165 | This action is possible via this icon:[[image:amazonS3_en_html_5bf0156c61aee07c.png]] . | ||
| 166 | |||
| 167 | Here are the possible actions: | ||
| 168 | |||
| 169 | === Updating a document content === | ||
| 170 | |||
| 171 | You are able to update the content of an existing document selecting another file on their file system. | ||
| 172 | |||
| 173 | (% class="box warningmessage" %) | ||
| 174 | ((( | ||
| 175 | [[image:amazonS3_en_html_391450f0053994db.jpg]] This unique action will not alter the document name. | ||
| 176 | ))) | ||
| 177 | |||
| 178 | === Renaming === | ||
| 179 | |||
| 180 | You are able to rename a document. You will specify in the text field the new name without any extension (it remains the same). | ||
| 181 | |||
| 182 | == Deleting == | ||
| 183 | |||
| 184 | You are able to delete one or several existing documents in the directory specified during the server configuration. | ||
| 185 | |||
| 186 | If the user wants to delete more than one document, they can do it thanks to the check boxes. | ||
| 187 | |||
| 188 | This action is possible via this icon: [[image:amazonS3_en_html_3f54b9224a4c4ef3.png]] . | ||
| 189 | |||
| 190 |