a!submitUploadedFiles( onSuccess, onError )
Submits all uploaded files in a!fileUploadField or a!signatureField components to their target folders. The function only executes inside a saveInto parameter. Only for use with Portals.
For best results, use this function in the saveInto parameter of submit links and buttons. If the user has uploaded any files to file upload or signature components, the function submits the files automatically and immediately to Appian when the function is evaluated. When the function is used correctly in the saveInto parameter of submission links and buttons, the function is evaluated when the user clicks the link or button to submit the form.
If you use the function in the saveInto parameter of the file upload or signature components, the files are submitted to the target folder as soon as a user uploads them. This means that if a user accidentally uploads the wrong file, the function submits it before the user can change files. This can result in unnecessary or incorrect files mistakenly added to the target folder.
To avoid this and ensure that the files are submitted with the rest of the data in the form, add the function to submit links or buttons.
Caution: WARNING: To write document IDs from uploaded files to a database through an integration, the integration input that you're writing must be of type Number(Integer), not Document. An incorrect type can cause the data and document IDs to not save properly.
See also:
| Keyword | Type | Description |
|---|---|---|
|
|
Any Type |
A list of saves to execute after the uploaded files are submitted successfully to the target folder. |
|
|
Any Type |
A list of saves to execute after the uploaded files are not submitted successfully to the target folder. Use |
Any type
The a!submitUploadedFiles() function returns an error code if a runtime error happens. The error code can be accessed using fv!error in the onError parameter.
To learn how to display the error code on your portal interface, see this example.
The following table lists each error code along with its meaning.
| Error Code | Meaning |
|---|---|
| APNX-1-4561-007 | An error occurred when submitting the uploaded file(s). |
| APNX-2-4196-000 | An unexpected error has occurred. The form can't be submitted. |
| APNX-2-4196-001 | The destination folder specified is invalid. |
| APNX-2-4196-002 | You do not have sufficient privileges to upload a file to the designated folder. |
| APNX-2-4196-006 | This file is empty. |
| APNX-2-4196-007 | The uploaded file doesn't exist. |
These expressions should only be used as examples and should not be used to test the a!submitUploadedFiles() function. Test the a!submitUploadedFiles() function in a published portal in a development environment.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
a!localVariables(
local!file,
{
a!fileUploadField(
label: "Supporting Image",
value: local!file,
saveInto: local!file,
target: cons!myFolder,
maxSelections: 1,
validations: if(
or(upper(fv!files.extension) = { "PNG", "JPG" }),
null,
"Please upload a valid image type: png or jpg"
)
),
a!buttonArrayLayout(
buttons: {
a!buttonWidget(
label: "Submit",
submit: true,
style: "PRIMARY",
saveInto: a!submitUploadedFiles()
)
},
align: "END"
)
}
)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
a!localVariables(
local!customer: type!Customer(),
local!submissionSuccessful,
{
a!textField(
label: "Name",
value: local!customer.name,
saveInto: local!customer.name,
characterLimit: 255
),
a!fileUploadField(
label: "Image",
value: local!customer.document,
saveInto: local!customer.document,
target: cons!myFolder,
maxSelections: 1,
validations: if(
or(upper(fv!files.extension) = { "PNG", "JPG" }),
null,
"Please upload a valid image type: png or jpg"
)
),
a!buttonArrayLayout(
buttons: {
a!buttonWidget(
label: "Submit",
style: "PRIMARY",
saveInto: {
a!writeToDataStoreEntity(
dataStoreEntity: cons!PORTAL_ENTITY,
valueToStore: local!customer,
onSuccess: {
/*Only upload the files if the data is successfully written*/
a!submitUploadedFiles(
onSuccess: {
a!save(local!submissionSuccessful, true)
},
onError: {
a!save(local!submissionSuccessful, false)
}
)
},
onError: {
a!save(local!submissionSuccessful, false)
}
)
}
)
},
align: "END"
)
}
)
Because the a!submitUploadedFiles() function only works inside a published portal, the only way to view the value of fv!error is to display it in your interface if the file fails to upload.
To test the below example:
cons!DOCUMENT_FOLDER with a constant that points to the folder that the files will be uploaded to.1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
a!localVariables(
local!file,
local!submissionSuccessful,
local!errorCode,
{
a!fileUploadField(
label: "Supporting Image",
target: cons!DOCUMENT_FOLDER,
maxSelections: 1,
value: local!file,
saveInto: local!file
),
a!buttonArrayLayout(
buttons: {
a!buttonWidget(
label: "Submit",
saveInto: a!submitUploadedFiles(
onSuccess: a!save(local!submissionSuccessful, true),
onError: {
a!save(local!submissionSuccessful, false),
a!save(local!errorCode, fv!error)
}
),
submit: true,
style: "PRIMARY"
)
},
align: "END"
),
{
if(
isnull(local!submissionSuccessful),
{},
if(
local!submissionSuccessful = true,
/* Success message */
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextIcon(
icon: "check-circle",
color: "POSITIVE"),
" ",
a!richTextItem(
text: "File uploaded successfully",
style: "STRONG"
)
},
align: "RIGHT"
),
/* Error message */
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextIcon(
icon: "times-circle",
color: "NEGATIVE"),
" ",
a!richTextItem(
text: {
"File not uploaded (",
local!errorCode,
")"
},
style: "STRONG",
color: "NEGATIVE"
)
},
align: "RIGHT"
)
)
)
}
}
)
| Feature | Compatibility | Note |
|---|---|---|
| Portals | Compatible | |
| Offline Mobile | Incompatible | |
| Sync-Time Custom Record Fields | Incompatible | |
| Real-Time Custom Record Fields | Incompatible | |
| Process Reports | Incompatible | You cannot use this function to configure a process report. |
| Process Events | Incompatible | You cannot use this function to configure a process event node, such as a start event or timer event. |
a!submitUploadedFiles() Function
