Wiki source code of Alfresco
Last modified by Aurelie Bertrand on 2025/03/13 08:51
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
43.1 | 1 | Documents server Alfresco |
| 2 | |||
| |
1.1 | 3 | {{ddtoc/}} |
| 4 | |||
| |
43.1 | 5 | = Prerequisites = |
| |
2.1 | 6 | |
| |
43.1 | 7 | * An Alfresco server (development and tests have been realized on the Community version of Alfresco (free version)) |
| 8 | * Alfresco’s administrator’s identifiers (for the server configuration) | ||
| 9 | * Knowing the Alfresco structure (for the server configuration) | ||
| 10 | * Creating one or more Alfresco users with the same usernames defined in Digdash | ||
| |
1.1 | 11 | |
| |
43.1 | 12 | = Digdash user / Alfresco user = |
| |
21.1 | 13 | |
| |
43.1 | 14 | In this document, we suppose that the current Digdash user also exists in Alfresco with the same username. |
| |
1.1 | 15 | |
| |
43.1 | 16 | = Create a new Alfresco document server = |
| |
1.1 | 17 | |
| |
43.1 | 18 | Digdash Enterprise allows you to get your documents on your Alfresco account. |
| |
1.1 | 19 | |
| |
43.1 | 20 | * Via the Digdash Studio |
| |
1.1 | 21 | |
| |
43.1 | 22 | To create a new Alfresco document server in the Digdash Studio : |
| |
1.1 | 23 | |
| |
43.1 | 24 | Open the Enterprise Studio of Digdash > **Tools** > **Server URL manager…** > **New...** |
| |
1.1 | 25 | |
| 26 | |||
| |
43.1 | 27 | [[image:alfresco_en_html_380ffec9fdf5b40.png||height="184" width="437"]] |
| 28 | \\ | ||
| |
1.1 | 29 | |
| |
43.1 | 30 | [[image:alfresco_en_html_e7264af1ec94f267.png||height="152" width="548"]] |
| 31 | \\ | ||
| |
1.1 | 32 | |
| |
43.1 | 33 | //__Screenshot: Creation of a new Alfresco document server__// |
| |
1.1 | 34 | |
| 35 | |||
| |
43.1 | 36 | * Via the browser |
| |
1.1 | 37 | |
| |
43.1 | 38 | [[image:alfresco_en_html_d057beaef5d1f988.png||height="253" width="472"]] |
| 39 | |||
| 40 | |||
| 41 | [[image:alfresco_en_html_50b6c75132116e78.png||height="291" width="486"]] | ||
| 42 | //__Screenshot : the document manager via the browser__// | ||
| 43 | |||
| 44 | = Server Configuration = | ||
| 45 | |||
| 46 | * Via the Digdash Studio | ||
| 47 | |||
| 48 | [[image:alfresco_en_html_b2c875a9a56e0491.png||height="296" width="366"]] | ||
| 49 | |||
| 50 | |||
| 51 | //__Screenshot: Server configuration for Alfresco via the Studio__// | ||
| 52 | |||
| 53 | |||
| 54 | * Via the browser | ||
| 55 | |||
| 56 | [[image:alfresco_en_html_f48f4490dfc6559c.png||height="270" width="522"]] | ||
| 57 | |||
| 58 | |||
| 59 | //__Screenshot: Server configuration for Alfresco via the browser__// | ||
| 60 | |||
| 61 | |||
| 62 | == Identifiers (login / password) == | ||
| 63 | |||
| 64 | The current Digdash user (whoever they are) will __always__ be logged as the Alfresco admin. | ||
| 65 | |||
| |
1.1 | 66 | == URL == |
| 67 | |||
| |
43.1 | 68 | The user has to specify the Alfresco server’s address and the port number if necessary. |
| |
1.1 | 69 | |
| |
43.1 | 70 | == Path (documents path for a user) == |
| |
1.1 | 71 | |
| |
43.1 | 72 | The path the user has to specify to commit the actions mentioned below has the following pattern: |
| |
1.1 | 73 | |
| |
43.1 | 74 | Site/Container/Uploaddirectory |
| |
1.1 | 75 | |
| |
43.1 | 76 | Site and Container are mandatory |
| |
1.1 | 77 | |
| |
43.1 | 78 | Uploaddirectory is optional |
| |
1.1 | 79 | |
| |
43.1 | 80 | |Site/|Container/|Uploaddirectory |
| 81 | |Site name|A container is a folder or space in a site (« Document Library » most of the time) __[[http:~~/~~/docs.alfresco.com/5.1/concepts/library-intro.html>>url:http://docs.alfresco.com/5.1/concepts/library-intro.html]]__| Name of the folder where the document will be uploaded. This folder must already exist. | ||
| |
1.1 | 82 | |
| |
43.1 | 83 | __Table: Alfresco’s path pattern for the configuration server__ |
| |
1.1 | 84 | |
| |
43.1 | 85 | __Example:__ |
| |
1.1 | 86 | |
| |
43.1 | 87 | [[image:alfresco_en_html_863665d400dc4d29.png]] |
| |
1.1 | 88 | |
| |
43.1 | 89 | __Screen: Example of an Alfresco tree for a site (called « swsdp »)__ |
| |
1.1 | 90 | |
| 91 | |||
| |
43.1 | 92 | Here is a given path: swsdp/documentLibrary/test/retest |
| |
1.1 | 93 | |
| |
43.1 | 94 | |Site/|Container/|Uploaddirectory |
| 95 | |Site name|A container is a folder or space in a site (« Document Library » most of the time) __[[http:~~/~~/docs.alfresco.com/5.1/concepts/library-intro.html>>url:http://docs.alfresco.com/5.1/concepts/library-intro.html]]__| Name of the folder where the document will be uploaded. This folder must already exist. | ||
| 96 | |swsdp/|documentLibrary/|test/retest | ||
| |
1.1 | 97 | |
| |
43.1 | 98 | __Table: Example: path for a site on Alfresco__ |
| |
1.1 | 99 | |
| 100 | |||
| |
43.1 | 101 | == Exploration of subfolders == |
| |
1.1 | 102 | |
| |
43.1 | 103 | You have the possibility to set the level of exploration of the subfolders from your document path. |
| |
1.1 | 104 | |
| |
43.1 | 105 | By default, Digdash seeks for all your documents, recursively, and explores all the subfolders. |
| |
1.1 | 106 | |
| |
43.1 | 107 | |Fields|//Explore subfolders//|(% colspan="2" %)//Level of subfolders// |
| 108 | |(% rowspan="2" %)Values|Selected|((( | ||
| 109 | Empty | ||
| |
1.1 | 110 | |
| |
43.1 | 111 | Default value, exploration in all subfolders |
| 112 | )))|((( | ||
| 113 | N > 0 | ||
| |
1.1 | 114 | |
| 115 | |||
| |
43.1 | 116 | Exploration in the N subfolders |
| 117 | ))) | ||
| 118 | |Deselected|(% colspan="2" %)((( | ||
| 119 | 0 | ||
| |
1.1 | 120 | |
| |
43.1 | 121 | No exploration in the subfolders, only in the current directory |
| 122 | ))) | ||
| |
1.1 | 123 | |
| |
43.1 | 124 | //__Table for the different levels of exploration of subfolders__// |
| |
1.1 | 125 | |
| |
43.1 | 126 | = Access rights (limited) = |
| |
1.1 | 127 | |
| |
43.1 | 128 | Despite the fact that the current Digdash user is logged as Admin on Alfresco, we have decided to limit the access rights for the user (other than Admin) to a certain point according to Alfresco’s restrictions. |
| |
1.1 | 129 | |
| 130 | |||
| |
43.1 | 131 | [[image:alfresco_en_html_2a594ab6d0251660.png||height="137" width="554"]] |
| 132 | |||
| |
1.1 | 133 | |
| |
43.1 | 134 | __Table: Roles and permissions for the documents, Alfresco wise__ |
| |
1.1 | 135 | |
| 136 | |||
| |
43.1 | 137 | Thus, a Consumer (uninvited user on the site) only has the rights of reading and downloading documents. |
| |
1.1 | 138 | |
| |
43.1 | 139 | We have deliberately chosen not to limit the rights (Alfresco wise) for the actions that would only be possible when the current Digdash user is the creator (oranges cells). |
| 140 | |||
| 141 | = Available actions = | ||
| 142 | |||
| 143 | *According to the access rights and the directory mentioned in the server configuration. | ||
| 144 | |||
| 145 | == Search by keywords == | ||
| 146 | |||
| 147 | [[image:alfresco_en_html_d66e84f7715512e1.png||height="127" width="434"]] | ||
| 148 | __Screen: Search bar for the documents on Alfresco__ | ||
| 149 | |||
| 150 | |||
| 151 | The current Digdash user will be able to search for documents in the directory mentioned in the configuration AND in the subdirectories entering keywords in the search bar. | ||
| 152 | |||
| 153 | If the search bar is empty, then « * » is applied (all the documents in the directory AND subdirectories will be displayed). | ||
| 154 | |||
| 155 | == Downloading a document from Alfresco == | ||
| 156 | |||
| 157 | [[image:alfresco_en_html_706bfff3dcfb98aa.png||height="191" width="416"]] | ||
| 158 | |||
| 159 | |||
| 160 | __Screen: downloading a document from Alfresco__ | ||
| 161 | |||
| 162 | It is a basic action. Every connected Digdash user is at least able to read any documents on any Alfresco sites, and particularly the site specified during the server configuration. | ||
| 163 | |||
| 164 | This action is possible via this icon:[[image:alfresco_en_html_fb114753cc5d7478.png]] . | ||
| 165 | |||
| 166 | == Uploading a document on the Alfresco server == | ||
| 167 | |||
| 168 | [[image:alfresco_en_html_890d7075258e60fd.png||height="362" width="699"]] | ||
| 169 | |||
| 170 | |||
| 171 | __Screen: Uploading a document on Alfresco__ | ||
| 172 | |||
| 173 | |||
| 174 | Depending on the current user’s role in Alfresco, they have the have the right to upload documents in the directory specified during the server configuration. | ||
| 175 | |||
| 176 | (Cf. table: title) | ||
| 177 | |||
| 178 | (% class="box infomessage" %) | ||
| |
28.1 | 179 | ((( |
| |
43.1 | 180 | __**Note:**__ In Digdash, it is preferable to upload documents with explicit extensions. |
| |
28.1 | 181 | ))) |
| |
1.1 | 182 | |
| |
43.1 | 183 | Three options are possible: |
| 184 | |||
| 185 | * **Choose a local file**: click on **Browse... **to select the document to add. Click **OK**.** **The dialog **Open** shows. | ||
| 186 | * **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.). | ||
| 187 | * **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”. | ||
| 188 | |||
| 189 | [[image:alfresco_en_html_628ba38f122ed35b.png]] To go further: (v1 of this functionality) | ||
| 190 | |||
| 191 | The fields called « Author » and « Creator » of the document are updated with the current Digdash username once the document is uploaded. | ||
| 192 | |||
| 193 | If the user does not have the right for this action, a message will notify the action could not take place. | ||
| 194 | |||
| 195 | |||
| 196 | == Updating a document on Alfresco == | ||
| 197 | |||
| 198 | [[image:alfresco_en_html_c7616c763f62013c.png||height="152" width="554"]] | ||
| 199 | |||
| 200 | |||
| 201 | __Screen: updating a document on Alfresco (renaming and updating content)__ | ||
| 202 | |||
| 203 | |||
| 204 | This action is possible via this icon:[[image:alfresco_en_html_5bf0156c61aee07c.png]] . | ||
| 205 | |||
| 206 | Depending on the current user’s role on Alfresco, they have the have the right to modify the documents they have the right to edit (c.f. table). Here are the possible actions: | ||
| 207 | |||
| 208 | === Updating the document content === | ||
| 209 | |||
| 210 | The user with the adequate access rights is able to update the content of an existing document selecting another file on their file system. | ||
| 211 | |||
| 212 | [[image:alfresco_en_html_391450f0053994db.jpg]] This unique action will not alter the document name. | ||
| 213 | |||
| 214 | If the user does not have the right for this action, a message will notify the action could not take place. | ||
| 215 | |||
| 216 | === Renaming === | ||
| 217 | |||
| 218 | The user with the adequate rights is able to rename a document. They will specify in the text field the new name without any extension (it remains the same). | ||
| 219 | |||
| 220 | If the user does not have the right for this action, a message will notify the action could not take place. | ||
| 221 | |||
| 222 | (% class="box infomessage" %) | ||
| 223 | ((( | ||
| 224 | __**Note**:__ updating the content of a document and renaming it can be processed at the same time. | ||
| 225 | ))) | ||
| 226 | |||
| 227 | |||
| 228 | == Deleting a document on Alfresco == | ||
| 229 | |||
| 230 | The user with the adequate rights is able to delete one or several existing documents in the directory specified during the server configuration. | ||
| 231 | |||
| 232 | If the user wants to delete more than one document, they can do it thanks to the check boxes. | ||
| 233 | |||
| 234 | This action is possible via this icon: [[image:alfresco_en_html_3f54b9224a4c4ef3.png]] . | ||
| 235 | |||
| 236 | If the user does not have the right for this action, a message will notify the action could not take place. | ||
| 237 | |||
| 238 |