Changes for page Amazon-S3-Plugin

From version 1.1 >
edited by gru
on 15.03.2019, 10:30
To version < 13.4
edited by gru
on 29.01.2021, 16:33
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Integration in Amazon S3
1 +Amazon S3 plugin
Content
... ... @@ -1,42 +1,46 @@
1 -With the Amazon S3 plugin for XIMA® FORMCYCLE you are able to to upload files to your [[Amazon S3>>https://docs.aws.amazon.com/AmazonS3/latest/dev/Welcome.html]] account during form processing. Two steps need to be taken in order to upload files to your S3 storage:
1 +[[**Plugin download**>>url:https://customer.formcycle.eu/index.php/apps/files/?dir=/FORMCYCLE%20-%20Plugins%20Customer/fc-plugin-bundle-aws-s3&fileid=3080||target="_blank"]] (requires login)
2 2  
3 -1. [[Providing files for the upload into Amazon S3 storage>>||anchor="HProvidingfilesfortheuploadintoAmazonS3storage"]]
4 -1. [[Configuration of the Amazon S3 plugin>>||anchor="HConfigurationoftheAmazonS3plugin"]]
3 +{{info}}
4 +Please use **plugin version 2.0.0** or above for FORMCYCLE V6.
5 +{{/info}}
5 5  
6 -An installation guide for plugins can be found [[here>>https://help.formcycle.eu/xwiki/bin/view/Main/Mandant-Plugins]].
7 +{{info}}
8 +When switching from plugin version 1 to version 2 please check the plugin configuration in the [[workflow>>Formcycle.UserInterface.MyForms.WorkflowProcessing]] of the forms.
9 +{{/info}}
7 7  
8 -= Providing files for the upload into Amazon S3 storage =
9 -
10 -{{figure image="Formular.png" width="300"}}
11 -Users can attach files to forms via the form element [[Upload>>https://help.formcycle.eu/xwiki/bin/view/Main/Upload]].
11 +{{figure image="Formular.png"}}
12 +Users can attach files to forms via the form element [[Upload>>Formcycle.FormDesigner.FormElements.Upload]] which may be uploaded to the [[Amazon Simple Storage Server (S3)>>https://aws.amazon.com/de/s3/]].
12 12  {{/figure}}
13 13  
14 -In order to upload files to your Amazon S3 account, the files have to be provided to the [[workflow processing>>https://help.formcycle.eu/xwiki/bin/view/Main/Status+und+Aktionsverarbeitung+]] beforehand. As an example, files may be attached to to a form process via the form element [[Upload>>https://help.formcycle.eu/xwiki/bin/view/Main/Upload]] (see [[attach:Formular.png]]).
15 +With the Amazon S3 plugin for XIMA® FORMCYCLE you are able to to upload files to your [[Amazon S3>>https://docs.aws.amazon.com/AmazonS3/latest/dev/Welcome.html]] account during form processing. This plugin is subject to additional charge.
15 15  
16 -{{figure image="Provide_upload.png" width="300"}}
17 -Providing attached files via the action [[Provide upload>>https://help.formcycle.eu/xwiki/bin/view/Main/Upload+bereitstellen]].
18 -{{/figure}}
17 +An installation guide for plugins can be found [[here>>Formcycle.UserInterface.Client.Plugins]].
19 19  
20 -The action [[Provide upload>>https://help.formcycle.eu/xwiki/bin/view/Main/Upload+bereitstellen]] takes care of making these files available for further processing steps. In the example [[attach:Provide_upload.png]] files are provided for further processing in the same [[state>>https://help.formcycle.eu/xwiki/bin/view/Main/Statusliste]] via the form element with the name "file_upload" (Note: files can only be provided for the same state).
21 -
22 -A listing of all providing actions can be found [[here>>https://help.formcycle.eu/xwiki/bin/view/Main/Aktionen]].
23 -
24 24  = Configuration of the Amazon S3 plugin =
25 25  
26 -After files have been provided for further processing, you can add a new action of type Amazon S3 plugin in order to upload these files to your S3 storage.
21 +Add a new action of type Amazon Storage (Upload) in order to upload files to your S3 storage.
27 27  
28 28  == Authorization of FORMCYCLE ==
29 29  
30 -{{figure image="Amazon_S3_Plugin_en.png" width="300"}}
25 +{{id name="fig_plugin_aws_s3"/}}
26 +{{figure image="plugin_aws_s3_en.png"}}
31 31  After a successful authorization the ID or name of the Amazon S3 account will be displayed in the user interface of the plugin. Furthermore the selection of an [[S3 bucket>>https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html]] of the authorized [[IAM user>>https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html]] is possible.
32 32  {{/figure}}
33 33  
34 34  First XIMA® FORMCYCLE has to be authorized in order to access your Amazon S3 account. To this end you need to create a new [[IAM user>>https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html]] in your [[IAM (Identity and Access Management) Console>>https://console.aws.amazon.com/iam]]. It is important that you grant this user programmatic access for FORMCYCLE to be able to access your S3 account. Additionally you can manage the IAM user's permission in various way for complete control of what FORMCYCLE is allowed to access within your Amazon S3 account. For furhter information about the S3 access permissions please consult Amazon's [[Identity and Access Management>>https://docs.aws.amazon.com/IAM/latest/UserGuide/introduction.html]]. After completing the IAM user creation you will be presented with an [[access key>>https://docs.aws.amazon.com/general/latest/gr/managing-aws-access-keys.html]] consisting of an //access key ID// and a //secret access key//. This access key needs to be input into the appropriate fields in the plugin user interface. After a successfull authorization the name or ID of your S3 account will be displayed. Saving the action is not possible as long as you have not input a valid access key.
35 35  
36 -== Uploadeinstellungen ==
32 +== Upload settings ==
37 37  
38 -The table of the plugin user interface lets you select the providing actions, the files of which should be uploaded to your S3 storage. With actions of type [[Provide upload>>https://help.formcycle.eu/xwiki/bin/view/Main/Upload+bereitstellen]] it is possible to delete their files from the form attachements after the upload to the S3 storage. This way the files only reside in your S3 storage and not in the system of XIMA® FORMCYCLE anymore.
34 +Two types of files can be uploaded to Amazon with the plugin:
39 39  
40 -The input field "Upload in bucket" lets you select the bucket of your Amazon S3 account to which the selected files should be uploaded to.
36 +* **Files of previous actions**
37 +Here action are available that provide files to the [[workflow>>Formcycle.UserInterface.MyForms.WorkflowProcessing]]. The files of the selected actions will be uploaded to the selected Amazon S3 account. You can find a list of all file providing actions [[here>>Formcycle.UserInterface.MyForms.WorkflowProcessing.Actions]]. {{info}}Only actions are availbale that are positioned before and within the same state.{{/info}}
38 +* **Files to upload**
39 +Here files of [[form uploads>>Formcycle.FormDesigner.FormElements.Upload]] are provided. Additionally these files can be deleted from the form attachments. This way the files only reside in your S3 storage and not in the system of XIMA® FORMCYCLE anymore.
41 41  
42 -By default files will be uploaded to the root directory of the selected bucket. The input field "Upload to folder" lets you specify a file path in the selected bucket in which the uploaded files will be placed. Separate folders with a "/". In the example [[attach:Amazon_S3_Plugin_en.png]] [[variables>>https://help.formcycle.eu/xwiki/bin/view/Main/Platzhalter]] are used to create a new folder for the project and a new folder for every form process.
41 +Configuration of the upload destination:
42 +
43 +* **Upload in bucket**
44 +The input field "Upload in bucket" lets you select the bucket of your Amazon S3 account to which the selected files should be uploaded to.
45 +* **Upload to folder**
46 +By default files will be uploaded to the root directory of the selected bucket. The input field "Upload to folder" lets you specify a file path in the selected bucket in which the uploaded files will be placed. Separate folders with a "/". In the [[example>>||anchor="fig_plugin_aws_s3"]] [[variables>>Formcycle.UserInterface.Variables]] are used to create a new folder for the form and a new folder for every form process.

Navigation

Copyright 2000-2025