Content Studio Web Content Management System
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
XML An Xml document with the following sample syntax (in this case the AdminURL settings is requested).
Comments
READ permission on the settings to list is required.
This is the backwards compatible implementation of this method.
This implementation does not throw any exceptions, instead callers must examine the outcome of the call in the Status and StatusText output parameters.
The following well-known settings are recognized
[This is preliminary documentation and is subject to change.]
Gets the details of a setting or a list of all settings as an XML document.
Namespace: ContentStudio
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
public string GetSetting( ConnectionId connectionId, SessionId sessionId, string settingName, out int status, out string statusText )
Parameters
- connectionId
- Type: ContentStudioConnectionId
A value that identifies the web site. - sessionId
- Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId). - settingName
- Type: SystemString
The name of the setting to return. The length of this value may not exceed MAX_SETTING_NAME. - status
- Type: SystemInt32
An integer indication the the call. Zero is success. - statusText
- Type: SystemString
The textual representation of the call result.
Return Value
Type: StringXML An Xml document with the following sample syntax (in this case the AdminURL settings is requested).
<root> <status>0</status> <statustext>Success</statustext> <settings> <setting> <name>AdminURL</name> <value>http://Mysite/csAdmin</value> <setting>site.AdminURL</setting> <datatype>text</datatype> <attributes></attributes> <description>The full URL of the admin site</description> </setting> <!-- More settings can follow if a list is requested --> </settings> </root>
Field | Comment |
---|---|
name | The name of the setting. |
value | The value of the setting, which can be numeric only or regular text |
setting | The full name of the setting consisting of the section name and the name separated by a dot (.). |
datatype | Determines the type of data the setting can contain. Values can be numeric or text. |
attributes | Extended properties for the setting. This field can either be left empty or contain the string read-only. |
description | The description of the setting. |
Content Studio permissions
Remarks
The following well-known settings are recognized
Name | Read-only | Description |
---|---|---|
AdminURL | No | The full URL of the admin site. Normally modified from the SiteContentManager tool. |
Anonymous_Account | No | IIS Anonymous user account. Empty string to have CS to ask the IIS metabase. Normally modified from the SiteContentManager tool. |
CharacterSet | Yes | CharacterSet used on the site. This value can be overridden on any level below. |
DB_SessionTimeOut | No | Sets the time (in) minutes how long a user session is valid without activity. Default value is 60 and values less than 10 is ignored. Normally there is no need to to modify this value. |
Default_SMTP_Server | No | Specifies the default SMTP server used by this installation. |
DelegateMasterUrl | No | Used for master-slave server synchronization only. Setting for anonymous delegation of http-requests to admin. Here you can type an internal admin url. |
DisplaySiteUrlData | No | Controls when Content Studio web pages displays url information in client side scripts code. Values can be
|
DocNotFoundId | No | Redirect to this document when a user navigates to a document that does not exist. |
DocNotPublishedId | No | Redirect to this document when a user navigates to a document that is not published. |
Yes | The email address of Content Studio support, currently not used. | |
EmptyFileContent | No | A default value to insert into a ASPX-file that not yet has been approved. |
File_Path | Yes | Physical path of file storage. Can only be modified from the SiteContentManager tool. |
MultiHomedAdminUrl | No | For sites using more than one site url, empty otherwise. Add one or more urls separated by a semicolon (;). The ordering must be the same as the corresponding MultiHomedSiteUrl setting. Requires multi site mode.If you wish that one of the addresses should not use an admin url add an semicolon as a place-holder. |
MultiHomedSiteUrl | No | For sites using more than one site url, empty otherwise. Add one or more urls separated by a semicolon (;). The ordering must be the same as the corresponding MultiHomedAdminUrl setting. Requires multi site mode. |
QueryStringPrefix | No | Tells witch prefix that should be used in querystring to reference document id. |
TreeCategoryList | No | A list of comma separated category id:s. This setting in combination with TreeDocId is used to force users to only choose between this set of categories when users creates a new document in the hierarchy. |
TreeDocId | No | Document root tree id. In this setting you can type the root document id for the site document hierarchy. This will enable switching to a tree view in the folder structure. |
UseDelegateRequest | No | Regulates anonymous delegation of http-requests. This is used for external web-objects and anonymous access in document writer 4.0.
|
HideFullText | No | The value 1 hides the button that allows an administrator to manage CS fulltext index. This will be enabled if fulltext is installed and enable for the database. |
IgnoreFullTextFields | No | This setting can contain a comma separated list of EPT fields that will not be full text indexed. An asterisk (*) can be used as a wild-chard at the end or at the start of each field. |
InfoURL | No | URL to application information site or document. |
IE_Style | No | Relative or absolute path and filename of the style sheet used by Internet Explorer. |
Language | No | Admin application language |
Max_UserLogInEntries | No | Sets the number of user login entries that are saved in the system. 0 is unlimited. |
Max_WFLogEntries | No | The number of entries in the workflow log before the log wraps around. Values below 100 means no wrap around. |
MetaData | No | Global meta data for the entire site. This info will be included in every content. |
MaxHistory | No | The number of history entrances stored for each user. 0 means no limit. |
PDF_ServerInstalled | No | Specifies that this site is enabled for background generation. Set this setting to 1 only if there is a Content Studio PDF service installed and licensed to use with this site. |
RevisionDemanded | No | Set to 1 if a document must be sent for revision before it can be approved. This setting is not relevant for categories when Workflow is in use. |
SiteURL | No | The full URL of the main site. Normally modified from the SiteContentManager tool. |
StartID | No | Default start page id. Determines the document to display when the visitor only specifies a path. |
SupportURL | Yes | URL to support site. |
SyncExtUserProps | No | Indicates that Content Studio should synchronize extended user properties such as fax and telephone numbers from Active Directory. |
WebName | No | Name of web |
See Also