SA XT for web access > System Architect XT > System Architect XT Web Service > System Architect XT Web Service methods > OpenEncyclopedia method
  
OpenEncyclopedia method
When a session is established on the server, the client must open an encyclopedia. Only Enterprise encyclopedias are supported by the System Architect XT Web Service. The OpenEncyclopedia method requires a SessionId and a SAWSEncy object. The SAWSEncy object contains the information needed to locate the desired enterprise encyclopedia. The database type can be specified by using the exposed SAWSENCY_TYPE enumeration.
The impersonation account defined in the System Architect XT Web Service web.config file is used to access the database that contains the target encyclopedia. This account requires standard System Architect privileges on the SQL Server. The System Architect XT Web Service server software will run in the context of this account and must be able to connect to the SQL Server database using Integrated Windows Authentication; users do not need their own SQL Server database account. Users will be authorized by the System Architect Enterprise Catalog on the SQL Server selected at run time.
See the System Architect and System Architect XT Installation Guide for more information on accessing encyclopedias.
SAWSENCY_TYPE
SAWSENCY_SQL
SAWSENCY_ORA
SAWSEncy
eType as SAWSENCY_TYPE
sServerName as string
sEncyName as string
Updated values
The following SessionState values will be updated as follows:
State
SAEncyopen
ServerType
The passed database type
ServerName
The passed server name
EncyName
The passed encyclopedia name
LastDateTime
Current date and time
Arguments
sSessionId
The session id returned from the startsession method
SAWSEncy:
eType
Specify one of the encyclopedia types defined in the SAWSENCY_TYPE enumeration.
sServerName
Provide the name of the database server
sEncyName
Provide the name of the encyclopedia
Return
SAWSResult:
iError
0 if successful, otherwise an error number
sErrorMsg
Empty if successful, otherwise a description of the problem
sOutput
Always empty
See also
System Architect XT Web Service methods