FileType
A complex data type that describes a file type. Specify FileType in the SOAP header for all execute, submit, and view IDAPI requests.
Schema
<xsd:complexType name="FileType">
<xsd:all>
<xsd:element name="Name" type="xsd:string" minOccurs="0"/>
<xsd:element name="IsNative" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="IsExecutable" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="IsPrintable" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="IsRequired" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="OutputType" type="xsd:string"
minOccurs="0"/>
<xsd:element name="LocalExtension" type="xsd:string"
minOccurs="0"/>
<xsd:element name="DisplayType" type="xsd:string"
minOccurs="0"/>
<xsd:element name="ShortDescription" type="xsd:string"
minOccurs="0"/>
<xsd:element name="LongDescription" type="xsd:string"
minOccurs="0"/>
<xsd:element name="SmallImageURL" type="xsd:string"
minOccurs="0"/>
<xsd:element name="LargeImageURL" type="xsd:string"
minOccurs="0"/>
<xsd:element name="ExportBeforeViewing" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="DriverName" type="xsd:string"
minOccurs="0"/>
<xsd:element name="MutexClass" type="xsd:string"
minOccurs="0"/>
<xsd:element name="ContentType" type="xsd:string"
minOccurs="0"/>
<xsd:element name="EnableAutoParamCollection"
type="xsd:boolean" minOccurs="0"/>
<xsd:element name="IsCompoundDoc" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="AllowViewTimeParameter" type="xsd:boolean"
minOccurs="0"/>
</xsd:all>
</xsd:complexType>
Elements
Name
The file type name.
IsNative
Specifies whether the file is an internal Actuate type. IsNative is read‑only. Providing an input value for this attribute in CreateFileType or UpdateFileType causes SetAttributes to be ignored.
IsExecutable
Specifies whether the file is executable. If False, the file type is set to Document file type. The OutputType and ExportBeforeViewing attributes do not apply to Document file type.
IsPrintable
Specifies whether the file is printable. If the file type is Executable, IsPrintable refers to the output file.
IsRequired
Specifies whether the file is required.
OutputType
The file type for the output file. Required if the file type is Executable.
LocalExtension
The local extension.
DisplayType
Specifies either Simple or Advanced display types.
ShortDescription
The short description of the file type.
LongDescription
The long description of the file type.
SmallImageURL
The URL of the small image for the file.
LargeImageURL
The URL of the large image for the file.
ExportBeforeViewing
Specifies whether the file is exported before viewing.
DriverName
The name of the driver. Required if file type is Executable or Printable.
MutexClass
The mutex class name.
ContentType
The content type.
EnableAutoParamCollection
True enables automatic parameter collection for the file type.
IsCompoundDoc
Specifies whether the file is a compound document. The default value is False.
AllowViewTimeParameter
Specifies whether to allow view-time parameters. The default value is True.