Summary

• Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Author

...	...	@@ -1,1 +1,1 @@
1		-XWiki.nlo
	1	+XWiki.gru

Content

...	...	@@ -1,48 +1,96 @@
1	1	{{content/}}
2	2
3		-{{figure image="form_files_en.png" height="300"}}
4		-Uploading a new client specific file
5		-{{/figure}} {{figure image="2_en_File.png" width="300"}}
6		-The //Files// menu for client specific files with a file selected
7		-{{/figure}}There are two different types of files in {{formcycle/}}:
	3	+{{figure image="files_list_en.png" width="600"}}
	4	+A list of all uploaded files. These may be form-specific files or files available to all forms.
	5	+{{/figure}}
8	8
9		-* Client specific files are available to all forms. For example, they could be used as template files for actions of type //[[PDF (Fill)>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.Actions.PDFFill.WebHome]]// or [[//Word (Fill)//>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.Actions.WordFill.WebHome]], as the same template may be required by multiple forms. Client specific files with the extensions //.css// ([[Stylesheet>>doc:Formcycle.FormDesigner.CSS.WebHome]]) or //.js //([[Javascript>>doc:Formcycle.FormDesigner.ScriptMetaAndCssTabs.ScriptTab.WebHome]]) will be included in all forms automatically.
	7	+There are two different types of files in {{formcycle/}}:
10	10
11		-* Form-specific files are only available to the form for which they have been uploaded. Form specific files with the extensions //.css// ([[Stylesheet>>doc:Formcycle.FormDesigner.CSS.WebHome]]) or //.js //([[Javascript>>doc:Formcycle.FormDesigner.ScriptMetaAndCssTabs.ScriptTab.WebHome]]) will be included in the form automatically.
	9	+; Client-specific files
	10	+: Files that are available to all forms. For example, they could be used as template files for actions of type //[[PDF (Fill)>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.Actions.PDFFill.WebHome]]// or [[//Word (Fill)//>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.Actions.WordFill.WebHome]]: The same template may be required by multiple forms. Client-specific files with the extension //.css// ([[{{smallcaps}}Css{{/smallcaps}}>>doc:Formcycle.FormDesigner.CodingPanel.CSSTab.WebHome]]) or //.js// ([[JavaScript>>doc:Formcycle.FormDesigner.CodingPanel.ScriptTab.WebHome]]) are included automatically in all forms. You can upload these files in the menu //Files & templates //{{rarrow/}} //Files//.
	11	+; Form-specific files
	12	+: Files that are only available to the form for which they have been uploaded. Form-specific files with the extension //.css// ([[{{smallcaps}}Css{{/smallcaps}}>>doc:Formcycle.FormDesigner.CodingPanel.CSSTab.WebHome]]) or //.js //([[JavaScript>>doc:Formcycle.FormDesigner.CodingPanel.ScriptTab.WebHome]]) are included automatically in the form. You can upload these files in the form overview menu //My forms// if you open the side menu of the form and click on //Files//. Or you can upload files directly from within the designer by clicking on //More// {{rarrow/}} //Files//.
12	12
13		-== Uploading files ==
	14	+=== Create a new file ===
14	14
15		-=== Client specific files ===
	16	+{{figure image="files_new.png"}}
	17	+Creating a new file. You can upload a file either with the browser's upload dialog or directly via drag&drop.
	18	+{{/figure}}
16	16
17		-Files that should be available for all forms of a certain client can be uploaded via //Files & templates {{rarrow/}} Files//.
	20	+1. Click on the {{ficon name="plus-circle-outline"/}} button to the top left.
	21	+1. The browser's file upload dialog opens. Select the file or files you would like to upload. After you choose a file, it will be uploaded automatically.
	22	+1. Optionally, you can give the uploaded files a different name and description in the panel to the right. To save the changes you have made, click the //Save// button at the bottom.
18	18
19		-=== Form specific files ===
	24	+If a file with the same name exists already, the file is renamed and created as a separate file.
20	20
21		-Files, which should only be available for a certain form, can be uploaded under //My Forms// by clicking at //Files// in the menu of the respective form. Alternatively, an upload in the {{designer/}} under //More {{rarrow/}} Files// is also possible. More information can be found [[here>>doc:Formcycle.UserInterface.MyForms.Files.WebHome]].
	26	+=== Update a file ===
22	22
23		-== Operations & settings ==
	28	+{{figure image="files_update_en.png"}}
	29	+You can change the content of a file later. Either use the update button or the drag&drop support. When you make use of a file elsewhere in the system (such as in a workflow action), you should not change the name of the file anymore. Otherwise, references to the file may be lost.
	30	+{{/figure}}
24	24
25		-Since this page describes the menu item //Files & templates {{rarrow/}} Files// it is therefore all about the client specific ones.
	32	+1. Select the file you would like to update, by clicking on the file name.
	33	+1. Click on the button //Update file// to the bottom right
	34	+1. This opens the browser's upload dialog. Choose a new file and press {{smallcaps}}Ok{{/smallcaps}}.
	35	+1. To apply the changes, press the //Save// button to the bottom right
26	26
27		-=== Creating new files ===
	37	+=== Download a file ===
28	28
29		-{{figure image="FCSnapshot6.png" width="500"/}}
	39	+{{figure image="files_download.png"}}
	40	+You can download either individual files or a set of files as a {{smallcaps}}Zip{{/smallcaps}} archive.
	41	+{{/figure}}
30	30
31		-1. Click on the {{ficon name="plus-circle-outline"/}} button to the top left.
32		-1. In the system dialog that opens, select the file or files to be uploaded and confirm your selection. Your selection will then be uploaded automatically.
33		-1. Optionally, you can give uploaded files a different name and description under //Properties// in the upper right corner. To save the changes you have made, click the //Save// button at the bottom center.
	43	+1. Use the checkboxes to the left of the filename to select the files you would like to download.
	44	+1. Click on the download {{icon name="download"/}} to download the selected files
34	34
35		-=== Downloading a file ===
	46	+This starts a file download. If you selected only one files, you can download the file directly. Otherwise, when you selected more than one files, you will get a {{smallcaps}}Zip{{/smallcaps}} archive with the files.
36	36
37		-TBD
38		-
39	39	=== Deleting a file ===
40	40
41		-TBD
	50	+{{figure image="files_delete.png"}}
	51	+When you do not need a file anymore, you can delete it. Once deleted, a files cannot be restored anymore.
	52	+{{/figure}}
42	42
	54	+1. Use the checkboxes to the left of the filename to select the files you would like to delete.
	55	+1. Click on the button {{icon name="trash"/}} to delete the files
	56	+
	57	+This will prompt you to confirm whether you would really like to delete the files. A file that has been deleted cannot be restored.
	58	+
43	43	== Additional information ==
44	44
45		-TBD
46		-Properites
47		-File details
48		-URL to file
	61	+The panel to the right offers some more information and several more settings. You can view or edit the following settings:
	62	+
	63	+; Alias
	64	+: The name of the file, as it is used in other parts of the system.
	65	+; Description
	66	+: An internal description for the file. This description is never visible to the end user.
	67	+
	68	+Next, you can also review the following information:
	69	+
	70	+; Name
	71	+: The original file name of the uploaded file. This is useful, for instance, when you have updated a file and would like to check whether you uploaded the right file.
	72	+ Kann etwa genutzt werden, um beim Aktualisieren einer Datei zu prüfen, ob die richtige Datei hochgeladen wurde.
	73	+; Size
	74	+: The file size of the file.
	75	+; Created
	76	+: The date and time when the file was originally created.
	77	+; Create by
	78	+: The name of the user who originally created the file.
	79	+; Changed
	80	+: The date and time when the file was most recently updated.
	81	+; Changed by
	82	+: The name of the user who made the most recent update to the file
	83	+
	84	+{{figure image="files_url_en.png"}}
	85	+You can also access a file via an {{smallcaps}}Url{{/smallcaps}}. This can be used, for example, to load a file dynamically via JavaScript or to include a font file in a form.
	86	+{{/figure}}
	87	+
	88	+Finally you can get check out the {{smallcaps}}Url{{/smallcaps}} to the file. Use this {{smallcaps}}Url{{/smallcaps}} to access the contents of the file. Please note that the {{smallcaps}}Url{{/smallcaps}} may need to be modified in case you are making use of [[frontend servers>>doc:Formcycle.SystemSettings.UserInterface.FrontendServer]].
	89	+
	90	+{{smallcaps}}Urls{{/smallcaps}} are shown for files with the following file extensions only:
	91	+//.html, .htm, .shtm, .xhtm, .css, .js, .json, .xml, .jpg, .jpeg, .png, .gif, .svg, .ttf, .pdf//
	92	+
	93	+{{version major="6" minor="3"/}} Starting with version 6.3.0 the {{smallcaps}}Url{{/smallcaps}} is shown for files with the following file extensions, too:
	94	+//.otf, .woff, .woff2, .svg, .ttf, .eot, .sfnt, .jpe//
	95	+
	96	+For files with other extensions, {{formcycle/}} does not show {{smallcaps}}urls{{/smallcaps}} and these files are not accessible from outside via {{smallcaps}}url{{/smallcaps}}.