Server (Component)

The Server object lets you save and delete hosting customers, set the server's state (active or inactive), suspend authoring, and return high-level server information such as date and time formats, available keys, admin menu customizations, and so on.

Methods marked below with [L] may be logged at the server level (if transaction logging is licensed and enabled by the administrator)

Methods marked below with [C] may be customized at the server level

Methods:

deleteHostingCustomer [L] [C]	Deletes a hosting customer.
getAdminMenuCustomizations	Returns zero or more structures, each containing information on customized Server Administrator menu items; for example, the menu's name, description, and onclick action.
getAdminMenuSectionCustomizations	Returns zero or more structures, each containing information about customized Server Administrator menu sections. This includes information such as the section's description, name, and permissions.
getAuthorSuspendState	Returns a structure containing information about the authoring suspend state; for example, when it will be suspended, a warning message displayed before authoring is suspended, and so on.
getAvailableServerKeys	Returns a comma-delimited list of one or more server key file names that are not in use. If this is an empty string, no server keys exist that are not in use.
getDatasourcesList	Returns an array of datasource names for sites and users.
getDateFormats	Returns one or more structures, each containing information on the formats that can be used to display a date.
getHostingCustomerList	Returns one or more structures, each containing basic information about hosting customers configured for this server.
getInfo	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.
getInstalledPatches	Returns zero or more structures, each containing information about one patch made to CommonSpot.
getLocales	Returns one or more structures, each containing information about the locales configured for this server.
getMenuContext	Returns a structure containing information used to determine which CommonSpot menu items to display and enable.
getMigratedSiteInfo	Retrieve a structure whose contents are the path, URL, and the mapping for a site to be migrated.
getSiteReplicationRequests	Returns zero or more structures, each containing information on a replication request on a read-only server; for example the master server's ID, the server requesting replication, and so on.
getSitesList	Returns zero or more structures, each containing information about a server's sites; for example, inactive, read only, and so on.
getTimeFormats	Returns one or more structures, each containing information on one of a site's time formats.
saveAuthorSuspendState [L] [C]	Either suspends the server's authoring state or allows authoring to resume. If authoring will be suspended, you must enter the date and time at which this will occur and tell CommonSpot how many minutes before the suspension it will display a warning message.
saveHostingCustomer [L] [C]	Updates an existing hosting customer record.
saveSiteState [L] [C]	Sets a site's state to 'Active' or 'Inactive'.