Jump to: navigation, search

CfgFolder

Description

Folders can be used to create hierarchies of other types of objects. Each folder can contain a collection of objects of a single type.

Filter Keys

Filter Name Type Description
dbid int A unique identifier of a folder. If specified, Configuration Server will return information only about this folder.
name string Name of a folder. Shall be specified as a character string. If specified, Configuration Server will return information only about the folder(s) with that name.
owner_dbid int A unique identifier of an owner object. If specified, Configuration Server will return information only about the folders that belong to this object. Must be used in conjunction with the owner_type filter.
owner_type int A type of an owner object. Must be used in conjunction with the owner_dbid filter.
type int A type of a folder. If specified, Configuration Server will return information only about folders of this type.
default_folder int A flag which selects among the folders belonging to some owner object the topmost one, e.g. that which does not have a parent folder above. Must be used in conjunction with owner_type and owner_dbid filters. Most likely will be used with type filter.
object_dbid int A unique identifier of a subordinate object. If specified, Configuration Server will return information only about the folder that contains this object. Must be used in conjunction with the object_type filter.
object_type int A type of a subordinate object. Must be used in conjunction with the object_dbid filter.
state int Current state of a folder (see type CfgObjectState). If specified, Configuration Server will return information only about folders that are currently in this state.
folder_class int A class of a folder. If specified, Configuration Server will return information only about folders of this class.

Attributes

  • DBID — An identifier of this object in the Configuration Database. Generated by Configuration Server and is unique within an object type. Identifiers of deleted objects are not used again. Read-only.
  • name — A pointer to name of the folder. Mandatory. Must be unique within the parent object.
  • type — Type of the objects this folder may contain. A folder may contain either objects of this type or subfolders with the same value of type property. See the CfgObjectType enumeration.
  • ownerID — A structure containing the object type and DBID of the folder's owner object. Unlike parentID, this field defines the folder's logical affiliation rather than its hierarchical affiliation. An owner may be an object of the following types:
    See CfgID.
  • state — Current object state. Mandatory. Refer to CfgObjectState.
  • userProperties — A pointer to the list of user-defined properties. Parameter userProperties has the following structure: Each key-value pair of the primary list (TKVList *userProperties) uses the key for the name of a user-defined section, and the value for a secondary list, that also has the TKVList structure and specifies the properties defined within that section.
  • objectIDs — Pointer to the list of CfgID objects containing the type and DBID of the objects subordinate to this folder. Only objects of the type equal to the folder's type property or subfolders of this type may be contained in this list.
  • parentID — A structure containing object type and DBID of the folder's parent, e.g. object which stands higher in the hierarchy. This may be another folder, if this folder is a subfolder, or this field may coincide with ownerID field if this folder is a topmost (default) one. A parent may an object of the following types: CfgFolder, CfgTenant, CfgSwitch, CfgIVR, or CfgEnumerator. See CfgID.
  • folderClass — The class of the Folder.Refer to CfgFolderClass enumeration.
  • customType — User classificator of the Folder. Optional.
  • resources — A pointer to the list of the objects associated with this Folder (every item of this list is structured as CfgObjectResource).
    When used as an entry in CfgDeltaFolder, it is a pointer to a list of resources added to the existing list. Only objects of the following types can be associated with Folder object through resources:

Comments

  • A folder may contain objects of the type equal to the folder's type property or subfolders of this type.
  • An object may be contained in one and only one folder (has only one parent).
  • A folder may be a subfolder of only one parent folder or does not have a parent folder at all (be a default folder under some parent object)
  • There can not be more than one default folder of particular type for some parent object.
  • A folder can not be removed as long as it has at least one subordinate object.
  • A Configuration Unit is a GUI name for the folder of type CfgFolder. Unlike other folders, this folder can not contain ordinary objects, but may contain folders of any type including folders of type CfgFolder (Configuration Units)
  • Configuration Units can only be created under the Tenant object or other Configuration Unit.

XML Representation

Important
This XML was created using the Configuration Server 7.5 schema.
<CfgFolder>
	<DBID value="101" />
	<name value="A Folder" />
	<type value="3" />
	<CfgOwnerID>
		<CSID value="0" />
		<DBID value="1" />
		<type value="7" />
	</CfgOwnerID>
	<state value="1" />
	<objectIDs>
		<CfgObjectID>
			<CSID value="0" />
			<DBID value="223" />
			<type value="22" />
		</CfgObjectID>
		<CfgObjectID>
			<CSID value="0" />
			<DBID value="99" />
			<type value="20" />
		</CfgObjectID>
	</objectIDs>
	<CfgParentID>
		<CSID value="0" />
		<DBID value="1" />
		<type value="7" />
	</CfgParentID>
	<folderClass value="1" />
	<customType value="0" />
</CfgFolder>

See Also

CfgDeltaFolder

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on 27 June 2017, at 13:21.