The TrimEnterpriseWorkgroupServer class represents the configuration of a workgroup server within the TRIMEnterpriseConfiguration More...

Public Member Functions
void	Remove (TrimEnterpriseWorkgroupServer replaceWith)
	Removes this workgroup server from from the configuration. If the workgroup server is currently configured to do rendering or event processing you will need to provide another workgroup server to replace it. More...

void	EnableHTTP (string httpAddress, int httpPort)
	Enable HTTP for this workgroup server. More...

void	DisableHTTP ()
	Disable HTTP for this workgroup server. More...

void	EnableHTTPS (string httpsAddress, int httpsPort, string certSubject, string certThumbprint)
	Enable HTTPS for this workgroup server. More...

void	DisableHTTPS ()
	Disables HTTPS for this workgroup server. More...

bool	IsAuthenticationMethodSupported (AuthenticationMethod meth)

void	SetAuthenticationMethod (AuthenticationMethod meth, bool isSupported)

Properties
string	Id `[get]`
	Gets the unique identifier of this workgroup server. More...

string	ServerName `[get]`
	Gets the server machine name of this workgroup server. More...

int	PortNumber `[get]`
	Gets the TCP port number used by this workgroup server. More...

string	TCPAddress `[get, set]`
	Gets or sets the TCP address of this server. A blank value indicates binding to all local interfaces (i.e. '0.0.0.0'). More...

bool	HTTPEnabled `[get]`
	Gets a boolean value, indicating whether HTTP is enabled for this workgroup server. More...

string	HTTPAddress `[get]`
	Gets the HTTP address of this server. A blank value indicates binding to all local interfaces (i.e. '0.0.0.0'). More...

int	HTTPPortNumber `[get]`
	Gets the HTTP port number used by this workgroup server. More...

bool	HTTPSEnabled `[get]`
	Gets a boolean value, indicating whether HTTPS is enabled for this workgroup server. More...

string	HTTPSAddress `[get]`
	Gets the HTTPS address of this workgroup server. A blank value indicates binding to all local interfaces (i.e. '0.0.0.0'). More...

int	HTTPSPortNumber `[get]`
	Gets the HTTPS port number used by this workgroup server. More...

string	HTTPSCertSubject `[get]`
	Gets the HTTPS certificate subject for this workgroup server. More...

string	HTTPSCertThumbprint `[get]`
	Gets the HTTPS certificate thumbprint for this workgroup server. More...

bool	CanProcessEvents `[get, set]`
	Gets or sets a boolean variable indicating whether this workgroup processes events. More...

bool	PublishDatasets `[get, set]`
	Gets or sets a boolean variable indicating whether this workgroup publishes the list of available datasets to clients. More...

short	SharePointFarmId `[get, set]`
	Gets or sets a number indicating the id of the SharePoint farm designated for this workgroup. 0 indicates that it is not sending events to the SharePoint integration. More...

bool	UsesDocumentCache `[get, set]`
	Gets or sets a boolean variable indicating whether this workgroup maintains a local cache of recently accessed documents. More...

int	DocumentCacheSizeLimitMg `[get, set]`
	Gets or sets a number of megabytes to limit the size of the local document cache. More...

bool	LoggingEnabled `[get, set]`
	Gets or sets a boolean variable indicating whether this workgroup produces an output log. More...

bool	LogWgsInternalCalls `[get, set]`
	Gets or sets a boolean variable indicating whether this workgroup logs internal workgroup calls to the output log. More...

bool	LogUserQueryStrings `[get, set]`
	Gets or sets a boolean variable indicating whether this workgroup logs user search strings to the output log. More...

bool	LogSQLWithNoParams `[get, set]`
	Gets or sets a boolean variable indicating whether this workgroup logs SQL in an unparameterized format to the output log. More...

bool	LogRCFCalls `[get, set]`
	Gets or sets a boolean variable indicating whether this workgroup logs RCF calls to the output log. More...

Detailed Description

The TrimEnterpriseWorkgroupServer class represents the configuration of a workgroup server within the TRIMEnterpriseConfiguration

Member Function Documentation

◆ DisableHTTP()

void TRIM.SDK.TrimEnterpriseWorkgroupServer.DisableHTTP ( )

Disable HTTP for this workgroup server.

◆ DisableHTTPS()

void TRIM.SDK.TrimEnterpriseWorkgroupServer.DisableHTTPS ( )

Disables HTTPS for this workgroup server.

◆ EnableHTTP()

void TRIM.SDK.TrimEnterpriseWorkgroupServer.EnableHTTP	(	string	httpAddress,
		int	httpPort
	)

Enable HTTP for this workgroup server.

◆ EnableHTTPS()

void TRIM.SDK.TrimEnterpriseWorkgroupServer.EnableHTTPS	(	string	httpsAddress,
		int	httpsPort,
		string	certSubject,
		string	certThumbprint
	)

Enable HTTPS for this workgroup server.

◆ IsAuthenticationMethodSupported()

bool TRIM.SDK.TrimEnterpriseWorkgroupServer.IsAuthenticationMethodSupported ( AuthenticationMethod meth )

◆ Remove()

void TRIM.SDK.TrimEnterpriseWorkgroupServer.Remove ( TrimEnterpriseWorkgroupServer replaceWith )

Removes this workgroup server from from the configuration. If the workgroup server is currently configured to do rendering or event processing you will need to provide another workgroup server to replace it.

◆ SetAuthenticationMethod()

void TRIM.SDK.TrimEnterpriseWorkgroupServer.SetAuthenticationMethod	(	AuthenticationMethod	meth,
		bool	isSupported
	)

Property Documentation

◆ CanProcessEvents

bool TRIM.SDK.TrimEnterpriseWorkgroupServer.CanProcessEvents

getset

Gets or sets a boolean variable indicating whether this workgroup processes events.

◆ DocumentCacheSizeLimitMg

int TRIM.SDK.TrimEnterpriseWorkgroupServer.DocumentCacheSizeLimitMg

getset

Gets or sets a number of megabytes to limit the size of the local document cache.

◆ HTTPAddress

string TRIM.SDK.TrimEnterpriseWorkgroupServer.HTTPAddress

get

Gets the HTTP address of this server. A blank value indicates binding to all local interfaces (i.e. '0.0.0.0').

◆ HTTPEnabled

bool TRIM.SDK.TrimEnterpriseWorkgroupServer.HTTPEnabled

get

Gets a boolean value, indicating whether HTTP is enabled for this workgroup server.

◆ HTTPPortNumber

int TRIM.SDK.TrimEnterpriseWorkgroupServer.HTTPPortNumber

get

Gets the HTTP port number used by this workgroup server.

◆ HTTPSAddress

string TRIM.SDK.TrimEnterpriseWorkgroupServer.HTTPSAddress

get

Gets the HTTPS address of this workgroup server. A blank value indicates binding to all local interfaces (i.e. '0.0.0.0').

◆ HTTPSCertSubject

string TRIM.SDK.TrimEnterpriseWorkgroupServer.HTTPSCertSubject

get

Gets the HTTPS certificate subject for this workgroup server.

◆ HTTPSCertThumbprint

string TRIM.SDK.TrimEnterpriseWorkgroupServer.HTTPSCertThumbprint

get

Gets the HTTPS certificate thumbprint for this workgroup server.

◆ HTTPSEnabled

bool TRIM.SDK.TrimEnterpriseWorkgroupServer.HTTPSEnabled

get

Gets a boolean value, indicating whether HTTPS is enabled for this workgroup server.

◆ HTTPSPortNumber

int TRIM.SDK.TrimEnterpriseWorkgroupServer.HTTPSPortNumber

get

Gets the HTTPS port number used by this workgroup server.

◆ Id

string TRIM.SDK.TrimEnterpriseWorkgroupServer.Id

get

Gets the unique identifier of this workgroup server.

◆ LoggingEnabled

bool TRIM.SDK.TrimEnterpriseWorkgroupServer.LoggingEnabled

getset

Gets or sets a boolean variable indicating whether this workgroup produces an output log.

◆ LogRCFCalls

bool TRIM.SDK.TrimEnterpriseWorkgroupServer.LogRCFCalls

getset

Gets or sets a boolean variable indicating whether this workgroup logs RCF calls to the output log.

◆ LogSQLWithNoParams

bool TRIM.SDK.TrimEnterpriseWorkgroupServer.LogSQLWithNoParams

getset

Gets or sets a boolean variable indicating whether this workgroup logs SQL in an unparameterized format to the output log.

◆ LogUserQueryStrings

bool TRIM.SDK.TrimEnterpriseWorkgroupServer.LogUserQueryStrings

getset

Gets or sets a boolean variable indicating whether this workgroup logs user search strings to the output log.

◆ LogWgsInternalCalls

bool TRIM.SDK.TrimEnterpriseWorkgroupServer.LogWgsInternalCalls

getset

Gets or sets a boolean variable indicating whether this workgroup logs internal workgroup calls to the output log.

◆ PortNumber

int TRIM.SDK.TrimEnterpriseWorkgroupServer.PortNumber

get

Gets the TCP port number used by this workgroup server.

◆ PublishDatasets

bool TRIM.SDK.TrimEnterpriseWorkgroupServer.PublishDatasets

getset

Gets or sets a boolean variable indicating whether this workgroup publishes the list of available datasets to clients.

◆ ServerName

string TRIM.SDK.TrimEnterpriseWorkgroupServer.ServerName

get

Gets the server machine name of this workgroup server.

◆ SharePointFarmId

short TRIM.SDK.TrimEnterpriseWorkgroupServer.SharePointFarmId

getset

Gets or sets a number indicating the id of the SharePoint farm designated for this workgroup. 0 indicates that it is not sending events to the SharePoint integration.

◆ TCPAddress

string TRIM.SDK.TrimEnterpriseWorkgroupServer.TCPAddress

getset

Gets or sets the TCP address of this server. A blank value indicates binding to all local interfaces (i.e. '0.0.0.0').

◆ UsesDocumentCache

bool TRIM.SDK.TrimEnterpriseWorkgroupServer.UsesDocumentCache

getset

Gets or sets a boolean variable indicating whether this workgroup maintains a local cache of recently accessed documents.

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ DisableHTTP()

◆ DisableHTTPS()

◆ EnableHTTP()

◆ EnableHTTPS()

◆ IsAuthenticationMethodSupported()

◆ Remove()

◆ SetAuthenticationMethod()

Property Documentation

◆ CanProcessEvents

◆ DocumentCacheSizeLimitMg

◆ HTTPAddress

◆ HTTPEnabled

◆ HTTPPortNumber

◆ HTTPSAddress

◆ HTTPSCertSubject

◆ HTTPSCertThumbprint

◆ HTTPSEnabled

◆ HTTPSPortNumber

◆ Id

◆ LoggingEnabled

◆ LogRCFCalls

◆ LogSQLWithNoParams

◆ LogUserQueryStrings

◆ LogWgsInternalCalls

◆ PortNumber

◆ PublishDatasets

◆ ServerName

◆ SharePointFarmId

◆ TCPAddress

◆ UsesDocumentCache