Wiki source code of Datei bereitstellen


Hide last authors
gru 1.1 1
awa 11.3 2 {{figure image="provide_file_en.png" clear="h1"}}
3 Configuration interface of the //Provide file// action.
gru 1.1 4 {{/figure}}
5
awa 11.3 6 This action allows to retrieve files from different sources and make them available within the workflow. Possible sources are from previous actions, client and form files, attachments of the process, and files from the Internet.
gru 1.1 7
awa 11.3 8 == Parameters ==
jdr 9.3 9
awa 11.3 10 === File resource details ===
jdr 5.2 11
awa 11.3 12 ; File
13 : Selection of the file to be used. Available are [[Formcycle files>>Formcycle.UserInterface.MyForms.Files]], [[Client files>>doc:Formcycle.UserInterface.FilesAndTemplates.Files]], resources loaded via a URL, files from previous actions or form record attachments. There is no restriction regarding the format, so all file types (PDF, GIF, PNG, DOC ...) can be used. See [[actions>>doc:Formcycle.Designer.Workflow.Actions.WebHome]] for a list of supported URL protocols.
jdr 5.2 14
awa 11.3 15 When using an external resource URL:
gru 1.1 16
awa 11.3 17 ; Resource URL
18 : URL to the file. The use of variables is possible.
19 ; Connection timeout
20 : Defines the time limit in seconds for establishing the connection to retrieve the external resource. The value must be between 1 and 60.
21 ; Read timeout
22 : Defines the time limit in seconds for read operations during the retrieval of the external resource. The value must be between 1 and 600.
jdr 9.2 23
awa 11.3 24 === Storage options for the created files ===
jdr 5.2 25
awa 11.3 26 ; Output file name
27 : Name of the output file.
28 ; Attach file to form record
29 : If this option is selected, files created in this action will be attached to the form record. Otherwise, they are only available for other actions within the workflow processing in the same processing chain.
jdr 5.2 30
awa 11.3 31 == Action variables ==
jdr 5.2 32
awa 11.3 33 Actions of type //Provide file// provide [[Action variables>>Formcycle.UserInterface.Variables||anchor="HActionvariables"]] which can be used in subsequent actions.
jdr 5.2 34
awa 11.3 35 === Standard action variables ===
jdr 5.2 36
awa 11.3 37 ; [%$<action name>.SUCCESS%]
38 : Return whether action was successfully executed. Returns Boolean (true/false).
39 ; [%$<action name>.RESULT%]
40 : Return all results provided by the action in structured form.
jdr 5.2 41
awa 11.3 42 ; [%$<action name>.ERROR_CODE%]
43 : The error code thrown in case of an error in the action. Empty if no error occurred.
44 ; [%$<action name>.ERROR_MESSAGE%]
45 : The thrown error message in the action's error case. Empty if no error occurred.
jdr 5.2 46
awa 11.3 47 === Action specific action variables ===
48
49 ; [%$<action name>.RESULT.fileSize%]
50 : Size of the provided file, in bytes.
51 ; [%$<action name>.ERROR.message%]
52 : Error code returned if the text file could not be written to the file system or could not be read, if the URL provided does not match a valid format, or if no source file could be determined to perform the action.