Writes XML content in an XML file.

The Write XML step allows outputting XML content in an XML file on the disk. It can either create a new XML file or update an existing XML file.

Property Type Category Description
Append timestamp boolean standard Defines whether the file name should be created with a timestamp.
If set to true, the date is concatenated to the file name in yyyymmddHHmmssSSS format.
Comment String standard Describes the object comment to include in the documentation report.
This property generally contains an explanation about the object.
Default root tag name String standard Defines the root element tag name of the resulting XML to be written, if none is defined by the source.
Setting this property allows adding a root element named after this property value in the XML file written.
Encoding String standard Defines the encoding used in output file.
Default used encoding is ISO-8859-1.
Is active boolean standard Defines whether the step is active.
Output file JS expression standard Defines the output file path including the file name.
This property is a JavaScript expression that is evaluated during the sequence execution and gives the path and name of the file to write.
This path is either absolute or relative to Convertigo environment. Relative paths starting with:

./ are relative to Convertigo workspace,
.// are relative to current project folder.
Append Result boolean expert Defines whether the XML must be appended at the end of the file.
If set to true, and if the file exists, the step appends the XML at the end of the file. If set to false, it overrides the current file content.
Output boolean expert Defines whether the XML generated by this step should be appended to the resulting XML.
Set this property to true to add the step’s resulting XML to the sequence’s output XML (default value for steps generating XML). Set this property to false to prevent the steps’s XML result to appear in the sequence’s output XML.
Setting this property to false does not prevent the step’s generated XML from being used as a source by other steps.
Source XMLVector expert Defines the source data to write.
This property allows defining a list of nodes from a previous step used as data root to be written in the file.
A source is defined as a reference on a step previously existing in the parent sequence, associated with an XPath applied on the step’s result DOM. At runtime, the XPath is applied on the step’s current execution result XML and extracts a list of XML nodes resulting from this execution.
If the XPath doesn’t match or if the source is left blank, the XML output document of the sequence (i.e., sequence resulting XML) is used as source. In this case, the step behavior can be seen as a sequence output dump.
If REST or SOAP interfaces are used to call parent sequence, the XML output document is normally returned to the sequence caller.
Write Output False boolean expert Defines if the XML should contains Output False elements.
If set to true (default), all XML generated from the source is written to the file else only Step flagged as Output True will be.