|
Writes
an XML document to the file system of the LiveCycle server.
For information about the General and Route Evaluation property
groups, see
Common operation properties
.
Input properties
Properties that specify the file to write.
Pathname Pattern
A
string
value that represents
the fully qualified name of the file to create on the file system
of the LiveCycle server. Filename can include the following parameters
that are replaced with specific values at run time.
|
Parameter
|
Description
|
|
%Y
|
The current year (four digits)
|
|
%y
|
The current year (last two digits)
|
|
%M
|
The current month
|
|
%D
|
The current day of the month
|
|
%d
|
The current day of the year
|
|
%H
|
The current hour using the 24-hour clock
|
|
%h
|
The current hour using the 12-hour clock
|
|
%m
|
The current minute
|
|
%s
|
The current second
|
|
%R
|
A random number between 0 and 9
|
XML Document
An
org.w3c.dom.Document
value
that represents the content to write to the file.
CharSet
(Optional)
A
Character Set (File Utilities)
value that represents the character set that the file uses. The
following values are valid:
-
Big_Five
-
GB_2312
-
ISO_8859_1
-
ISO_8859_2
-
ISO_8859_7
-
KSC_5601
-
Shift_JIS
-
US_ASCII
-
UTF_16
-
UTF_16BE
-
UTF_16LE
-
UTF_8
The default is
UTF_8
.
If you create a
com.adobe.livecycle.fileutils.CharSet
variable,
you must select Find Type in the Type list and search for the
CharSet
type.
Make Unique
A
boolean
value that specifies
whether the name of the file is to be made unique. A value of
True
indicates
that the file name be made unique, and a value of
False
indicates
that the file name is not unique. The default is
False
.
To specify the literal value of
True
, select Make
Unique. To specify the literal value of
False
,
deselect Make Unique.
The following behavior occurs if a file
exists with the same file name that is specified for the new file:
-
If Make Unique is set to
true
, an index
is appended to the name of the file that is created. The index distinguishes
the new file from the existing file.
-
If Make Unique is set to
false
, the value
of the Over Write property determines the behavior:
-
if Over Write is set to
true
, the existing
file is overwritten with the new file.
-
If Over Write is set to
false
, an exception
is thrown.
Over Write
A
boolean
value that specifies
whether to replace a file of the same name provided for Pathname
Pattern if it exists. A value of
True
indicates
that the file is replaced, and a value of
False
indicates
that the file is not replaced. The default is
False
.
To specify the literal value of
True
, select Over
Write. To specify the literal value of
False
, deselect
Over Write.
Note:
An exception is thrown when a
file exists with the same name that is specified for the new file,
Over Write is set to
false,
and Make Unique is
set to
false
.
Output properties
Properties for storing operation results.
Result
(Optional)
A
string
value that represents
the actual path of the file that was created.
|
|
|
