Start
Initializes the RSSE. Implement Start to initialize RSSE.
Request schema
<xsd:complexType name="Start">
<xsd:sequence>
<xsd:element name="ServerHome" type="xsd:string"/>
<xsd:element name="Volume" type="xsd:string"/>
<xsd:element name="LogFile" type="xsd:string"/>
<xsd:element name="Version" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
Request elements
ServerHome
The path to the BIRT iHub installation, for example C:\Program Files\Actuate\Server on Windows.
Volume
The name of the Encyclopedia volume.
LogFile
The path to the log file for RSSE activity.
Version
The BIRT iHub version number.
Response schema
<xsd:complexType name="StartResponse">
<xsd:sequence>
<xsd:element name="IntegrationLevel" type="xsd:string"
minOccurs="0"/>
<xsd:element name="ExternalProperties"
type="typens:ArrayOfString" minOccurs="0"/>
<xsd:element name="RSSEVersion" type="xsd:string"/>
<xsd:element name="UserACLExternal" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="ConnectionPropertyExternal"
type="xsd:boolean" minOccurs="0"/>
<xsd:element name="SelectUsersOfRole" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="SelectGroupsOfUser" type="xsd:boolean"
minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
Response elements
IntegrationLevel
The integration level of external security. One of the following values:
External_Authentication
External_Registration
None
ExternalProperties
One or more of the following external user or role properties:
EmailAddress
The user’s e-mail address
HomeFolder
The user’s home folder
EmailForm
The form of the e‑mail attachment, included or linked
EmailWhen
The type of notification to use for a completed job
FolderWhen
An indicator of when the user uses the Completed folder
SuccessNoticeExpiration
The number of minutes that elapse before the Encyclopedia service deletes a successful job notice
FailNoticeExpiration
The number of minutes that elapse before the Encyclopedia service deletes a failed job notice
DefaultObjectPrivileges
The privileges that the user has by default on the objects the user creates
MaxPriority
The maximum request priority the user can set when creating a report printing or generation request
ViewPreference
The user’s web viewing preference, default or DHTML
ChannelSubscriptionList
A list of channels to which the user subscribes
RSSEVersion
The version of RSSE.
UserACLExternal
Specifies whether the user’s access list is stored externally. Applies only if using page-level security.
ConnectionPropertyExternal
Specifies whether the user’s connection properties are retrieved externally from the RSSE. If True, the connection properties are retrieved externally. In this case, BIRT iHub directs requests to set connection properties to the RSSE and does not use GetConnectionProperties.
SelectUsersOfRole
Applies only under external registration. Specifies whether the Role element in SelectUsers is implemented. The setting indicates whether BIRT iHub enables this feature. The default value is False.
SelectGroupsOfUser
Applies only under external registration. Specifies whether the User element in SelectGroups is implemented. The setting indicates whether BIRT iHub enables this feature. The default value is False.