Show last authors
1 {{figure image="export_xml_en.png" clear="h1"}}
2 Configuration interface of the //Export as XML// action.
3 {{/figure}}
4
5 Actions of type //Export as XML// allow to provide the data of an form record as XML. Optionally, a [[//XSL//-Template>>Formcycle.UserInterface.FilesAndTemplates.XSLTransformation]] provides the possibility to transform the data into another format.
6
7 == Parameters ==
8
9 === Details for export ===
10
11 ; XSL template
12 : Selection of an XSL template for optional transformation.
13
14 === Export additional fields ===
15
16 The following optional fields can be exported:
17
18 ; ID
19 : ID of the respective form record.
20 ; Process ID
21 : Process ID of the respective form record.
22 ; Subject
23 : Subject of the respective form record.
24 ; Status
25 : Name of the status in which the respective form record is located at the time of export.
26 ; Inbox
27 : Inbox of the respective form record.
28 ; Date of receipt
29 : Creation date of the form record.
30 ; Modification date
31 : Time of the last change to the form record.
32 ; Form variables
33 : Configured [[Form variables>>doc:Formcycle.Designer.Form.CodingPanel.VariablesTab]] and their values.
34 ; Control fields
35 : Control fields of the form like //xf-action//. The //xf-action// stepper field contains the name of the button used to submit the form.
36 ; Metadata
37 : Date of export and the {{formcycle/}} version used.
38
39 === Storage options for the created files ===
40
41 ; Output file name
42 : File name under which the XML file will be saved. Please note that the filename extension must be xml, so the filename must end in .xml.
43 ; Attach file to form record
44 : 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.
45
46 == Action variables ==
47
48 Actions of type //Export as XML// provide [[Action variables>>Formcycle.UserInterface.Variables||anchor="HActionvariables"]] which can be used in subsequent actions.
49
50 === Standard action variables ===
51
52 ; [%$<action name>.SUCCESS%]
53 : Return whether action was successfully executed. Returns Boolean (true/false).
54 ; [%$<action name>.RESULT%]
55 : Return all results provided by the action in structured form.
56
57 ; [%$<action name>.ERROR_CODE%]
58 : The error code thrown in case of an error in the action. Empty if no error occurred.
59 ; [%$<action name>.ERROR_MESSAGE%]
60 : The thrown error message in the action's error case. Empty if no error occurred.
61
62 === Action specific action variables ===
63
64 ; [%$<action name>.RESULT.fileSize%]
65 : Size of the XML file created, in bytes.
66 ; [%$<action name>.ERROR.message%]
67 : Error code returned if the text file could not be written to the file system, the selected XSL template does not match an XSLT template, or the XSLT transformation was not successful.
Copyright 2000-2022