Main Page | Class Hierarchy | Class List | File List | Class Members | File Members

IDSSServerAdmin Interface Reference

Inherited by IDSSServerAdmin2.

List of all members.

Detailed Description

IDSSServerAdmin's properties and methods fall in three areas: server monitoring, server runtime configuration and misc.

client administrative functions. Server monitoring includes job monitoring, server status monitoring, project monitoring, database connection monitoring, and user session monitoring. Server runtime configuration presents the current server configuration, it also provides the capabilities to change some of the server configuration such as processing unit thread count and statistics collection flag. Misc client administrative functions allow the client to login/logout a project running at dss server and retrieve personalization profile


Public Member Functions

HRESULT ApplyRunTimeSettings ([in, optional, defaultvalue(0)] IDSSServerDef *ServerDef)
 This method applies the settings in the given server definition object.
HRESULT CacheAdministrator ([in] Int32 InternalProjectID,[out, retval] IDSSCacheAdmin ppCacheAdministrator)
 This property returns the cache administrator object corresponding to the project identified by the given internal project ID.
HRESULT ChangeUserPassword ([in] BSTR OldPasswd,[in] BSTR NewPasswd)
 This method changes the password for the user.
HRESULT CloseUserSession ([in] BSTR SessionID,[in, optional, defaultvalue(-1)] Int32 ServerContextID)
 This method closes the user session from a project.
HRESULT ClusterManager ([out, retval] IDSSClusterManager ppClusterManager)
 This property returns the server cluster manager.
HRESULT ConfigurationID ([out, retval] BSTR *pConfigurationID)
 The property returns the ID of the DSS Configuration object for the configuration metadata used by this DSS Server.
HRESULT Create ([in] EnumDSSCreateFlags Flags,[in] BSTR ID,[in] BSTR Name,[in, optional, defaultvalue(NULL)] BSTR ScriptFileName)
 This method is reserved.
HRESULT DatabaseAdministrator ([out, retval] IDSSDatabaseAdministrator ppAdm)
 This property returns the database administrator object.
HRESULT DataSource ([in] IDSSDataSource *pDataSource)
 This property returns the data source object.
HRESULT DataSource ([out, retval] IDSSDataSource ppDataSource)
 This property returns the data source object.
HRESULT DBMonitors ([in] EnumDSSGetDBConnOption DBConnOption,[out, retval] IDSSDBMonitors ppCollection)
 This property returns the DBMonistors object.
HRESULT DiagLogFlag ([in] BSTR ID,[in] EnumDSSServerDiagnosticsFlag iFlag,[in] Int32 newVal)
 This is a reserved property.
HRESULT DiagLogFlag ([in] BSTR ID,[in] EnumDSSServerDiagnosticsFlag iFlag,[out, retval] Int32 *pVal)
 This is a reserved property.
HRESULT DisconnectUser ([in] BSTR Name,[in] BSTR NetAddr)
 Disconnect a user from the DSS Server.
HRESULT GetUserInBox ([in] Int32 ProjectId,[out, retval] IDSSInBox ppMsgs)
 This method returns the inbox object.
HRESULT Idle ([in] EnumDSSServerIdleOption StopOption)
 This method is reserved.
HRESULT JobManager ([out, retval] IDSSJobManager ppManagers)
 This read only property returns an IDSSJobManager interface handle which provides the functionalities of managing and monitor jobs on DSS Server.
HRESULT LoginProject ([in] Int32 ProjectId,[in] IUnknown *InputDbFs,[out]BSTR *pAccessToken,[out, retval] IUnknown RequiredDbFs)
 Login this client to a project.
HRESULT LogoutProject ([in] Int32 ProjectId)
 Logout this client from a project.
HRESULT LogoutUserFromProject ([in] BSTR Name,[in] BSTR NetAddr,[in] Int32 ProjectId)
 Logout a user from a project.
HRESULT Name ([in] BSTR Name)
 This property is the name of the server.
HRESULT Name ([out, retval] BSTR *pName)
 This property is the name of the server.
HRESULT Ping ()
 This method checks that the server can be contacted.
HRESULT ProjectInstances ([in] EnumDSSRefreshOption RefreshOption,[out, retval] IDSSProjectInstances ppCollection)
 Monitor project instances registered to this DSS Server.
HRESULT RefreshSQLEngineSchema ([in, optional, defaultvalue(-1)]Int32 iInternalProjectID)
 This method reloads the schema for the specified project.
HRESULT RefreshUserObjects ([in, optional] BSTR iUser)
 Refresh one or all users in order to see the latest security permissions.
HRESULT RunRequest ([in] IDSSRequest *pRequest)
 Run a request with the given request object.
HRESULT RunRequestByID ([in] BSTR ID)
 Run a request with the given request object ID.
HRESULT SaveInBoxToFile ()
HRESULT ScheduleAdministrator ([out, retval] IDSSScheduleAdministrator ppScheduleAdministrator)
 This property returns the schedule administrator object.
HRESULT ScheduleInstances ([in] EnumDSSRefreshOption RefreshOption,[out, retval] IDSSScheduleInstances ppCollection)
 This property returns a collection of schedules used by this DSS Server.
HRESULT ServerID ([out, retval] BSTR *pServerID)
 This property returns the server ID.
HRESULT ServerMemAdministrator ([out, retval] IDSSServerMemAdmin ppServerMemAdmin)
 This property returns the server memory administrator object.
HRESULT ServerNet ([in] IDSSServerNet *pServerNet)
 The communication network layer that serveradmin uses to communicate with Dss Server.
HRESULT ServerNet ([out, retval] IDSSServerNet pServerNet)
 The communication network layer that serveradmin uses to communicate with Dss Server.
HRESULT ServerSummary ([out, retval] IDSSServerSummary ppServerSummary)
 This property returns the server summary object.
HRESULT ServiceName ([in] BSTR iServiceName)
 The service name of the Dss Server when it runs as a service.
HRESULT ServiceName ([out, retval] BSTR *oServiceName)
 The service name of the Dss Server when it runs as a service.
HRESULT Session ([in] IDSSSession *iSession)
 This property is the session object used to connect to this Intelligent Server.
HRESULT Session ([out, retval] IDSSSession ppSession)
 This property is the session object used to connect to this Intelligent Server.
HRESULT Start (BSTR MachineName,[optional]BSTR Path,[optional]BSTR Name,[optional]BSTR Passwd)
 Start the server.
HRESULT Statistics ([out, retval] IDSSStatistics ppStatistics)
 This property returns the statistic object.
HRESULT Status ([in] EnumDSSRefreshOption RefreshOption,[out, retval] EnumDSSServerStatus *pStatus)
 Check the status of the DSSServer.
HRESULT Stop ([in] EnumDSSServerStopOption StopOption)
 Stop the server.
HRESULT UpdateDiagnostics ()
 This method instruct the server to update its diagnostic output.
HRESULT UserSessions ([in] EnumDSSRefreshOption RefreshOption,[out, retval] IDSSUserSessions ppUserSessions)
 Monitor the user sessions in DSS Server.

Member Function Documentation

HRESULT IDSSServerAdmin::ApplyRunTimeSettings (  [in, optional, defaultvalue(0)] IDSSServerDef *  ServerDef  ) 
 

This method applies the settings in the given server definition object.

Parameters:
ServerDef Server definition object.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::CacheAdministrator (  [in] Int32  InternalProjectID,
[out, retval] IDSSCacheAdmin   ppCacheAdministrator
) 
 

This property returns the cache administrator object corresponding to the project identified by the given internal project ID.

The internal project ID is the sequential number of the project loaded in the server. The number starts from 0.

Parameters:
InternalProjectID The internal project ID for the project with which the cache administrator is requested.
ppCacheAdministrator The cache administrator object for the given project.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::ChangeUserPassword (  [in] BSTR  OldPasswd,
[in] BSTR  NewPasswd
) 
 

This method changes the password for the user.

Parameters:
OldPasswd The old password
NewPasswd The new password
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::CloseUserSession (  [in] BSTR  SessionID,
[in, optional, defaultvalue(-1)] Int32  ServerContextID
) 
 

This method closes the user session from a project.

The project is identified by the ServerContextID. Each project loaded into a server is identified by a server context ID which is basically a sequential number starting from 0. When the ServerContextID is -1, which is the default, this method will close the user session from all projects.

Parameters:
SessionID ID of the user session
ServerContextID The server context ID used to identify a project loaded in the server.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::ClusterManager (  [out, retval] IDSSClusterManager   ppClusterManager  ) 
 

This property returns the server cluster manager.

Parameters:
ppClusterManager Cluster manager object.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::ConfigurationID (  [out, retval] BSTR *  pConfigurationID  ) 
 

The property returns the ID of the DSS Configuration object for the configuration metadata used by this DSS Server.

Parameters:
pConfigurationID ID of the DSS Configuration object for the configuration metadata used by this DSS Server
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::Create (  [in] EnumDSSCreateFlags  Flags,
[in] BSTR  ID,
[in] BSTR  Name,
[in, optional, defaultvalue(NULL)] BSTR  ScriptFileName
) 
 

This method is reserved.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::DatabaseAdministrator (  [out, retval] IDSSDatabaseAdministrator   ppAdm  ) 
 

This property returns the database administrator object.

Parameters:
ppAdm The database administrator object.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::DataSource (  [in] IDSSDataSource *  pDataSource  ) 
 

This property returns the data source object.

Parameters:
pDataSource The data source object.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::DataSource (  [out, retval] IDSSDataSource   ppDataSource  ) 
 

This property returns the data source object.

Parameters:
ppDataSource The data source object.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::DBMonitors (  [in] EnumDSSGetDBConnOption  DBConnOption,
[out, retval] IDSSDBMonitors   ppCollection
) 
 

This property returns the DBMonistors object.

DBConnOption takes a value from EnumDSSGetDBConnOption
Constant Value Comment
DssGetDBConnOptionDetail 0 DB connection detailed information.
DssGetDBConnOption 1 DB connection basic information.
Returns:
Usual COM result code:
  • S_OK
  • S_OK

HRESULT IDSSServerAdmin::DiagLogFlag (  [in] BSTR  ID,
[in] EnumDSSServerDiagnosticsFlag  iFlag,
[in] Int32  newVal
) 
 

This is a reserved property.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::DiagLogFlag (  [in] BSTR  ID,
[in] EnumDSSServerDiagnosticsFlag  iFlag,
[out, retval] Int32 *  pVal
) 
 

This is a reserved property.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::DisconnectUser (  [in] BSTR  Name,
[in] BSTR  NetAddr
) 
 

Disconnect a user from the DSS Server.

The user loses its connection to DSS Server.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::GetUserInBox (  [in] Int32  ProjectId,
[out, retval] IDSSInBox   ppMsgs
) 
 

This method returns the inbox object.

The inbox object contains the inbox messages for the given project.

Parameters:
ProjectId The ID of the project for which the inbox object is retrieved.
ppMsgs The inbox object.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::Idle (  [in] EnumDSSServerIdleOption  StopOption  ) 
 

This method is reserved.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::JobManager (  [out, retval] IDSSJobManager   ppManagers  ) 
 

This read only property returns an IDSSJobManager interface handle which provides the functionalities of managing and monitor jobs on DSS Server.

Parameters:
ppManagers JobManager handle.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::LoginProject (  [in] Int32  ProjectId,
[in] IUnknown *  InputDbFs,
[out] BSTR *  pAccessToken,
[out, retval] IUnknown   RequiredDbFs
) 
 

Login this client to a project.

This step is necessary before this client can browse application objects or execute report in the project.

Parameters:
ProjectId The ID of the project to login to.
InputDbFs Reserved.
pAccessToken Access Token for a successful login.
RequiredDbFs Reserved.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::LogoutProject (  [in] Int32  ProjectId  ) 
 

Logout this client from a project.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::LogoutUserFromProject (  [in] BSTR  Name,
[in] BSTR  NetAddr,
[in] Int32  ProjectId
) 
 

Logout a user from a project.

The user cannot run reports in that project.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::Name (  [in] BSTR  Name  ) 
 

This property is the name of the server.

Parameters:
Name Intelligent server name.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::Name (  [out, retval] BSTR *  pName  ) 
 

This property is the name of the server.

Parameters:
pName Intelligent server name.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::Ping (   ) 
 

This method checks that the server can be contacted.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::ProjectInstances (  [in] EnumDSSRefreshOption  RefreshOption,
[out, retval] IDSSProjectInstances   ppCollection
) 
 

Monitor project instances registered to this DSS Server.

RefreshOption has the following value:
  • DssServerRefreshNo - Get the status stored in ServerAdmin--no network traffic to the server.
  • DssServerRefreshSynch - Get the status from server, call is blocked until server response.
  • DssServerRefreshAsynch - Get the status from server, call returns once the request is sent. An status change event is fired when server response. (this option hasn't been implemented yet)
  • DssServerRefreshRegister - Register this client on the server. Whenever the server status changes, a status change event is fired. (this option hasn't been implemented yet)
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::RefreshSQLEngineSchema (  [in, optional, defaultvalue(-1)] Int32  iInternalProjectID  ) 
 

This method reloads the schema for the specified project.

Subsequent reports will be executed using the latest schema.

When the projectID is left off, the schema for all the projects are refreshed.
Parameters:
iInternalProjectID The project ID.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::RefreshUserObjects (  [in, optional] BSTR  iUser  ) 
 

Refresh one or all users in order to see the latest security permissions.

When the user name is left off, all the users will be refreshed.
Parameters:
iUser The user name.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::RunRequest (  [in] IDSSRequest *  pRequest  ) 
 

Run a request with the given request object.

Parameters:
pRequest The request object.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::RunRequestByID (  [in] BSTR  ID  ) 
 

Run a request with the given request object ID.

Parameters:
ID The ID of the request object.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::SaveInBoxToFile (   ) 
 

HRESULT IDSSServerAdmin::ScheduleAdministrator (  [out, retval] IDSSScheduleAdministrator   ppScheduleAdministrator  ) 
 

This property returns the schedule administrator object.

Parameters:
ppScheduleAdministrator The schedule administrator object.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::ScheduleInstances (  [in] EnumDSSRefreshOption  RefreshOption,
[out, retval] IDSSScheduleInstances   ppCollection
) 
 

This property returns a collection of schedules used by this DSS Server.

Parameters:
RefreshOption Reserved parameter.
ppCollection A collection of schedules used by this DSS Server
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::ServerID (  [out, retval] BSTR *  pServerID  ) 
 

This property returns the server ID.

Parameters:
pServerID Server ID.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::ServerMemAdministrator (  [out, retval] IDSSServerMemAdmin   ppServerMemAdmin  ) 
 

This property returns the server memory administrator object.

Parameters:
ppServerMemAdmin Server memory administrator object.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::ServerNet (  [in] IDSSServerNet *  pServerNet  ) 
 

The communication network layer that serveradmin uses to communicate with Dss Server.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::ServerNet (  [out, retval] IDSSServerNet   pServerNet  ) 
 

The communication network layer that serveradmin uses to communicate with Dss Server.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::ServerSummary (  [out, retval] IDSSServerSummary   ppServerSummary  ) 
 

This property returns the server summary object.

Parameters:
ppServerSummary The server summary object.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::ServiceName (  [in] BSTR  iServiceName  ) 
 

The service name of the Dss Server when it runs as a service.

This is a read only property. DSS Server service name is pre-defined, and one NT machine can only have one DSS Server service.

Parameters:
iServiceName The name of the service when the server is running as a NT service.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::ServiceName (  [out, retval] BSTR *  oServiceName  ) 
 

The service name of the Dss Server when it runs as a service.

This is a read only property. DSS Server service name is pre-defined, and one NT machine can only have one DSS Server service.

Parameters:
oServiceName The name of the service when the server is running as a NT service.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::Session (  [in] IDSSSession *  iSession  ) 
 

This property is the session object used to connect to this Intelligent Server.

Parameters:
iSession The session object.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::Session (  [out, retval] IDSSSession   ppSession  ) 
 

This property is the session object used to connect to this Intelligent Server.

Parameters:
ppSession The session object.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::Start (  BSTR  MachineName,
[optional] BSTR  Path,
[optional] BSTR  Name,
[optional] BSTR  Passwd
) 
 

Start the server.

If the server is set to run as a service, the MachineName is enough to start the server. If the server is to run as an application. We need the path where the server is installed, the user name and password for the user to start the server.
Parameters:
MachineName The server machine name
Path The path where the server is installed
Name Name of the user to start the server
Passwd The password of the user to start the server
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::Statistics (  [out, retval] IDSSStatistics   ppStatistics  ) 
 

This property returns the statistic object.

It contains the statistical information collected by this server.

Parameters:
ppStatistics The statistic object.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::Status (  [in] EnumDSSRefreshOption  RefreshOption,
[out, retval] EnumDSSServerStatus *  pStatus
) 
 

Check the status of the DSSServer.

RefreshOption has the following value:
  • DssServerRefreshNo - Get the status stored in ServerAdmin--no network traffic to the server.
  • DssServerRefreshSynch - Get the status from server, call is blocked until server response.
  • DssServerRefreshAsynch - Get the status from server, call returns once the request is sent. An status change event is fired when server response. (this option hasn't been implemented yet)
  • DssServerRefreshRegister - Register this client on the server. Whenever the server status changes, a status change event is fired. (this option hasn't been implemented yet)
Server Status has the following value:
  • DssServerNotAvailable - Server is not responding, or connection to it fails.
  • DssServerWarmingUp - Server is creating its components.
  • DssServerAdminReady - Server finish creating its components, ready to accept request.
  • DSSServerShuttingDown - Server is shutting down.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::Stop (  [in] EnumDSSServerStopOption  StopOption  ) 
 

Stop the server.

StopOption has following values:

  • DSSServerStopNormal - Stop the server in normal procedure, jobs are backed up, resource are released normally.
  • DSSServerStopImmediately - Stop the server process immediately without any backup.
    Returns:
    Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::UpdateDiagnostics (   ) 
 

This method instruct the server to update its diagnostic output.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSServerAdmin::UserSessions (  [in] EnumDSSRefreshOption  RefreshOption,
[out, retval] IDSSUserSessions   ppUserSessions
) 
 

Monitor the user sessions in DSS Server.

A user session represents a user connection to the server. There is a special case in which user session doesn't corresponding to any user connection - batch/schedule user job: a user session is created by the system representing a user while the user does not actually connect to the server.

RefreshOption has the following values:
  • DssServerRefreshNo - Get the status stored in ServerAdmin--no network traffic to the server.
  • DssServerRefreshSynch - Get the status from server, call is blocked until server response.
  • DssServerRefreshAsynch - Get the status from server, call returns once the request is sent. An status change event is fired when server response. (this option hasn't been implemented yet)
  • DssServerRefreshRegister - Register this client on the server. Whenever the server status changes, a status change event is fired. (this option hasn't been implemented yet)
Returns:
Usual COM result code:
  • S_OK

Copyright © 1996-2018 MicroStrategy Inc. All Rights Reserved.