Actuate Information Delivery API data types : User
 
User
A complex data type that describes a user.
Schema
<xsd:complexType name="User">
<xsd:sequence>
<xsd:element name="Id" type="xsd:string" minOccurs="0"/>
<xsd:element name="Name" type="xsd:string" minOccurs="0"/>
<xsd:element name="Password" type="xsd:string"
minOccurs="0"/>
<xsd:element name="Description" type="xsd:string"
minOccurs="0"/>
<xsd:element name="IsLoginDisabled" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="EmailAddress" type="xsd:string"
minOccurs="0"/>
<xsd:element name="HomeFolder" type="xsd:string"
minOccurs="0"/>
<xsd:element name="ViewPreference" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Default"/>
<xsd:enumeration value="DHTML"/>
<xsd:enumeration value="LRX"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="MaxJobPriority" type="xsd:long"
minOccurs="0"/>
<xsd:element name="SendNoticeForSuccess" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="SendNoticeForFailure" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="SuccessNoticeExpiration" type="xsd:long"
minOccurs="0"/>
</xsd:element>
<xsd:element name="FailureNoticeExpiration" type="xsd:long"
minOccurs="0"/>
<xsd:element name="SendEmailForSuccess" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="SendEmailForFailure" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="AttachReportInEmail" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="DefaultPrinterName" type="xsd:string"
minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
Elements
Id
The user’s user ID.
Name
The user’s name. A user name is a string of 1 to 256 characters, including any character except a control character. A user name is not case-sensitive. BIRT iHub stores a user name in mixed case, always displaying it exactly the way it was typed during creation.
Password
The user’s password. A password is a string of 1 to 256 characters, including any character except a control character or space. Security experts recommend using passwords of at least eight characters, including mixed-case alphabetic and numeric characters. A password is case-sensitive. The Administrator can change any user’s password. Users can only change their own passwords. BIRT iHub encrypts a user’s password.
Description
The description of the user.
IsLoginDisabled
Specifies whether the user can log in.
EmailAddress
The user’s e-mail address.
HomeFolder
The user’s home folder.
ViewPreference
The user’s viewer, Default or DHTML.
MaxJobPriority
The maximum priority that the user can assign to a job.
SendNoticeForSuccess
Specifies whether the BIRT iHub sends success notices to the user.
SendNoticeForFailure
Specifies whether the BIRT iHub sends failure notices to the user.
SuccessNoticeExpiration
Specifies the minimum number of minutes success notices remain in the Completed folder. After this time elapses, BIRT iHub removes the notices the next time it removes requests from the volume’s Requests\Completed folder. If not set or set to 0, DefaultSuccessNoticeExpiration specified in Volume is used. To set the user’s success notices to never expire, set the value to 0xffffffff.
FailureNoticeExpiration
Specifies the minimum number of minutes failure notices remain in the Completed folder. After this time elapses, BIRT iHub removes the notices the next time it removes requests from the volume’s Requests\Completed folder. If not set or set to 0, DefaultFailureNoticeExpiration specified in Volume is used. To set the user’s failure notices to never expire, set the value to 0xffffffff.
SendEmailForSuccess
Specifies whether the BIRT iHub sends success notices in an e-mail message to the user.
SendEmailForFailure
Specifies whether the BIRT iHub sends failure notices in an e-mail message to the user.
AttachReportInEmail
Specifies whether to attach a report to an e-mail completion notice.
DefaultPrinterName
The name of the user’s default printer.