Server.getInfo (Method)
Returns a structure containing information about this server's CommonSpot license; for example, the data sources it uses, the kind of license, the maximum number or users, and so on.
Returns:
Server_GetInfo_Struct (struct)
Each row of the returned query results has the following fields:
Field Name | Type | Description |
---|---|---|
AuthoringEnabled | Boolean | Boolean flag which when true indicates that authoring is enabled for this server. |
CacheServerLimit | NonNegativeSmallInteger | Count of caching servers licensed for this cluster. |
CommonSpotVersion | PlainText_NonNull | The version of CommonSpot installed on this server. |
DatabaseType | DatabaseType | The database's manufacturer, which can be 'MySQL', 'Oracle', or 'SQLServer'. |
DatabaseVersion | PlainText_NonNull | The database version. |
Datasource | PlainText_NonNull | The name of the data source pointing to the 'sites' database. |
DatasourceRO | PlainText | If a sandbox configuration is enabled, this is the name of a read only version of the data source. Otherwise, this is an empty string. |
ID | ServerID | The server's ID. |
isCachingServer | Boolean | Boolean flag indicating whether the server is a caching server. |
IsDeveloper | Boolean | Boolean flag which when true indicates that this server's license is a developers license. |
IsEval | Boolean | Boolean flag which when true indicates that this server's license is an evaluation license. |
isHost | Boolean | Boolean flag which when true indicates that this server's license allows multiple customers. |
isMaster | Boolean | Boolean flag which when true indicates that this server is the master/authoring server in a shared database configuration. |
IsNoResale | Boolean | Boolean flag which when true indicates that this server's license is a not for resale license. |
isSharedCacheEnabled | Boolean | Boolean flag indicating whether shared cache is enabled in a shared-database cluster. |
isSharedDatabaseEnvironment | Boolean | A boolean flag which when set to true indicates that this server supports Shared Database. |
IsTraining | Boolean | Boolean flag which when true indicates that this server's license is a training license. |
LicensedDatabases | PlainText_NonNull | A '||' delimited list of databases that the customer is licensed to use. |
LicensedTo | PlainText_NonNull | The name of the organization to which CommonSpot is licensed. |
LicenseKey | PlainText_NonNull | The file name of the 'server' license key. |
MaxCustomers | NonNegativeInteger | The maximum number of customers that the license allows to access CommonSpot simultaneously. |
MaxROPs | NonNegativeInteger | The maximum number of shared database read-only production servers that the license allows. |
Name | PlainText_NonNull_128 | The server's name. |
OperatingSystem | PlainText_NonNull | The name of the operating system of the computer upon which CommonSpot is running. |
SchemaVersion | PlainText_NonNull | The date and time of the CommonSpot schema version for the 'sites' database. |
ServerAlias | IPAddressOrHostName_EmptyString | The IP Address or alias of the server. |
ServerPort | ServerPort_EmptyString | The server port, if applicable. |
ServerType | ServerType | String identifying a server's type; for example, authoring, replication master, and so on. |
Context:
License Requirements | None |
Permission Requirements | ContributorOrServerCode |
Deny Context | None |
Require Context | None |
Author Lock | (not required) |
Transaction Logging | Transaction logging is disabled for this method |
Customization | Customization is not supported for this method. |
Error Codes:
None
Notes:
None